sprout-ruby-aws 1.2.0

data/samples/mturk/reviewer/mturk.yml

@@ -0,0 +1,8 @@
+# Your AWSAccessKeyId ( leave commented to use global default )
+# AWSAccessKeyId: <need access key id>
+
+# Your AWSAccessKey ( leave commented to use global default )
+# AWSAccessKey: <need access key>
+
+# Host to talk to ( Prod or Sandbox )
+Host: Sandbox

data/samples/mturk/simple_survey/SimpleSurvey.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+begin ; require 'rubygems' ; rescue LoadError ; end
+
+# The Simple Survey sample application will create a HIT asking a worker to indicate their
+# political party preferences.
+#
+# mturk.properties must be found in the current file path.
+#
+# The following concepts are covered:
+# - File based QuestionForm HIT loading
+# - Using a locale qualification
+
+require 'ruby-aws'
+@mturk = Amazon::WebServices::MechanicalTurkRequester.new
+
+
+# Check to see if your account has sufficient funds
+def hasEnoughFunds?
+  available = @mturk.availableFunds
+  puts "Got account balance: %.2f" % available
+  return available > 0.055
+end
+
+def getHITUrl( hitTypeId )
+  if @mturk.host =~ /sandbox/
+    "http://workersandbox.mturk.com/mturk/preview?groupId=#{hitTypeId}" # Sandbox Url
+  else
+    "http://mturk.com/mturk/preview?groupId=#{hitTypeId}" # Production Url
+  end
+end
+
+# Creates the simple survey.
+def createSimpleSurvey
+  title = "What is your political preference?"
+  description = "This is a simple survey HIT created by the Amazon Mechanical Turk SDK for Ruby."
+  numAssignments = 1
+  reward = { :Amount => 0.05, :CurrencyCode => 'USD' }
+  keywords = "sample, SDK, survey"
+  assignmentDurationInSeconds = 60 * 60 # 1 hour
+  autoApprovalDelayInSeconds = 60 * 60 # 1 hour
+  lifetimeInSeconds = 60 * 60 # 1 hour
+  requesterAnnotation = "sample#survey"
+
+  # Defining the location of the externalized question (QuestionForm) file.
+  rootDir = File.dirname $0
+  questionFile = rootDir + "/simple_survey.question"
+		
+
+  # This is an example of creating a qualification.
+  # This is a built-in qualification -- user must be based in the US
+  qualReq = { :QualificationTypeId => Amazon::WebServices::MechanicalTurkRequester::LOCALE_QUALIFICATION_TYPE_ID,
+              :Comparator => 'EqualTo',
+              :LocaleValue => {:Country => 'US'}, }
+
+  # The create HIT method takes in an array of QualificationRequirements since a HIT can have multiple qualifications.
+  qualReqs = [qualReq]
+
+  # Loading the question (QuestionForm) file
+  question = File.read( questionFile )
+
+  # Creating the HIT and loading it into Mechanical Turk
+  hit = @mturk.createHIT( :Title => title,
+                          :Description => description,
+                          :Keywords => keywords,
+                          :Question => question,
+                          :Reward => reward,
+                          :AssignmentDurationInSeconds => assignmentDurationInSeconds,
+                          :AutoApprovalDelayInSeconds => autoApprovalDelayInSeconds,
+                          :LifetimeInSeconds => lifetimeInSeconds,
+                          :MaxAssignments => numAssignments,
+                          :RequesterAnnotation => requesterAnnotation,
+                          :QualificationRequirement => qualReqs )
+
+  puts "Created HIT: #{hit[:HITId]}"
+  puts "Url: #{getHITUrl( hit[:HITTypeId] )}"
+
+  # Demonstrates how a HIT can be retrieved if you know its HIT ID
+  hit2 = @mturk.getHIT(:HITId => hit[:HITId])
+
+  puts "Retrieved HIT: #{hit2[:HITId]}"
+
+  puts "Oops!  The HIT Ids shoud match: #{hit[:HITId]}, #{hit2[:HITId]}" unless hit[:HITId] == hit2[:HITId]
+
+end
+
+createSimpleSurvey if hasEnoughFunds?

