vacuum 0.2.2 → 0.3.0

data/lib/vacuum/request/base.rb

@@ -1,109 +0,0 @@
-module Vacuum
-  module Request
-    # An Amazon Web Services (AWS) API request.
-    class Base
-      # Returns the AWS API Endpoint.
-      attr :endpoint
-
-      # Creates a new request for given locale and credentials.
-      #
-      # Yields the AWS API endpoint if a block is given.
-      def initialize(&blk)
-        @parameters = {}
-        @endpoint = Endpoint.const_get(class_basename).new
-
-        configure &blk if block_given?
-      end
-
-      # Adds given parameters to the request.
-      #
-      # hsh - A Hash of parameter key and value pairs.
-      #
-      # Returns self.
-      def build(hsh)
-        hsh.each do |k, v|
-          k = Utils.camelize k.to_s if k.is_a? Symbol
-          @parameters[k] = v.is_a?(Array) ? v.join(',') : v.to_s
-        end
-
-        self
-      end
-
-      # Resets the request to the given parameters.
-      #
-      # hsh - A Hash of parameter key and value pairs.
-      #
-      # Returns self.
-      def build!(hsh = {})
-        @parameters = {}
-        build hsh
-      end
-
-      # Yields the AWS API Endpoint.
-      #
-      # Returns nothing.
-      def configure(&blk)
-        yield @endpoint
-      end
-
-      # Returns a Faraday::Connection.
-      #
-      # Yields a Faraday::Builder to configure the connection if a block is
-      # given.
-      def connection
-        @connection ||= Faraday.new do |builder|
-          builder.use Signature::Authentication, endpoint.secret
-
-          yield builder if block_given?
-
-          unless builder.handlers.any? { |h| h.name.include? ':Adapter:' }
-            builder.adapter Faraday.default_adapter
-          end
-        end
-      end
-
-      # Performs the AWS API request.
-      #
-      # Returns a Vacuum::Response::Base or a subclass thereof.
-      def get
-        res = connection.get url
-        Response.const_get(class_basename).new res.body, res.status
-      end
-
-      # Performs the AWS API request.
-      #
-      # Raises a Bad Response if the response is not valid.
-      #
-      # Returns a Vacuum::Response::Base or a subclass thereof.
-      def get!
-        unless (res = get).valid?
-          raise BadResponse, "#{res.code} #{res['Code'].first}"
-        end
-
-        res
-      end
-
-      # Returns the Hash parameters of the AWS API request.
-      def parameters
-        default_parameters.merge @parameters
-      end
-
-      # Raises a Not Implemented Error.
-      #
-      # When implemented, this should return an Addressable::URI.
-      def url
-        raise NotImplementedError
-      end
-
-      private
-
-      def class_basename
-        self.class.name.split('::').last
-      end
-
-      def default_parameters
-        { 'AWSAccessKeyId' => endpoint.key }
-      end
-    end
-  end
-end

data/lib/vacuum/request/mws.rb

@@ -1,24 +0,0 @@
-module Vacuum
-  module Request
-    # A Marketplace Web Services (MWS) API request.
-    class MWS < Base
-      # Returns the Addressable::URI URL of the MWS API request.
-      def url
-        Addressable::URI.new :scheme        => 'https',
-                             :host          => endpoint.host,
-                             :path          => endpoint.path,
-                             :query_values  => parameters
-      end
-
-      private
-
-      def default_parameters
-        super.merge 'MarketplaceId'    => endpoint.marketplace,
-                    'SellerId'         => endpoint.seller,
-                    'Service'          => 'AWSECommerceService',
-                    'SignatureMethod'  => 'HmacSHA256',
-                    'SignatureVersion' => 2
-      end
-    end
-  end
-end

data/lib/vacuum/request/product_advertising.rb

