vacuum 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d688557c2a30832e793deb6f932f78e38f3fe2eb
-  data.tar.gz: 762f70ee270015de03c5ba177724bcea03fcac9f
+  metadata.gz: f7024407a6c3d216a247ce435ef0ed65f56c1338
+  data.tar.gz: 86557dbfd10b6df9b0cec4a17fd12bd8f8cf5705
 SHA512:
-  metadata.gz: 4f4d7fc84ef456bbdc31b6ce81169eb9799ce79c1112ec0a1e9e35cbf6a619dceadda25e4386458b0ecdddec8bd1179216d98dc6451a8de5a511c717bdbfc5ea
-  data.tar.gz: c353c71626477896d12385b58c47049cdcdce226bd114c961904a3e3520fc2fcefac383527a3f5b9cc3b52ef5ff0f6abd26042a642c3ea629f688e849be9b0c0
+  metadata.gz: 492be10dda8e7ea60b2f39db7531c503add9b37ceff989a5a11b45dbc77dabf972520988b04c7e6322797dc0c750a723f991ffd9cbad9e327a04473eb9492da8
+  data.tar.gz: e04fe2ee991293dbaf942190f05f49fb3008f6613023e6ac701e15769765f86c7b21cdee449369c5294a32d32b2976f2f33763ff626d16eab57dfa8052edacea

data/README.md

@@ -2,20 +2,23 @@
 
 [![Build Status][1]][2]
 
-Vacuum is a Ruby wrapper to the [Amazon Product Advertising API][4].
+Vacuum is a light-weight Ruby wrapper to the
+[Amazon Product Advertising API][4].
 
 ![vacuum][3]
 
 ## Usage
 
+### Setup
+
 Set up a request:
 
 ```ruby
 req = Vacuum.new
 ```
 
-The locale defaults to the US. If you wish to use another locale, instantiate
-with its ISO-3166 two-letter country code:
+The locale defaults to the US. To use another locale, instantiate with its
+two-letter country code:
 
 ```ruby
 req = Vacuum.new('GB')
@@ -31,7 +34,22 @@ req.configure(
 )
 ```
 
-Make a request:
+Alternatively, set the key and secret as environment variables globally:
+
+```bash
+export AWS_ACCESS_KEY_ID=key
+export AWS_SECRET_ACCESS_KEY=secret
+```
+
+You will still need to set a distinct associate tag for each locale:
+
+```ruby
+req.associate_tag = 'tag'
+```
+
+### Request
+
+Set up your parameters and make a request:
 
 ```ruby
 params = {
@@ -40,18 +58,29 @@ params = {
 }
 res = req.item_search(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.
+
+### Response
 
-Parse the response into a Ruby hash:
+The quick way to consume a response is to parse it into a Ruby hash:
 
 ```ruby
 res.to_h
 ```
 
-Allowed requests include `browse_node_lookup`, `cart_add`, `cart_clear`,
-`cart_create`, `cart_get`, `cart_modify`, `item_lookup`, `item_search`,
-`similarity_lookup`.
+Vacuum uses [MultiXml][6], which will work with a number of popular XML
+libraries.
 
-Vacuum is built with [excon][5] and [multi_xml][6].
+You can also pass the response body into a custom parser:
+
+```ruby
+MyParser.new(res.body)
+```
 
 [1]: https://secure.travis-ci.org/hakanensari/vacuum.png
 [2]: http://travis-ci.org/hakanensari/vacuum

data/lib/vacuum/request.rb

@@ -46,9 +46,9 @@ module Vacuum
     #          false)
     #
     # Raises a Bad Locale error if locale is not valid.
-    def initialize(locale = nil, secure = false)
-      host = HOSTS[locale || 'US'] or raise BadLocale
-      self.aws_endpoint = "#{secure ? 'https' : 'http' }://#{host}/onca/xml"
+    def initialize(locale = 'US', secure = false)
+      host = HOSTS.fetch(locale) { raise BadLocale }
+      @aws_endpoint = "#{secure ? 'https' : 'http' }://#{host}/onca/xml"
     end
 
     # Configure the Amazon Product Advertising API request.
@@ -67,8 +67,9 @@ module Vacuum
 
     OPERATIONS.each do |operation|
       method_name = operation.gsub(/(.)([A-Z])/,'\1_\2').downcase
-      define_method(method_name) do |params, excon_options = {}|
-        Response.new(get(excon_options.merge(query: params.merge('Operation' => operation))))
+      define_method(method_name) do |params, opts = {}|
+        res = get(opts.merge(query: params.merge('Operation' => operation)))
+        Response.new(res)
       end
     end
 
@@ -78,8 +79,8 @@ module Vacuum
     #
     # Returns the built URL String.
     def url(params)
-      options = { method: :get, query: params }
-      [aws_endpoint, build_options(options).fetch(:query)].join('?')
+      opts = { method: :get, query: params }
+      [aws_endpoint, build_options(opts).fetch(:query)].join('?')
     end
   end
 end

data/lib/vacuum/version.rb

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

data/test/test_vacuum.rb

@@ -1,10 +1,11 @@
 require 'minitest/autorun'
+require 'minitest/pride'
 require_relative '../lib/vacuum'
 
 class TestVacuum < Minitest::Test
   include Vacuum
 
-  def test_request_valid_locale
+  def test_requires_valid_locale
     assert_raises(Request::BadLocale) { Request.new('foo') }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-11 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeff
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !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