vacuum 0.0.1 → 0.1.0

data/spec/vacuum/request_spec.rb

@@ -2,102 +2,81 @@ require 'spec_helper'
 
 module Vacuum
   describe Request do
-    let(:req) { Request.new('us') }
-
-    describe '#<<' do
-      before do
-        req.configure do |c|
-          c.key = 'foo'
-          c.tag = 'bar'
-        end
+    let(:req) do
+      Request.new :locale => :us,
+                  :key    => 'foo',
+                  :secret => 'bar',
+                  :tag    => 'baz'
+    end
 
-        req.reset!
+    describe ".new" do
+      it 'raises an error if key is missing' do
+        expect do
+          Request.new :secret => 'foo',
+                      :tag    => 'bar'
+        end.to raise_error MissingKey
       end
 
-      it 'merges parameters into the query' do
-        req << { 'Key' => 'value' }
-
-        req.params['Key'].should eql 'value'
+      it 'raises an error if secret is missing' do
+        expect do
+          Request.new :key => 'foo',
+                      :tag => 'bar'
+        end.to raise_error MissingSecret
       end
 
-      it 'camelizes keys' do
-        req << { :some_key => 'value' }
-
-        req.params.should have_key 'SomeKey'
+      it 'raises an error if tag is missing' do
+        expect do
+          Request.new :key    => 'foo',
+                      :secret => 'bar'
+        end.to raise_error MissingTag
       end
 
-      it 'leaves camelized keys as is' do
-        req << { 'SomeKey' => 'value' }
-
-        req.params.should have_key 'SomeKey'
+      it 'raises an error if locale is not valid' do
+        expect do
+          Request.new :key    => 'foo',
+                      :secret => 'bar',
+                      :tag    => 'baz',
+                      :locale => 'bad'
+        end.to raise_error BadLocale
       end
+    end
 
-      it 'casts numeric values to string' do
-        req << { 'Key' => 1 }
-
-        req.params['Key'].should eql '1'
+    describe '#build' do
+      it 'merges parameters into the query' do
+        req.build 'Key' => 'value'
+        req.params['Key'].should eql 'value'
       end
 
-      it 'converts array values to string' do
-        req << { 'Key' => ['foo', 'bar'] }
+      it 'casts values to string' do
+        req.build 'Key' => 1
+        req.params['Key'].should eql '1'
 
+        req.build 'Key' => ['foo', 'bar']
         req.params['Key'].should eql 'foo,bar'
       end
 
-      it 'removes whitespace after commas in values' do
-        req << { 'Key' => 'foo,  bar' }
-
-        req.params['Key'].should eql 'foo,bar'
+      it 'returns self' do
+        req.build({}).should eql req
       end
     end
 
-    describe '#configure' do
-      it 'yields the locale' do
-        req.configure(&:class).should eql Locale
+    describe '#build!' do
+      it 'clears existing query' do
+        req.build 'Key' => 'value'
+        req.params.should have_key 'Key'
+
+        req.build!.params.should_not have_key 'Key'
       end
     end
 
     describe '#get' do
-      before do
-        req.configure do |c|
-          c.key    = 'foo'
-          c.secret = 'bar'
-          c.tag    = 'baz'
-        end
-      end
-
       it 'returns a response' do
         req.get.should be_a Response
       end
-
-      it 'raises an error if secret is missing' do
-        req.configure { |c| c.secret = nil }
-
-        expect { req.get }.to raise_error MissingSecret
-      end
     end
 
     describe '#params' do
-      before do
-        req.configure do |c|
-          c.key = 'foo'
-          c.tag = 'bar'
-        end
-      end
-
-      it 'raises an error if key is missing' do
-        req.configure { |c| c.key = nil }
-
-        expect { req.params }.to raise_error MissingKey
-      end
-
-      it 'raises an error if tag is missing' do
-        req.configure { |c| c.tag = nil }
-
-        expect { req.params }.to raise_error MissingTag
-      end
-
-      it 'includes common request parameters' do
+      it 'includes shared request parameters' do
         req.params['Service'].should eql 'AWSECommerceService'
       end
 
@@ -110,46 +89,21 @@ module Vacuum
         req.params['Timestamp'].should =~ /^\d+-\d+-\d+T\d+:\d+:\d+Z$/
       end
 
-      context 'when no API version is specified' do
+      context 'when no API version is given' do
         it 'includes the current API version' do
           req.params['Version'].should eql Request::CURRENT_API_VERSION
         end
       end
 
