sucker 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+ 
+Copyright (c) 2009 Paper Cavalier
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,19 @@
+h1. Sucker
+
+Sucker is a thin Ruby wrapper to the Amazon Product Advertising API. It's built on Curb, which is great for querying Amazon on multiple network ports.
+
+    @sucker = Sucker.new(
+      :locale => "us",
+      :key    => "key",
+      :secret => "secret")
+
+    @sucker.curl { |curl| curl.interface = "eth2" }
+
+    @sucker.parameters.merge!({
+        "Operation"   => "ItemLookup",
+        "IdType"      => "ASIN",
+        "ItemId"      => "0816614024" })
+    @sucker.fetch
+    p @sucker.to_h # Now, do something with that hash!
+
+!http://upload.wikimedia.org/wikipedia/commons/a/af/Vacuum_cleaner.jpg!

data/lib/sucker/request.rb

@@ -0,0 +1,112 @@
+# = Sucker
+# Sucker is a thin Ruby wrapper to the {Amazon Product Advertising API}[http://docs.amazonwebservices.com/AWSECommerceService/latest/DG/].
+#
+module Sucker
+  class Request
+    HOSTS = {
+      :us  => 'ecs.amazonaws.com',
+      :uk  => 'ecs.amazonaws.co.uk',
+      :de  => 'ecs.amazonaws.de',
+      :ca  => 'ecs.amazonaws.ca',
+      :fr  => 'ecs.amazonaws.fr',
+      :jp  => 'ecs.amazonaws.jp' }
+
+    # The Amazon locale to query
+    attr_accessor :locale
+
+    # The Amazon secret access key
+    attr_accessor :secret
+
+    # The hash of parameters to query Amazon with
+    attr_accessor :parameters
+
+    def initialize(args)
+      self.parameters = {
+        "Service" => "AWSECommerceService",
+        "Version" => Sucker::AMAZON_API_VERSION
+      }
+
+      args.each { |k, v| send("#{k}=", v) }
+    end
+
+    # A reusable, configurable cURL object
+    def curl
+      @curl ||= Curl::Easy.new
+
+      yield @curl if block_given?
+
+      @curl
+    end
+
+    # Hits Amazon with an API request
+    def fetch
+      return nil if !valid?
+
+      curl.url = uri.to_s
+      curl.perform
+    end
+
+    # A helper method that sets the AWS Access Key ID
+    def key=(key)
+      parameters["AWSAccessKeyId"] = key
+    end
+
+    # Returns a hash of the response
+    def to_h
+      Crack::XML.parse(curl.body_str)
+    end
+
+    private
+
+    # Escapes parameters and concatenates them into a query string
+    def build_query
+      parameters.
+        sort.
+        collect do |k, v|
+          "#{CGI.escape(k)}=" + CGI.escape(v.is_a?(Array) ? v.join(",") : v)
+        end.
+        join("&")
+    end
+
+    def digest
+      OpenSSL::Digest::Digest.new("sha256")
+    end
+
+    def host
+      HOSTS[locale.to_sym]
+    end
+
+    def path
+      "/onca/xml"
+    end
+
+    # Returns a signed and timestamped query string
+    def sign_query
+      timestamp_parameters
+
+      query = build_query
+
+      string = ["GET", host, path, query].join("\n")
+      hmac = OpenSSL::HMAC.digest(digest, secret, string)
+
+      query + "&Signature=" + CGI.escape([hmac].pack("m").chomp)
+    end
+
+    def uri
+      URI::HTTP.build(
+        :host   => host,
+        :path   => path,
+        :query  => sign_query)
+    end
+
+    # Timestamps the parameters
+    def timestamp_parameters
+      self.parameters["Timestamp"] = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+    end
+
+    # Returns true if request has key, secret, and a valid locale set
+    def valid?
+      !!locale && !!HOSTS[locale.to_sym] && !!secret && !!parameters["AWSAccessKeyId"]
+    end
+  end
+end

data/lib/sucker.rb

@@ -0,0 +1,14 @@
+module Sucker
+  VERSION             = '0.1.0'.freeze
+  AMAZON_API_VERSION  = '2009-11-01'.freeze
+
+  class SuckerError < StandardError; end
+
+  def self.new(args={})
+    Sucker::Request.new(args)
+  end
+end
+
+require 'cgi'
+require 'sucker/request'
+require 'crack/xml'

