sucker 1.4.1 → 1.5.0

data/README.md

@@ -1,27 +1,26 @@
 Sucker
 ======
 
-Sucker is a Nokogiri-based Ruby wrapper to the [Amazon Product Advertising API](https://affiliate-program.amazon.co.uk/gp/advertising/api/detail/main.html).
-
-Sucker is fast and supports __the entire Amazon API__.
+Sucker is a Nokogiri-based Ruby wrapper to the [Amazon Product Advertising API](https://affiliate-program.amazon.co.uk/gp/advertising/api/detail/main.html). It's fast and supports the entire API.
 
 ![Hoover](https://github.com/papercavalier/sucker/raw/master/hoover.jpg)
 
 Usage
 -----
 
-Read the [API](http://aws.amazon.com/archives/Product%20Advertising%20API). Skip to the __Operations__ section if in a hurry.
+Read [Amazon's API](http://aws.amazon.com/archives/Product%20Advertising%20API).
+Skip to the __Operations__ section if in a hurry.
 
 Set up.
 
-    worker = Sucker.new \
-      :locale => :us,
-      :key    => api_key,
-      :secret => api_secret
+    request = Sucker.new(
+      :locale        => :us,
+      :key           => a_key,
+      :secret        => a_secret)
 
 Build a request.
 
-    worker << {
+    request << {
       'Operation'     => 'ItemLookup',
       'IdType'        => 'ASIN',
       'ItemId'        => 10.asins,
@@ -29,7 +28,7 @@ Build a request.
 
 Get a response.
 
-    response = worker.get
+    response = request.get
 
 Fulfill a business value.
 
@@ -58,56 +57,20 @@ To dig further into the response object:
       response.to_hash,
       response.xml
 
-Browse the Sucker API [here](http://rdoc.info/github/papercavalier/sucker/master/frames). To see more advanced examples such as twenty-item batch requests and remote cart manipulation, read [here](http://relishapp.com/papercavalier/sucker).
-
-Managing calls
---------------
-
-We have a home-grown collection of gems that help us manage our
-calls to the Amazon API.
-
-* [Multiplex](http://github.com/papercavalier/multiplex) binds a
-  request to a specified local IP.
-* [Throttler](http://github.com/papercavalier/throttler) throttles
-  requests to a venue to one per second per IP.
+To use multiple local IPs on your server, configure the request object like so:
 
-A hypothetical setup:
+    adapter = request.adapter
+    adapter.socket_local.host = '10.0.0.2'
 
-    require 'multiplex'
-    require 'throttler'
-
-    ips.each do |ip|
-
-      Thread.new do
-        scope = "#{ip}-#{locale}"
-
-        Throttler.throttle(scope) do
-          Net::HTTP.bind ip do
-            # Set up worker
-            response = worker.get
-            # Consume response
-          end
-        end
-
-      end
-
-    end
-
-We prefer to use [Resque](http://github.com/defunkt/resque) to manage
-multiple requests.
-
-Generally, four or five workers per locale per IP proves enough to provide
-optimum throughput.
+Browse the public interface of Sucker
+[here](http://rdoc.info/github/papercavalier/sucker/master/frames). To see more
+advanced usage examples such as twenty-item batch requests and remote cart
+manipulation, read [here](http://relishapp.com/papercavalier/sucker).
 
 Stubbing in Tests
 -----------------
 
-Use [VCR](http://github.com/myronmarston/vcr).
-
-Compatibility
--------------
-
-Specs pass against Ruby 1.8.7, Ruby 1.9.2, JRuby 1.5.6, and Rubinius 1.2.1.
+Try [VCR](http://github.com/myronmarston/vcr).
 
 Moral of the story
 ------------------

data/lib/sucker/hash.rb

@@ -1,5 +1,6 @@
 module Sucker
 
+  # A monkey-patched Hash, safely stashed away in the Sucker namespace.
   class Hash < ::Hash
     class << self
 

data/lib/sucker/hash.rbc

@@ -480,11 +480,11 @@ p
 I
 0
 I
-14
+15
 I
 a
 I
-15
+16
 I
 1c
 x
@@ -727,47 +727,47 @@ p
 I
 0
 I
-18
+19
 I
 4
 I
-19
+1a
 I
 e
 I
-1b
+1c
 I
 1a
 I
-1c
+1d
 I
 22
 I
-1d
+1e
 I
 27
 I
-1f
+20
 I
 38
 I
-21
+22
 I
 45
 I
-22
+23
 I
 58
 I
-23
+24
 I
 6a
 I
-25
+26
 I
 8d
 I
-28
+29
 I
 9f
 x
@@ -795,43 +795,43 @@ p
 I
 -1
 I
-d
+e
 I
 0
 I
-e
+f
 I
 2
 I
-f
+10
 I
 11
 I
-10
+11
 I
 43
 I
-11
+12
 I
 52
 I
-12
+13
 I
 6c
 I
-14
+15
 I
 77
 I
-18
+19
 I
 82
 I
-2c
+2d
 I
 87
 I
-2e
+2f
 I
 90
 x
@@ -856,7 +856,7 @@ p
 I
 2
 I
-d
+e
 I
 10
 x
@@ -872,7 +872,7 @@ p
 I
 2
 I
-4
+5
 I
 1c
 x
@@ -888,7 +888,7 @@ p
 I
 2
 I
-3
+4
 I
 1f
 x

data/lib/sucker/parameters.rb

@@ -3,6 +3,10 @@ module Sucker
     CURRENT_API_VERSION = '2010-11-01'
 
     def initialize
+      set_up
+    end
+
+    def set_up
       self.store 'Service',   'AWSECommerceService'
       self.store 'Version',   CURRENT_API_VERSION
       self.store 'Timestamp', timestamp

data/lib/sucker/parameters.rbc

@@ -129,7 +129,7 @@ x
 10
 Parameters
 i
-58
+72
 5
 66
 65
@@ -170,15 +170,29 @@ i
 6
 4
 15
+99
+7
+9
+7
+10
+65
+67
+49
+5
+0
+49
+6
+4
+15
 5
 48
-9
+11
 15
 99
 7
-10
+12
 7
-11
+13
 65
 67
 49
@@ -198,7 +212,7 @@ I
 0
 n
 p
-12
+14
 x
 19
 CURRENT_API_VERSION
@@ -219,6 +233,59 @@ x
 10
 initialize
 i
+4
+5
+48
+0
+11
+I
+1
+I
+0
+I
+0
+I
+0
+n
+p
+1
+x
+6
+set_up
+p
+5
+I
+-1
+I
+5
+I
+0
+I
+6
+I
+4
+x
+55
+/Users/hakanensari/code/sucker/lib/sucker/parameters.rb
+p
+0
+x
+17
+method_visibility
+x
+15
+add_defn_method
+x
+6
+set_up
+M
+1
+n
+n
+x
+6
+set_up
+i
 33
 5
 7
@@ -291,19 +358,19 @@ p
 I
 -1
 I
-5
+9
 I
 0
 I
-6
+a
 I
 b
 I
-7
+b
 I
 16
 I
-8
+c
 I
 21
 x
@@ -312,12 +379,6 @@ x
 p
 0
 x
-17
-method_visibility
-x
-15
-add_defn_method
-x
 9
 normalize
 M
@@ -562,7 +623,7 @@ p
 I
 0
 I
-10
+14
 I
 1d
 x
@@ -584,23 +645,23 @@ p
 I
 0
 I
-d
+11
 I
 a
 I
-e
+12
 I
 18
 I
-f
+13
 I
 34
 I
-10
+14
 I
 53
 I
-11
+15
 I
 56
 x
@@ -628,11 +689,11 @@ p
 I
 -1
 I
-c
+10
 I
 0
 I
-d
+11
 I
 f
 x
@@ -703,11 +764,11 @@ p
 I
 -1
 I
-17
+1b
 I
 0
 I
-18
+1c
 I
 10
 x
@@ -716,7 +777,7 @@ x
 p
 0
 p
-11
+13
 I
 2
 I
@@ -728,17 +789,21 @@ I
 I
 1a
 I
-c
+9
 I
 28
 I
-15
+10
 I
-2c
+36
 I
-17
+19
 I
 3a
+I
+1b
+I
+48
 x
 55
 /Users/hakanensari/code/sucker/lib/sucker/parameters.rb

data/lib/sucker/request.rb

@@ -1,4 +1,4 @@
-require 'net/http'
+require 'httpclient'
 require 'openssl'
 require 'sucker/parameters'
 
@@ -14,6 +14,11 @@ module Sucker
       :fr  => 'ecs.amazonaws.fr',
       :jp  => 'ecs.amazonaws.jp' }
 
+    # Available Amazon locales.
+    def self.locales
+      @locales ||= HOSTS.keys
+    end
+
     # The Amazon associate tag.
     attr_accessor :associate_tag
 
@@ -30,17 +35,24 @@ module Sucker
     #
     # Takes an optional hash of attribute and value pairs.
     #
-    #   worker = Sucker.new(
-    #     :key    => 'API KEY',
-    #     :secret => 'API SECRET')
+    #   request = Sucker.new(
+    #     :locale        => :us,
+    #     :key           => a_key,
+    #     :secret        => a_secret,
+    #     :associate_tag => a_tag)
     #
     def initialize(args={})
       args.each { |k, v| send("#{k}=", v) }
     end
 
+    # The HTTP adapter.
+    def adapter
+      @adapter ||= HTTPClient.new
+    end
+
     # Merges a hash into the existing parameters.
     #
-    #   worker << {
+    #   request << {
     #     'Operation' => 'ItemLookup',
     #     'IdType'    => 'ASIN',
     #     'ItemId'    => '0816614024' }
@@ -51,14 +63,10 @@ module Sucker
 
     # Performs a request and returns a response object.
     #
-    #   response = worker.get
+    #   response = request.get
     #
     def get
-      response = Net::HTTP.start(host) do |http|
-        query = build_signed_query
-        http.get("/onca/xml?#{query}")
-      end
-
+      response = adapter.get(uri)
       Response.new(response)
     end
 
@@ -67,9 +75,17 @@ module Sucker
       @parameters ||= Parameters.new
     end
 
+    # Resets parameters and returns itself.
+    def reset
+      parameters.clear
+      parameters.set_up
+
+      self
+    end
+
     # Sets the Amazon API version.
     #
-    #   worker.version = '2010-06-01'
+    #   request.version = '2010-06-01'
     #
     def version=(version)
       parameters['Version'] = version
@@ -107,5 +123,12 @@ module Sucker
     def host
       HOSTS[locale.to_sym]
     end
+
+    def uri
+      URI::HTTP.build(
+        :host   => host,
+        :path   => '/onca/xml',
+        :query  => build_signed_query)
+    end
   end
 end