rturk 1.0.5 → 2.0.0

data/spec/builders/qualifications_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+
+describe RTurk::Qualifications do
+  
+  before(:each) do
+    @qualifications = RTurk::Qualifications.new
+  end
+  
+  it "should build a qualification set with multiple qualifications" do
+    @qualifications.add :approval_rate, {:gt => 80}
+    @qualifications.approval_rate(:lt => 90)
+    @qualifications.to_params['QualificationRequirement.1.Comparator'].should == 'GreaterThan'
+    @qualifications.to_params['QualificationRequirement.2.IntegerValue'].should == 90
+  end
+  
+  it "should build a qualification set with booleans" do
+    @qualifications.add :adult, true
+    @qualifications.to_params['QualificationRequirement.1.Comparator'].should == 'EqualTo'
+    @qualifications.to_params['QualificationRequirement.1.IntegerValue'].should == 1
+  end
+  
+  it "should build a qualification set with a country condition" do
+    @qualifications.add :adult, true
+    @qualifications.country :eql => 'US'
+    @qualifications.to_params['QualificationRequirement.2.Comparator'].should == 'EqualTo'
+    @qualifications.to_params['QualificationRequirement.2.LocaleValue.Country'].should == 'US'
+  end
+  
+end

data/spec/builders/question_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+require 'cgi'
+
+describe RTurk::Question do
+  
+  before(:all) do
+  end
+  
+  it "should build a question" do
+    question = RTurk::Question.new('http://mpercival.com')
+    question.url.should == 'http://mpercival.com' 
+    question.frame_height.should == 400
+  end
+
+  it "should build a question " do
+    question = RTurk::Question.new('http://mpercival.com', :frame_height => 500, :chapter => 1)
+    question.params[:chapter] = 2
+    question.url.should == 'http://mpercival.com?chapter=2' 
+    question.frame_height.should == 500
+  end
+  
+  it "should build a question with params" do
+    params = RTurk::Question.new('http://google.com/', :id => 'foo').to_params
+    CGI.unescape(params).should == 
+    <<-XML
+<ExternalQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd">
+  <ExternalURL>http://google.com/?id=foo</ExternalURL>	
+  <FrameHeight>400</FrameHeight>
+</ExternalQuestion>
+    XML
+  end
+
+  it "should build a question without params" do
+    params = RTurk::Question.new('http://google.com/').to_params
+    CGI.unescape(params).should == 
+    <<-XML
+<ExternalQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd">
+  <ExternalURL>http://google.com/</ExternalURL>	
+  <FrameHeight>400</FrameHeight>
+</ExternalQuestion>
+    XML
+  end
+  
+  
+  
+end

data/spec/fake_responses/approve_assignment.xml

@@ -0,0 +1,5 @@
+<ApproveAssignmentResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+</ApproveAssignmentResult>

data/spec/fake_responses/create_hit.xml

@@ -0,0 +1,12 @@
+<CreateHITResponse>
+  <OperationRequest>
+    <RequestId>ece2785b-6292-4b12-a60e-4c34847a7916</RequestId>
+  </OperationRequest>
+  <HIT>
+    <Request>
+      <IsValid>True</IsValid>
+    </Request>
+    <HITId>GBHZVQX3EHXZ2AYDY2T0</HITId>
+    <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId>
+  </HIT>
+</CreateHITResponse>

data/spec/fake_responses/disable_hit.xml

@@ -0,0 +1,5 @@
+<DisposeHITResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+</DisposeHITResult>

data/spec/fake_responses/dispose_hit.xml

@@ -0,0 +1,5 @@
+<DisposeHITResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+</DisposeHITResult>

data/spec/fake_responses/force_expire_hit.xml

@@ -0,0 +1,5 @@
+<ForceExpireHITResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+</ForceExpireHITResult>

data/spec/fake_responses/get_account_balance.xml

@@ -0,0 +1,10 @@
+<GetAccountBalanceResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+  <AvailableBalance>
+    <Amount>15555.55</Amount>
+    <CurrencyCode>USD</CurrencyCode>
+    <FormattedPrice>$15,555.55</FormattedPrice>
+  </AvailableBalance>
+</GetAccountBalanceResult>

data/spec/fake_responses/get_assignments.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0"?>
+<GetAssignmentsForHITResponse>
+  <OperationRequest>
+    <RequestId>a964d1f8-d315-4bbb-9ab6-692625d662ff</RequestId>
+  </OperationRequest>
+  <GetAssignmentsForHITResult>
+    <Request>
+      <IsValid>True</IsValid>
+    </Request>
+    <NumResults>1</NumResults>
+    <TotalNumResults>1</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>
+  </GetAssignmentsForHITResult>
+</GetAssignmentsForHITResponse>

