vacuum 0.2.0.pre.1 → 0.2.0

data/README.md

@@ -2,76 +2,112 @@
 
 [![travis] [1]] [2]
 
-Vacuum is a Ruby wrapper to [various Amazon Web Services (AWS) APIs] [3].
+Vacuum is a thin Ruby wrapper to various [Amazon Web Services (AWS) APIs] [3].
 
 ![vacuum] [4]
 
+## Installation
+
+```sh
+gem install vacuum
+```
+
 ## Amazon Product Advertising API
 
-Vacuum knows the [Amazon Product Advertising API] [5] [inside out] [6].
+Vacuum knows the [Amazon Product Advertising API] [5] inside out.
+
+Set up a request:
 
 ```ruby
-request = Vacuum.new(:product_advertising) do |config|
-  config.locale 'US'
+req = Vacuum.new :product_advertising
 
+req.configure do |config|
   config.key    'key'
   config.secret 'secret'
   config.tag    'tag'
 end
+```
+
+Build and run a search:
+
+```ruby
+req.build operation:    'ItemSearch',
+          search_index: 'Books',
+          keywords:     'Deleuze'
+res = req.get
+```
+
+Or accomplish the same search less verbosely:
+
+```ruby
+res = req.search :books, 'Deleuze'
+```
+
+The response wraps a [Nokogiri] [6] document:
+
+```ruby
+res.xml
+```
 
-# Use an alternative Faraday adapter.
-# request.connection do |builder|
-#   builder.adapter :typhoeus
-# end
-
-# A barebone search request.
-request.build operation:    'ItemSearch',
-              search_index: 'Books',
-              keywords:     'Deleuze'
-response = request.get
-
-# A less verbose search.
-request.search :books, 'Deleuze'
-
-if response.valid?
-  # response.code
-  # response.body
-  # response.errors
-  # response.xml # The Nokogiri XML doc
-  # response.to_hash
-  response.find('Item') do |item|
-    p item['ASIN']
+And lets you drop down to any node:
+
+```ruby
+if res.valid?
+  res.find('Item') do |item|
+    p item
   end
 end
 ```
+
+You will find more examples [here] [7].
+
 ## Amazon Marketplace Web Services API
 
-The wrapper to the [Amazon Marketplace Web Services API] [7] is a
+The wrapper to the [Amazon Marketplace Web Services API] [8] is a
 work-in-progress.
 
+Set up a request to the Products API:
+
 ```ruby
-request = Vacuum.new(:mws_products) do |config|
+req = Vacuum.new(:mws_products) do |config|
   config.locale      'US'
-
   config.key         'key'
   config.secret      'secret'
   config.marketplace 'marketplace'
   config.seller      'seller'
 end
+```
+
+Get the lowest offers for a single ASIN:
 
-request.build 'Action'          => 'GetLowestOfferListingsForASIN',
-              'ASINList.ASIN.1' => '0231081596'
-offers = request.get.find 'GetLowestOfferListingsForASINResult'
+```ruby
+req.build 'Action'          => 'GetLowestOfferListingsForASIN',
+          'ASINList.ASIN.1' => '0231081596'
+offers = req.get.find 'GetLowestOfferListingsForASINResult'
 ```
 
+I will at some point throw in some syntactic sugar for common operations.
+
 ## Other AWS APIs
 
-Vacuum should work with EC2, S3, IAM, SimpleDB, SQS, SNS, SES, ELB, CW, and so
-on. Implement and send a pull request.
+Vacuum should work with all AWS libraries, including EC2, S3, IAM, SimpleDB,
+SQS, SNS, SES, and ELB. Most of these already have popular Ruby
+implementations. If you need to implement one using Vacuum, please fork and
+send a pull request when done.
+
+## HTTP Client Adapters
+
+You can use any of the alternative adapters [Faraday] [9] supports:
+
+```ruby
+req.connection do |builder|
+  builder.adapter :em_synchrony
+end
+```
 
-# Addendum
+## Addendum
 
-![vacuums] [8]
+![vacuums] [10]
 
 > Workers queuing to crawl AWS.
 
@@ -80,6 +116,8 @@ on. Implement and send a pull request.
 [3]: http://aws.amazon.com/
 [4]: http://f.cl.ly/items/2k2X0e2u0G3k1c260D2u/vacuum.png
 [5]: https://affiliate-program.amazon.co.uk/gp/advertising/api/detail/main.html
-[6]: https://github.com/hakanensari/vacuum/blob/master/examples/product_advertising/
-[7]: https://developer.amazonservices.com/gp/mws/docs.html
-[8]: http://f.cl.ly/items/1Q3W372A0H3M0w2H1e0W/hoover.jpeg
+[6]: http://nokogiri.org/
+[7]: https://github.com/hakanensari/vacuum/blob/master/examples/product_advertising/
+[8]: https://developer.amazonservices.com/gp/mws/docs.html
+[9]: https://github.com/technoweenie/faraday
+[10]: http://f.cl.ly/items/1Q3W372A0H3M0w2H1e0W/hoover.jpeg

data/lib/vacuum/version.rb

@@ -1,3 +1,3 @@
 module Vacuum
-  VERSION = '0.2.0.pre.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.1
-  prerelease: 6
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-02 00:00:00.000000000 Z
+date: 2012-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70260273152380 !ruby/object:Gem::Requirement
+  requirement: &70130080587320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70260273152380
+  version_requirements: *70130080587320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70260273201100 !ruby/object:Gem::Requirement
+  requirement: &70130080586800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *70260273201100
+  version_requirements: *70130080586800
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70260273200640 !ruby/object:Gem::Requirement
+  requirement: &70130080586300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70260273200640
+  version_requirements: *70130080586300
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70260273200160 !ruby/object:Gem::Requirement
+  requirement: &70130080585780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.7.6
   type: :runtime
   prerelease: false
-  version_requirements: *70260273200160
+  version_requirements: *70130080585780
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70260273199640 !ruby/object:Gem::Requirement
+  requirement: &70130080585140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70260273199640
+  version_requirements: *70130080585140
 description: ! 'Vacuum is a wrapper to various Amazon Web Services (AWS) APIs, including
 
   Product Advertising and Marketplace Web Services (MWS).
@@ -128,9 +128,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11