ruby-aws 1.6.0

data/samples/mturk/site_category/site_category.question

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<!-- Note the inclusion of the @urls variable which is defined as a field in the input file.  ERB is the template engine that is 
+used to perform the merging of variables into template files.
+-->
+<% require 'cgi' %>
+<ExternalQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd">
+	<ExternalURL>http://s3.amazonaws.com/mturk/samples/sitecategory/externalpage.htm?url=<%= CGI::escape @urls %></ExternalURL>	
+	<FrameHeight>400</FrameHeight>
+</ExternalQuestion>

data/test/mturk/test_changehittypeofhit.rb

@@ -0,0 +1,130 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+require 'test/unit/testcase'
+require 'ruby-aws'
+require 'amazon/webservices/mturk/question_generator'
+require 'amazon/webservices/util/soap_transport'
+require 'amazon/webservices/util/rest_transport'
+require 'amazon/webservices/util/mock_transport'
+
+
+class TestChangeHITTypeOfHIT < Test::Unit::TestCase
+  include Amazon::WebServices
+
+  def setup
+    # Setting up the default requester interface.  
+    #   This will default to running against Sandbox, but we specify the host explicitly for safety. 
+    #   Access Key ID and Secret Access Key will be loaded from user preference file
+    #     If not found, the user will be interatively queried for their authentication information.
+    @@mturk    ||= Amazon::WebServices::MechanicalTurkRequester.new :Host => :Sandbox if ENV['DISABLE_MTURK_SANDBOX_TEST'].nil?
+
+    # set up a mock version of the service
+    @@mock     ||= Amazon::WebServices::Util::MockTransport.new
+    @@mockturk ||= Amazon::WebServices::MechanicalTurkRequester.new( :Transport => @@mock, :AWSAccessKey => 'bogus', :AWSAccessKeyId => 'fake' )
+
+    # lets just build this question once
+    @@question ||= MTurk::QuestionGenerator.build { |q| q.ask 'Have you tried changing the description of a HIT?' }
+  end
+
+  def testUpdateHITMock
+    @@mock.listen do |call|
+      case call.name
+      when :GetHIT
+        {:HIT => {:HITId => call.request[:HITId], :Title => "old title", :Description => "foo", :Request => {} } }
+      when :RegisterHITType
+        {:RegisterHITTypeResult => {:HITTypeId => 'mockHITType', :Request => {} } }
+      else
+        {}
+      end
+    end
+
+    @@mockturk.updateHIT( 'mockHIT', { :Title => 'new title' } )
+    assert_equal :GetHIT, @@mock.next.name
+
+    ht = @@mock.next
+    assert_equal :RegisterHITType, ht.name
+    assert_equal "new title", ht.request[:Title]
+    assert_equal "foo", ht.request[:Description]
+
+    update = @@mock.next
+    assert_equal :ChangeHITTypeOfHIT, update.name
+    assert_equal 'mockHIT', update.request[:HITId]
+    assert_equal 'mockHITType', update.request[:HITTypeId]
+  end
+
+  # Allow user to skip these tests by setting the DISABLE_MTURK_SANDBOX_TEST environment variable
+  if ENV['DISABLE_MTURK_SANDBOX_TEST'].nil?
+
+  def testHappyCase
+    hit_result = @@mturk.createHIT :Title => 'Ruby SDK Test Hit (ChangeHITTypeOfHIT)',
+                                  :Description => 'Autogenerated ruby-aws test case description1',
+                                  :Keywords => 'Ruby, test, SDK, changehittypeofhit, description1',
+                                  :Reward => { :Amount => 0.01, :CurrencyCode => 'USD' },
+                                  :Question => @@question
+    new_hit_type = @@mturk.registerHITType :Title => 'Ruby SDK Test Hit (ChangeHITTypeOfHIT) - Updated',
+                                          :Description => 'Autogenerated ruby-aws test case description2',
+                                          :Keywords => 'Ruby, test, SDK, changehittypeofhit, description2',
+                                          :Reward => { :Amount => 0.01, :CurrencyCode => 'USD' }
+    @@mturk.changeHITTypeOfHIT :HITId => hit_result[:HITId],
+                              :HITTypeId => new_hit_type[:HITTypeId]
+    updated_hit = @@mturk.getHIT :HITId => hit_result[:HITId]
+    assert_equal new_hit_type[:HITTypeId], updated_hit[:HITTypeId], 'HITTypeId of ' + hit_result[:HITId] + ' not updated'
+    @@mturk.forceExpireHIT :HITId => hit_result[:HITId]
+    @@mturk.disposeHIT :HITId => hit_result[:HITId]
+  end
+
+  def testUpdateHIT
+    hit_result = @@mturk.createHIT :Title => 'Ruby SDK Test Hit (ChangeHITTypeOfHIT)',
+                                  :Description => 'Autogenerated ruby-aws test case description1',
+                                  :Keywords => 'Ruby, test, SDK, changehittypeofhit, description1',
+                                  :Reward => { :Amount => 0.01, :CurrencyCode => 'USD' },
+                                  :Question => @@question
+    new_template = { :Title => 'Ruby SDK Test Hit (ChangeHITTypeOfHIT) - Updated',
+                     :Description => 'Autogenerated ruby-aws test case description2',
+                     :Keywords => 'Ruby, test, SDK, changehittypeofhit, description2',
+                     :Reward => { :Amount => 0.01, :CurrencyCode => 'USD' } }
+    @@mturk.updateHIT(hit_result[:HITId], new_template)
+    assert_not_equal hit_result[:HITTypeId], @@mturk.getHIT(:HITId=>hit_result[:HITId])[:HITTypeId], 'HITTypeId not changed'
+    @@mturk.forceExpireHIT :HITId => hit_result[:HITId]
+    @@mturk.disposeHIT :HITId => hit_result[:HITId]
+  end
+
+  def testUpdateHITs
+    hit_result1 = @@mturk.createHIT :Title => 'Ruby SDK Test Hit (ChangeHITTypeOfHIT)',
+                                   :Description => 'Autogenerated ruby-aws test case description1',
+                                   :Keywords => 'Ruby, test, SDK, changehittypeofhit, description1',
+                                   :Reward => { :Amount => 0.01, :CurrencyCode => 'USD' },
+                                   :Question => @@question
+    hit_result2 = @@mturk.createHIT :Title => 'Ruby SDK Test Hit (ChangeHITTypeOfHIT)',
+                                   :Description => 'Autogenerated ruby-aws test case description1',
+                                   :Keywords => 'Ruby, test, SDK, changehittypeofhit, description1',
+                                   :Reward => { :Amount => 0.01, :CurrencyCode => 'USD' },
+                                   :Question => @@question
+    hit_result3 = @@mturk.createHIT :Title => 'Ruby SDK Test Hit (ChangeHITTypeOfHIT)',
+                                   :Description => 'Autogenerated ruby-aws test case description1',
+                                   :Keywords => 'Ruby, test, SDK, changehittypeofhit, description1',
+                                   :Reward => { :Amount => 0.01, :CurrencyCode => 'USD' },
+                                   :Question => @@question
+    new_template = { :Title => 'Ruby SDK Test Hit (ChangeHITTypeOfHIT) - Updated',
+                     :Description => 'Autogenerated ruby-aws test case description2',
+                     :Keywords => 'Ruby, test, SDK, changehittypeofhit, description2',
+                     :Reward => { :Amount => 0.01, :CurrencyCode => 'USD' } }
+
+    @@mturk.updateHITs(new_template, [hit_result1[:HITId], hit_result2[:HITId], hit_result3[:HITId]])
+
+    assert_not_equal hit_result1[:HITTypeId], @@mturk.getHIT(:HITId=>hit_result1[:HITId])[:HITTypeId], 'HITTypeId not changed'
+    assert_not_equal hit_result2[:HITTypeId], @@mturk.getHIT(:HITId=>hit_result2[:HITId])[:HITTypeId], 'HITTypeId not changed'
+    assert_not_equal hit_result3[:HITTypeId], @@mturk.getHIT(:HITId=>hit_result3[:HITId])[:HITTypeId], 'HITTypeId not changed'
+    @@mturk.forceExpireHIT :HITId => hit_result1[:HITId]
+    @@mturk.disposeHIT :HITId => hit_result1[:HITId]
+    @@mturk.forceExpireHIT :HITId => hit_result2[:HITId]
+    @@mturk.disposeHIT :HITId => hit_result2[:HITId]
+    @@mturk.forceExpireHIT :HITId => hit_result3[:HITId]
+    @@mturk.disposeHIT :HITId => hit_result3[:HITId]
+  end
+
+  end # if not DISABLE_MTURK_SANDBOX_TEST
+
+end
+

