rturk 2.8.0 → 2.9.0

data/CHANGELOG.markdown

@@ -1,3 +1,12 @@
+2.8.0
+----
+* Adding support for operation SearchQualificationTypes [hampei]
+* Bumped to API version 2012-03-25
+2.7.0
+----
+* Adding support for operation SearchQualificationTypes [denniskuczynski]
+* Added ServiceUnavailable error type for detecting/handling HTTP
+  Service Unavailable errors [denniskuczynski]
 2.6.0
 -----
 * Adding IntegerValue attribute to AssignQualification from Ross

data/lib/rturk/adapters/assignment.rb

@@ -16,6 +16,10 @@ module RTurk
       RTurk::ApproveAssignment(:assignment_id => self.id, :feedback => feedback)
     end
 
+    def approve_rejected!(feedback = nil)
+      RTurk::ApproveRejectedAssignment(:assignment_id => self.id, :feedback => feedback)
+    end
+
     def reject!(reason)
       RTurk::RejectAssignment(:assignment_id => self.id, :feedback => reason)
     end

data/lib/rturk/builders/qualification_builder.rb

@@ -10,7 +10,7 @@ module RTurk
                    :lte => 'LessThanOrEqualTo', :eql => 'EqualTo', :not => 'NotEqualTo', :exists => 'Exists'}
 
     TYPES = {:approval_rate => '000000000000000000L0', :submission_rate => '00000000000000000000',
-             :abandoned_rate => '0000000000000000007', :return_rate => '000000000000000000E0',
+             :abandoned_rate => '00000000000000000070', :return_rate => '000000000000000000E0',
              :rejection_rate => '000000000000000000S0', :hits_approved => '00000000000000000040',
              :adult => '00000000000000000060', :country => '00000000000000000071'}
 
@@ -20,9 +20,9 @@ module RTurk
     # needs at the minimum
     #  type_id, :comparator => :value
     #  or
-    #  type_id, true
+    #  type_id, :exists => true
     #  or
-    #  type_id, :exists
+    #  type_id, true
     #
     def initialize(type, opts)
       # If the value is a string, we can assume it's the country since,
@@ -39,7 +39,7 @@ module RTurk
       elsif opts == true || opts == false
          qualifier[:IntegerValue] = opts == true ? 1 : 0
          qualifier[:Comparator] = COMPARATORS[:eql]
-       end
+      end
       qualifier
     end
 
@@ -68,7 +68,7 @@ module RTurk
           if v.to_s.match(/[A-Z]./)
             qualifier[:Country] = v
           else
-            qualifier[:IntegerValue] = v
+            qualifier[:IntegerValue] = v unless k == :exists
           end
         end
       end

data/lib/rturk/operations/approve_rejected_assignment.rb

@@ -0,0 +1,16 @@
+module RTurk
+  class ApproveRejectedAssignment < Operation
+
+    attr_accessor :assignment_id, :feedback
+    require_params :assignment_id
+
+    def to_params
+      {'AssignmentId' => self.assignment_id,
+        'RequesterFeedback' => self.feedback}
+    end
+  end
+
+  def self.ApproveRejectedAssignment(*args)
+    RTurk::ApproveRejectedAssignment.create(*args)
+  end
+end

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

@@ -48,11 +48,12 @@ module RTurk
                 :expires_at, :assignments_duration, :reward_amount, :max_assignments,
                 :auto_approval_delay, :description, :reward, :lifetime, :annotation,
                 :similar_hits_count, :assignments_pending_count, :assignments_available_count,
-                :assignments_completed_count
+                :assignments_completed_count, :question_external_url, :qualification_requirement_comparator,
+                :qualification_requirement_value
 
     def initialize(response)
       @raw_xml = response.body
-      @xml = Nokogiri::XML(@raw_xml)
+      @xml = Nokogiri::XML(CGI.unescapeHTML(@raw_xml))
       raise_errors
       map_content(@xml.xpath('//HIT'),
         :hit_id => 'HITId',
@@ -74,7 +75,10 @@ module RTurk
         :similar_hits_count => 'NumberOfSimilarHITs',
         :assignments_pending_count => 'NumberOfAssignmentsPending',
         :assignments_available_count => 'NumberOfAssignmentsAvailable',
-        :assignments_completed_count => 'NumberOfAssignmentsCompleted'
+        :assignments_completed_count => 'NumberOfAssignmentsCompleted',
+        :question_external_url => 'Question/*/*[1]',
+        :qualification_requirement_comparator => 'QualificationRequirement/Comparator',
+        :qualification_requirement_value => 'QualificationRequirement/IntegerValue'
       )
 
       @keywords = @keywords.split(', ') if @keywords

data/lib/rturk/version.rb

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

data/spec/adapters/assignment_spec.rb

@@ -4,10 +4,19 @@ describe RTurk::Assignment do
   describe "#bonus_payments" do
     it "should call GetBonusPayments with the assignment_id" do
       result = mock('result', :payments => [1, 2, 3])
-      hit = RTurk::Assignment.new(123456)
+      assignment = RTurk::Assignment.new(123456)
       RTurk.should_receive(:GetBonusPayments).
         with(:assignment_id => 123456).and_return(result)
-      hit.bonus_payments.should == result.payments
+      assignment.bonus_payments.should == result.payments
+    end
+  end
+
+  describe "#approve_rejected!" do
+    it "should call ApproveRejectedAssignment with assignment_id and optional feedback" do
+      RTurk.should_receive(:ApproveRejectedAssignment).
+        with(:assignment_id => 123456, :feedback => "abcde")
+      assignment = RTurk::Assignment.new(123456)
+      assignment.approve_rejected!("abcde")
     end
   end
 end

