mturk 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2824ace506e32d3d0b6cba0806e4472e0c8a374f
-  data.tar.gz: 77f5276b908ee6eea5ab1557012a40bd0b054aee
+  metadata.gz: b055d3df233877b411415ee5bc49333d4e5e631b
+  data.tar.gz: 07e95e1534f167c8b25f71f91e1000d668de60ca
 SHA512:
-  metadata.gz: 9b8ed5e600b26db8465470a385ea4b09873c7c9aaa91fc8643347cddbac6c560b1b0a132dc240a4aaead75d35c463b35d179db59a73b37c441b47f6d6a39dad6
-  data.tar.gz: 43c7b5bf39c6a8e07037a3affd2cc75317cf6da84c1b175baa0d63aa3211ad5982532f4784ff0f6dc699fc5df6ccf29de24c8d4f0f54ed5c28c2fb3324276701
+  metadata.gz: 131b073c825340bfc2d96a01eb45eda4ced2b190ba6a119ca2019a6b0fe9effecb8179d880d5be018a8ce7460a480963a653e11e2520f97b531b0c83768c62fd
+  data.tar.gz: d38d47fe0cbbe11a13eca73896ab1177eb4998ae5b91a825d88940a37ad25d63149a3ac2d46fd739ab92f38038af43551272ac1c20fa1c1c8ce086570138a171

data/History.md

@@ -1,3 +1,8 @@
+== 1.9.0 / 2015-09-14
+
+=== 1 major enhancement
+* Safely retry CreateHIT, ExtendHIT, and GrantBonus operations
+
 == 1.8.1 / 2015-02-16
 
 === 1 minor update

data/lib/amazon/webservices/mechanical_turk_requester.rb

@@ -47,10 +47,12 @@ class MechanicalTurkRequester < Amazon::WebServices::Util::ConvenienceWrapper
                                   :AutoApprovalDelayInSeconds => 60*60*24*7,
                                   :LifetimeInSeconds => 60*60*24,
                                 }
+  idempotent :CreateHIT
 
   serviceCall :DisableHIT, :DisableHITResult
   serviceCall :DisposeHIT, :DisposeHITResult
   serviceCall :ExtendHIT, :ExtendHITResult
+  idempotent :ExtendHIT
   serviceCall :ForceExpireHIT, :ForceExpireHITResult
   serviceCall :GetHIT, :HIT, { :ResponseGroup => %w( Minimal HITDetail HITQuestion HITAssignmentSummary ) }
   serviceCall :ChangeHITTypeOfHIT, :ChangeHITTypeOfHITResult
@@ -71,6 +73,7 @@ class MechanicalTurkRequester < Amazon::WebServices::Util::ConvenienceWrapper
   serviceCall :ApproveRejectedAssignment, :ApproveRejectedAssignmentResult
 
   serviceCall :GrantBonus, :GrantBonusResult
+  idempotent :GrantBonus
   serviceCall :GetBonusPayments, :GetBonusPaymentsResult
 
   serviceCall :CreateQualificationType, :QualificationType, { :QualificationTypeStatus => 'Active' }

data/lib/amazon/webservices/util/convenience_wrapper.rb

@@ -51,6 +51,29 @@ class ConvenienceWrapper
     end
   end
 
+  DEFAULT_UNIQUE_REQUEST_TOKEN_FACTORY = proc do |params|
+    time_hash = Time.now.hash.to_s(36)
+    rand_hash = rand(1679615).to_s(36)
+    params_hash = params.hash.to_s(36)
+    "#{params_hash}#{time_hash}#{rand_hash}"
+  end
+
+  def self.idempotent( method, key=:UniqueRequestToken, factory = DEFAULT_UNIQUE_REQUEST_TOKEN_FACTORY )
+    method = method.to_s
+    method = ( method[0..0].downcase + method[1..-1] ).to_sym
+    old_method = instance_method(method)
+
+    define_method(method) do |*params|
+      userArgs = params[0] || {}
+      args = if userArgs.has_key?(key)
+               userArgs
+             else
+               { key => factory.call(userArgs) }.merge(userArgs)
+             end
+      old_method.bind(self).(args)
+    end
+  end
+
   def self.paginate( method, elementTag, pageSize=25 )
     method = method.to_s
     all_name = ( method[0..0].downcase + method[1..-1] + "All" ).to_sym

data/lib/mturk/version.rb

@@ -2,5 +2,5 @@
 # License::   Apache License, Version 2.0
 
 module MTurk
-  VERSION = '1.8.1'.freeze
+  VERSION = '1.9.0'.freeze
 end

data/test/mturk/test_error_handler.rb

@@ -47,9 +47,9 @@ class TestErrorHandler < Test::Unit::TestCase
       nil
     end
 
-    # invoking a non-retryable call will throw an exception
+    # invoking a non-retryable call will throw an exception if we explicitly skip passing in :UniqueRequestToken
     begin
-      @mturk.grantBonus
+      @mturk.grantBonus UniqueRequestToken: nil
       fail "Should have thrown an exception"
     rescue Timeout::Error
       # expect this exception
@@ -77,6 +77,25 @@ class TestErrorHandler < Test::Unit::TestCase
     @mock.each {|call| assert_equal :GrantBonus, call.name, "Should have been a GrantBonus call" }
   end
 
