vacuum 0.2.2 → 0.3.0

data/README.md

@@ -1,126 +1,24 @@
 # Vacuum
 
-[![travis] [1]] [2]
+[![travis][1]][2]
 
-Vacuum is a thin Ruby wrapper to various [Amazon Web Services (AWS) APIs] [3].
+Vacuum is a thin Ruby wrapper to the [Amazon Product Advertising API][3].
 
-![vacuum] [4]
-
-## Installation
-
-```sh
-gem install vacuum
-```
-
-## Amazon Product Advertising API
-
-Vacuum knows the [Amazon Product Advertising API] [5] inside out.
-
-Set up a request:
+![vacuum][4]
 
 ```ruby
-req = Vacuum.new :product_advertising
+request = Vacuum.new
 
-req.configure do |config|
-  config.key    'key'
-  config.secret 'secret'
-  config.tag    'tag'
-end
-```
-
-Build and run a search:
-
-```ruby
-req.build operation:    'ItemSearch',
-          search_index: 'Books',
-          keywords:     'Deleuze'
-res = req.get
-
-res.valid? or raise res.code
+request.configure key:    'foo',
+                  secret: 'secret',
+                  tag:    'foo-bar'
 
-p res.body
-```
-
-Or run the same search less verbosely:
-
-```ruby
-res = req.search :books, 'Deleuze'
-p res.body
-```
-
-The response wraps a [Nokogiri] [6] document:
-
-```ruby
-res.xml
-```
-
-And lets you drop down to any node:
-
-```ruby
-res.find('Item') do |item|
-  p item
-end
+request.get query: { 'Operation'   => 'ItemSearch',
+                     'SearchIndex' => 'Books',
+                     'Keywords'    => 'Architecture' }
 ```
 
-Browse more examples [here] [7].
-
-## Amazon Marketplace Web Services API
-
-The wrapper to the [Amazon Marketplace Web Services API] [8] is a
-work-in-progress.
-
-Set up a request to the Products API:
-
-```ruby
-req = Vacuum.new(:mws_products) do |config|
-  config.locale      'US'
-  config.key         'key'
-  config.secret      'secret'
-  config.marketplace 'marketplace'
-  config.seller      'seller'
-end
-```
-
-Get the lowest offers for a single ASIN:
-
-```ruby
-req.build 'Action'          => 'GetLowestOfferListingsForASIN',
-          'ASINList.ASIN.1' => '0231081596'
-offers = req.get.find 'GetLowestOfferListingsForASINResult'
-```
-
-I will at some point throw in some syntactic sugar for common operations.
-
-## Other AWS APIs
-
-Vacuum should work with all AWS libraries, including EC2, S3, IAM, SimpleDB,
-SQS, SNS, SES, and ELB. Most of these already have popular Ruby
-implementations. If you need to implement one using Vacuum, please fork and
-send a pull request when done.
-
-## HTTP Client Adapters
-
-You can use any of the alternative adapters [Faraday] [9] supports:
-
-```ruby
-req.connection do |builder|
-  builder.adapter :em_synchrony
-end
-```
-
-## Addendum
-
-![vacuums] [10]
-
-> Workers queuing to crawl AWS.
-
 [1]: https://secure.travis-ci.org/hakanensari/vacuum.png
 [2]: http://travis-ci.org/hakanensari/vacuum
-[3]: http://aws.amazon.com/
+[3]: https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html
 [4]: http://f.cl.ly/items/2k2X0e2u0G3k1c260D2u/vacuum.png
-[5]: https://affiliate-program.amazon.co.uk/gp/advertising/api/detail/main.html
-[6]: http://nokogiri.org/
-[7]: https://github.com/hakanensari/vacuum/blob/master/examples/product_advertising/
-[8]: https://developer.amazonservices.com/gp/mws/docs.html
-[9]: https://github.com/technoweenie/faraday
-[10]: http://f.cl.ly/items/1Q3W372A0H3M0w2H1e0W/hoover.jpeg

data/lib/vacuum/request.rb