data/spec/integration/item_lookup_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+module Sucker
+  describe "Item Lookup" do
+    before do
+      @sucker = Sucker.new(
+        :locale => "us",
+        :key    => amazon["key"],
+        :secret => amazon["secret"])
+
+      # @sucker.curl { |curl| curl.verbose = true }
+
+      @sucker.parameters.merge!({
+          "Operation"   => "ItemLookup",
+          "IdType"      => "ASIN"})
+    end
+
+    context "single item" do
+      before do
+        @sucker.parameters.merge!({
+          "ItemId"      => "0816614024" })
+        @sucker.fetch
+        @item = @sucker.to_h["ItemLookupResponse"]["Items"]["Item"]
+      end
+
+      it "returns an item" do
+        @item.should be_an_instance_of Hash
+      end
+
+      it "includes an ASIN string" do
+        @item["ASIN"].should eql "0816614024"
+      end
+
+      it "includes the item attributes" do
+        @item["ItemAttributes"].should be_an_instance_of Hash
+      end
+    end
+
+    context "multiple items" do
+      before do
+        @sucker.parameters.merge!({
+          "ItemId"      => ["0816614024", "0143105825"] })
+        @sucker.fetch
+        @items = @sucker.to_h["ItemLookupResponse"]["Items"]["Item"]
+      end
+
+      it "returns two items" do
+        @items.should be_an_instance_of Array
+        @items.size.should eql 2
+      end
+    end
+  end
+end

data/spec/integration/seller_listing_search_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+module Sucker
+  describe "Seller Listing Search" do
+    before do
+      @sucker = Sucker.new(
+        :locale => "us",
+        :key    => amazon["key"],
+        :secret => amazon["secret"])
+
+      # @sucker.curl { |curl| curl.verbose = true }
+
+      @sucker.parameters.merge!({
+          "Operation"   => "SellerListingSearch",
+          "SellerId"    => "A31N271NVIORU3"})
+      @sucker.fetch
+      @listings = @sucker.to_h["SellerListingSearchResponse"]["SellerListings"]
+    end
+
+    it "returns page count" do
+      @listings["TotalPages"].to_i.should be > 0
+    end
+
+    it "returns listings" do
+      @listings["SellerListing"].size.should be > 0
+      @listings["SellerListing"].first.has_key?("Price").should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler"
+Bundler.require(:default)
+
+require File.expand_path("../../lib/sucker", __FILE__)
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each{ |f| require f }

data/spec/support/amazon_credentials.rb

@@ -0,0 +1,3 @@
+def amazon
+  @amazon ||= YAML::load_file(File.dirname(__FILE__) + "/amazon.yml")
+end

data/spec/support/curb_stubber.rb

@@ -0,0 +1,7 @@
+def fixture(filename)
+  File.new(File.dirname(__FILE__) + "/../fixtures/#{filename}.xml", "r").read
+end
+
+def record(filename, output)
+  File.open(File.dirname(__FILE__) + "/../fixtures/#{filename}.xml", "w") { |f| f.write output }
+end

data/spec/unit/sucker/request_spec.rb