@@ -1,101 +0,0 @@
-module Vacuum
-  module Request
-    # A Product Advertising API request.
-    class ProductAdvertising < Base
-      # Looks up attributes of up to twenty items.
-      #
-      # item_ids - Splat Array of item IDs. The last element may optionally
-      #            specify a Hash of parameter key and value pairs.
-      #
-      # Examples
-      #
-      #   request.find '0679753354', response_group: 'Images'
-      #
-      # Raises a Bad Response if response is not valid.
-      #
-      # Returns a Vacuum::Response::ProductAdvertising.
-      def look_up(*item_ids)
-        given = item_ids.last.is_a?(Hash) ? item_ids.pop : {}
-
-        params = begin
-          case item_ids.size
-          when 1..10
-            {
-              'Operation' => 'ItemLookup',
-              'ItemId'    => item_ids
-            }.merge given
-          when 11..20
-            default = {
-              'Operation'           => 'ItemLookup',
-              'ItemLookup.1.ItemId' => item_ids.shift(10),
-              'ItemLookup.2.ItemId' => item_ids
-            }
-
-            if version = given.delete('Version') || given.delete(:version)
-              default['Version'] = version
-            end
-
-            given.reduce(default) do |a, (k, v)|
-              a.merge "ItemLookup.Shared.#{Utils.camelize k.to_s}" => v
-            end
-          else
-            raise ArgumentError, "Can't look up #{item_ids.size} items"
-          end
-        end
-        build! params
-
-        get!
-      end
-
-      # Searches for items that satisfy the given criteria, including one or
-      # more search indices.
-      #
-      # index           - Symbol search index
-      # query_or_params - String keyword query or Hash of parameter key and
-      #                   value pairs.
-      #
-      # Examples
-      #
-      #   # Search the entire Amazon catalog for Deleuze.
-      #   request.search :all, 'Deleuze'
-      #
-      #   # Search books for non-fiction titles authored by Deleuze and sort
-      #   # results by relevance.
-      #   request.search :books, power: 'author:lacan and not fiction',
-      #                          sort:  'relevancerank'
-      #
-      # Raises a Bad Response if response is not valid.
-      #
-      # Returns a Vacuum::Response::ProductAdvertising.
-      def search(index, query_or_params = nil)
-        params = case query_or_params
-                 when String
-                   { 'Keywords' => query_or_params }
-                 else
-                   query_or_params
-                 end
-        build! params.merge! 'Operation'   => 'ItemSearch',
-                             'SearchIndex' => Utils.camelize(index.to_s)
-
-        get!
-      end
-
-      # Returns the Addressable::URI URL of the Product Advertising API
-      # request.
-      def url
-        Addressable::URI.new :scheme        => 'http',
-                             :host          => endpoint.host,
-                             :path          => '/onca/xml',
-                             :query_values  => parameters
-      end
-
-      private
-
-      def default_parameters
-        super.merge 'AssociateTag' => endpoint.tag,
-                    'Service'      => 'AWSECommerceService',
-                    'Version'      => '2011-08-01'
-      end
-    end
-  end
-end

data/lib/vacuum/request/signature/authentication.rb

@@ -1,32 +0,0 @@
-module Vacuum
-  module Request
-    module Signature
-      # Internal: Middleware that signs REST requests to various Amazon API
-      # endpoints.
-      class Authentication < Faraday::Middleware
-        # Initializes the middleware.
-        #
-        # app - An Object that responds to `call` and returns a
-        # Faraday::Response.
-        # secret - The String Amazon AWS access secret key.
-        def initialize(app, secret)
-          @secret = secret
-          super app
-        end
-
-        # Signs the request.
-        #
-        # env - A Hash that contains info about the request.
-        #
-        # Returns an Object that responds to `call` and returns a
-        # Faraday::Response.
-        def call(env)
-          builder = Builder.new env, @secret
-          builder.timestamp.sort_query.sign
-
-          @app.call builder.env
-        end
-      end
-    end
-  end
-end

data/lib/vacuum/request/signature/builder.rb