+  def testTimeoutOnceRetryableDefaultUniqueRequestToken
+    # mock will timeout first time, return success on second call
+    should_fail = true
+    @mock.listen do |call|
+      Timeout.timeout(1) do
+        if should_fail
+          should_fail = false
+          sleep(2)
+        end
+      end
+      nil
+    end
+
+    # invoke call, library will automatically insert a unique idempotency token
+    @mturk.grantBonus
+    assert_equal 2, @mock.call_buffer.size, "Should have retried once"
+    @mock.each {|call| assert_equal :GrantBonus, call.name, "Should have been a GrantBonus call" }
+  end
+
   def testTimeoutAlways
     #mock will always timeout
     @mock.listen do |call|
@@ -126,7 +145,7 @@ class TestErrorHandler < Test::Unit::TestCase
 
     # invoking a non-retryable call will throw an exception
     begin
-      @mturk.grantBonus
+      @mturk.grantBonus UniqueRequestToken: nil
       fail "Should have thrown an exception"
     rescue Errno::ECONNRESET
       # expect this exception
@@ -152,6 +171,23 @@ class TestErrorHandler < Test::Unit::TestCase
     @mock.each {|call| assert_equal :GrantBonus, call.name, "Should have been a GrantBonus call" }
   end
 
+  def testResetConnectionOnceDefaultRetryableUniqueRequestToken
+    # mock will reset connection first time, return success on second call
+    should_fail = true
+    @mock.listen do |call|
+      if should_fail
+        should_fail = false
+        raise Errno::ECONNRESET
+      end
+      nil
+    end
+
+    # invoke call, library will automatically insert a unique idempotency token
+    @mturk.grantBonus
+    assert_equal 2, @mock.call_buffer.size, "Should have retried once"
+    @mock.each {|call| assert_equal :GrantBonus, call.name, "Should have been a GrantBonus call" }
+  end
+
   def testResetConnectionAlways
     #mock will always reset connection
     @mock.listen do |call|
@@ -201,7 +237,7 @@ class TestErrorHandler < Test::Unit::TestCase
 
     # invoking a non-retryable call will throw an exception
     begin
-      @mturk.grantBonus
+      @mturk.grantBonus UniqueRequestToken: nil
       fail "Should have thrown an exception"
     rescue Errno::EPIPE
       # expect this exception
@@ -227,6 +263,23 @@ class TestErrorHandler < Test::Unit::TestCase
     @mock.each {|call| assert_equal :GrantBonus, call.name, "Should have been a GrantBonus call" }
   end
 
+  def testPipeBrokenOnceRetryableDefaultUniqueRequestToken
+    # mock will reset connection first time, return success on second call
+    should_fail = true
+    @mock.listen do |call|
+      if should_fail
+        should_fail = false
+        raise Errno::EPIPE
+      end
+      nil
+    end
+
+    # invoke call, library will automatically insert a unique idempotency token
+    @mturk.grantBonus
+    assert_equal 2, @mock.call_buffer.size, "Should have retried once"
+    @mock.each {|call| assert_equal :GrantBonus, call.name, "Should have been a GrantBonus call" }
+  end
+
   def testPipeBrokenAlways
     #mock will always break pipe
     @mock.listen do |call|
@@ -276,7 +329,7 @@ class TestErrorHandler < Test::Unit::TestCase
 
     # invoking a non-retryable call will throw an exception
     begin
-      @mturk.grantBonus
+      @mturk.grantBonus UniqueRequestToken: nil
       fail "Should have thrown an exception"
     rescue Amazon::WebServices::Util::ValidationException
       # expect this exception
@@ -302,6 +355,23 @@ class TestErrorHandler < Test::Unit::TestCase
     @mock.each {|call| assert_equal :GrantBonus, call.name, "Should have been a GrantBonus call" }
   end
 
+  def testServiceUnavailableOnceRetryableDefaultUniqueRequestToken
+    # mock will reset connection first time, return success on second call
+    should_fail = true
+    @mock.listen do |call|
+      if should_fail
+        should_fail = false
+        raise Amazon::WebServices::Util::ValidationException.new(nil, 'AWS.ServiceUnavailable')
+      end
+      nil
+    end
+
+    # invoke call, library will automatically insert a unique idempotency token
+    @mturk.grantBonus
+    assert_equal 2, @mock.call_buffer.size, "Should have retried once"
+    @mock.each {|call| assert_equal :GrantBonus, call.name, "Should have been a GrantBonus call" }
+  end
+
   def testServiceUnavailableAlways
     #mock will always break pipe
     @mock.listen do |call|

data/test/mturk/test_mock_mechanical_turk_requester.rb

@@ -39,7 +39,7 @@ class TestMockMechanicalTurkRequester < Test::Unit::TestCase
     default_call = @mock.next # request from convenience layer
     request = default_call.request
     assert !request.keys.empty?
-    expected = [:MaxAssignments, :AssignmentDurationInSeconds, :AutoApprovalDelayInSeconds, :LifetimeInSeconds]
+    expected = [:MaxAssignments, :AssignmentDurationInSeconds, :AutoApprovalDelayInSeconds, :LifetimeInSeconds, :UniqueRequestToken]
     assert_equal [], request.keys - expected, 'Convenience layer should not populate unexpected arguments'
     assert_equal [], expected - request.keys, 'Convenience layer should populate all expected arguments'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mturk
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - David J Parrott
@@ -29,7 +29,7 @@ cert_chain:
   tlC13CXjOWGW+hn+n/swny4LFXOus/qZixxiMAePSmN3QUC+bl/GvdBqZz0uPmQc
   QRVpdW2BFol3aw2mXmdYxaOwHvTxcB7DHmkfOf2h
   -----END CERTIFICATE-----
-date: 2015-02-17 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -202,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby libraries for working with Mechanical Turk