@@ -0,0 +1,159 @@
+require "spec_helper"
+
+module Sucker
+  describe "Request" do
+    before do
+      @sucker = Sucker.new
+    end
+
+    context "public" do
+      context ".new" do
+        it "sets default parameters" do
+          default_parameters = {
+            "Service" => "AWSECommerceService",
+            "Version" => Sucker::AMAZON_API_VERSION }
+          @sucker.parameters.should eql default_parameters
+        end
+      end
+
+      context "#curl" do
+        it "returns a cURL object" do
+          @sucker.curl.should be_an_instance_of Curl::Easy
+        end
+
+        it "configures the cURL object" do
+          @sucker.curl.interface.should be_nil
+
+          @sucker.curl do |curl|
+            curl.interface = "eth1"
+          end
+
+          @sucker.curl.interface.should eql "eth1"
+        end
+      end
+
+      context "#fetch" do
+        it "returns nil if valid? returns false" do
+          @sucker.stub!(:valid?).and_return(false)
+          @sucker.fetch.should be_nil
+        end
+      end
+
+      context "#to_h" do
+        before do
+          @sucker.curl.stub!(:body_str).and_return(fixture("single_item_lookup.us"))
+        end
+
+        it "should return a hash" do
+          @sucker.to_h.should be_an_instance_of Hash
+        end
+      end
+    end
+
+    context "private" do
+      context "#build_query" do
+        it "canonicalizes parameters" do
+          query = @sucker.send(:build_query)
+          query.should eql "Service=AWSECommerceService&Version=#{Sucker::AMAZON_API_VERSION}"
+        end
+
+        it "sorts parameters" do
+          @sucker.parameters["Foo"] = "bar"
+          query = @sucker.send(:build_query)
+          query.should match /^Foo=bar/
+        end
+
+        it "converts a parameter whose value is an array to a string" do
+          @sucker.parameters["Foo"] = ["bar", "baz"]
+          query = @sucker.send(:build_query)
+          query.should match /^Foo=bar%2Cbaz/
+        end
+      end
+
+      context "#digest" do
+        it "returns a digest object" do
+          @sucker.send(:digest).should be_an_instance_of OpenSSL::Digest::Digest
+        end
+      end
+
+      context "#key=" do
+        it "sets the Amazon AWS access key in the parameters" do
+          @sucker.key = "key"
+          @sucker.parameters["AWSAccessKeyId"].should eql "key"
+        end
+      end
+
+      context "#host" do
+        it "returns a host" do
+          @sucker.locale = "us"
+          @sucker.send(:host).should eql "ecs.amazonaws.com"
+        end
+      end
+
+      context "#path" do
+        it "returns a path" do
+          @sucker.send(:path).should eql "/onca/xml"
+        end
+      end
+
+      context "#sign_query" do
+        it "returns a signed query string" do
+          @sucker.secret = "secret"
+          @sucker.locale = "us"
+          query = @sucker.send :sign_query
+          query.should match /&Signature=.*/
+        end
+      end
+
+      context "#timestamp_parameters" do
+        it "upserts a timestamp to the parameters" do
+          @sucker.send :timestamp_parameters
+          @sucker.parameters["Timestamp"].should match /^\d+-\d+-\d+T\d+:\d+:\d+Z$/
+        end
+      end
+
+      context "#uri" do
+        it "returns the URI with which to query Amazon" do
+          @sucker.key    = "key"
+          @sucker.locale = "us"
+          @sucker.secret = "secret"
+          @sucker.send(:uri).should be_an_instance_of URI::HTTP
+        end
+      end
+
+      context "valid?" do
+        it "returns true if key, secret, and a valid locale are set" do
+          @sucker.key    = "key"
+          @sucker.locale = "us"
+          @sucker.secret = "secret"
+          @sucker.send(:valid?).should be_true
+        end
+
+        it "returns false if key is not set" do
+          @sucker.locale = "us"
+          @sucker.secret = "secret"
+          @sucker.send(:valid?).should be_false
+        end
+
+        it "returns false if secret is not set" do
+          @sucker.locale = "us"
+          @sucker.key    = "key"
+          @sucker.send(:valid?).should be_false
+        end
+
+        it "returns false if locale is not set" do
+          @sucker.key    = "key"
+          @sucker.secret = "secret"
+          @sucker.send(:valid?).should be_false
+        end
+
+        it "returns false if locale is not valid" do
+          @sucker.key    = "key"
+          @sucker.locale = "US"
+          @sucker.secret = "secret"
+          @sucker.send(:valid?).should be_false
+        end
+      end
+    end
+  end
+end

data/spec/unit/sucker_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe Sucker do
+  context ".new" do
+    it "returns a Request object" do
+      Sucker.new.should be_an_instance_of Sucker::Request
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification 
+name: sucker
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Hakan Ensari
+- Piotr Laszewski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: crack
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 1
+        - 8
+        version: 0.1.8
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: curb
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 105
+        segments: 
+        - 0
+        - 7
+        - 7
+        - 1
+        version: 0.7.7.1
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 62196417
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 17
+        version: 2.0.0.beta.17
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: ruby-debug
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 10
+        - 3
+        version: 0.10.3
+  requirement: *id004
+description: Sucker is a thin Ruby wrapper to the Amazon Product Advertising API.
+email: code@papercavalier.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- LICENSE
+- lib/sucker.rb
+- lib/sucker/request.rb
+- README.textile
+- spec/integration/item_lookup_spec.rb
+- spec/integration/seller_listing_search_spec.rb
+- spec/spec_helper.rb
+- spec/support/amazon_credentials.rb
+- spec/support/curb_stubber.rb
+- spec/unit/sucker/request_spec.rb
+- spec/unit/sucker_spec.rb
+has_rdoc: true
+homepage: http://github.com/papercavalier/sucker
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A thin Ruby wrapper to the Amazon Product Advertising API
+test_files: 
+- spec/integration/item_lookup_spec.rb
+- spec/integration/seller_listing_search_spec.rb
+- spec/spec_helper.rb
+- spec/support/amazon_credentials.rb
+- spec/support/curb_stubber.rb
+- spec/unit/sucker/request_spec.rb
+- spec/unit/sucker_spec.rb