vacuum 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7024407a6c3d216a247ce435ef0ed65f56c1338
-  data.tar.gz: 86557dbfd10b6df9b0cec4a17fd12bd8f8cf5705
+  metadata.gz: c4c2d00043baa236106ea42ca2e2938ba88b40ba
+  data.tar.gz: 8e30624c24d2631a4a3bc9dfee01bbe2fcb8b5ea
 SHA512:
-  metadata.gz: 492be10dda8e7ea60b2f39db7531c503add9b37ceff989a5a11b45dbc77dabf972520988b04c7e6322797dc0c750a723f991ffd9cbad9e327a04473eb9492da8
-  data.tar.gz: e04fe2ee991293dbaf942190f05f49fb3008f6613023e6ac701e15769765f86c7b21cdee449369c5294a32d32b2976f2f33763ff626d16eab57dfa8052edacea
+  metadata.gz: a6ea78733efb0ab6a5f32c3356d78a9954f16944148de341addf25e05c1fd50fa850a6343b44de75a867d0e0de085654db26af9b82c1807981d77185e0d33538
+  data.tar.gz: 4842c0dbde4ccdab7864441ef770c18655536d089bb7ff48f3b1e9ab7cb5fc0dba6ddb8ed3628cd19b218386fc804db7b9b969432067c0dae89629f46d8c30e8

data/README.md

@@ -2,8 +2,7 @@
 
 [![Build Status][1]][2]
 
-Vacuum is a light-weight Ruby wrapper to the
-[Amazon Product Advertising API][4].
+Vacuum is a fast, light-weight Ruby wrapper to the [Amazon Product Advertising API][4].
 
 ![vacuum][3]
 
