vacuum 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2187eb118ab30e2d03a6aa4363456335614b2ea0
-  data.tar.gz: d627561295a2da45b87030ccb10cef19461070ef
+  metadata.gz: d688557c2a30832e793deb6f932f78e38f3fe2eb
+  data.tar.gz: 762f70ee270015de03c5ba177724bcea03fcac9f
 SHA512:
-  metadata.gz: 50fc2693d3e43a4ca83279d4a39c162ea9bef69f722b4a70fbf9bf0816a7058bd6dc03c919be5c1d95b00e6c6ae7a2e51e88649d4f6083f338c96fbc75ef69fc
-  data.tar.gz: 27e153888b98328823574adc22f5ff93e9420998b025163d5ae0cfd0e98189747417d194b0d08a5db6f0b5256679ac5a6e00f84e2507db72ab15350ac73de69a
+  metadata.gz: 4f4d7fc84ef456bbdc31b6ce81169eb9799ce79c1112ec0a1e9e35cbf6a619dceadda25e4386458b0ecdddec8bd1179216d98dc6451a8de5a511c717bdbfc5ea
+  data.tar.gz: c353c71626477896d12385b58c47049cdcdce226bd114c961904a3e3520fc2fcefac383527a3f5b9cc3b52ef5ff0f6abd26042a642c3ea629f688e849be9b0c0

data/README.md

@@ -12,59 +12,50 @@ Set up a request:
 
 ```ruby
 req = Vacuum.new
-  .configure(
-    aws_access_key_id:     'foo',
-    aws_secret_access_key: 'secret',
-    associate_tag:         'biz-val'
-  )
 ```
 
-The locale defaults to the US. If you wish to use another locale, specify its
-ISO-3166 two-letter code when instantiating the request:
+The locale defaults to the US. If you wish to use another locale, instantiate
+with its ISO-3166 two-letter country code:
 
 ```ruby
-Vacuum.new('GB')
+req = Vacuum.new('GB')
 ```
 
-Make a request:
+Configure the request credentials:
 
 ```ruby
-params = { 'Operation'   => 'ItemSearch',
-           'SearchIndex' => 'Books',
-           'Keywords'    => 'Architecture' }
-
-res = req.get(query: params)
+req.configure(
+    aws_access_key_id:     'key',
+    aws_secret_access_key: 'secret',
+    associate_tag:         'tag'
+)
 ```
 
-Once you have a response, parse it with your favourite XML parser and parsing
-method.
-
-If you don't mind the performance hit, here is a simplistic solution based on
-[`MultiXml`][5]:
+Make a request:
 
 ```ruby
-require 'forwardable'
-require 'multi_xml'
-
-class Response
-  extend Forwardable
+params = {
+  'SearchIndex' => 'Books',
+  'Keywords'    => 'Architecture'
+}
+res = req.item_search(params)
+```
 
-  def_delegators :@response, :code, :body
+Parse the response into a Ruby hash:
 
-  def initialize(response)
-    @response = response
-  end
+```ruby
+res.to_h
+```
 
-  def to_h
-    MultiXml.parse(body)
-  end
-end
+Allowed requests include `browse_node_lookup`, `cart_add`, `cart_clear`,
+`cart_create`, `cart_get`, `cart_modify`, `item_lookup`, `item_search`,
+`similarity_lookup`.
 
-Response.new(res).to_h
-```
+Vacuum is built with [excon][5] and [multi_xml][6].
 
 [1]: https://secure.travis-ci.org/hakanensari/vacuum.png
 [2]: http://travis-ci.org/hakanensari/vacuum
 [3]: http://f.cl.ly/items/2k2X0e2u0G3k1c260D2u/vacuum.png
 [4]: https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html
-[5]: https://github.com/sferik/multi_xml
+[5]: https://github.com/geemus/excon
+[6]: https://github.com/sferik/multi_xml

data/lib/vacuum/request.rb

@@ -1,4 +1,5 @@
 require 'jeff'
+require 'vacuum/response'
 
 module Vacuum
   # An Amazon Product Advertising API request.
@@ -7,7 +8,6 @@ module Vacuum
 
     BadLocale  = Class.new(ArgumentError)
 
-    # A list of Amazon Product Advertising API hosts.
     HOSTS = {
       'CA' => 'webservices.amazon.ca',
       'CN' => 'webservices.amazon.cn',
@@ -21,23 +21,34 @@ module Vacuum
       'US' => 'webservices.amazon.com'
     }.freeze
 
+    OPERATIONS = %w(
+      BrowseNodeLookup
+      CartAdd
+      CartClear
+      CartCreate
+      CartGet
+      CartModify
+      ItemLookup
+      ItemSearch
+      SimilarityLookup
+    ).freeze
+
     params 'AssociateTag' => -> { associate_tag },
            'Service'      => 'AWSECommerceService',
            'Version'      => '2011-08-01'
 
+    attr_accessor :associate_tag
+
     # Create a new request for given locale.
     #
     # locale - The String Product Advertising API locale (default: US).
+    # secure - Whether to use the secure version of the endpoint (default:
+    #          false)
     #
     # Raises a Bad Locale error if locale is not valid.
-    def initialize(locale = nil)
-      if locale == 'UK'
-        warn '[DEPRECATION] Use GB instead of UK'
-        locale = 'GB'
-      end
-
+    def initialize(locale = nil, secure = false)
       host = HOSTS[locale || 'US'] or raise BadLocale
-      self.aws_endpoint = "http://#{host}/onca/xml"
+      self.aws_endpoint = "#{secure ? 'https' : 'http' }://#{host}/onca/xml"
     end
 
     # Configure the Amazon Product Advertising API request.
@@ -54,24 +65,21 @@ module Vacuum
       self
     end
 
-    # Get/Sets the String Associate Tag.
-    attr_accessor :associate_tag
-    # Keep around old attribute for a while for backward compatibility.
-    alias :tag :associate_tag
-    alias :tag= :associate_tag=
+    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))))
+      end
+    end
 
     # Build a URL.
     #
-    # params - A Hash of Amazon Product Advertising query params.
+    # 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('?')
+      options = { method: :get, query: params }
+      [aws_endpoint, build_options(options).fetch(:query)].join('?')
     end
   end
 end

data/lib/vacuum/response.rb

@@ -0,0 +1,10 @@
+require 'delegate'
+require 'multi_xml'
+
+module Vacuum
+  class Response < SimpleDelegator
+    def to_h
+      MultiXml.parse(body)
+    end
+  end
+end

data/lib/vacuum/version.rb

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

data/lib/vacuum.rb

@@ -1,5 +1,4 @@
 require 'forwardable'
-
 require 'vacuum/request'
 require 'vacuum/version'
 
@@ -8,6 +7,6 @@ module Vacuum
   class << self
     extend Forwardable
 
-    def_delegator 'Vacuum::Request', :new
+    def_delegator Vacuum::Request, :new
   end
 end

data/test/test_vacuum.rb

@@ -0,0 +1,29 @@
+require 'minitest/autorun'
+require_relative '../lib/vacuum'
+
+class TestVacuum < Minitest::Test
+  include Vacuum
+
+  def test_request_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
+  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'))
+  end
+
+  def test_fetches_parsable_response
+    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)
+    refute_empty res.to_h
+    Excon.stubs.clear
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeff
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -46,10 +60,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - 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:
 - MIT
@@ -74,4 +90,5 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Amazon Product Advertising in Ruby
-test_files: []
+test_files:
+- test/test_vacuum.rb