Skip to content

Commit bab33a0

Browse files
res0nat0rres0nat0r
committed
fixed formatting
1 parent b7994f4 commit bab33a0

File tree

1 file changed

+129
-134
lines changed

1 file changed

+129
-134
lines changed

‎README.rdoc

+129-134
Original file line numberDiff line numberDiff line change
@@ -1,134 +1,129 @@
1-
#--
2-
# $Id: README.rdoc,v 1.19 2008/10/03 12:00:57 ianmacd Exp $
3-
#++
4-
#
5-
#
6-
# = Ruby/AWS - A Ruby interface to the Amazon Associates Web Services API.
7-
#
8-
# == Introduction
9-
#
10-
# Ruby/AWS is a Ruby language library that allows programmatic access to
11-
# the popular Amazon Web sites via the AWS v4 API. It is the successor to the
12-
# now obsolete Ruby/Amazon.
13-
#
14-
# In addition to the original
15-
# amazon.com[http://www.amazon.com/exec/obidos/redirect-home/calibanorg-20]
16-
# site, the local sites
17-
# amazon.co.uk[http://www.amazon.co.uk/exec/obidos/redirect-home/caliban-21],
18-
# amazon.de[http://www.amazon.de/exec/obidos/redirect-home/calibanorg0a-21],
19-
# amazon.fr[http://www.amazon.fr/exec/obidos/redirect-home/caliban08-21],
20-
# amazon.ca[http://www.amazon.ca/exec/obidos/redirect-home/caliban-20] and
21-
# amazon.co.jp[http://www.amazon.co.jp/exec/obidos/redirect-home/calibanorg-20]
22-
# are also supported.
23-
#
24-
# Although the library is still in development, the AWS v4 API is now more or
25-
# less fully supported, with only tiny gaps in the functionality of some
26-
# operations.
27-
#
28-
# The following operations are supported:
29-
#
30-
# BrowseNodeLookup
31-
# CustomerContentLookup
32-
# CustomerContentSearch
33-
# Help
34-
# ItemLookup
35-
# ItemSearch
36-
# ListLookup
37-
# ListSearch
38-
# SellerListingLookup
39-
# SellerListingSearch
40-
# SellerLookup
41-
# SimilarityLookup
42-
# TagLookup
43-
# TransactionLookup
44-
#
45-
# Remote shopping-carts are also supported. This adds the following operations:
46-
#
47-
# CartCreate
48-
# CartAdd
49-
# CartModify
50-
# CartClear
51-
# CartGet
52-
#
53-
# In addition, multiple operations and batch requests are also supported.
54-
#
55-
# Ruby/AWS also offers advanced features not directly available in the AWS
56-
# API, such as the ability to retrieve *all* results pages for a particular
57-
# search, rather than having to manually deal with AWS responses of 10 results
58-
# per page.
59-
#
60-
# You can also retrieve product images and optionally overlay them with
61-
# percentage discount icons.
62-
#
63-
# Another advanced feature is the ability to cache responses returned by AWS.
64-
# If the cache is used (as it is by default), the results of each unique
65-
# query will be cached and used for 24 hours. The cache can be manually
66-
# flushed of all or just the expired entries.
67-
#
68-
# One other useful advanced feature is the ability to determine the
69-
# appropriate Amazon locale for a given client, based on its IP address or
70-
# host name. This allows you to perform AWS operations using the correct
71-
# geographical Amazon site for any given client. German and Austrian clients
72-
# can be made to interact with amazon.de, British and Irish clients with
73-
# amazon.co.uk, etc.
74-
#
75-
#
76-
# == Installation
77-
#
78-
# Please see the +INSTALL+ file supplied with the software for details of how
79-
# to install Ruby/AWS. You can choose between an installation script and a
80-
# RubyGems[http://www.rubygems.org/] installation.
81-
#
82-
# Note, however, if choosing the gem installation, that whilst Ruby/AWS's
83-
# RubyForge UNIX name is now ruby-aaws. The ruby-aws name was taken by
84-
# {another project}[http://rubyforge.org/projects/ruby-aws/] and this clash
85-
# prevented remote installation of the Ruby/AWS gem.
86-
#
87-
#
88-
# == Prerequisites
89-
#
90-
# Before you can use this library, you need to obtain an Amazon Web Services
91-
# {access key
92-
# ID}[https://aws-portal.amazon.com/gp/aws/developer/registration/index.html].
93-
#
94-
# You should also apply for an {Associates
95-
# account}[http://docs.amazonwebservices.com/AWSECommerceService/2008-04-07/GSG/BecominganAssociate.html],
96-
# although this isn't strictly necessary. If you do not explicitly provide an
97-
# Associates tag in your calls through Ruby/AWS, the tag of the Ruby/AWS
98-
# author will be used by default.
99-
#
100-
#
101-
# == See Also
102-
#
103-
# Ultimately, the way to get the most from this library is to read the AWS
104-
# documentation to get a feel for what is possible, and then experiment with
105-
# this library to see how the AWS calls are mapped into the Ruby world. You
106-
# should also review this library's
107-
# RDoc[http://www.ruby-doc.org/core/classes/RDoc.html]
108-
# documentation[http://www.caliban.org/ruby/ruby-aws/] as well as the
109-
# plain-text +README+ file that came with the archive.
110-
#
111-
# Additionally, there's a
112-
# {mailing-list}[http://www.caliban.org/mailman/listinfo/ruby-aws] available,
113-
# where you can discuss all Ruby/AWS-related subjects and issues.
114-
#
115-
# Please see the Amazon Web Services
116-
# documentation[http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=5]
117-
# for definitive information on the capabilities and inner workings of the AWS
118-
# API.
119-
#
120-
#
121-
# == Download
122-
#
123-
# Version 0.4.4
124-
# === {gzip'ed tar archive}[http://www.caliban.org/files/ruby/ruby-aws-0.4.4.tar.gz]
125-
# === {Ruby Gem}[http://www.caliban.org/files/ruby/ruby-aaws-0.4.4.gem]
126-
# === {Fedora 9 RPM}[http://www.caliban.org/files/redhat/RPMS/noarch/ruby-aws-0.4.4-1.fc9.noarch.rpm]
127-
# === {Fedora 9 doc RPM}[http://www.caliban.org/files/redhat/RPMS/noarch/ruby-aws-doc-0.4.4-1.fc9.noarch.rpm]
128-
# === {Fedora 9 source RPM}[http://www.caliban.org/files/redhat/SRPMS/ruby-aws-0.4.4-1.fc9.src.rpm]
129-
#
130-
#
131-
# ---
132-
# Author:: Ian Macdonald <mailto:[email protected]>
133-
# Version:: 0.4.4
134-
# Licence:: GPL[http://www.gnu.org/copyleft/gpl.html]
1+
= Ruby/AWS - A Ruby interface to the Amazon Associates Web Services API.
2+
3+
== Introduction
4+
5+
Ruby/AWS is a Ruby language library that allows programmatic access to
6+
the popular Amazon Web sites via the AWS v4 API. It is the successor to the
7+
now obsolete Ruby/Amazon.
8+
9+
In addition to the original
10+
amazon.com[http://www.amazon.com/exec/obidos/redirect-home/calibanorg-20]
11+
site, the local sites
12+
amazon.co.uk[http://www.amazon.co.uk/exec/obidos/redirect-home/caliban-21],
13+
amazon.de[http://www.amazon.de/exec/obidos/redirect-home/calibanorg0a-21],
14+
amazon.fr[http://www.amazon.fr/exec/obidos/redirect-home/caliban08-21],
15+
amazon.ca[http://www.amazon.ca/exec/obidos/redirect-home/caliban-20] and
16+
amazon.co.jp[http://www.amazon.co.jp/exec/obidos/redirect-home/calibanorg-20]
17+
are also supported.
18+
19+
Although the library is still in development, the AWS v4 API is now more or
20+
less fully supported, with only tiny gaps in the functionality of some
21+
operations.
22+
23+
The following operations are supported:
24+
25+
BrowseNodeLookup
26+
CustomerContentLookup
27+
CustomerContentSearch
28+
Help
29+
ItemLookup
30+
ItemSearch
31+
ListLookup
32+
ListSearch
33+
SellerListingLookup
34+
SellerListingSearch
35+
SellerLookup
36+
SimilarityLookup
37+
TagLookup
38+
TransactionLookup
39+
40+
Remote shopping-carts are also supported. This adds the following operations:
41+
42+
CartCreate
43+
CartAdd
44+
CartModify
45+
CartClear
46+
CartGet
47+
48+
In addition, multiple operations and batch requests are also supported.
49+
50+
Ruby/AWS also offers advanced features not directly available in the AWS
51+
API, such as the ability to retrieve *all* results pages for a particular
52+
search, rather than having to manually deal with AWS responses of 10 results
53+
per page.
54+
55+
You can also retrieve product images and optionally overlay them with
56+
percentage discount icons.
57+
58+
Another advanced feature is the ability to cache responses returned by AWS.
59+
If the cache is used (as it is by default), the results of each unique
60+
query will be cached and used for 24 hours. The cache can be manually
61+
flushed of all or just the expired entries.
62+
63+
One other useful advanced feature is the ability to determine the
64+
appropriate Amazon locale for a given client, based on its IP address or
65+
host name. This allows you to perform AWS operations using the correct
66+
geographical Amazon site for any given client. German and Austrian clients
67+
can be made to interact with amazon.de, British and Irish clients with
68+
amazon.co.uk, etc.
69+
70+
71+
== Installation
72+
73+
Please see the +INSTALL+ file supplied with the software for details of how
74+
to install Ruby/AWS. You can choose between an installation script and a
75+
RubyGems[http://www.rubygems.org/] installation.
76+
77+
Note, however, if choosing the gem installation, that whilst Ruby/AWS's
78+
RubyForge UNIX name is now ruby-aaws. The ruby-aws name was taken by
79+
{another project}[http://rubyforge.org/projects/ruby-aws/] and this clash
80+
prevented remote installation of the Ruby/AWS gem.
81+
82+
83+
== Prerequisites
84+
85+
Before you can use this library, you need to obtain an Amazon Web Services
86+
{access key
87+
ID}[https://aws-portal.amazon.com/gp/aws/developer/registration/index.html].
88+
89+
You should also apply for an {Associates
90+
account}[http://docs.amazonwebservices.com/AWSECommerceService/2008-04-07/GSG/BecominganAssociate.html],
91+
although this isn't strictly necessary. If you do not explicitly provide an
92+
Associates tag in your calls through Ruby/AWS, the tag of the Ruby/AWS
93+
author will be used by default.
94+
95+
96+
== See Also
97+
98+
Ultimately, the way to get the most from this library is to read the AWS
99+
documentation to get a feel for what is possible, and then experiment with
100+
this library to see how the AWS calls are mapped into the Ruby world. You
101+
should also review this library's
102+
RDoc[http://www.ruby-doc.org/core/classes/RDoc.html]
103+
documentation[http://www.caliban.org/ruby/ruby-aws/] as well as the
104+
plain-text +README+ file that came with the archive.
105+
106+
Additionally, there's a
107+
{mailing-list}[http://www.caliban.org/mailman/listinfo/ruby-aws] available,
108+
where you can discuss all Ruby/AWS-related subjects and issues.
109+
110+
Please see the Amazon Web Services
111+
documentation[http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=5]
112+
for definitive information on the capabilities and inner workings of the AWS
113+
API.
114+
115+
116+
== Download
117+
118+
Version 0.4.4
119+
=== {gzip'ed tar archive}[http://www.caliban.org/files/ruby/ruby-aws-0.4.4.tar.gz]
120+
=== {Ruby Gem}[http://www.caliban.org/files/ruby/ruby-aaws-0.4.4.gem]
121+
=== {Fedora 9 RPM}[http://www.caliban.org/files/redhat/RPMS/noarch/ruby-aws-0.4.4-1.fc9.noarch.rpm]
122+
=== {Fedora 9 doc RPM}[http://www.caliban.org/files/redhat/RPMS/noarch/ruby-aws-doc-0.4.4-1.fc9.noarch.rpm]
123+
=== {Fedora 9 source RPM}[http://www.caliban.org/files/redhat/SRPMS/ruby-aws-0.4.4-1.fc9.src.rpm]
124+
125+
126+
---
127+
Author:: Ian Macdonald <mailto:[email protected]>
128+
Version:: 0.4.4
129+
Licence:: GPL[http://www.gnu.org/copyleft/gpl.html]

0 commit comments

Comments
 (0)