vacuum 0.1.3 → 0.2.0.pre

data/spec/vacuum/request/signature/builder_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+module Vacuum
+  module Request
+    module Signature
+      describe Builder do
+        let :url do
+          Addressable::URI.parse 'http://example.com/foo?bar=1'
+        end
+
+        let :builder do
+          described_class.new env, 'secret'
+        end
+
+        let :env do
+          { :method => :get, :url => url }
+        end
+
+        describe '#method' do
+          it 'returns an HTTP method' do
+            builder.method.should eql 'GET'
+          end
+        end
+
+        describe '#sign' do
+          it 'signs the request' do
+            builder.sign
+            builder.url.query.should include 'Signature='
+          end
+        end
+
+        describe '#signature' do
+          after do
+            builder.signature
+          end
+
+          it 'generates an HMAC-SHA signature' do
+            OpenSSL::HMAC.should_receive(:digest).and_return 'secret'
+          end
+
+          it 'base64-encodes generated signature' do
+            Base64.should_receive(:encode64).and_return 'a string'
+          end
+        end
+
+        describe '#sort_query' do
+          it 'sorts query values' do
+            url.query = 'baz=0&bar=1'
+            builder.sort_query
+            builder.url.query.should eql 'bar=1&baz=0'
+          end
+        end
+
+        describe '#string_to_sign' do
+          it 'concatenates the request method, host, path, and query' do
+            expected_string = %w(GET example.com /foo bar=1).join "\n"
+            builder.string_to_sign.should eql expected_string
+          end
+        end
+
+        describe '#timestamp' do
+          it 'timestamps the request' do
+            builder.timestamp
+            builder.url.query.should include 'Timestamp='
+          end
+        end
+
+        describe '#url' do
+          it 'returns the request URL' do
+            builder.url.should be_an Addressable::URI
+          end
+        end
+      end
+    end
+  end
+end

data/spec/vacuum/request/utils_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Vacuum
+  module Request
+    describe Utils do
+      describe '.camelize' do
+        it 'camelizes an underscored String' do
+          Utils.camelize('foo_bar').should eql 'FooBar'
+        end
+      end
+
+      describe '.encode' do
+        it 'encodes reserved characters' do
+          Utils.encode(',').should eql '%2C'
+        end
+
+        it 'does not encode unreserved characters' do
+          Utils.encode('~').should eql '~'
+        end
+      end
+    end
+  end
+end

data/spec/vacuum/response/base_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Vacuum
+  module Response
+    describe Base do
+      let(:body) do
+        '<?xml version="1.0" ?>
+          <children>
+            <child>
+              <name>foo</name>
+            </child>
+            <child>
+              <name>bar</name>
+            </child>
+          </children>'.gsub />\s+</, '><'
+      end
+
+      let(:response) do
+        described_class.new body, '200'
+      end
+
+      it_behaves_like 'a response'
+
+      describe '#find' do
+        it 'returns an array of matches' do
+          response.find('child').should_not be_empty
+        end
+
+        it 'yields matches to a block' do
+          names = response.find('child') do |child|
+            child['name']
+          end
+          names.should =~ %w(foo bar)
+        end
+      end
+    end
+  end
+end

data/spec/vacuum/response/product_advertising_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+module Vacuum
+  module Response
+    describe ProductAdvertising do
+      let(:response) do
+        path = File.expand_path('../../../fixtures/product_advertising', __FILE__)
+        body = File.read path
+
+        described_class.new body, '200'
+      end
+
+      it_behaves_like 'a response'
+
+      context 'when Amazon returns errors' do
+        before do
+          response.body =  <<-EOF.gsub!(/>\s+</, '><').strip!
+          <?xml version=\"1.0\" ?>
+          <Response xmlns="http://example.com">
+            <Errors>
+              <Error>foo</Error>
+            </Errors>
+          </Response>
+          EOF
+        end
+
+        describe '#errors' do
+          it 'returns an Array of errors' do
+            response.errors.should =~ ['foo']
+          end
+        end
+      end
+
+      describe '#has_errors?' do
+        context 'when response does not contain any errors' do
+          before do
+            response.stub!(:errors).and_return([])
+          end
+
+          it 'returns false' do
+            response.should_not have_errors
+          end
+        end
+
+        context 'when response contains errors' do
+          before do
+            response.stub!(:errors).and_return([1])
+          end
+
+          it 'returns true' do
+            response.should have_errors
+          end
+        end
+      end
+    end
+  end
+end