data/spec/fake_responses/get_hit.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<GetHITResponse>
+  <OperationRequest>
+    <RequestId>49341251-fcbd-45c3-ab98-8fbe2e4d8060</RequestId>
+  </OperationRequest>
+  <HIT>
+    <Request>
+      <IsValid>True</IsValid>
+    </Request>
+    <HITId>GR4R3HY3YGBZXDCAPJWZ</HITId>
+    <HITTypeId>YGKZ2W5X6YFZ08ZRXXZZ</HITTypeId>
+    <CreationTime>2009-06-25T04:21:17Z</CreationTime>
+    <Title>Write a twitter update</Title>
+    <Description>Simply write a twitter update for me</Description>
+    <Question>&lt;ExternalQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd"&gt;
+	&lt;ExternalURL&gt;http://s3.amazonaws.com/mpercival.com/newtweet.html?id=foo&lt;/ExternalURL&gt;	
+	&lt;FrameHeight&gt;400&lt;/FrameHeight&gt;
+&lt;/ExternalQuestion&gt;
+</Question>
+    <Keywords>twitter, blogging, writing, english</Keywords>
+    <HITStatus>Reviewable</HITStatus>
+    <MaxAssignments>1</MaxAssignments>
+    <Reward>
+      <Amount>0.10</Amount>
+      <CurrencyCode>USD</CurrencyCode>
+      <FormattedPrice>$0.10</FormattedPrice>
+    </Reward>
+    <AutoApprovalDelayInSeconds>3600</AutoApprovalDelayInSeconds>
+    <Expiration>2009-06-25T05:21:17Z</Expiration>
+    <AssignmentDurationInSeconds>3600</AssignmentDurationInSeconds>
+    <NumberOfSimilarHITs>0</NumberOfSimilarHITs>
+    <RequesterAnnotation>OptionalNote</RequesterAnnotation>
+    <QualificationRequirement>
+      <QualificationTypeId>000000000000000000L0</QualificationTypeId>
+      <Comparator>GreaterThan</Comparator>
+      <IntegerValue>90</IntegerValue>
+      <RequiredToPreview>0</RequiredToPreview>
+    </QualificationRequirement>
+    <HITReviewStatus>NotReviewed</HITReviewStatus>
+  </HIT>
+</GetHITResponse>

data/spec/fake_responses/get_reviewable_hits.xml

@@ -0,0 +1,17 @@
+<GetReviewableHITsResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+  <NumResults>3</NumResults>
+  <TotalNumResults>3</TotalNumResults>
+  <PageNumber>1</PageNumber>
+  <HIT>
+    <HITId>GBHZVQX3EHXZ2AYDY2T0</HITId>
+  </HIT>
+  <HIT>
+    <HITId>GBHZVQX3EHXZ2AYDY2T1</HITId>
+  </HIT>
+  <HIT>
+    <HITId>GBHZVQX3EHXZ2AYDY2T2</HITId>
+  </HIT>
+</GetReviewableHITsResult>

data/spec/fake_responses/grant_bonus.xml

@@ -0,0 +1,5 @@
+<GrantBonusResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+</GrantBonusResult>

data/spec/fake_responses/invalid_credentials.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<GetResponse>
+  <OperationRequest>
+    <RequestId>1306b1ca-0169-49fb-a196-83f6a762738c</RequestId>
+    <Errors>
+      <Error>
+        <Code>AWS.NotAuthorized</Code>
+        <Message>The identity contained in the request is not authorized to use this AWSAccessKeyId</Message>
+      </Error>
+    </Errors>
+  </OperationRequest>
+</GetResponse>

data/spec/fake_responses/reject_assignment.xml

@@ -0,0 +1,5 @@
+<RejectAssignmentResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+</RejectAssignmentResult>

data/spec/operations/approve_assignment_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::ApproveAssignment do
+
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    faker('approve_assignment', :operation => 'ApproveAssignment')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::ApproveAssignment()}.should raise_error RTurk::MissingParameters
+  end
+  
+  it "should successfully request the operation" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'ApproveAssignment'))
+    RTurk::ApproveAssignment(:assignment_id => "123456789") rescue RTurk::InvalidRequest
+  end
+  
+  it "should parse and return the result" do
+    RTurk::ApproveAssignment(:assignment_id => "123456789").elements.should eql(
+      {"ApproveAssignmentResult"=>{"Request"=>{"IsValid"=>"True"}}}
+    )
+  end
+
+end