-      context 'when an API version is specified' do
-        it 'includes the specified API version' do
-          req << { 'Version' => '1' }
+      context 'when an API version is given' do
+        it 'includes the given API version' do
+          req.build 'Version' => '1'
           req.params['Version'].should eql '1' 
         end
       end
     end
 
-    describe '#reset!' do
-      before do
-        req.configure do |c|
-          c.key = 'foo'
-          c.tag = 'bar'
-        end
-      end
-
-      it 'resets the request parameters' do
-        req << { 'Key' => 'value' }
-        req.params.should have_key 'Key'
-
-        req.reset!
-        req.params.should_not have_key 'Key'
-      end
-    end
-
     describe '#url' do
-      before do
-        req.configure do |c|
-          c.key = 'foo'
-          c.secret = 'bar'
-          c.tag = 'baz'
-        end
-      end
-
       it 'builds a URL' do
         req.url.should be_a URI::HTTP
       end
@@ -159,25 +113,18 @@ module Vacuum
       end
 
       it 'sorts the request parameters' do
-        req << { 'A' => 1 }
+        req.build 'A' => 1
         req.url.query.should match /^A=1&/
       end
 
       it 'URL-encodes values' do
-        req << { :key => 'foo,bar' }
+        req.build 'Key' => 'foo,bar'
         req.url.query.should match /foo%2Cbar/
       end
 
-      it 'signs the query' do
+      it 'is signed' do
         req.url.query.should match /&Signature=/
       end
-
-      it 'raises an error if no secret is specified' do
-        expect do
-          req.configure { |c| c.secret = nil }
-          req.url
-        end.to raise_error MissingSecret
-      end
     end
   end
 end

data/spec/vacuum/response_spec.rb

@@ -2,94 +2,78 @@ require 'spec_helper'
 
 module Vacuum
   describe Response do
-    let(:resp) do
+    let(:res) do
       body = File.read(File.expand_path('../../fixtures/http_response', __FILE__))
-      code = '200'
-      Response.new(body, code)
-    end
-
-    describe '#each' do
-      it 'yields matches to given block' do
-        yielded = false
-        resp.each('Item') do |item|
-          yielded = true
-        end
-
-        yielded.should be_true
-      end
+      Response.new(body, '200')
     end
 
     describe '#errors' do
       it 'returns an array of errors' do
-        resp.body =  <<-EOF.gsub!(/>\s+</, '><').strip!
+        res.body =  <<-EOF.gsub!(/>\s+</, '><').strip!
         <?xml version=\"1.0\" ?>
-        <resp xmlns="http://example.com">
+        <Response xmlns="http://example.com">
           <Errors>
             <Error>foo</Error>
           </Errors>
-        </resp>
+        </Response>
         EOF
 
-        resp.errors.should =~ ['foo']
+        res.errors.should =~ ['foo']
       end
     end
 
-    describe '#has_errors?' do
-      context 'when a resp does not contain any errors' do
-        it 'returns false' do
-          resp.stub!(:errors).and_return([])
-
-          resp.should_not have_errors
-        end
+    describe '#find' do
+      it 'returns an array of matching nodes' do
+        res.find('ASIN').should_not be_empty
       end
 
-      context 'when a resp contains errors' do
-        it 'returns true' do
-          resp.stub!(:errors).and_return([1])
-
-          resp.should have_errors
-        end
+      it 'yields matches to a block if given one' do
+        titles = res.find('Item') { |item| item['ItemAttributes']['Title'] }
+        titles.count.should eql 2
+        titles.each { |title| title.should be_a String }
       end
     end
 
-    describe '#find' do
-      it 'returns an array of matching nodes' do
-        resp.find('ASIN').should_not be_empty
+    describe '#has_errors?' do
+      context 'when response does not contain any errors' do
+        it 'returns false' do
+          res.stub!(:errors).and_return([])
+          res.should_not have_errors
+        end
       end
-    end
-
-    describe "#map" do
-      it "yields each match to a block and maps returned values" do
-        titles = resp.map('Item') { |i| i['ItemAttributes']['Title'] }
 
-        titles.count.should eql 2
+      context 'when response contains errors' do
+        it 'returns true' do
+          res.stub!(:errors).and_return([1])
+          res.should have_errors
+        end
       end
     end
 
     describe '#to_hash' do
-      it 'casts resp to a hash' do
-        resp.to_hash.should be_a Hash
+      it 'casts response to a hash' do
+        res.to_hash.should be_a Hash
       end
     end
 
     describe '#valid?' do
       context 'when HTTP status is OK' do
         it 'returns true' do
-          resp.should be_valid
+          res.should be_valid
         end
       end
 
       context 'when HTTP status is not OK' do
         it 'returns false' do