@@ -36,7 +35,7 @@ req.configure(
 
 Alternatively, set the key and secret as environment variables globally:
 
-```bash
+```sh
 export AWS_ACCESS_KEY_ID=key
 export AWS_SECRET_ACCESS_KEY=secret
 ```
@@ -56,27 +55,33 @@ params = {
   'SearchIndex' => 'Books',
   'Keywords'    => 'Architecture'
 }
-res = req.item_search(params)
+res = req.item_search(query: params)
 ```
 The above executes an item search operation. The names of available methods
 derive from the operations listed in the API docs and include
 `browse_node_lookup`, `cart_add`, `cart_clear`, `cart_create`, `cart_get`,
 `cart_modify`, `item_lookup`, `item_search`, and `similarity_lookup`.
 
-Vacuum builds on [Excon][5]. See latter's API for ways to tweak your requests.
+Vacuum uses [Excon][5] as HTTP client. Check the Excon API for ways to tweak
+your request:
+
+```ruby
+res = req.item_search(query: params, persistent: true)
+```
 
 ### Response
 
-The quick way to consume a response is to parse it into a Ruby hash:
+The quickest way to consume a response is to parse it into a Ruby hash:
 
 ```ruby
 res.to_h
 ```
 
 Vacuum uses [MultiXml][6], which will work with a number of popular XML
-libraries.
+libraries. If working in MRI, you may want to use [Ox][7].
 
-You can also pass the response body into a custom parser:
+You can also pass the response body into your own parser for some custom XML
+heavy-lifting:
 
 ```ruby
 MyParser.new(res.body)
@@ -88,3 +93,4 @@ MyParser.new(res.body)
 [4]: https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html
 [5]: https://github.com/geemus/excon
 [6]: https://github.com/sferik/multi_xml
+[7]: https://github.com/ohler55/ox

data/lib/vacuum/request.rb

@@ -9,15 +9,16 @@ module Vacuum
     BadLocale  = Class.new(ArgumentError)
 
     HOSTS = {
+      'BR' => 'webservices.amazon.com.br',
       'CA' => 'webservices.amazon.ca',
       'CN' => 'webservices.amazon.cn',
       'DE' => 'webservices.amazon.de',
       'ES' => 'webservices.amazon.es',
       'FR' => 'webservices.amazon.fr',
+      'GB' => 'webservices.amazon.co.uk',
       'IN' => 'webservices.amazon.in',
       'IT' => 'webservices.amazon.it',
       'JP' => 'webservices.amazon.co.jp',
-      'GB' => 'webservices.amazon.co.uk',
       'US' => 'webservices.amazon.com'
     }.freeze
 
@@ -65,22 +66,39 @@ module Vacuum
       self
     end
 
+    # Execute an API operation. See `OPERATIONS` constant for available
+    # operation names.
+    #
+    # params - The Hash request parameters.
+    # opts   - Options passed to Excon (default: {}).
+    #
+    # Alternatively, pass Excon options as first argument and include request
+    # parameters as query key.
+    #
+    # Examples
+    #
+    #   req.item_search(
+    #     'SearchIndex' => 'All',
+    #     'Keywords' => 'Architecture'
+    #   )
+    #
+    #   req.item_search(
+    #     query: {
+    #       'SearchIndex' => 'All',
+    #       'Keywords' => 'Architecture'
+    #     },
+    #     persistent: true
+    #   )
+    #
+    # Returns a Vacuum Response.
     OPERATIONS.each do |operation|
       method_name = operation.gsub(/(.)([A-Z])/,'\1_\2').downcase
       define_method(method_name) do |params, opts = {}|
-        res = get(opts.merge(query: params.merge('Operation' => operation)))
-        Response.new(res)
-      end
-    end
+        params.has_key?(:query) ? opts = params : opts.update(query: params)
+        opts[:query].update('Operation' => operation)
 
-    # Build a URL.
-    #
-    # params - A Hash of Amazon Product Advertising request parameters.
-    #
-    # Returns the built URL String.
-    def url(params)
-      opts = { method: :get, query: params }
-      [aws_endpoint, build_options(opts).fetch(:query)].join('?')
+        Response.new(get(opts))
+      end
     end
   end
 end

data/lib/vacuum/version.rb

@@ -1,3 +1,3 @@
 module Vacuum
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/test/test_vacuum.rb

@@ -5,26 +5,34 @@ require_relative '../lib/vacuum'
 class TestVacuum < Minitest::Test
   include Vacuum
 
+  def setup
+    @req = Request.new
+  end
+
+  def teardown
+    Excon.stubs.clear
+  end
+
   def test_requires_valid_locale
     assert_raises(Request::BadLocale) { Request.new('foo') }
   end
 
   def test_defaults_to_us_endpoint
-    assert_equal 'http://webservices.amazon.com/onca/xml', Request.new.aws_endpoint
+    assert_equal 'http://webservices.amazon.com/onca/xml', @req.aws_endpoint
   end
 
-  def test_returns_url
-    req = Request.new
-    req.configure(aws_access_key_id: 'key', aws_secret_access_key: 'secret', associate_tag: 'tag')
-    assert_match(/webservices.amazon.com.*Foo=Bar/, req.url('Foo' => 'Bar'))
+  def test_fetches_parsable_response
+    Excon.stub({}, { body: '<foo>bar</foo>' })
+    @req.configure(aws_access_key_id: 'key', aws_secret_access_key: 'secret', associate_tag: 'tag')
+    res = @req.item_lookup({}, mock: true)
+    refute_empty res.to_h
   end
 
-  def test_fetches_parsable_response
+  def test_alternative_query_syntax
     Excon.stub({}, { body: '<foo>bar</foo>' })
     req = Request.new
     req.configure(aws_access_key_id: 'key', aws_secret_access_key: 'secret', associate_tag: 'tag')
-    res = req.item_lookup({}, mock: true)
+    res = req.item_lookup(query: {}, mock: true)
     refute_empty res.to_h
-    Excon.stubs.clear
   end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeff
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A wrapper to the Amazon Product Advertising API
@@ -73,12 +73,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/vacuum.rb
 - lib/vacuum/request.rb
 - lib/vacuum/response.rb
 - lib/vacuum/version.rb
-- lib/vacuum.rb
-- LICENSE
-- README.md
 - test/test_vacuum.rb
 homepage: https://github.com/hakanensari/vacuum
 licenses:
@@ -90,17 +90,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Amazon Product Advertising in Ruby