rturk 2.3.3 → 2.3.4

data/CHANGELOG.markdown

@@ -0,0 +1,3 @@
+2.3.4
+-----
+* Added bonus_payments to Assignment and HIT for auditing [dbalatero]

data/Rakefile

@@ -22,7 +22,7 @@ begin
     gem.add_dependency('nokogiri', '>= 1.4.1')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
-
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-2.3.3
+2.3.4

data/lib/rturk/adapters/assignment.rb

@@ -8,6 +8,10 @@ module RTurk
       @id, @source = id, source
     end
 
+    def bonus_payments
+      RTurk::GetBonusPayments(:assignment_id => id).payments
+    end
+
     def approve!(feedback = nil)
       RTurk::ApproveAssignment(:assignment_id => self.id, :feedback => feedback)
     end

data/lib/rturk/adapters/hit.rb

@@ -81,6 +81,10 @@ module RTurk
       RTurk::ForceExpireHIT(:hit_id => self.id)
     end
 
+    def bonus_payments
+      RTurk::GetBonusPayments(:hit_id => id).payments
+    end
+
     def dispose!
       RTurk::DisposeHIT(:hit_id => self.id)
     end
@@ -105,8 +109,5 @@ module RTurk
         self.details.send(method)
       end
     end
-
-
   end
-
 end

data/lib/rturk/operations/get_bonus_payments.rb

@@ -0,0 +1,26 @@
+module RTurk
+  class GetBonusPayments < Operation
+    attr_accessor :hit_id, :assignment_id, :page_size,
+                  :page_number
+
+    def parse(xml)
+      GetBonusPaymentsResponse.new(xml)
+    end
+
+    def to_params
+      params = {
+        'PageSize' => (page_size || 100),
+        'PageNumber' => (page_number || 1)
+      }
+      
+      params['HITId'] = hit_id if hit_id
+      params['AssignmentId'] = assignment_id if assignment_id
+
+      params
+    end
+  end
+
+  def self.GetBonusPayments(*args, &block)
+    RTurk::GetBonusPayments.create(*args, &block)
+  end
+end

data/lib/rturk/parsers/bonus_payment_parser.rb

@@ -0,0 +1,16 @@
+module RTurk
+  class BonusPaymentParser < RTurk::Parser
+    attr_reader :assignment_id, :bonus_amount, :currency_code,
+                :reason, :grant_time
+
+    def initialize(payment_xml)
+      @xml_obj = payment_xml
+      map_content(@xml_obj,
+                  :assignment_id => 'AssignmentId',
+                  :bonus_amount => 'BonusAmount/Amount',
+                  :currency_code => 'BonusAmount/CurrencyCode',
+                  :reason => 'Reason',
+                  :grant_time => 'GrantTime')
+    end
+  end
+end

data/lib/rturk/parsers/hit_parser.rb

@@ -44,7 +44,5 @@ module RTurk
                   :completed_assignments => 'NumberOfAssignmentsCompleted',
                   :auto_approval_delay => 'AutoApprovalDelayInSeconds')
     end
-
   end
-
 end

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

@@ -0,0 +1,9 @@
+module RTurk
+  class GetBonusPaymentsResponse < Response
+    def payments
+      @payments ||= @xml.xpath('//BonusPayment').map do |payment_xml|
+        BonusPaymentParser.new(payment_xml)
+      end
+    end
+  end
+end