@@ -0,0 +1,66 @@
+require 'jeff'
+
+module Vacuum
+  # An Amazon Product Advertising API request.
+  class Request
+    include Jeff
+
+    BadLocale  = Class.new ArgumentError
+    MissingTag = Class.new ArgumentError
+
+    # A list of Amazon Product Advertising API 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',
+      'UK' => 'ecs.amazonaws.co.uk',
+      'US' => 'ecs.amazonaws.com'
+    }.freeze
+
+    params 'AssociateTag' => -> { tag },
+           'Service'      => 'AWSECommerceService',
+           'Version'      => '2011-08-01'
+
+    # Creates a new request for given locale and credentials.
+    #
+    # locale - The String Product Advertising API locale (default: US).
+    #
+    # Raises a Bad Locale error if locale is not valid.
+    def initialize(locale = nil)
+      host = HOSTS[locale || 'US'] or raise BadLocale
+      self.endpoint = "http://#{host}/onca/xml"
+    end
+
+    # Configures 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
+    end
+
+    # Gets the String Associate Tag.
+    #
+    # Raises a Missing Tag error if Associate Tag is missing.
+    def tag
+      @tag or raise MissingTag
+    end
+
+    # Sets the String Associate Tag.
+    attr_writer :tag
+  end
+end

data/lib/vacuum/version.rb

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

data/lib/vacuum.rb

@@ -1,46 +1,13 @@
-# Standard library dependencies.
-require 'base64'
 require 'forwardable'
-require 'openssl'
-require 'time'
 
-# External dependencies.
-require 'addressable/uri'
-require 'faraday'
-require 'nokogiri'
-
-# Internal dependencies.
-require 'vacuum/endpoint/base'
-require 'vacuum/request/base'
-require 'vacuum/request/signature/authentication'
-require 'vacuum/request/signature/builder'
-require 'vacuum/request/utils'
-require 'vacuum/response/base'
-require 'vacuum/response/utils'
+require 'vacuum/request'
 require 'vacuum/version'
 
-# Vacuum is a Ruby wrapper to various Amazon Web Services (AWS) APIs.
+# Vacuum is a Ruby wrapper to the Amazon Product Advertising API.
 module Vacuum
-  BadLocale     = Class.new ArgumentError
-  BadResponse   = Class.new StandardError
-  MissingKey    = Class.new ArgumentError
-  MissingSecret = Class.new ArgumentError
-
   class << self
-    def new(api, &blk)
-      case api
-      when /^mws/
-        require 'vacuum/mws'
-        Request::MWS.new do |config|
-          config.api = api.slice(4, api.size).to_sym
-          blk.call config
-        end
-      when :product_advertising
-        require 'vacuum/product_advertising'
-        Request::ProductAdvertising.new &blk
-      else
-        raise NotImplementedError
-      end
-    end
+    extend Forwardable
+
+    def_delegator 'Vacuum::Request', :new
   end
 end

data/test/request_test.rb

@@ -0,0 +1,18 @@
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vacuum
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,110 +9,53 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-05 00:00:00.000000000 Z
+date: 2012-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70295025564860 !ruby/object:Gem::Requirement
+  name: jeff
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: *70295025564860
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70295025564460 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.9'
-  type: :development
+        version: 0.4.0
+  type: :runtime
   prerelease: false
-  version_requirements: *70295025564460
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: &70295025563720 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: *70295025563720
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: &70295025563140 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.6
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
-  version_requirements: *70295025563140
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: &70295025562560 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: *70295025562560
-description: ! 'Vacuum is a wrapper to various Amazon Web Services (AWS) APIs, including
-
-  Product Advertising and Marketplace Web Services (MWS).
-
-'
+        version: '0'
+description: A wrapper to the Amazon Product Advertising API
 email:
 - hakan.ensari@papercavalier.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- 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/request.rb
 - lib/vacuum/version.rb
 - lib/vacuum.rb
 - LICENSE
 - README.md
-- spec/fixtures/product_advertising
-- spec/spec_helper.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
+- test/request_test.rb
 homepage: https://github.com/hakanensari/vacuum
 licenses: []
 post_install_message: 
@@ -124,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,25 +76,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A wrapper to various Amazon Web Services APIs
+summary: Amazon Product Advertising in Ruby
 test_files:
-- spec/fixtures/product_advertising
-- spec/spec_helper.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
+- test/request_test.rb
+has_rdoc: 

data/lib/vacuum/endpoint/base.rb

