rturk 2.7.0 → 2.8.0

data/examples/create_hit.rb

@@ -10,4 +10,5 @@ hit = RTurk::Hit.create(:title => 'Write a tweet for me') do |hit|
   hit.question("http://mpercival.com.s3.amazonaws.com/newtweet.html")
 end
 
+p hit.hit_id
 p hit.url

data/lib/rturk.rb

@@ -3,7 +3,7 @@ module RTurk
 
   SANDBOX = 'https://mechanicalturk.sandbox.amazonaws.com/'
   PRODUCTION = 'https://mechanicalturk.amazonaws.com/'
-  API_VERSION = '2008-08-02'
+  API_VERSION = '2012-03-25' # '2008-08-02'
   OLD_API_VERSION = '2006-05-05'
 
   class << self

data/lib/rturk/operations/get_assignment.rb

@@ -0,0 +1,18 @@
+module RTurk
+  class GetAssignment < Operation
+    require_params :assignment_id
+    attr_accessor  :assignment_id
+
+    def parse(xml)
+      GetAssignmentResponse.new(xml)
+    end
+
+    def to_params
+      {'AssignmentId' => assignment_id}
+    end
+  end
+
+  def self.GetAssignment(*args, &blk)
+    RTurk::GetAssignment.create(*args, &blk)
+  end
+end

data/lib/rturk/parsers/responses/get_assignment_response.rb

@@ -0,0 +1,12 @@
+module RTurk
+  class GetAssignmentResponse < Response
+
+    def assignment
+      @assignment ||= AssignmentParser.new(@xml.xpath('//Assignment').first)
+    end
+
+    def hit
+      @hit ||= HITParser.new(@xml.xpath('//HIT').first)
+    end
+  end
+end

data/lib/rturk/version.rb

@@ -1,3 +1,3 @@
 module RTurk
-  VERSION = "2.7.0"
+  VERSION = "2.8.0"
 end

data/spec/fake_responses/get_assignment.xml

@@ -0,0 +1,64 @@
+<?xml version="1.0"?>
+<GetAssignmentResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+  <Assignment>
+    <AssignmentId>GYFTRHZ5J3DZREY48WNZE38ZR9RR1ZPMXGWE7WE0</AssignmentId>
+    <WorkerId>AD20WXZZP9XXK</WorkerId>
+    <HITId>GYFTRHZ5J3DZREY48WNZ</HITId>
+    <AssignmentStatus>Approved</AssignmentStatus>
+    <AutoApprovalTime>2012-08-12T19:21:54Z</AutoApprovalTime>
+    <AcceptTime>2012-07-13T19:21:40Z</AcceptTime>
+    <SubmitTime>2012-07-13T19:21:54Z</SubmitTime>
+    <ApprovalTime>2012-07-13T19:27:54Z</ApprovalTime>
+    <Answer>
+      &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
+      &lt;QuestionFormAnswers xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd"&gt;
+        &lt;Answer&gt;
+          &lt;QuestionIdentifier&gt;Question100&lt;/QuestionIdentifier&gt;
+          &lt;FreeText&gt;Move to X.&lt;/FreeText&gt;
+        &lt;/Answer&gt;
+      &lt;/QuestionFormAnswers&gt;
+    </Answer>
+  </Assignment>
+  <HIT>
+    <HITId>GYFTRHZ5J3DZREY48WNZ</HITId>
+    <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId>
+    <CreationTime>2012-07-07T00:56:40Z</CreationTime>
+    <Title>Location</Title>
+    <Description>Answer this Question</Description>
+    <Question>
+      <QuestionForm xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionForm.xsd">
+        <Question>
+          <QuestionIdentifier>Question100</QuestionIdentifier>
+          <DisplayName>My Question</DisplayName>
+          <IsRequired>true</IsRequired>
+          <QuestionContent>
+            <Binary>
+              <MimeType>
+                <Type>image</Type>
+                <SubType>gif</SubType>
+              </MimeType>
+              <DataURL>http://tictactoe.amazon.com/game/01523/board.gif</DataURL>
+              <AltText>The game board, with "X" to move.</AltText>
+            </Binary>
+          </QuestionContent>
+          <AnswerSpecification><FreeTextAnswer/></AnswerSpecification>
+        </Question> 
+      </QuestionForm>
+    </Question>
+    <HITStatus>Assignable</HITStatus>
+    <MaxAssignments>1</MaxAssignments>
+    <Reward>
+      <Amount>5.00</Amount>
+      <CurrencyCode>USD</CurrencyCode>
+      <FormattedPrice>$5.00</FormattedPrice>
+    </Reward>
+    <AutoApprovalDelayInSeconds>2592000</AutoApprovalDelayInSeconds>
+    <Expiration>2012-07-14T00:56:40Z</Expiration>
+    <AssignmentDurationInSeconds>30</AssignmentDurationInSeconds>
+    <NumberOfSimilarHITs>1</NumberOfSimilarHITs>
+    <HITReviewStatus>NotReviewed</HITReviewStatus>
+  </HIT>
+</GetAssignment>

data/spec/operations/get_assignment_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::GetAssignment do
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::GetAssignment()}.should raise_error RTurk::MissingParameters
+  end
+
+  it "should successfully request an assignment" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'GetAssignment'))
+    RTurk::GetAssignment(:assignment_id => "abcd") rescue RTurk::InvalidRequest
+  end
+
+  context "an HIT with one assignment" do
+    before(:all) do
+      WebMock.reset!
+      faker('get_assignment', :operation => 'GetAssignment')
+    end
+
+    it "should parse and return and answer" do
+      answers = RTurk::GetAssignment(:assignment_id => "abcd").assignment.answers
+      answers['Question100'].should eql("Move to X.")
+    end
+
+    it "should parse and return the hit" do
+      hit = RTurk::GetAssignment(:assignment_id => "abcd").hit
+      hit.title.should eql("Location")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rturk
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -212,6 +212,7 @@ files:
 - lib/rturk/operations/extend_hit.rb
 - lib/rturk/operations/force_expire_hit.rb
 - lib/rturk/operations/get_account_balance.rb
+- lib/rturk/operations/get_assignment.rb
 - lib/rturk/operations/get_assignments_for_hit.rb
 - lib/rturk/operations/get_bonus_payments.rb
 - lib/rturk/operations/get_hit.rb
@@ -244,6 +245,7 @@ files:
 - lib/rturk/parsers/response.rb
 - lib/rturk/parsers/responses/create_hit_response.rb
 - lib/rturk/parsers/responses/get_account_balance_response.rb
+- lib/rturk/parsers/responses/get_assignment_response.rb
 - lib/rturk/parsers/responses/get_assignments_for_hit_response.rb
 - lib/rturk/parsers/responses/get_bonus_payments_response.rb
 - lib/rturk/parsers/responses/get_hit_response.rb
@@ -276,6 +278,7 @@ files:
 - spec/fake_responses/extend_hit.xml
 - spec/fake_responses/force_expire_hit.xml
 - spec/fake_responses/get_account_balance.xml
+- spec/fake_responses/get_assignment.xml
 - spec/fake_responses/get_assignments.xml
 - spec/fake_responses/get_assignments_multiple.xml
 - spec/fake_responses/get_bonus_payments.xml
@@ -309,6 +312,7 @@ files:
 - spec/operations/extend_hit_spec.rb
 - spec/operations/force_expire_hit_spec.rb
 - spec/operations/get_account_balance_spec.rb
+- spec/operations/get_assignment_spec.rb
 - spec/operations/get_assignments_spec.rb
 - spec/operations/get_bonus_payments_spec.rb
 - spec/operations/get_hit_spec.rb