data/rturk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rturk}
-  s.version = "2.3.3"
+  s.version = "2.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Percival"]
-  s.date = %q{2010-11-17}
+  s.date = %q{2010-11-18}
   s.email = %q{mark@mpercival.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
     ".gitignore",
      ".gitmodules",
      ".yardoc",
+     "CHANGELOG.markdown",
      "Gemfile",
      "LICENSE",
      "README.markdown",
@@ -141,6 +142,7 @@ Gem::Specification.new do |s|
      "lib/rturk/operations/force_expire_hit.rb",
      "lib/rturk/operations/get_account_balance.rb",
      "lib/rturk/operations/get_assignments_for_hit.rb",
+     "lib/rturk/operations/get_bonus_payments.rb",
      "lib/rturk/operations/get_hit.rb",
      "lib/rturk/operations/get_qualification_type.rb",
      "lib/rturk/operations/get_qualifications_for_qualification_type.rb",
@@ -158,12 +160,14 @@ Gem::Specification.new do |s|
      "lib/rturk/parser.rb",
      "lib/rturk/parsers/answer_parser.rb",
      "lib/rturk/parsers/assignment_parser.rb",
+     "lib/rturk/parsers/bonus_payment_parser.rb",
      "lib/rturk/parsers/hit_parser.rb",
      "lib/rturk/parsers/qualification_parser.rb",
      "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_assignments_for_hit_response.rb",
+     "lib/rturk/parsers/responses/get_bonus_payments_response.rb",
      "lib/rturk/parsers/responses/get_hit_response.rb",
      "lib/rturk/parsers/responses/get_qualification_type_response.rb",
      "lib/rturk/parsers/responses/get_qualifications_for_qualification_type_response.rb",
@@ -193,6 +197,7 @@ Gem::Specification.new do |s|
      "spec/fake_responses/get_account_balance.xml",
      "spec/fake_responses/get_assignments.xml",
      "spec/fake_responses/get_assignments_multiple.xml",
+     "spec/fake_responses/get_bonus_payments.xml",
      "spec/fake_responses/get_hit.xml",
      "spec/fake_responses/get_qualification_type.xml",
      "spec/fake_responses/get_qualifications_for_qualification_type.xml",
@@ -219,6 +224,7 @@ Gem::Specification.new do |s|
      "spec/operations/force_expire_hit_spec.rb",
      "spec/operations/get_account_balance_spec.rb",
      "spec/operations/get_assignments_spec.rb",
+     "spec/operations/get_bonus_payments_spec.rb",
      "spec/operations/get_hit_spec.rb",
      "spec/operations/get_qualification_type_spec.rb",
      "spec/operations/get_qualifications_for_qualification_type_spec.rb",
@@ -265,6 +271,7 @@ Gem::Specification.new do |s|
      "spec/operations/force_expire_hit_spec.rb",
      "spec/operations/get_account_balance_spec.rb",
      "spec/operations/get_assignments_spec.rb",
+     "spec/operations/get_bonus_payments_spec.rb",
      "spec/operations/get_hit_spec.rb",
      "spec/operations/get_qualification_type_spec.rb",
      "spec/operations/get_qualifications_for_qualification_type_spec.rb",

data/spec/adapters/assignment_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+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)
+      RTurk.should_receive(:GetBonusPayments).
+        with(:assignment_id => 123456).and_return(result)
+      hit.bonus_payments.should == result.payments
+    end
+  end
+end

data/spec/adapters/hit_spec.rb

@@ -18,6 +18,16 @@ describe "HIT adapter" do
   it "should let us create a hit" do
     RTurk::Hit.create(:title => 'foo', :description => 'do foo', :question => 'http://mpercival.com', :reward => 0.05)
   end
+
+  describe "#bonus_payments" do
+    it "should call GetBonusPayments with the hit_id" do
+      result = mock('result', :payments => [1, 2, 3])
+      hit = RTurk::Hit.new(12345)
+      RTurk.should_receive(:GetBonusPayments).
+        with(:hit_id => 12345).and_return(result)
+      hit.bonus_payments.should == result.payments
+    end
+  end
   
   it "should retrieve all the details of a HIT with find" do
     proxy_hit = RTurk::Hit.new(12345)

data/spec/fake_responses/get_bonus_payments.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<GetBonusPaymentsResponse><OperationRequest><RequestId>2851062f-f1a1-46b4-9aa0-268906aef381</RequestId></OperationRequest><GetBonusPaymentsResult><Request><IsValid>True</IsValid></Request><NumResults>3</NumResults><TotalNumResults>3</TotalNumResults><PageNumber>1</PageNumber><BonusPayment><WorkerId>AGDRU4D1VTQLB</WorkerId><BonusAmount><Amount>0.04</Amount><CurrencyCode>USD</CurrencyCode><FormattedPrice>$0.04</FormattedPrice></BonusAmount><AssignmentId>180E4LY5TVT3R8QIIGL8GNEZWCF0UF</AssignmentId><Reason>Congrats! You earned a $0.04 bonus!</Reason><GrantTime>2010-09-17T20:16:40Z</GrantTime></BonusPayment><BonusPayment><WorkerId>A2UMLFMF60AX21</WorkerId><BonusAmount><Amount>0.04</Amount><CurrencyCode>USD</CurrencyCode><FormattedPrice>$0.04</FormattedPrice></BonusAmount><AssignmentId>199HR1YM20ZMAFPXZF8OCEGRF8BHQT</AssignmentId><Reason>Congrats! You earned a $0.04 bonus!</Reason><GrantTime>2010-09-17T20:16:41Z</GrantTime></BonusPayment><BonusPayment><WorkerId>A3FUPDYEZ3Z67F</WorkerId><BonusAmount><Amount>0.04</Amount><CurrencyCode>USD</CurrencyCode><FormattedPrice>$0.04</FormattedPrice></BonusAmount><AssignmentId>10NJ8OOK1GQKTFA5UU0RQDWISW81GL</AssignmentId><Reason>Congrats! You earned a $0.04 bonus!</Reason><GrantTime>2010-09-17T20:16:41Z</GrantTime></BonusPayment></GetBonusPaymentsResult></GetBonusPaymentsResponse>

data/spec/operations/get_assignments_spec.rb

@@ -1,7 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
 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)
@@ -18,7 +17,6 @@ describe RTurk::GetAssignmentsForHIT do
   end
 
   context "an HIT with one assignment" do
-    
     before(:all) do
       FakeWeb.clean_registry
       faker('get_assignments', :operation => 'GetAssignmentsForHIT')