data/test/mturk/test_error_handler.rb

@@ -0,0 +1,137 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+require 'test/unit/testcase'
+require 'ruby-aws'
+require 'amazon/webservices/util/mock_transport'
+require 'timeout'
+
+class TestErrorHandler < Test::Unit::TestCase
+
+  def setup
+    @mock = Amazon::WebServices::Util::MockTransport.new
+    @mturk = Amazon::WebServices::MechanicalTurkRequester.new( :Transport => @mock, :AWSAccessKey => 'bogus', :AWSAccessKeyId => 'fake' )
+  end
+
+  def testTimeoutOnce
+
+    # mock will timeout first time, return success on second call
+    toggle = false
+   @mock.listen do |call|
+     Timeout.timeout(1) do
+       if toggle
+         toggle = !toggle
+       else
+         toggle = !toggle
+         sleep(5)
+       end
+      end
+      nil
+    end
+
+    assert_equal false, toggle
+    # invoke a retryable call once, should auto-retry and return success
+    @mturk.getAccountBalance
+    assert_equal 2, @mock.call_buffer.size, "Should have retried once"
+    @mock.each {|call| assert_equal :GetAccountBalance, call.name, "Should have been a GetAccountBalance call" }
+
+    @mock.flush
+    assert_equal false, toggle
+    # but invoking a non-retryable call will throw an exception
+    begin
+      @mturk.grantBonus
+      fail "Should have thrown an exception"
+    rescue Timeout::Error
+      # expect this exception
+    end
+    assert_equal true, toggle
+    assert_equal :GrantBonus, @mock.next.name
+    assert_nil @mock.next
+  end
+
+  def testTimeoutAlways
+
+    #mock will always timeout
+    @mock.listen do |call|
+      Timeout.timeout(1) { sleep(2) }
+    end
+
+    begin
+      @mturk.searchHITs
+      fail "Should have thrown an exception"
+    rescue Timeout::Error
+      # expect this exception
+    end
+
+    7.times do
+      assert_equal :SearchHITs, @mock.next.name
+    end
+    assert_nil @mock.next
+  end
+
+
+  def testRuntimeError
+    @mock.listen do |call|
+      raise "Blah"
+    end
+
+    begin
+      @mturk.searchHITs
+      fail "Should have thrown an exception"
+    rescue RuntimeError => e
+      assert_equal "Blah", e.to_s
+    end
+  end
+
+  def testRuntimeErrorThrottled
+     @mock.listen do |call|
+      raise "Throttled"
+    end
+
+    begin
+      @mturk.searchHITs
+      fail "Should have thrown an exception"
+    rescue RuntimeError => e
+      assert_equal "Throttled", e.to_s
+    end
+  end
+
+  if Amazon::WebServices::Util::SOAPTransport.canSOAP?
+  def testSOAPFaultError
+    arg = (Struct.new :faultcode, :faultstring, :faultactor, :detail).new 
+    arg.faultcode = (Struct.new :data).new 'aws:blarg'
+    arg.faultstring = (Struct.new :data).new 'blarg blarg blarg'
+    s = SOAP::FaultError.new( arg )
+    
+    @mock.listen do |call|
+      raise s
+    end
+
+    begin
+      @mturk.searchHITs
+      fail "Should have thrown an exception"
+    rescue SOAP::FaultError => e
+      assert_equal s, e
+    end
+  end
+
+  def testSOAPFaultErrorThrottled
+    arg = (Struct.new :faultcode, :faultstring, :faultactor, :detail).new 
+    arg.faultcode = (Struct.new :data).new 'aws:Server.ServiceUnavailable'
+    arg.faultstring = (Struct.new :data).new 'Hey, give us a break!'
+    s = SOAP::FaultError.new( arg )
+    
+    @mock.listen do |call|
+      raise s
+    end
+
+    begin
+      @mturk.searchHITs
+      fail "Should have thrown an exception"
+    rescue SOAP::FaultError => e
+      assert_equal s, e
+    end
+  end
+  end # canSOAP?
+
+end