data/spec/operations/create_hit_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe "using mechanical turk with RTurk" do
+
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    FakeWeb.clean_registry
+    faker('create_hit', :operation => "CreateHIT")
+    faker('get_hit', :operation => "GetHIT")
+  end
+
+  it "should let me build and send a hit" do
+    hit = RTurk::CreateHIT.new(:title => "Look at some pictures from 4Chan") do |hit|
+      hit.assignments = 5
+      hit.description = 'blah'
+      hit.question("http://mpercival.com", :frame_height => 600)
+      hit.reward = 0.05
+      hit.qualifications.add :approval_rate, {:gt => 80}
+    end
+    hit.assignments.should eql(5)
+    response = hit.request
+    response.hit_id.should_not be_nil
+  end
+
+  it "should let me create a hit" do
+    response = RTurk::CreateHIT(:title => "Look at some pictures from 4Chan") do |hit|
+      hit.assignments = 5
+      hit.description = 'blah'
+      hit.question("http://mpercival.com", :test => 'b')
+      hit.reward = 0.05
+      hit.qualifications.add(:adult, true)
+    end
+    response.hit.url.should eql('http://workersandbox.mturk.com/mturk/preview?groupId=YGKZ2W5X6YFZ08ZRXXZZ')
+  end
+
+  it "should let me create a hit with just option arguments" do
+    hit = RTurk::CreateHIT.new(:title => "Look at some pictures from 4Chan",
+                               :description => "Pics from the b-tards",
+                               :assignments => 5,
+                               :reward => nil,
+                               :question => 'http://mpercival.com?picture=1',
+                               :qualifications => [
+                                 [:approval_rate, {:gt => 80}],
+                                 [:adult, true]
+                               ]
+                               )
+    hit.assignments.should eql(5)
+    hit.qualifications.qualifications.size.should eql(2)
+    lambda{hit.request}.should raise_error RTurk::MissingParameters
+  end
+
+  it "should rerturn a CreateHITResponse after the request" do
+    response = RTurk::CreateHIT(:title => "Look at some pictures from 4Chan") do |hit|
+      hit.assignments = 5
+      hit.description = "foo"
+      hit.question("http://mpercival.com", :test => 'b')
+      hit.reward = 0.05
+      hit.qualifications.add(:adult, true)
+    end
+    response.is_a?(RTurk::CreateHITResponse).should be_true
+    response.hit_id.should == 'GBHZVQX3EHXZ2AYDY2T0'
+    response.hit_type_id.should == 'NYVZTQ1QVKJZXCYZCZVZ'
+  end
+
+end

data/spec/operations/disable_hit_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::DisableHIT do
+
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    faker('disable_hit', :operation => 'DisableHIT')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::DisableHIT()}.should raise_error RTurk::MissingParameters
+  end
+  
+  it "should successfully request the operation" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'DisableHIT'))
+    RTurk::DisableHIT(:hit_id => "123456789") rescue RTurk::InvalidRequest
+  end
+  
+  it "should parse and return the result" do
+    RTurk::DisableHIT(:hit_id => "123456789").should
+      be_a_kind_of RTurk::Response
+  end
+
+end

data/spec/operations/dispose_hit_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::DisposeHIT do
+
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    faker('dispose_hit', :operation => 'DisposeHIT')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::DisposeHIT()}.should raise_error RTurk::MissingParameters
+  end
+  
+  it "should successfully request the operation" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'DisposeHIT'))
+    RTurk::DisposeHIT(:hit_id => "123456789") rescue RTurk::InvalidRequest
+  end
+  
+  it "should parse and return the result" do
+    RTurk::DisposeHIT(:hit_id => "123456789").should
+      be_a_kind_of RTurk::Response
+  end
+
+end

data/spec/operations/force_expire_hit_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::ForceExpireHIT do
+
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+    faker('force_expire_hit', :operation => 'ForceExpireHIT')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::ForceExpireHIT()}.should raise_error RTurk::MissingParameters
+  end
+  
+  it "should successfully request the operation" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'ForceExpireHIT'))
+    RTurk::ForceExpireHIT(:hit_id => "123456789") rescue RTurk::InvalidRequest
+  end
+  
+  it "should parse and return the result" do
+    RTurk::ForceExpireHIT(:hit_id => "123456789").should
+      be_a_kind_of RTurk::Response
+  end
+
+end

data/spec/operations/get_account_balance_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+
+describe RTurk::GetAccountBalance do
+
+  before(:all) do
+    faker('get_account_balance', :operation => 'GetAccountBalance')
+  end
+
+  it "should give me my account balance" do
+    RTurk.GetAccountBalance.amount.should eql(15555.55)
+  end
+
+
+end