rturk 2.0.0 → 2.0.1

data/README.markdown

@@ -70,7 +70,7 @@ Let's say you have a form at "http://myapp.com/turkers/add_tags" where Turkers c
 ### Logging
 Want to see what's going on - enable logging.
 
-RTurk::Logger.level = Logger::DEBUG
+    RTurk::log.level = Logger::DEBUG
     
 ## Nitty Gritty
 
@@ -79,6 +79,7 @@ Here's a quick peak at what happens on the Mechanical Turk side.
 A worker takes a look at your hit. The page will contain an iframe with your question URL loaded inside of it.
 
 Amazon will append the AssignmentID parameter to the URL for your own information. In preview mode this will look like
+
     http://myapp.com/turkers/add_tags?item_id=1234&AssignmentId=ASSIGNMENT_ID_NOT_AVAILABLE
     
 If the Turker accepts the HIT, the page will reload and the iframe URL will resemble

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.1

data/examples/blank_slate.rb

@@ -3,7 +3,7 @@ require 'rubygems'
 require '../lib/rturk'
 
 aws = YAML.load(File.open(File.join(File.dirname(__FILE__), 'mturk.yml')))
-RTurk::setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+RTurk::setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'])
 
 hits = RTurk::Hit.all_reviewable
 
@@ -11,13 +11,12 @@ puts "#{hits.size} reviewable hits. \n"
 
 unless hits.empty?
   puts "Approving all assignments and disposing of each hit!"
-  
+
   hits.each do |hit|
-    hit.expire!
+    hit.expire! if (hit.status == "Assignable" || hit.status == 'Unassignable')
     hit.assignments.each do |assignment|
-      assignment.approve!
+      assignment.approve! if assignment.status == 'Submitted'
     end
     hit.dispose!
   end
 end
-

data/examples/create_hit.rb

@@ -5,10 +5,6 @@ require '../lib/rturk'
 aws = YAML.load(File.open(File.join(File.dirname(__FILE__), 'mturk.yml')))
 RTurk::setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
 
-root = File.expand_path(File.dirname(__FILE__))
-aws = YAML.load(File.open(File.join(root, 'mturk.yml')))
-RTurk::setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
-
 hit = RTurk::Hit.create(:title => 'Write a tweet for me') do |hit|
   hit.description = 'Simply write a witty twitter update for my account'
   hit.reward = 0.05

data/examples/review_answer.rb

@@ -1,9 +1,11 @@
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'rubygems'
 require '../lib/rturk'
+require 'yaml'
 
 aws = YAML.load(File.open(File.join(File.dirname(__FILE__), 'mturk.yml')))
-RTurk::setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+RTurk::setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'])
+file = File.open(File.join(File.dirname(__FILE__), 'answers.yml'), 'w')
 
 hits = RTurk::Hit.all_reviewable
 
@@ -14,7 +16,7 @@ unless hits.empty?
   
   hits.each do |hit|
     hit.assignments.each do |assignment|
-      puts assignment.answers['tweet']
+      file.puts assignment.answers.to_hash.to_yaml
       assignment.approve! if assignment.status == 'Submitted'
     end
   end

data/lib/rturk/adapters/assignment.rb

@@ -1,7 +1,7 @@
 require 'time'
 
 module RTurk
-  
+
   # Parses:
   # <Assignment>
   #   <AssignmentId>GYFTRHZ5J3DZREY48WNZE38ZR9RR1ZPMXGWE7WE0</AssignmentId>
@@ -22,28 +22,28 @@ module RTurk
   #     </QuestionFormAnswers>
   #   </Answer>
   # </Assignment>
-  
+
   class Assignment
     include RTurk::XmlUtilities
-    
+
     attr_accessor :worker_id, :id, :status, :submitted_at, :accepted_at, :approved_at
     attr_reader :answers
-    
+
     def initialize(xml_object)
       map_content(xml_object,
-        :id => 'AssignmentId',
-        :worker_id => 'WorkerId',
-        :status => 'AssignmentStatus',
-        :accepted_at => 'AcceptTime',
-        :approved_at => "ApprovalTime",
-        :submitted_at => 'SubmitTime')
-        self.answers = xml_object.xpath('Answer').children.to_s
+                  :id => 'AssignmentId',
+                  :worker_id => 'WorkerId',
+                  :status => 'AssignmentStatus',
+                  :accepted_at => 'AcceptTime',
+                  :approved_at => "ApprovalTime",
+                  :submitted_at => 'SubmitTime')
+      self.answers = xml_object.xpath('Answer')
     end
-    
+
     def approved_at=(time)
       @approved_at = Time.parse(time)
     end
-    
+
     def submitted_at=(time)
       @submitted_at = Time.parse(time)
     end