data/spec/vacuum/response/utils_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Vacuum
+  module Response
+    describe Utils do
+      describe '.xml_to_hash' do
+        let(:hash) do
+          str = <<-XML.gsub!(/>\s+</, '><').strip!
+          <?xml version=\"1.0\" ?>
+          <ItemAttributes>
+            <Title>Anti-Oedipus</Title>
+            <Author>Gilles Deleuze</Author>
+            <Author>Felix Guattari</Author>
+            <Creator Role="Translator">Robert Hurley</Creator>
+          </ItemAttributes>
+          XML
+          xml = Nokogiri::XML.parse str
+
+          Utils.xml_to_hash xml
+        end
+
+        it 'returns a hash' do
+          hash.should be_an_instance_of Hash
+        end
+
+        it 'handles only childs' do
+          hash['Title'].should eql 'Anti-Oedipus'
+        end
+
+        it 'handles arrays' do
+          hash['Author'].should be_a Array
+        end
+
+        it 'handles attributes' do
+          node = hash['Creator']
+          node['Role'].should eql 'Translator'
+          node['__content__'].should eql 'Robert Hurley'
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,46 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 0.2.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-14 00:00:00.000000000 Z
+date: 2012-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: knack
-  requirement: &70162196586060 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &70296598618460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70296598618460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70296598617960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70296598617960
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70296598617500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70296598617500
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70296598617040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70296598617040
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70296598616580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70162196586060
-description: Vacuum is a Ruby wrapper to the Amazon Product Advertising API.
+  version_requirements: *70296598616580
+description: ! 'Vacuum is a wrapper to various Amazon Web Services (AWS) APIs, including
+
+  Product Advertising and Marketplace Web Services (MWS).
+
+'
 email:
 - hakan.ensari@papercavalier.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/vacuum/em.rb
-- lib/vacuum/request.rb
-- lib/vacuum/response.rb
+- lib/vacuum/endpoint/base.rb
+- lib/vacuum/endpoint/mws.rb
+- lib/vacuum/endpoint/product_advertising.rb
+- lib/vacuum/mws.rb
+- lib/vacuum/product_advertising.rb
+- lib/vacuum/request/base.rb
+- lib/vacuum/request/mws.rb
+- lib/vacuum/request/product_advertising.rb
+- lib/vacuum/request/signature/authentication.rb
+- lib/vacuum/request/signature/builder.rb
+- lib/vacuum/request/utils.rb
+- lib/vacuum/response/base.rb
+- lib/vacuum/response/mws.rb
+- lib/vacuum/response/product_advertising.rb
+- lib/vacuum/response/utils.rb
 - lib/vacuum/version.rb
 - lib/vacuum.rb
 - LICENSE
 - README.md
-- spec/fixtures/http_response
+- spec/fixtures/product_advertising
 - spec/spec_helper.rb
-- spec/vacuum/request_spec.rb
-- spec/vacuum/response_spec.rb
-homepage: http://github.com/hakanensari/vacuum
+- spec/support/shared_examples/endpoint.rb
+- spec/support/shared_examples/request.rb
+- spec/support/shared_examples/response.rb
+- spec/vacuum/endpoint/base_spec.rb
+- spec/vacuum/endpoint/mws_spec.rb
+- spec/vacuum/endpoint/product_advertising_spec.rb
+- spec/vacuum/request/base_spec.rb
+- spec/vacuum/request/mws_spec.rb
+- spec/vacuum/request/product_advertising_spec.rb
+- spec/vacuum/request/signature/authentication_spec.rb
+- spec/vacuum/request/signature/builder_spec.rb
+- spec/vacuum/request/utils_spec.rb
+- spec/vacuum/response/base_spec.rb
+- spec/vacuum/response/product_advertising_spec.rb
+- spec/vacuum/response/utils_spec.rb
+homepage: https://github.com/hakanensari/vacuum
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -55,17 +128,30 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: A Ruby wrapper to the Amazon Product Advertising API
+summary: A wrapper to various Amazon Web Services APIs
 test_files:
-- spec/fixtures/http_response
+- spec/fixtures/product_advertising
 - spec/spec_helper.rb
-- spec/vacuum/request_spec.rb
-- spec/vacuum/response_spec.rb
+- spec/support/shared_examples/endpoint.rb
+- spec/support/shared_examples/request.rb
+- spec/support/shared_examples/response.rb
+- spec/vacuum/endpoint/base_spec.rb
+- spec/vacuum/endpoint/mws_spec.rb
+- spec/vacuum/endpoint/product_advertising_spec.rb
+- spec/vacuum/request/base_spec.rb
+- spec/vacuum/request/mws_spec.rb
+- spec/vacuum/request/product_advertising_spec.rb
+- spec/vacuum/request/signature/authentication_spec.rb
+- spec/vacuum/request/signature/builder_spec.rb
+- spec/vacuum/request/utils_spec.rb
+- spec/vacuum/response/base_spec.rb
+- spec/vacuum/response/product_advertising_spec.rb
+- spec/vacuum/response/utils_spec.rb

data/lib/vacuum/em.rb

@@ -1,21 +0,0 @@
-require 'vacuum'
-require 'em-http-request'
-
-module Vacuum
-  class Request
-    # Performs an async request.
-    #
-    # @param err [Proc] A callback to be executed if request fails
-    # @yield Passes response to given block
-    def aget(err = nil, &blk)
-      http = EM::HttpRequest.new(url).get
-      # @todo Consider using a SAX parser that can work on the chunks as they
-      # come in?
-      # http.stream { |chunk| parse chunk }
-      http.callback do
-        yield Response.new http.response, http.response_header.status
-      end
-      http.errback &err if err
-    end
-  end
-end

data/lib/vacuum/request.rb