@@ -28,9 +26,8 @@ describe RTurk::GetAssignmentsForHIT do
       assignments = RTurk::GetAssignmentsForHIT(:hit_id => "abcd").assignments
       assignments.first.answers['tweet'].should eql("This is my tweet!")
     end
-
   end
-  
+
   context "an HIT with multiple assignment" do
 
     before(:all) do
@@ -42,7 +39,5 @@ describe RTurk::GetAssignmentsForHIT do
       assignments = RTurk::GetAssignmentsForHIT(:hit_id => "abcd").assignments
       assignments.first.answers['tweet'].should eql("This is my tweet!")
     end
-
   end
-
 end

data/spec/operations/get_bonus_payments_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe RTurk::GetBonusPayments do
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    RTurk.setup(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+  end
+
+  context "a HIT with multiple payments" do
+    before(:all) do
+      FakeWeb.clean_registry
+      faker('get_bonus_payments', :operation => 'GetBonusPayments')
+
+      @response = RTurk::GetBonusPayments(:hit_id => 'fdsa')
+    end
+
+    it "should return 3 payments" do
+      @response.payments.should have(3).things
+    end
+
+    it "should parse each payment correctly" do
+      payment = @response.payments.first
+      payment.bonus_amount.should == 0.04
+      payment.currency_code.should == 'USD'
+      payment.assignment_id.should == '180E4LY5TVT3R8QIIGL8GNEZWCF0UF'
+      payment.reason.should == "Congrats! You earned a $0.04 bonus!"
+      payment.grant_time.should < Time.now
+    end
+
+    it "should have unique assignment IDs" do
+      ids = @response.payments.collect { |p| p.assignment_id }.uniq
+      ids.should have(3).things
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,13 +5,13 @@ require 'rubygems'
 require 'spec'
 require 'fakeweb'
 require 'yaml'
+
 module FakeWeb
   class Registry
     # Comment out this override if you're using a quantum computer 
     def variations_of_uri_as_strings(uri)
       [uri.to_s]
-    end
-    
+    end    
   end
 end
 
@@ -37,4 +37,4 @@ end
 
 Spec::Runner.configure do |config|
   
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rturk
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 11
   prerelease: false
   segments: 
   - 2
   - 3
-  - 3
-  version: 2.3.3
+  - 4
+  version: 2.3.4
 platform: ruby
 authors: 
 - Mark Percival
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-17 00:00:00 -08:00
+date: 2010-11-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,6 +63,7 @@ files:
 - .gitignore
 - .gitmodules
 - .yardoc
+- CHANGELOG.markdown
 - Gemfile
 - LICENSE
 - README.markdown
@@ -185,6 +186,7 @@ files:
 - lib/rturk/operations/force_expire_hit.rb
 - lib/rturk/operations/get_account_balance.rb
 - lib/rturk/operations/get_assignments_for_hit.rb
+- lib/rturk/operations/get_bonus_payments.rb
 - lib/rturk/operations/get_hit.rb
 - lib/rturk/operations/get_qualification_type.rb
 - lib/rturk/operations/get_qualifications_for_qualification_type.rb
@@ -202,12 +204,14 @@ files:
 - lib/rturk/parser.rb
 - lib/rturk/parsers/answer_parser.rb
 - lib/rturk/parsers/assignment_parser.rb
+- lib/rturk/parsers/bonus_payment_parser.rb
 - lib/rturk/parsers/hit_parser.rb
 - lib/rturk/parsers/qualification_parser.rb
 - 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_assignments_for_hit_response.rb
+- lib/rturk/parsers/responses/get_bonus_payments_response.rb
 - lib/rturk/parsers/responses/get_hit_response.rb
 - lib/rturk/parsers/responses/get_qualification_type_response.rb
 - lib/rturk/parsers/responses/get_qualifications_for_qualification_type_response.rb
@@ -237,6 +241,7 @@ files:
 - spec/fake_responses/get_account_balance.xml
 - spec/fake_responses/get_assignments.xml
 - spec/fake_responses/get_assignments_multiple.xml
+- spec/fake_responses/get_bonus_payments.xml
 - spec/fake_responses/get_hit.xml
 - spec/fake_responses/get_qualification_type.xml
 - spec/fake_responses/get_qualifications_for_qualification_type.xml
@@ -263,6 +268,7 @@ files:
 - spec/operations/force_expire_hit_spec.rb
 - spec/operations/get_account_balance_spec.rb
 - spec/operations/get_assignments_spec.rb
+- spec/operations/get_bonus_payments_spec.rb
 - spec/operations/get_hit_spec.rb
 - spec/operations/get_qualification_type_spec.rb
 - spec/operations/get_qualifications_for_qualification_type_spec.rb
@@ -337,6 +343,7 @@ test_files:
 - spec/operations/force_expire_hit_spec.rb
 - spec/operations/get_account_balance_spec.rb
 - spec/operations/get_assignments_spec.rb
+- spec/operations/get_bonus_payments_spec.rb
 - spec/operations/get_hit_spec.rb
 - spec/operations/get_qualification_type_spec.rb
 - spec/operations/get_qualifications_for_qualification_type_spec.rb