@@ -51,25 +51,23 @@ module RTurk
     def accepted_at=(time)
       @accepted_at = Time.parse(time)
     end
-    
+
     def approve!(feedback = nil)
       RTurk::ApproveAssignment(:assignment_id => self.id, :feedback => feedback)
     end
-    
+
     def reject!(reason)
       RTurk::ApproveAssignment(:assignment_id => self.id, :feedback => reason)
     end
-    
+
     def bonus!(amount, reason)
-     RTurk::GrantBonus(:amount, :feedback => reason)
+      RTurk::GrantBonus(:amount, :feedback => reason)
     end
-    
+
     def answers=(answer_xml)
-      unless answer_xml.empty?
-        @answers = RTurk::Answers.new(answer_xml)
-      end
+      @answers = RTurk::Answers.new(answer_xml.children.to_s)
     end
-    
+
   end
-  
-end
+
+end

data/lib/rturk/adapters/hit.rb

@@ -48,22 +48,6 @@ module RTurk
     def assignments
       RTurk::GetAssignmentsForHIT(:hit_id => self.id).assignments
     end
-
-    def type_id
-      @type_id ||= details.type_id
-    end
-    
-    def status
-      @status ||= details.status
-    end
-    
-    def expires_at
-      @expires_at ||= details.expires_at
-    end
-
-    def title
-      @title ||= details.title
-    end
     
     def details
       @details ||= RTurk::GetHIT(:hit_id => self.id)
@@ -90,6 +74,11 @@ module RTurk
       end
     end
 
+    def method_missing(method, *args)
+      if self.details.respond_to?(method)
+        self.details.send(method, *args)
+      end
+    end
 
 
   end

data/lib/rturk/logger.rb

@@ -17,4 +17,8 @@ module RTurk
     end
   end
   
+  def self.Logger(*args)
+    RTurk::Logger.logger(*args)
+  end
+  
 end

data/rturk.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rturk}
-  s.version = "2.0.0"
+  s.version = "2.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Percival"]
@@ -74,6 +74,7 @@ Gem::Specification.new do |s|
      "spec/fake_responses/force_expire_hit.xml",
      "spec/fake_responses/get_account_balance.xml",
      "spec/fake_responses/get_assignments.xml",
+     "spec/fake_responses/get_assignments_multiple.xml",
      "spec/fake_responses/get_hit.xml",
      "spec/fake_responses/get_reviewable_hits.xml",
      "spec/fake_responses/grant_bonus.xml",

data/spec/fake_responses/get_assignments_multiple.xml