@@ -1,58 +0,0 @@
-module Vacuum
-  module Endpoint
-    # An Amazon Web Services (AWS) API endpoint.
-    class Base
-      LOCALES = %w(CA CN DE ES FR IT JP UK US)
-
-      # Raises a Not Implemented Error.
-      #
-      # When implemented, this should return a String AWS API host.
-      def host
-        raise NotImplementedError
-      end
-
-      # Returns the String AWS access key ID.
-      #
-      # Raises a Missing Key error if key is missing.
-      def key
-        @key or raise MissingKey
-      end
-
-      # Sets the String AWS access key ID.
-      attr_writer :key
-
-      # Returns the String AWS API locale (default: US).
-      #
-      # Raises a Bad Locale error if locale is not valid.
-      def locale
-        @locale ||= 'US'
-        LOCALES.include? @locale or raise BadLocale
-
-        @locale
-      end
-
-      # Sets the String AWS API locale.
-      attr_writer :locale
-
-      # Returns the String AWS access secret key.
-      #
-      # Raises a Missing Secret error if secret is missing.
-      def secret
-        @secret or raise MissingSecret
-      end
-
-      # Sets the String AWS access secret key.
-      attr_writer :secret
-
-      # Returns a String user agent for the AWS API request.
-      def user_agent
-        engine   = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
-        language = [engine, RUBY_VERSION, "p#{RUBY_PATCHLEVEL}"].join ' '
-        hostname = `hostname`.chomp
-        version  = Vacuum::VERSION
-
-        "Vacuum/#{version} (Language=#{language}; Host=#{hostname})"
-      end
-    end
-  end
-end

data/lib/vacuum/endpoint/mws.rb

@@ -1,59 +0,0 @@
-module Vacuum
-  module Endpoint
-    # A Marketplace Web Services (MWS) API endpoint.
-    class MWS < Base
-      # A list of MWS API hosts.
-      HOSTS = {
-        'CA' => 'mws.amazonservices.ca',
-        'CN' => 'mws.amazonservices.com.cn',
-        'DE' => 'mws-eu.amazonservices.com',
-        'ES' => 'mws-eu.amazonservices.com',
-        'FR' => 'mws-eu.amazonservices.com',
-        'IT' => 'mws-eu.amazonservices.com',
-        'JP' => 'mws.amazonservices.jp',
-        'UK' => 'mws-eu.amazonservices.com',
-        'US' => 'mws.amazonservices.com'
-      }
-
-      # Internal: Gets/Sets the Symbol MWS API type.
-      attr_accessor :api
-
-      # Returns a String MWS API host.
-      def host
-        HOSTS[locale]
-      end
-
-      # Sets the String marketplace ID.
-      #
-      # Raises a Missing Marketplace error if marketplace ID is missing.
-      def marketplace
-        @marketplace or raise MissingMarketplace
-      end
-
-      # Sets the String marketplace ID tag.
-      attr_writer :marketplace
-
-      # Returns a String MWS API URL path.
-      #
-      # Raises a Not Implemented Error if API is not implemented.
-      def path
-        case api
-        when :products
-          '/Products/2011-10-01'
-        else
-          raise NotImplementedError
-        end
-      end
-
-      # Sets the String seller ID.
-      #
-      # Raises a Missing Seller error if seller ID is missing.
-      def seller
-        @seller or raise MissingSeller
-      end
-
-      # Sets the String seller ID tag.
-      attr_writer :seller
-    end
-  end
-end

data/lib/vacuum/endpoint/product_advertising.rb

@@ -1,34 +0,0 @@
-module Vacuum
-  module Endpoint
-    # A Product Advertising API endpoint.
-    class ProductAdvertising < Base
-      # A list of Product Advertising API 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',
-        'UK' => 'ecs.amazonaws.co.uk',
-        'US' => 'ecs.amazonaws.com'
-      }
-
-      # Returns a String Product Advertising API host.
-      def host
-        HOSTS[locale]
-      end
-
-      # Sets the String Associate tag.
-      #
-      # Raises a Missing Tag error if tag is missing.
-      def tag
-        @tag or raise MissingTag
-      end
-
-      # Sets the String Associate tag.
-      attr_writer :tag
-    end
-  end
-end

data/lib/vacuum/mws.rb

@@ -1,8 +0,0 @@
-%w(endpoint request response).each do |path|
-  require "vacuum/#{path}/mws"
-end
-
-module Vacuum
-  class MissingMarketplace < ArgumentError; end
-  class MissingSeller      < ArgumentError; end
-end

data/lib/vacuum/product_advertising.rb

@@ -1,7 +0,0 @@
-%w(endpoint request response).each do |path|
-  require "vacuum/#{path}/product_advertising"
-end
-
-module Vacuum
-  MissingTag = Class.new(ArgumentError)
-end