data/test/mturk/test_mechanical_turk_requester.rb

@@ -0,0 +1,178 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+require 'test/unit/testcase'
+require 'ruby-aws'
+require 'amazon/webservices/mturk/question_generator'
+require 'amazon/webservices/util/soap_transport'
+require 'amazon/webservices/util/rest_transport'
+
+# Allow user to skip these tests by setting the DISABLE_MTURK_SANDBOX_TEST environment variable
+if ENV['DISABLE_MTURK_SANDBOX_TEST'].nil?
+
+class TestMechanicalTurkRequester < Test::Unit::TestCase
+  include Amazon::WebServices
+
+  def setup
+    # Setting up the default requester interface.  
+    #   This will default to running against Sandbox, but we'll the host explicitly for safety. 
+    #   Access Key ID and Secret Access Key will be loaded from user preference file
+    #     If not found, the user will be interatively queried for their authentication information.
+    @@mturk ||= MechanicalTurkRequester.new( :Host => :Sandbox )
+
+    # utilize the SOAP transport, if we can
+    @@mturk_soap ||= MechanicalTurkRequester.new( :Host => :Sandbox, :Transport => :SOAP ) if Util::SOAPTransport.canSOAP?
+    # utilize the REST transport with default HTTP method
+    @@mturk_rest ||= MechanicalTurkRequester.new( :Host => :Sandbox, :Transport => :REST )
+    # utilize the REST transport via Get
+    @@mturk_rest_get ||= MechanicalTurkRequester.new( :Host => :Sandbox, :Transport => :REST, :RestStyle => :Get )
+    # utilize the REST transport via Post, if we can
+    @@mturk_rest_post ||= MechanicalTurkRequester.new( :Host => :Sandbox, :Transport => :REST, :RestStyle => :Post ) if Util::RESTTransport.canPost?
+  end
+
+  def testAvailableFunds
+    funds = @@mturk.availableFunds
+    assert_equal 10000.0, funds, "Sandbox should always show 10k available funds"
+  end
+
+  def testCreateHIT
+    question = MTurk::QuestionGenerator.build { |q| q.ask 'Have you tried Ruby?' }
+    result = @@mturk.createHIT :Title => 'Ruby SDK Test Hit',
+                              :Description => 'Autogenerated hit from ruby-aws test cases',
+                              :Keywords => 'Ruby, test, SDK',
+                              :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                              :Question => question
+    assert_not_nil( result[:HITId] )
+    @@mturk.forceExpireHIT( :HITId => result[:HITId] )
+    @@mturk.disposeHIT( :HITId => result[:HITId] )
+  end
+
+  def testCreateHITFailure
+    begin
+      @@mturk.createHIT :Title => 'Ruby SDK Test Hit',
+                        :Description => 'Autogenerated hit from ruby-aws test cases',
+                        :Keywords => 'Ruby, test, SDK',
+                        :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                        :Question => "Invalid Question"
+      fail "Mechanical Turk should have thrown an exception"
+    rescue => e
+      raise e unless e.is_a?( Util::ValidationException )
+      assert_equal "AWS.MechanicalTurk.XMLParseError", e.message
+    end
+  end
+  
+if Util::SOAPTransport.canSOAP?
+
+  def testSOAPCreateHIT
+    question = MTurk::QuestionGenerator.build { |q| q.ask 'Have you tried Ruby?' }
+    result = @@mturk_soap.createHIT :Title => 'Ruby SDK Test Hit',
+                              :Description => 'Autogenerated hit from ruby-aws test cases',
+                              :Keywords => 'Ruby, test, SDK',
+                              :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                              :Question => question
+    assert_not_nil( result[:HITId] )
+    @@mturk_soap.forceExpireHIT( :HITId => result[:HITId] )
+    @@mturk_soap.disposeHIT( :HITId => result[:HITId] )
+  end
+
+  def testSOAPCreateHITFailure
+    begin
+      @@mturk_soap.createHIT :Title => 'Ruby SDK Test Hit',
+                             :Description => 'Autogenerated hit from ruby-aws test cases',
+                             :Keywords => 'Ruby, test, SDK',
+                             :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                             :Question => "Invalid Question"
+      fail "Mechanical Turk should have thrown an exception"
+    rescue => e
+      raise e unless e.is_a?( Util::ValidationException )
+      assert_equal "AWS.MechanicalTurk.XMLParseError", e.message
+    end
+  end
+
+end # if Util::SOAPTransport.canSOAP?
+
+  def testRESTCreateHIT
+    question = MTurk::QuestionGenerator.build { |q| q.ask 'Have you tried Ruby?' }
+    result = @@mturk_rest.createHIT :Title => 'Ruby SDK Test Hit',
+                              :Description => 'Autogenerated hit from ruby-aws test cases',
+                              :Keywords => 'Ruby, test, SDK',
+                              :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                              :Question => question
+    assert_not_nil( result[:HITId] )
+    @@mturk_rest.forceExpireHIT( :HITId => result[:HITId] )
+    @@mturk_rest.disposeHIT( :HITId => result[:HITId] )
+  end
+
+  def testRESTCreateHITFailure
+    begin
+      @@mturk_rest.createHIT :Title => 'Ruby SDK Test Hit',
+                             :Description => 'Autogenerated hit from ruby-aws test cases',
+                             :Keywords => 'Ruby, test, SDK',
+                             :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                             :Question => "Invalid Question"
+      fail "Mechanical Turk should have thrown an exception"
+    rescue => e
+      raise e unless e.is_a?( Util::ValidationException )
+      assert_equal "AWS.MechanicalTurk.XMLParseError", e.message
+    end
+  end
+
+  def testGetRESTCreateHIT
+    question = MTurk::QuestionGenerator.build { |q| q.ask 'Have you tried Ruby?' }
+    result = @@mturk_rest_get.createHIT :Title => 'Ruby SDK Test Hit',
+                                  :Description => 'Autogenerated hit from ruby-aws test cases',
+                                  :Keywords => 'Ruby, test, SDK',
+                                  :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                                  :Question => question
+    assert_not_nil( result[:HITId] )
+    @@mturk_rest_get.forceExpireHIT( :HITId => result[:HITId] )
+    @@mturk_rest_get.disposeHIT( :HITId => result[:HITId] )
+  end
+
+  def testGetRESTCreateHITFailure
+    begin
+      @@mturk_rest_get.createHIT :Title => 'Ruby SDK Test Hit',
+                                 :Description => 'Autogenerated hit from ruby-aws test cases',
+                                 :Keywords => 'Ruby, test, SDK',
+                                 :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                                 :Question => "Invalid Question"
+        fail "Mechanical Turk should have thrown an exception"
+    rescue => e
+      raise e unless e.is_a?( Util::ValidationException )
+      assert_equal "AWS.MechanicalTurk.XMLParseError", e.message
+    end
+  end
+
+if Util::RESTTransport.canPost?
+
+  def testPostRESTCreateHIT
+    question = MTurk::QuestionGenerator.build { |q| q.ask 'Have you tried Ruby?' }
+    result = @@mturk_rest_post.createHIT :Title => 'Ruby SDK Test Hit',
+                              :Description => 'Autogenerated hit from ruby-aws test cases',
+                              :Keywords => 'Ruby, test, SDK',
+                              :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                              :Question => question
+    assert_not_nil( result[:HITId] )
+    @@mturk_rest_post.forceExpireHIT( :HITId => result[:HITId] )
+    @@mturk_rest_post.disposeHIT( :HITId => result[:HITId] )
+  end
+
+  def testPostRESTCreateHITFailure
+    begin
+      @@mturk_rest_post.createHIT :Title => 'Ruby SDK Test Hit',
+                                  :Description => 'Autogenerated hit from ruby-aws test cases',
+                                  :Keywords => 'Ruby, test, SDK',
+                                  :Reward => { :Amount => 23.44, :CurrencyCode => 'USD' },
+                                  :Question => "Invalid Question"
+      fail "Mechanical Turk should have thrown an exception"
+    rescue => e
+      raise e unless e.is_a?( Util::ValidationException )
+      assert_equal "AWS.MechanicalTurk.XMLParseError", e.message
+    end
+  end
+
+end # if Util::RESTTransport.canPost?
+
+end
+
+end # if not DISABLE_MTURK_SANDBOX_TEST