@@ -1,70 +0,0 @@
-module Vacuum
-  module Request
-    module Signature
-      # Internal: Signs a request to an Amazon API with an HMAC-SHA256
-      # signature.
-      class Builder
-        # Returns a Hash that contains info about the request.
-        attr :env
-
-        # Returns the String Amazon AWS access secret key.
-        attr :secret
-
-        # Initializes a new Builder.
-        #
-        # env - A Hash that contains info about the request.
-        def initialize(env, secret)
-          env[:url] = Addressable::URI.parse env[:url]
-          @env, @secret = env, secret
-        end
-
-        # Returns the String name of the HTTP method used by the request.
-        def method
-          env[:method].to_s.upcase
-        end
-
-        # Signs the request.
-        #
-        # Returns self.
-        def sign
-          url.query = url.query.to_s + "&Signature=#{Utils.encode signature}"
-          self
-        end
-
-        # Returns a String signature.
-        def signature
-          sha256 = OpenSSL::Digest::SHA256.new
-          hash = OpenSSL::HMAC.digest sha256, secret, string_to_sign
-
-          Base64.encode64(hash).chomp
-        end
-
-        # Sorts the URL query values of the request.
-        #
-        # Returns self.
-        def sort_query
-          url.query_values = url.query_values
-          self
-        end
-
-        # Returns a String to sign based on pseudo-grammar specified by Amazon.
-        def string_to_sign
-          [method, url.host, url.path, url.query].join "\n"
-        end
-
-        # Timestamps the request.
-        #
-        # Returns self.
-        def timestamp
-          url.query = url.query.to_s + "&Timestamp=#{Utils.encode Time.now.utc.iso8601}"
-          self
-        end
-
-        # Returns the Addressable::URI URL of the request.
-        def url
-          env[:url]
-        end
-      end
-    end
-  end
-end

data/lib/vacuum/request/utils.rb

@@ -1,24 +0,0 @@
-module Vacuum
-  module Request
-    module Utils
-      # Camelizes a value.
-      #
-      # val - A String value.
-      #
-      # Returns an upper-camelcased String.
-      def self.camelize(val)
-        val.split('_').map(&:capitalize).join
-      end
-
-      # Percent encodes a URI component.
-      #
-      # component - The String URI component to encode.
-      #
-      # Returns the String encoded component.
-      def self.encode(component)
-        Addressable::URI.encode_component \
-          component, Addressable::URI::CharacterClasses::UNRESERVED
-      end
-    end
-  end
-end

data/lib/vacuum/response/base.rb

@@ -1,57 +0,0 @@
-module Vacuum
-  module Response
-    # An Amazon Web Services (AWS) API response.
-    class Base
-      # Gets/Sets the String response body.
-      attr_accessor :body
-
-      # Gets/Sets the Integer HTTP response code.
-      attr_accessor :code
-
-      # Initializes a new Response.
-      #
-      # body - The String response body.
-      # code - An HTTP response code that responds to to_i.
-      def initialize(body, code)
-        @body, @code = body, code.to_i
-      end
-
-      # Queries the response.
-      #
-      # query - String attribute to be queried.
-      #
-      # Yields matching nodes to a given block if one is given.
-      #
-      # Returns an Array of matching nodes or the return values of the yielded
-      # block if latter was given.
-      def find(query)
-        path = if xml.namespaces.empty?
-                 "//#{query}"
-               else
-                 "//xmlns:#{query}"
-               end
-
-        xml.xpath(path).map do |node|
-          hsh = Utils.xml_to_hash node
-          block_given? ? yield(hsh) : hsh
-        end
-      end
-      alias [] find
-
-      # Returns a Hash representation of the response.
-      def to_hash
-        Utils.xml_to_hash xml
-      end
-
-      # Returns whether the HTTP response is OK.
-      def valid?
-        code == 200
-      end
-
-      # Returns an XML document.
-      def xml
-        @xml ||= Nokogiri::XML.parse @body
-      end
-    end
-  end
-end

data/lib/vacuum/response/mws.rb

@@ -1,7 +0,0 @@
-module Vacuum
-  module Response
-    # A Marketplace Web Services (MWS) API response.
-    class MWS < Base
-    end
-  end
-end

data/lib/vacuum/response/product_advertising.rb

@@ -1,19 +0,0 @@
-module Vacuum
-  module Response
-    # A Product Advertising API response.
-    class ProductAdvertising < Base
-      # Returns an Array of errors.
-      def errors
-        find 'Error'
-      end
-
-      # Returns whether the response has errors.
-      #
-      # Note that a response with errors is still technically valid, i.e. the
-      # response code is 200.
-      def has_errors?
-        errors.count > 0
-      end
-    end
-  end
-end

data/lib/vacuum/response/utils.rb