-          resp.code = 403
-          resp.should_not be_valid
+          res.code = 403
+          res.should_not be_valid
         end
       end
     end
 
     describe '#xml' do
       it 'returns a Nokogiri document' do
-        resp.xml.should be_an_instance_of Nokogiri::XML::Document
+        res.xml.should be_an_instance_of Nokogiri::XML::Document
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-27 00:00:00.000000000 Z
+date: 2012-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70206980398600 !ruby/object:Gem::Requirement
+  requirement: &70211676691980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,37 +21,28 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70206980398600
+  version_requirements: *70211676691980
 description: Vacuum is a Ruby wrapper to the Amazon Product Advertising API.
 email:
-- code@papercavalier.com
+- hakan.ensari@papercavalier.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/vacuum/builder.rb
-- lib/vacuum/cart.rb
-- lib/vacuum/cart_operations.rb
-- lib/vacuum/error.rb
-- lib/vacuum/locale.rb
-- lib/vacuum/lookup_operations.rb
+- lib/vacuum/em.rb
+- lib/vacuum/hash_builder.rb
 - lib/vacuum/request.rb
 - lib/vacuum/response.rb
-- lib/vacuum/search_operations.rb
 - lib/vacuum/version.rb
 - lib/vacuum.rb
 - LICENSE
 - README.md
 - spec/fixtures/http_response
 - spec/spec_helper.rb
-- spec/vacuum/builder_spec.rb
-- spec/vacuum/cart_operations_spec.rb
-- spec/vacuum/cart_spec.rb
-- spec/vacuum/lookup_operations_spec.rb
+- spec/vacuum/hash_builder_spec.rb
 - spec/vacuum/request_spec.rb
 - spec/vacuum/response_spec.rb
-- spec/vacuum/search_operations_spec.rb
-homepage: http://code.papercavalier.com/vacuum/
+homepage: http://github.com/hakanensari/vacuum
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -71,17 +62,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper to the Amazon Product Advertising API
 test_files:
 - spec/fixtures/http_response
 - spec/spec_helper.rb
-- spec/vacuum/builder_spec.rb
-- spec/vacuum/cart_operations_spec.rb
-- spec/vacuum/cart_spec.rb
-- spec/vacuum/lookup_operations_spec.rb
+- spec/vacuum/hash_builder_spec.rb
 - spec/vacuum/request_spec.rb
 - spec/vacuum/response_spec.rb
-- spec/vacuum/search_operations_spec.rb

data/lib/vacuum/cart.rb

@@ -1,90 +0,0 @@
-module Vacuum
-  class Cart
-    # @return [String] cart_id
-    attr :id
-
-    # @return [String] hmac
-    attr :hmac
-
-    attr :items
-
-    # @return [Vacuum::Response] last_response last response
-    # returned by the Amazon API
-    attr :last_response
-
-    # @return [String] purchase_url
-    attr :purchase_url
-
-    attr :sub_total
-
-    # Creates a new cart
-    #
-    # @param [Vacuum::Request] req an API request
-    # @param [Hash] params a hash of parameters
-    def initialize(req, params)
-      @req = req
-      get 'Create', params
-    end
-
-    # Clears the cart
-    #
-    # @param [Hash] params a hash of parameters
-    def clear(params = {})
-      get 'Clear', params
-    end
-
-    private
-
-    def get(operation, params)
-      @req.reset!
-
-      if id
-        @req << { 'CartId'    => id,
-                  'HMAC'      => hmac }
-      end
-
-      @req << { 'Operation' => "Cart#{operation}" }.merge(params)
-
-      @last_response = @req.get
-      @items         = @last_response.find('CartItems')
-      @id            = @last_response.find('CartId').first
-      @hmac          = @last_response.find('HMAC').first
-      @purchase_url  = @last_response.find('PurchaseURL').first
-      @sub_total     = @last_response.find('SubTotal').first
-    end
-
-    # Add items to cart
-    #
-    # @param [String] cart_id
-    # @param [String] hmac
-    # @param [Hash] params
-    # @return [Vacuum::Cart] a response
-    # def add_to_cart(cart_id, hmac, params)
-    #   cartify 'Add', { 'CartId' => cart_id,
-    #                    'HMAC'   => hmac }.merge(params)
-    # end
-
-
-    # Gets an existing cart
-    #
-    # @param [String] cart_id
-    # @param [String] hmac
-    # @param [Hash] params
-    # @return [Vacuum::Cart] a response
-    # def get_cart(cart_id, hmac, params)
-    #   cartify 'Get', { 'CartId' => cart_id,
-    #                    'HMAC'   => hmac }.merge(params)
-    # end
-
-    # Modifies an existing cart
-    #
-    # @param [String] cart_id
-    # @param [String] hmac
-    # @param [Hash] params
-    # @return [Vacuum::Cart] a response
-    # def modify_cart(cart_id, hmac, params)
-    #   cartify 'Modify', { 'CartId' => cart_id,
-    #                       'HMAC'   => hmac }.merge(params)
-    # end
-  end
-end

