vacuum 0.3.0 → 0.3.1

data/README.md

@@ -1,24 +1,28 @@
 # Vacuum
 
-[![travis][1]][2]
+[![Build Status][1]][2]
 
-Vacuum is a thin Ruby wrapper to the [Amazon Product Advertising API][3].
+Vacuum is a Ruby wrapper to the [Amazon Product Advertising API][4].
 
-![vacuum][4]
+![vacuum][3]
+
+## Usage
 
 ```ruby
-request = Vacuum.new
+req = Vacuum.new
+
+req.configure key:    'foo',
+              secret: 'secret',
+              tag:    'biz-val'
 
-request.configure key:    'foo',
-                  secret: 'secret',
-                  tag:    'foo-bar'
+params = { 'Operation'   => 'ItemSearch',
+           'SearchIndex' => 'Books',
+           'Keywords'    => 'Architecture' }
 
-request.get query: { 'Operation'   => 'ItemSearch',
-                     'SearchIndex' => 'Books',
-                     'Keywords'    => 'Architecture' }
+req.get query: params # XPath is your friend.
 ```
 
 [1]: https://secure.travis-ci.org/hakanensari/vacuum.png
 [2]: http://travis-ci.org/hakanensari/vacuum
-[3]: https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html
-[4]: http://f.cl.ly/items/2k2X0e2u0G3k1c260D2u/vacuum.png
+[3]: http://f.cl.ly/items/2k2X0e2u0G3k1c260D2u/vacuum.png
+[4]: https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html

data/lib/vacuum/request.rb

@@ -5,8 +5,8 @@ module Vacuum
   class Request
     include Jeff
 
-    BadLocale  = Class.new ArgumentError
-    MissingTag = Class.new ArgumentError
+    BadLocale  = Class.new(ArgumentError)
+    MissingTag = Class.new(ArgumentError)
 
     # A list of Amazon Product Advertising API hosts.
     HOSTS = {
@@ -25,7 +25,7 @@ module Vacuum
            'Service'      => 'AWSECommerceService',
            'Version'      => '2011-08-01'
 
-    # Creates a new request for given locale and credentials.
+    # Create a new request for given locale.
     #
     # locale - The String Product Advertising API locale (default: US).
     #
@@ -35,25 +35,19 @@ module Vacuum
       self.endpoint = "http://#{host}/onca/xml"
     end
 
-    # Configures the Amazon Product Advertising API request.
+    # Configure the Amazon Product Advertising API request.
     #
     # credentials - The Hash credentials of the API endpoint.
     #               :key    - The String Amazon Web Services (AWS) key.
     #               :secret - The String AWS secret.
     #               :tag    - The String Associate Tag.
     #
-    # Yields self.
-    #
     # Returns nothing.
-    def configure(credentials, &blk)
-      if block_given?
-        yield self
-      else
-        credentials.each { |key, val| self.send "#{key}=", val }
-      end
+    def configure(credentials)
+      credentials.each { |key, val| self.send("#{key}=", val) }
     end
 
-    # Gets the String Associate Tag.
+    # Get the String Associate Tag.
     #
     # Raises a Missing Tag error if Associate Tag is missing.
     def tag
@@ -62,5 +56,19 @@ module Vacuum
 
     # Sets the String Associate Tag.
     attr_writer :tag
+
+    # Build a URL.
+    #
+    # params - A Hash of Amazon Product Advertising query params.
+    #
+    # Returns the built URL String.
+    def url(params)
+      opts = {
+        :method => :get,
+        :query  => params
+      }
+
+      [endpoint, build_options(opts).fetch(:query)].join('?')
+    end
   end
 end

data/lib/vacuum/version.rb

@@ -1,3 +1,3 @@
 module Vacuum
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,48 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  version: 0.3.0
   prerelease: 
+  version: 0.3.1
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jeff
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
+    none: false
+  name: jeff
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
+        version: 0.6.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: rake
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 description: A wrapper to the Amazon Product Advertising API
 email:
 - hakan.ensari@papercavalier.com
@@ -55,7 +55,6 @@ files:
 - lib/vacuum.rb
 - LICENSE
 - README.md
-- test/request_test.rb
 homepage: https://github.com/hakanensari/vacuum
 licenses: []
 post_install_message: 
@@ -63,23 +62,21 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '1.9'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Amazon Product Advertising in Ruby
-test_files:
-- test/request_test.rb
-has_rdoc: 
+test_files: []

data/test/request_test.rb

@@ -1,18 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/vacuum'
-
-module Vacuum
-  describe Request do
-    it 'requires a valid locale' do
-      -> { Request.new('foo') }.must_raise Request::BadLocale
-    end
-
-    it 'requires an Associate Tag' do
-      -> { Request.new('US').tag }.must_raise Request::MissingTag
-    end
-
-    it 'defaults to the US endpoint' do
-      Request.new.endpoint.must_equal 'http://ecs.amazonaws.com/onca/xml'
-    end
-  end
-end