@@ -1,119 +0,0 @@
-module Vacuum
-  # A wrapper around the request to the Amazon Product Advertising API.
-  class Request
-    # The latest Amazon API version.
-    CURRENT_API_VERSION = '2011-08-01'
-
-    # A list of Amazon endpoints.
-    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',
-      :uk => 'ecs.amazonaws.co.uk',
-      :us => 'ecs.amazonaws.com'
-    }
-
-    # Creates a new request for given locale and credentials.
-    #
-    # @param [Hash] options
-    # @option opts [#to_sym] :locale An Amazon locale
-    # @option opts [String] :key An Amazon AWS access key ID
-    # @option opts [String] :secret An Amazon AWS access secret key
-    # @option opts [String] :tag An Amazon Associate tag
-    # @raise [MissingKey] An Amazon AWS access key ID was not given
-    # @raise [MissingSecret] An Amazon AWS secret key was not given
-    # @raise [MissingTag] An Amazon Associate tag was not given
-    # @return [self]
-    def initialize(options)
-      _reset!
-
-      locale  = (options[:locale] || :us).to_sym
-      @host   = HOSTS[locale]    or raise BadLocale
-      @key    = options[:key]    or raise MissingKey
-      @secret = options[:secret] or raise MissingSecret
-      @tag    = options[:tag]    or raise MissingTag
-    end
-
-    # Merges given parameters into the request query.
-    #
-    # @param [Hash] hsh Pairs of keys and values
-    # @return [self]
-    def build(hsh)
-      hsh.each do |k, v|
-        @params[k] = v.is_a?(Array) ? v.join(',') : v.to_s
-      end
-
-      self
-    end
-
-    # Replaces the request query with given parameters.
-    #
-    # @see(#build)
-    def build!(hsh = {})
-      _reset!
-      build hsh
-    end
-
-    # Performs a request.
-    #
-    # @return [Vacuum::Response] A response
-    def get
-      res = Net::HTTP.get_response(url)
-      Response.new(res.body, res.code)
-    end
-
-    # @return [Hash] The parameters that make up the request query.
-    def params
-      _default_params.merge(@params)
-    end
-
-    # @return [URI::HTTP] The URL for the API request
-    def url
-      URI::HTTP.build :host  => @host,
-                      :path  => '/onca/xml',
-                      :query => _query_string
-    end
-
-    private
-
-    def _default_params
-      default = {
-        'AWSAccessKeyId' => @key,
-        'AssociateTag'   => @tag,
-        'Service'        => 'AWSECommerceService',
-        'Timestamp'      => _timestamp,
-        'Version'        => CURRENT_API_VERSION
-      }
-    end
-
-    def _escape(value)
-      value.gsub(/([^a-zA-Z0-9_.~-]+)/) do
-        '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
-      end
-    end
-
-    def _query_string
-      qs   = params.sort.map { |k, v| "#{k}=" + _escape(v) }.join('&')
-
-      # Sign query string.
-      dig  = OpenSSL::Digest::Digest.new 'sha256'
-      req  = ['GET', @host, '/onca/xml', qs]
-      hmac = OpenSSL::HMAC.digest dig, @secret, req.join("\n")
-      sig  = _escape [hmac].pack('m').chomp
-
-      "#{qs}&Signature=#{sig}"
-    end
-
-    def _reset!
-      @params = {}
-    end
-
-    def _timestamp
-      Time.now.utc.iso8601
-    end
-  end
-end

data/lib/vacuum/response.rb

@@ -1,63 +0,0 @@
-module Vacuum
-  # A wrapper around the API response.
-  class Response
-
-    # @return [String] body The response body
-    attr_accessor :body
-
-    # @return [Integer] code The HTTP status code of the response
-    attr_accessor :code
-
-    # Creates a new response.
-    #
-    # @param [String] body The response body
-    # @param [#to_i] code The HTTP status code of the response
-    def initialize(body, code)
-      @body = body
-      @code = code.to_i
-    end
-
-    # @return [Array] Errors in the response
-    def errors
-      find 'Error'
-    end
-
-    # Queries for a given attribute, yielding matching nodes to a block if
-    # given one.
-    #
-    # @param [String] Query attribute to be queried
-    # @yield Optionally passes matching nodes to a given block
-    # @return [Array] Matches
-    #
-    # @example
-    #   items = res.find('Item')
-    #   asins = res.find('Item') { |item| item['ASIN'] }
-    #
-    def find(query)
-      xml.xpath("//xmlns:#{query}").map do |node|
-        hsh = Knack.from_xml node
-        block_given? ? yield(hsh) : hsh
-      end
-    end
-
-    # @return [true, false] Whether the response has errors
-    def has_errors?
-      errors.count > 0
-    end
-
-    # @return [Hash] A hash representation of the entire response.
-    def to_hash
-      Knack.from_xml xml
-    end
-
-    # @return [true, false] Whether the HTTP response is OK
-    def valid?
-      code == 200
-    end
-
-    # @return [Nokogiri::XML] the XML document
-    def xml
-      @xml ||= Nokogiri::XML @body
-    end
-  end
-end