data/lib/vacuum/cart_operations.rb

@@ -1,12 +0,0 @@
-module Vacuum
-  # Cart operations
-  module CartOperations
-    # Creates a cart
-    #
-    # @param [Hash] params
-    # @return [Vacuum::Cart] a cart
-    def create_cart(params)
-      Cart.new(self, params)
-    end
-  end
-end

data/lib/vacuum/error.rb

@@ -1,13 +0,0 @@
-module Vacuum
-  # Raised when a bad locale is specified
-  class BadLocale < ArgumentError; end
-
-  # Raised when the Amazon key is not specified
-  class MissingKey < ArgumentError; end
-
-  # Raised when the Amazon secret is not specified
-  class MissingSecret < ArgumentError; end
-
-  # Raised when the Amazon associate tag is not specified
-  class MissingTag < ArgumentError; end
-end

data/lib/vacuum/locale.rb

@@ -1,39 +0,0 @@
-module Vacuum
-  # An Amazon locale
-  class Locale
-    # Amazon hosts
-    HOSTS = { :ca => 'ecs.amazonaws.ca',
-              :cn => 'webservices.amazon.cn',
-              :de => 'ecs.amazonaws.de',
-              :es => 'webservices.amazon.es',
-              :fr => 'ecs.amazonaws.fr',
-              :it => 'webservices.amazon.it',
-              :jp => 'ecs.amazonaws.jp',
-              :us => 'ecs.amazonaws.com',
-              :uk => 'ecs.amazonaws.co.uk' }
-
-    # Country codes for Amazon locales
-    LOCALES = HOSTS.keys
-
-    # @return [String] the Amazon Web Services access key
-    attr_accessor :key
-
-    # @return [String] the Amazon Web Services secret
-    attr_accessor :secret
-
-    # @return [String] the Amazon associate tag
-    attr_accessor :tag
-
-    # @param [Symbol] locale the locale key
-    # @raise [Vacuum::BadLocale] locale is bad
-    def initialize(locale)
-      raise BadLocale unless LOCALES.include?(locale)
-      @locale = locale
-    end
-
-    # @return [String] the Amazon host
-    def host
-      HOSTS[@locale]
-    end
-  end
-end

data/lib/vacuum/lookup_operations.rb

@@ -1,62 +0,0 @@
-module Vacuum
-  # Lookup operations
-  module LookupOperations
-    # Given up to ten item ids, returns some or all of the item
-    # attributes, depending on the response group specified in the
-    # request.
-    #
-    # @param [Array] item_ids splat of item IDs and an optional hash of
-    # parameters
-    # @return [Vacuum::Response] a response
-    #
-    # Id Type defaults to ASIN.
-    #
-    # @example The following returns some basic information for the
-    # ASIN 0679753354.
-    #
-    #   req.find('0679753354')
-    #
-    # @example The following request returns cover art for the same
-    # ASIN.
-    #
-    #   req.find('0679753354', :response_group => 'Images')
-    #
-    def find(*item_ids)
-      reset!
-      params = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
-      self.<<({ 'Operation' => 'ItemLookup',
-                'ItemId'    => item_ids }.merge(params))
-
-      get
-    end
-
-    # Given a browse node ID, returns the specified browse node’s name,
-    # children, and ancestors.
-    #
-    # @param [String] browse_node_id browse node ID
-    # @params [Hash] params hash of parameters
-    # @return [Vacuum::Response] a response
-    def find_browse_node(browse_node_id, params = {})
-      reset!
-      self.<<({ 'Operation'    => 'BrowseNodeLookup',
-                'BrowseNodeId' => browse_node_id }.merge(params))
-
-      get
-    end
-
-    # Given up to ten item ids, returns up to ten products per page
-    # that are similar to those items
-    #
-    # @param [Array] item_ids splat of item IDs and an optional hash of
-    # parameters
-    # @return [Vacuum::Response] a response
-    def find_similar(*item_ids)
-      reset!
-      params = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
-      self.<<({ 'Operation' => 'SimilarityLookup',
-                'ItemId'    => item_ids }.merge(params))
-
-      get
-    end
-  end
-end