@@ -0,0 +1,77 @@
+<?xml version="1.0"?>
+<GetAssignmentsForHITResponse>
+  <OperationRequest>
+    <RequestId>a964d1f8-d315-4bbb-9ab6-692625d662ff</RequestId>
+  </OperationRequest>
+  <GetAssignmentsForHITResult>
+    <Request>
+      <IsValid>True</IsValid>
+    </Request>
+    <NumResults>3</NumResults>
+    <TotalNumResults>3</TotalNumResults>
+    <PageNumber>1</PageNumber>
+    <Assignment>
+      <AssignmentId>32A8TDZQEZYRV84XKZ4ZBT6JT05DKJRZ1BC42YSZ</AssignmentId>
+      <WorkerId>ADOJP7RNRYAFG</WorkerId>
+      <HITId>32A8TDZQEZYRV84XKZ4Z</HITId>
+      <AssignmentStatus>Submitted</AssignmentStatus>
+      <AutoApprovalTime>2009-11-25T05:17:32Z</AutoApprovalTime>
+      <AcceptTime>2009-10-26T05:17:18Z</AcceptTime>
+      <SubmitTime>2009-10-26T05:17:32Z</SubmitTime>
+      <Answer>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;QuestionFormAnswers xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd"&gt;
+&lt;Answer&gt;
+&lt;QuestionIdentifier&gt;tweet&lt;/QuestionIdentifier&gt;
+&lt;FreeText&gt;This is my tweet!&lt;/FreeText&gt;
+&lt;/Answer&gt;
+&lt;Answer&gt;
+&lt;QuestionIdentifier&gt;Submit&lt;/QuestionIdentifier&gt;
+&lt;FreeText&gt;Submit&lt;/FreeText&gt;
+&lt;/Answer&gt;
+&lt;/QuestionFormAnswers&gt;
+</Answer>
+    </Assignment>
+        <Assignment>
+          <AssignmentId>32A8TDZQEZYRV84XKZ4ZBT6JT05DKJRZ1BC42YSX</AssignmentId>
+          <WorkerId>ADOJP7RNRYAF</WorkerId>
+          <HITId>32A8TDZQEZYRV84XKZ4Z</HITId>
+          <AssignmentStatus>Submitted</AssignmentStatus>
+          <AutoApprovalTime>2009-11-25T05:17:32Z</AutoApprovalTime>
+          <AcceptTime>2009-10-26T05:17:18Z</AcceptTime>
+          <SubmitTime>2009-10-26T05:17:32Z</SubmitTime>
+          <Answer>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+    &lt;QuestionFormAnswers xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd"&gt;
+    &lt;Answer&gt;
+    &lt;QuestionIdentifier&gt;tweet&lt;/QuestionIdentifier&gt;
+    &lt;FreeText&gt;Second Tweet&lt;/FreeText&gt;
+    &lt;/Answer&gt;
+    &lt;Answer&gt;
+    &lt;QuestionIdentifier&gt;Submit&lt;/QuestionIdentifier&gt;
+    &lt;FreeText&gt;Submit&lt;/FreeText&gt;
+    &lt;/Answer&gt;
+    &lt;/QuestionFormAnswers&gt;
+    </Answer>
+        </Assignment>
+            <Assignment>
+              <AssignmentId>32A8TDZQEZYRV84XKZ4ZBT6JT05DKJRZ1BC42YSY</AssignmentId>
+              <WorkerId>ADOJP7RNRYAFI</WorkerId>
+              <HITId>32A8TDZQEZYRV84XKZ4Z</HITId>
+              <AssignmentStatus>Submitted</AssignmentStatus>
+              <AutoApprovalTime>2009-11-25T05:17:32Z</AutoApprovalTime>
+              <AcceptTime>2009-10-26T05:17:18Z</AcceptTime>
+              <SubmitTime>2009-10-26T05:17:32Z</SubmitTime>
+              <Answer>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+        &lt;QuestionFormAnswers xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd"&gt;
+        &lt;Answer&gt;
+        &lt;QuestionIdentifier&gt;tweet&lt;/QuestionIdentifier&gt;
+        &lt;FreeText&gt;Third tweet&lt;/FreeText&gt;
+        &lt;/Answer&gt;
+        &lt;Answer&gt;
+        &lt;QuestionIdentifier&gt;Submit&lt;/QuestionIdentifier&gt;
+        &lt;FreeText&gt;Submit&lt;/FreeText&gt;
+        &lt;/Answer&gt;
+        &lt;/QuestionFormAnswers&gt;
+        </Answer>
+            </Assignment>
+  </GetAssignmentsForHITResult>
+</GetAssignmentsForHITResponse>

data/spec/operations/get_assignments_spec.rb

@@ -1,26 +1,48 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
-describe "getting assignments" do
-
+describe RTurk::GetAssignmentsForHIT do
+  
   before(:all) do
     aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
     RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
-    faker('get_assignments', :operation => 'GetAssignmentsForHIT')
   end
 
   it "should ensure required params" do
     lambda{RTurk::GetAssignmentsForHIT(:page_number => 5)}.should raise_error RTurk::MissingParameters
   end
-  
+
   it "should successfully request an assignment" do
     RTurk::Requester.should_receive(:request).once.with(
-      hash_including('Operation' => 'GetAssignmentsForHIT'))
+    hash_including('Operation' => 'GetAssignmentsForHIT'))
     RTurk::GetAssignmentsForHIT(:hit_id => "abcd") rescue RTurk::InvalidRequest
   end
+
+  context "an HIT with one assignment" do
+    
+    before(:all) do
+      FakeWeb.clean_registry
+      faker('get_assignments', :operation => 'GetAssignmentsForHIT')
+    end
+
+    it "should parse and return and answer" do
+      assignments = RTurk::GetAssignmentsForHIT(:hit_id => "abcd").assignments
+      assignments.first.answers['tweet'].should eql("This is my tweet!")
+    end
+
+  end
   
-  it "should parse and return and answer" do
-    assignments = RTurk::GetAssignmentsForHIT(:hit_id => "abcd").assignments
-    assignments.first.answers['tweet'].should eql("This is my tweet!")
+  context "an HIT with multiple assignment" do
+
+    before(:all) do
+      FakeWeb.clean_registry
+      faker('get_assignments_multiple', :operation => 'GetAssignmentsForHIT')
+    end
+
+    it "should parse and return and answer" do
+      assignments = RTurk::GetAssignmentsForHIT(:hit_id => "abcd").assignments
+      assignments.first.answers['tweet'].should eql("This is my tweet!")
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rturk
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors: 
 - Mark Percival
@@ -81,6 +81,7 @@ files:
 - spec/fake_responses/force_expire_hit.xml
 - spec/fake_responses/get_account_balance.xml
 - spec/fake_responses/get_assignments.xml
+- spec/fake_responses/get_assignments_multiple.xml
 - spec/fake_responses/get_hit.xml
 - spec/fake_responses/get_reviewable_hits.xml
 - spec/fake_responses/grant_bonus.xml