data/samples/mturk/simple_survey/simple_survey.question

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<QuestionForm xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd">
+  <Question>
+    <QuestionIdentifier>1</QuestionIdentifier>
+    <QuestionContent>
+      <Text>What is your political party affiliation?</Text>
+    </QuestionContent>
+    <AnswerSpecification>
+      <SelectionAnswer>
+        <MinSelectionCount>1</MinSelectionCount>
+        <MaxSelectionCount>1</MaxSelectionCount>
+        <StyleSuggestion>radiobutton</StyleSuggestion>
+        <Selections>
+          <Selection>
+            <SelectionIdentifier>republican</SelectionIdentifier>
+            <Text>Republican</Text>
+          </Selection>
+          <Selection>
+            <SelectionIdentifier>democrat</SelectionIdentifier>
+            <Text>Democrat</Text>
+          </Selection>
+		  <Selection>
+            <SelectionIdentifier>noneoftheabove</SelectionIdentifier>
+            <Text>None of the Above</Text>
+          </Selection>
+        </Selections>
+      </SelectionAnswer>
+    </AnswerSpecification>
+  </Question>
+</QuestionForm>

data/samples/mturk/site_category/SiteCategory.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+begin ; require 'rubygems' ; rescue LoadError ; end
+
+# The Site Category sample application will create 5 HITs asking workers to categorize websites into predefined categories.
+#
+# The following concepts are covered:
+# - Bulk load HITs using an input file
+# - File based HIT loading
+
+require 'ruby-aws'
+@mturk = Amazon::WebServices::MechanicalTurkRequester.new
+
+# Check to see if your account has sufficient funds
+def hasEnoughFunds?
+  available = @mturk.availableFunds
+  puts "Got account balance: %.2f" % available
+  return available > (0.055 * 5)
+end
+
+def getHITUrl( hitTypeId )
+  if @mturk.host =~ /sandbox/
+    "http://workersandbox.mturk.com/mturk/preview?groupId=#{hitTypeId}" # Sandbox Url
+  else
+    "http://mturk.com/mturk/preview?groupId=#{hitTypeId}" # Production Url
+  end
+end
+
+# Create the website category HITs.
+def createSiteCategoryHITs
+
+  # Defining the locations of the input files
+  rootDir = File.dirname $0
+  inputFile = rootDir + "/site_category.input"
+  propertiesFile = rootDir + "/site_category.properties"
+  questionFile = rootDir + "/site_category.question"
+
+  # Loading the input file.  The input file is a tab delimited file where the first row
+  # defines the fields/variables and the remaining rows contain the values for each HIT.
+  # Each row represents a unique HIT.  ERB is used to merge the values into the Question template.
+  input = Amazon::Util::DataReader.load( inputFile, :Tabular )
+
+  # Loading the question (QuestionForm) file
+  question = File.read( questionFile )
+
+  # Loading the HIT properties file.  The properties file defines two system qualifications that will
+  # be used for the HIT.  The properties file can also be an ERB template.  This allows the developer
+  # to "tie in" the input value to the results.
+  props = Amazon::Util::DataReader.load( propertiesFile, :Properties )
+
+  hits = [];
+
+  # Create multiple HITs using the input, properties, and question files
+
+  puts "--[Loading HITs]----------"
+  startTime = Time.now
+  puts "  Start time: #{startTime}"
+
+  # The simpliest way to bulk load a large number of HITs where all details are defined in files.
+  # This method returns a hash with two arrays:
+  # - :Created is an array of successfully created HITs
+  # - :Failed is an array of lines we failed to create HITs with
+  hits = @mturk.createHITs(props, question, input);
+
+  puts "--[End Loading HITs]----------"
+  endTime = Time.now
+  puts "  End time: #{endTime}"
+  puts "--[Done Loading HITs]----------"
+  puts "  Total load time: #{ endTime - startTime } seconds."
+
+  hit_ids = hits[:Created].collect {|h| h[:HITId] }
+  hit_type_id = hits[:Created].first[:HITTypeId]
+
+  puts "  Created HITs: #{hit_ids.join(' ')}"
+  puts "  Url: #{getHITUrl( hit_type_id )}"
+
+  # We'll save the results to hits.success and hits.failure
+  Amazon::Util::DataReader.save( rootDir + "/hits.success", hits[:Created], :Tabular )
+  Amazon::Util::DataReader.save( rootDir + "/hits.failure", hits[:Failed], :Tabular )
+  # The .success file can be used in subsequent operations to retrieve the results that workers submitted.
+
+end
+
+createSiteCategoryHITs if hasEnoughFunds?

data/samples/mturk/site_category/externalpage.htm