@@ -1,48 +0,0 @@
-module Vacuum
-  module Response
-    module Utils
-      # Builds a Hash from an XML document.
-      #
-      # xml - a Nokogiri::XML::Document or Nokogiri::XML::Element.
-      #
-      # Returns a Hash representation of the XML document.
-      def self.xml_to_hash(xml)
-        case xml
-        when Nokogiri::XML::Document
-          xml_to_hash xml.root
-        when Nokogiri::XML::Element
-          hsh = {}
-
-          xml.attributes.each_pair do |key, attribute|
-            hsh[key] = attribute.value
-          end
-
-          xml.children.each do |child|
-            result = xml_to_hash child
-
-            if child.name == 'text'
-              if hsh.empty?
-                return result
-              else
-                hsh['__content__'] = result
-              end
-            elsif hsh[child.name]
-              case hsh[child.name]
-              when Array
-                hsh[child.name] << result
-              else
-                hsh[child.name] = [hsh[child.name]] << result
-              end
-            else
-              hsh[child.name] = result
-            end
-          end
-
-          hsh
-        else
-          xml.content.to_s
-        end
-      end
-    end
-  end
-end

data/spec/fixtures/product_advertising

@@ -1 +0,0 @@
-<?xml version="1.0" ?><ItemLookupResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2011-08-01"><OperationRequest><RequestId>86b89a15-b717-4d95-99aa-fe531b4ca762</RequestId><Arguments><Argument Name="Operation" Value="ItemLookup"></Argument><Argument Name="Service" Value="AWSECommerceService"></Argument><Argument Name="AssociateTag" Value="theorydot08-20"></Argument><Argument Name="Version" Value="2011-08-01"></Argument><Argument Name="Signature" Value="vOT9O1NW8PYLvrUX6KI3jrZ4Fg7LdtEYTrlsWzhbm1k="></Argument><Argument Name="ItemId" Value="0816614024,0143105825"></Argument><Argument Name="IdType" Value="ASIN"></Argument><Argument Name="AWSAccessKeyId" Value="0ZVSQ33MDFPQS8H2PM02"></Argument><Argument Name="Timestamp" Value="2011-07-29T17:52:34Z"></Argument></Arguments><RequestProcessingTime>0.0111990000000000</RequestProcessingTime></OperationRequest><Items><Request><IsValid>True</IsValid><ItemLookupRequest><IdType>ASIN</IdType><ItemId>0816614024</ItemId><ItemId>0143105825</ItemId><ResponseGroup>Small</ResponseGroup><VariationPage>All</VariationPage></ItemLookupRequest></Request><Item><ASIN>0816614024</ASIN><DetailPageURL>http://www.amazon.com/Thousand-Plateaus-Schizophrenia-Gilles-Deleuze/dp/0816614024%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D165953%26creativeASIN%3D0816614024</DetailPageURL><ItemLinks><ItemLink><Description>Technical Details</Description><URL>http://www.amazon.com/Thousand-Plateaus-Schizophrenia-Gilles-Deleuze/dp/tech-data/0816614024%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0816614024</URL></ItemLink><ItemLink><Description>Add To Baby Registry</Description><URL>http://www.amazon.com/gp/registry/baby/add-item.html%3Fasin.0%3D0816614024%26SubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0816614024</URL></ItemLink><ItemLink><Description>Add To Wedding Registry</Description><URL>http://www.amazon.com/gp/registry/wedding/add-item.html%3Fasin.0%3D0816614024%26SubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0816614024</URL></ItemLink><ItemLink><Description>Add To Wishlist</Description><URL>http://www.amazon.com/gp/registry/wishlist/add-item.html%3Fasin.0%3D0816614024%26SubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0816614024</URL></ItemLink><ItemLink><Description>Tell A Friend</Description><URL>http://www.amazon.com/gp/pdp/taf/0816614024%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0816614024</URL></ItemLink><ItemLink><Description>All Customer Reviews</Description><URL>http://www.amazon.com/review/product/0816614024%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0816614024</URL></ItemLink><ItemLink><Description>All Offers</Description><URL>http://www.amazon.com/gp/offer-listing/0816614024%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0816614024</URL></ItemLink></ItemLinks><ItemAttributes><Author>Gilles Deleuze</Author><Creator Role="Contributor">Felix Guattari</Creator><Manufacturer>Univ Of Minnesota Press</Manufacturer><ProductGroup>Book</ProductGroup><Title>Thousand Plateaus: Capitalism and Schizophrenia</Title></ItemAttributes></Item><Item><ASIN>0143105825</ASIN><DetailPageURL>http://www.amazon.com/Anti-Oedipus-Capitalism-Schizophrenia-Penguin-Classics/dp/0143105825%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D165953%26creativeASIN%3D0143105825</DetailPageURL><ItemLinks><ItemLink><Description>Technical Details</Description><URL>http://www.amazon.com/Anti-Oedipus-Capitalism-Schizophrenia-Penguin-Classics/dp/tech-data/0143105825%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0143105825</URL></ItemLink><ItemLink><Description>Add To Baby Registry</Description><URL>http://www.amazon.com/gp/registry/baby/add-item.html%3Fasin.0%3D0143105825%26SubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0143105825</URL></ItemLink><ItemLink><Description>Add To Wedding Registry</Description><URL>http://www.amazon.com/gp/registry/wedding/add-item.html%3Fasin.0%3D0143105825%26SubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0143105825</URL></ItemLink><ItemLink><Description>Add To Wishlist</Description><URL>http://www.amazon.com/gp/registry/wishlist/add-item.html%3Fasin.0%3D0143105825%26SubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0143105825</URL></ItemLink><ItemLink><Description>Tell A Friend</Description><URL>http://www.amazon.com/gp/pdp/taf/0143105825%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0143105825</URL></ItemLink><ItemLink><Description>All Customer Reviews</Description><URL>http://www.amazon.com/review/product/0143105825%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0143105825</URL></ItemLink><ItemLink><Description>All Offers</Description><URL>http://www.amazon.com/gp/offer-listing/0143105825%3FSubscriptionId%3D0ZVSQ33MDFPQS8H2PM02%26tag%3Dtheorydot08-20%26linkCode%3Dxm2%26camp%3D2025%26creative%3D386001%26creativeASIN%3D0143105825</URL></ItemLink></ItemLinks><ItemAttributes><Author>Gilles Deleuze</Author><Author>Felix Guattari</Author><Creator Role="Translator">Robert Hurley</Creator><Creator Role="Translator">Mark Seem</Creator><Creator Role="Introduction">Mark Seem</Creator><Creator Role="Translator">Helen Lane</Creator><Creator Role="Preface">Michel Foucault</Creator><Manufacturer>Penguin Classics</Manufacturer><ProductGroup>Book</ProductGroup><Title>Anti-Oedipus: Capitalism and Schizophrenia (Penguin Classics)</Title></ItemAttributes></Item></Items></ItemLookupResponse>