data/spec/builders/qualification_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
 
 describe RTurk::Qualifications do
-  
+
   # Possible values coming back
   # {"QualificationTypeId","Comparator", "IntegerValue", "LocaleValue.Country","RequiredToPreview"}
 
@@ -21,21 +21,27 @@ describe RTurk::Qualifications do
     @qualification.to_params.should eql({"QualificationTypeId" => '000000000000000000L0',"Comparator" => 'GreaterThan',
                                          "IntegerValue" => 90, "RequiredToPreview" => 'false'})
   end
-  
+
   it "should build a qualification for boolean qualification" do
     @qualification = RTurk::Qualification.new('00000000000000000060', true)
     @qualification.to_params.should eql({"QualificationTypeId" => '00000000000000000060',"Comparator" => 'EqualTo',
                                          "IntegerValue" => 1, "RequiredToPreview" => "true"})
   end
-  
+
   it "should build a qualification for country qualification" do
     @qualification = RTurk::Qualification.new('00000000000000000071', :eql => 'PH')
     @qualification.to_params.should eql({"QualificationTypeId" => '00000000000000000071',"Comparator" => 'EqualTo',
                                          "LocaleValue.Country" => 'PH', "RequiredToPreview" => "true"})
   end
-  
+
+  it "should build a qualification for existence qualification" do
+    @qualification = RTurk::Qualification.new('00000000000000000071', :exists => true)
+    @qualification.to_params.should eql({"QualificationTypeId" => '00000000000000000071',"Comparator" => 'Exists',
+                                         "RequiredToPreview" => "true"})
+  end
+
   context 'passing in symbols representing a TypeID' do
-    
+
     it "should build a qualification for Approval rate" do
       @qualification = RTurk::Qualification.new(:approval_rate, :gt => 90)
       @qualification.to_params.should eql({"QualificationTypeId" => '000000000000000000L0',"Comparator" => 'GreaterThan',
@@ -53,7 +59,7 @@ describe RTurk::Qualifications do
       @qualification.to_params.should eql({"QualificationTypeId" => '00000000000000000071',"Comparator" => 'EqualTo',
                                            "LocaleValue.Country" => 'PH', "RequiredToPreview" => "true"})
     end
-    
+
   end
 
 end

data/spec/fake_responses/approve_rejected_assignment.xml

@@ -0,0 +1,6 @@
+<ApproveRejectedAssignmentResult>
+  <Request>
+    <IsValid>True</IsValid>
+  </Request>
+</ApproveRejectedAssignmentResult>
+

data/spec/operations/approve_rejected_assignment_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::ApproveRejectedAssignment 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_rejected_assignment', :operation => 'ApproveRejectedAssignment')
+  end
+
+  it "should ensure required params" do
+    lambda{RTurk::ApproveRejectedAssignment()}.should raise_error RTurk::MissingParameters
+  end
+
+  it "should successfully request the operation" do
+    RTurk::Requester.should_receive(:request).once.with(
+      hash_including('Operation' => 'ApproveRejectedAssignment'))
+    RTurk::ApproveRejectedAssignment(:assignment_id => "123456789") rescue RTurk::InvalidRequest
+  end
+
+  it "should parse and return the result" do
+    RTurk::ApproveRejectedAssignment(:assignment_id => "123456789").elements.should eql(
+      {"ApproveRejectedAssignmentResult"=>{"Request"=>{"IsValid"=>"True"}}}
+    )
+  end
+
+end
+

data/spec/operations/get_hit_spec.rb

@@ -11,6 +11,9 @@ describe RTurk::GetHIT do
     response.type_id.should eql('YGKZ2W5X6YFZ08ZRXXZZ')
     response.auto_approval_delay.should eql(3600)
     response.status.should eql('Reviewable')
+    response.question_external_url.should eql("http://s3.amazonaws.com/mpercival.com/newtweet.html?id=foo")
+    response.qualification_requirement_comparator.should eql("GreaterThan")
+    response.qualification_requirement_value.should eql(90)
   end
 
   it "should not specify the ResponseGroup by default" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rturk
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -202,6 +202,7 @@ files:
 - lib/rturk/macros.rb
 - lib/rturk/operation.rb
 - lib/rturk/operations/approve_assignment.rb
+- lib/rturk/operations/approve_rejected_assignment.rb
 - lib/rturk/operations/assign_qualification.rb
 - lib/rturk/operations/block_worker.rb
 - lib/rturk/operations/create_hit.rb
@@ -268,6 +269,7 @@ files:
 - spec/builders/qualifications_spec.rb
 - spec/builders/question_spec.rb
 - spec/fake_responses/approve_assignment.xml
+- spec/fake_responses/approve_rejected_assignment.xml
 - spec/fake_responses/assign_qualification.xml
 - spec/fake_responses/block_worker.xml
 - spec/fake_responses/create_hit.xml
@@ -302,6 +304,7 @@ files:
 - spec/fake_responses/update_qualification_type.xml
 - spec/mturk.sample.yml
 - spec/operations/approve_assignment_spec.rb
+- spec/operations/approve_rejected_assignment_spec.rb
 - spec/operations/assign_qualification_spec.rb
 - spec/operations/block_worker_spec.rb
 - spec/operations/create_hit_spec.rb