@@ -0,0 +1,71 @@
+<!-- This file needs to be hosted on an external server.  -->
+<html>
+<script language="Javascript">
+//
+// This method Gets URL Parameters (GUP)
+//
+function gup( name )
+{
+  var regexS = "[\\?&]"+name+"=([^&#]*)";
+  var regex = new RegExp( regexS );
+  var tmpURL = window.location.href;
+  var results = regex.exec( tmpURL );
+  if( results == null )
+    return "";
+  else
+    return results[1];
+}
+
+//
+// This method decodes the query parameters that were URL-encoded
+//
+function decode(strToDecode)
+{
+  var encoded = strToDecode;
+  return unescape(encoded.replace(/\+/g,  " "));
+}
+
+</script>
+<body>
+<form id="mturk_form" method="POST" action="http://www.mturk.com/mturk/externalSubmit">
+<input type="hidden" id="assignmentId" name="assignmentId" value="">
+<table border="0" height="100%" width="100%">
+<tr><td>
+<h1>What type of webpage is shown below?</h1>
+<p>
+<input type="radio" name="category" value="news">&nbsp;News Site<br>
+<input type="radio" name="category" value="search">&nbsp;Search Engine<br>
+<input type="radio" name="category" value="retail">&nbsp;Online Retailer<br>
+<input type="radio" name="category" value="other" selected>&nbsp;Other<br>
+<p>
+<input id="submitButton" type="submit" name="Submit" value="Submit">
+<p>
+</td></tr>
+<tr><td height="100%">
+<iframe id="pageFrame" width="100%" height="100%"></iframe>
+</td></tr>
+</table>
+</form>
+<script language="Javascript">
+    document.getElementById('pageFrame').src = decode(gup('url'));
+    document.getElementById('assignmentId').value = gup('assignmentId');
+
+
+    //
+    // Check if the worker is PREVIEWING the HIT or if they've ACCEPTED the HIT
+    //
+    if (gup('assignmentId') == "ASSIGNMENT_ID_NOT_AVAILABLE")
+    {
+  // If we're previewing, disable the button and give it a helpful message
+  document.getElementById('submitButton').disabled = true;
+  document.getElementById('submitButton').value = "You must ACCEPT the HIT before you can submit the results.";
+    } else {
+        var form = document.getElementById('mturk_form');
+        if (document.referrer && ( document.referrer.indexOf('workersandbox') != -1) ) {
+            form.action = "http://workersandbox.mturk.com/mturk/externalSubmit";
+        }
+    }
+
+</script>
+</body>
+</html>

data/samples/mturk/site_category/site_category.input

@@ -0,0 +1,6 @@
+urls
+http://www.reuters.com/
+http://www.google.com/
+http://www.amazon.com/
+http://www.apple.com/
+http://www.yahoo.com/

data/samples/mturk/site_category/site_category.properties

@@ -0,0 +1,45 @@
+######################################
+## External HIT Properties
+######################################
+
+Title:What website is this?
+Description:Please look at this website and tell us, in simple words, what website this is.
+Keywords:category, website, SDK, sample
+Reward.Amount:0.05
+Reward.CurrencyCode:USD
+MaxAssignments:1
+
+#Notice the use of ERB template directives here.  
+#This allows the input file to define the value of the HIT level annotation field. 
+RequesterAnnotation:<%= @urls %>
+
+######################################
+## HIT Timing Properties
+######################################
+
+# this Assignment Duration value is 60 * 60 = 1 hour
+AssignmentDuration:3600
+
+# this HIT Lifetime value is 60 * 60 = 1 hour
+LifetimeInSeconds:3600
+
+# this Auto Approval period is 60 * 60 = 1 hour 
+AutoApprovalDelayInSeconds:3600
+
+######################################
+## Qualification Properties
+######################################
+
+# In this example, two system qualifications are specified for the HIT.
+
+# this is a built-in qualification -- user must have an approval rate of 25% or greater
+QualificationRequirement.1.QualificationTypeId:000000000000000000L0
+QualificationRequirement.1.Comparator:GreaterThan
+QualificationRequirement.1.IntegerValue:25
+QualificationRequirement.1.RequiredToPreview:false
+
+# this is a built-in qualification -- user must have an abandonment rate of 50% or less
+QualificationRequirement.2.QualificationTypeId:00000000000000000070
+QualificationRequirement.2.Comparator:LessThan
+QualificationRequirement.2.IntegerValue:51
+QualificationRequirement.2.RequiredToPreview:true

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
+
+    hit = @@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
+