data/spec/spec_helper.rb

@@ -1,15 +0,0 @@
-require 'rspec'
-begin
-  require 'pry'
-rescue LoadError
-end
-
-require 'vacuum'
-require 'vacuum/mws'
-require 'vacuum/product_advertising'
-
-RSpec.configure do |c|
-  c.treat_symbols_as_metadata_keys_with_true_values = true
-end
-
-Dir['./spec/support/**/*.rb'].each { |f| require f }

data/spec/support/shared_examples/endpoint.rb

@@ -1,43 +0,0 @@
-shared_examples 'an endpoint' do
-  describe '#key' do
-    it 'requires key to have been set' do
-      expect { endpoint.key }.to raise_error Vacuum::MissingKey
-    end
-  end
-
-  describe '#locale' do
-    it 'defaults to the US' do
-      endpoint.locale.should eql 'US'
-    end
-
-    context 'if not valid' do
-      before do
-        endpoint.locale = 'foo'
-      end
-
-      it 'raises an error' do
-        expect { endpoint.locale }.to raise_error Vacuum::BadLocale
-      end
-    end
-  end
-
-  describe '#secret' do
-    it 'requires secret to have been set' do
-      expect { endpoint.secret }.to raise_error Vacuum::MissingSecret
-    end
-  end
-
-  describe '#user_agent' do
-    it 'includes the library version number' do
-      endpoint.user_agent.should match /Vacuum\/[\d\w.]+\s/
-    end
-
-    it 'describes the Ruby interpreter' do
-      endpoint.user_agent.should match /Language=(?:j?ruby|rbx)/
-    end
-
-    it 'describes the host' do
-      endpoint.user_agent.should match /Host=[\w\d]+/
-    end
-  end
-end