sucker 1.3.1 → 1.4.0

data/README.md

@@ -10,47 +10,90 @@ Sucker is fast and supports __the entire Amazon API__.
 Usage
 -----
 
+Read the [API](http://aws.amazon.com/archives/Product%20Advertising%20API). Jump to the __Operations__ section if in a hurry.
+
 Set up.
 
-    worker = Sucker.new(
+    worker = Sucker.new \
       :locale => :us,
-      :key    => 'API KEY',
-      :secret => 'API SECRET')
+      :key    => api_key,
+      :secret => api_secret
 
 Build a request.
 
     worker << {
       'Operation'     => 'ItemLookup',
       'IdType'        => 'ASIN',
-      'ItemId'        => '0816614024',
+      'ItemId'        => 10.asins,
       'ResponseGroup' => 'ItemAttributes' }
 
 Get a response.
 
     response = worker.get
 
-Do something with it.
+Fulfill a business value.
 
-    items = response['Item'] if response.valid? # and so on
+    if response.valid?
+      response.each('Item') do |item|
+        consume item
+      end
+    end
 
 Repeat ad infinitum.
 
+The following are all valid ways to query a response:
+
+    items = response.find('Item')
+    items = response['Item']
+    items = response.map('Item') { |item| ... }
+    response.each('Item') { |item| ... }
+
+To dig further into the response object:
+
+    p response.valid?,
+      response.body,
+      response.code,
+      response.errors,
+      response.has_errors?,
+      response.to_hash,
+      response.xml
+
 Read further [here](http://rdoc.info/github/papercavalier/sucker/master/frames) and [here](http://relishapp.com/papercavalier/sucker).
 
-Multiple IPs
-------------
+API Usage
+---------
+
+I have a growing cottage industry of gems we use to manage our
+consumption of 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.
 
-Amazon limits calls to a venue to one per second per IP address.
 
-If your server has multiple local interfaces, use them simultaneously like so:
+A hypothetical setup:
 
-    your_ips.each do |ip|
+    require 'multiplex'
+    require 'throttler'
+
+    ips.each do |ip|
       Thread.new do
-        worker.local_ip = ip
-        worker.get
+        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 venue per IP
+should provide optimum throughput.
+
 Stubbing in Tests
 -----------------
 

data/lib/sucker.rbc

@@ -1,5 +1,5 @@
 !RBIX
-10937318184790222022
+0
 x
 M
 1
@@ -9,7 +9,7 @@ x
 10
 __script__
 i
-46
+55
 5
 7
 0
@@ -28,30 +28,39 @@ i
 1
 1
 15
-99
+5
 7
 3
-65
+64
+47
 49
+1
+1
+15
+99
+7
 4
+65
+49
+5
 2
 13
 99
 12
 7
-5
+6
 12
 7
-6
+7
 12
 65
 12
 49
-7
+8
 4
 15
 49
-5
+6
 0
 15
 2
@@ -66,14 +75,17 @@ I
 0
 n
 p
-8
+9
 s
-14
-sucker/request
+17
+sucker/parameters
 x
 7
 require
 s
+14
+sucker/request
+s
 15
 sucker/response
 x
@@ -208,16 +220,16 @@ p
 I
 -1
 I
-10
+13
 I
 e
 I
-11
+14
 I
 2b
 x
-36
-/Users/snl/code/sucker/lib/sucker.rb
+44
+/Users/hakanensari/code/sucker/lib/sucker.rb
 p
 1
 x
@@ -231,35 +243,39 @@ p
 I
 2
 I
-10
+13
 I
 d
 x
-36
-/Users/snl/code/sucker/lib/sucker.rb
+44
+/Users/hakanensari/code/sucker/lib/sucker.rb
 p
 0
 x
 13
 attach_method
 p
-7
+9
 I
 0
 I
-1
+3
 I
 9
 I
-2
+4
 I
 12
 I
-7
+5
+I
+1b
 I
-2e
+a
+I
+37
 x
-36
-/Users/snl/code/sucker/lib/sucker.rb
+44
+/Users/hakanensari/code/sucker/lib/sucker.rb
 p
 0

data/lib/sucker/parameters.rbc

@@ -1,5 +1,5 @@
 !RBIX
-10937318184790222022
+0
 x
 M
 1
@@ -9,31 +9,40 @@ x
 10
 __script__
 i
-28
-99
+37
+5
 7
 0
-65
+64
+47
 49
 1
+1
+15
+99
+7
+2
+65
+49
+3
 2
 13
 99
 12
 7
-2
+4
 12
 7
-3
+5
 12
 65
 12
 49
-4
+6
 4
 15
 49
-2
+4
 0
 15
 2
@@ -48,7 +57,13 @@ I
 0
 n
 p
-5
+7
+s
+24
+active_support/inflector
+x
+7
+require
 x
 6
 Sucker
@@ -72,30 +87,30 @@ i
 99
 7
 0
-44
-43
+45
 1
+2
 65
 49
-2
+3
 3
 13
 99
 12
 7
-3
+4
 12
 7
-4
+5
 12
 65
 12
 49
-5
+6
 4
 15
 49
-3
+4
 0
 11
 I
@@ -108,13 +123,14 @@ I
 0
 n
 p
-6
+7
 x
 10
 Parameters
 x
 4
 Hash
+n
 x
 10
 open_class
@@ -308,24 +324,24 @@ p
 I
 -1
 I
-6
+b
 I
 0
 I
-7
+c
 I
 b
 I
-8
+d
 I
 16
 I
-9
+e
 I
 21
 x
-47
-/Users/snl/code/sucker/lib/sucker/parameters.rb
+55
+/Users/hakanensari/code/sucker/lib/sucker/parameters.rb
 p
 0
 x
@@ -391,7 +407,7 @@ x
 9
 normalize
 i
-86
+75
 58
 37
 19
@@ -451,19 +467,8 @@ i
 49
 5
 0
-7
-6
-64
 49
-7
-1
-56
-8
-50
-9
-0
-49
-4
+6
 0
 20
 3
@@ -471,7 +476,7 @@ i
 18
 3
 49
-10
+7
 2
 15
 15
@@ -488,7 +493,7 @@ I
 2
 n
 p
-11
+8
 x
 5
 Array
@@ -505,94 +510,9 @@ join
 x
 4
 to_s
-s
-1
-_
 x
-5
-split
-M
-1
-p
-2
-x
-9
-for_block
-t
-n
-x
-9
-normalize
-i
-29
-57
-19
-0
-15
-20
-0
-78
-79
-20
-0
-78
-79
-49
-0
-2
-49
-1
-0
-13
-18
-4
-49
-2
-3
-15
-15
-20
-0
-11
-I
 8
-I
-1
-I
-1
-I
-1
-n
-p
-3
-x
-2
-[]
-x
-6
-upcase
-x
-3
-[]=
-p
-3
-I
-0
-I
-11
-I
-1d
-x
-47
-/Users/snl/code/sucker/lib/sucker/parameters.rb
-p
-1
-x
-1
-w
-x
-3
-map
+camelize
 x
 3
 []=
@@ -601,28 +521,28 @@ p
 I
 0
 I
-e
+12
 I
 a
 I
-f
+13
 I
 18
 I
-10
+14
 I
 34
 I
-11
+15
 I
-53
+48
 I
-12
+16
 I
-56
+4b
 x
-47
-/Users/snl/code/sucker/lib/sucker/parameters.rb
+55
+/Users/hakanensari/code/sucker/lib/sucker/parameters.rb
 p
 4
 x
@@ -645,16 +565,16 @@ p
 I
 -1
 I
-d
+11
 I
 0
 I
-e
+12
 I
 f
 x
-47
-/Users/snl/code/sucker/lib/sucker/parameters.rb
+55
+/Users/hakanensari/code/sucker/lib/sucker/parameters.rb
 p
 0
 x
@@ -720,16 +640,16 @@ p
 I
 -1
 I
-18
+1c
 I
 0
 I
-19
+1d
 I
 10
 x
-47
-/Users/snl/code/sucker/lib/sucker/parameters.rb
+55
+/Users/hakanensari/code/sucker/lib/sucker/parameters.rb
 p
 0
 p
@@ -737,32 +657,32 @@ p
 I
 2
 I
-3
+8
 I
 c
 I
-4
+9
 I
 16
 I
-6
+b
 I
 24
 I
-d
+11
 I
 32
 I
-16
+1a
 I
 36
 I
-18
+1c
 I
 44
 x
-47
-/Users/snl/code/sucker/lib/sucker/parameters.rb
+55
+/Users/hakanensari/code/sucker/lib/sucker/parameters.rb
 p
 0
 x
@@ -773,27 +693,31 @@ p
 I
 2
 I
-2
+7
 I
 1f
 x
-47
-/Users/snl/code/sucker/lib/sucker/parameters.rb
+55
+/Users/hakanensari/code/sucker/lib/sucker/parameters.rb
 p
 0
 x
 13
 attach_method
 p
-3
+5
 I
 0
 I
-1
+3
 I
-1c
+9
+I
+5
+I
+25
 x
-47
-/Users/snl/code/sucker/lib/sucker/parameters.rb
+55
+/Users/hakanensari/code/sucker/lib/sucker/parameters.rb
 p
 0