rturk 2.0.1 → 2.0.2

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::log.level = Logger::DEBUG
+    RTurk::logger.level = Logger::DEBUG
     
 ## Nitty Gritty
 

data/VERSION

@@ -1 +1 @@
-2.0.1
+2.0.2

data/lib/rturk.rb

@@ -16,7 +16,7 @@ module RTurk
       @host == SANDBOX
     end
     
-    def log
+    def logger
       RTurk::Logger.logger
     end
 

data/lib/rturk/operation.rb

@@ -16,7 +16,7 @@ module RTurk
         @required_params.push(*args)
       end
 
-      def operation(op)
+      def set_operation(op)
         default_params.merge!('Operation' => op)
       end
 
@@ -65,7 +65,8 @@ module RTurk
         validate
       end
       check_params
-      params = self.default_params
+      params = {'Operation' => self.class.to_s.gsub('RTurk::', '')}
+      params = params.merge(self.default_params)
       params = to_params.merge(params)
       response = RTurk.Request(params)
       parse(response)

data/lib/rturk/operations/approve_assignment.rb

@@ -11,7 +11,6 @@
 module RTurk
   class ApproveAssignment < Operation
 
-    operation 'ApproveAssignment'
     attr_accessor :assignment_id, :feedback
     require_params :assignment_id
     

data/lib/rturk/operations/block_worker.rb

@@ -0,0 +1,23 @@
+# Operation to block a worker
+#
+# The worker does not see the reason you gave. It's for your records
+# only.
+
+
+module RTurk
+  class BlockWorker < Operation
+
+    attr_accessor :worker_id, :reason
+    require_params :worker_id, :reason
+    
+    def to_params
+      {'WorkerId' => self.worker_id,
+        'Reason' => self.reason}
+    end
+    
+  end
+  def self.BlockWorker(*args)
+    RTurk::BlockWorker.create(*args)
+  end
+
+end

data/lib/rturk/operations/create_hit.rb

@@ -1,8 +1,6 @@
 module RTurk
   class CreateHIT < Operation
     
-    operation 'CreateHIT'
-
     attr_accessor :title, :keywords, :description, :reward, :currency, :assignments
     attr_accessor :lifetime, :duration, :auto_approval, :note, :hit_type_id
 

data/lib/rturk/operations/disable_hit.rb

@@ -2,7 +2,6 @@
 module RTurk
   class DisableHIT < Operation
     
-    operation 'DisableHIT'
     require_params :hit_id
     attr_accessor :hit_id
     

data/lib/rturk/operations/dispose_hit.rb

@@ -2,7 +2,6 @@
 module RTurk
   class DisposeHIT < Operation
     
-    operation 'DisposeHIT'
     require_params :hit_id
     attr_accessor :hit_id
     

data/lib/rturk/operations/force_expire_hit.rb

@@ -1,7 +1,6 @@
 module RTurk
   class ForceExpireHIT < Operation
 
-    operation 'ForceExpireHIT'
     require_params :hit_id
     attr_accessor :hit_id
     

data/lib/rturk/operations/get_account_balance.rb

@@ -1,8 +1,6 @@
 module RTurk
   class GetAccountBalance < Operation
 
-    operation 'GetAccountBalance'
-    
     def parse(xml)
        RTurk::GetAccountBalanceResponse.new(xml)
     end

data/lib/rturk/operations/get_assignments_for_hit.rb

@@ -1,7 +1,6 @@
 module RTurk
   class GetAssignmentsForHIT < Operation
 
-    operation 'GetAssignmentsForHIT'
     require_params :hit_id
     
     attr_accessor :hit_id, :page_size, :page_number

data/lib/rturk/operations/get_hit.rb

@@ -1,7 +1,6 @@
 module RTurk
   class GetHIT < Operation
 
-    operation 'GetHIT'
     require_params :hit_id
     attr_accessor :hit_id
     

data/lib/rturk/operations/get_reviewable_hits.rb

@@ -1,7 +1,6 @@
 module RTurk
   class GetReviewableHITs < Operation
 
-    operation 'GetReviewableHITs'
     attr_accessor :page_size, :page_number
     
     def parse(xml)

data/lib/rturk/operations/grant_bonus.rb

@@ -7,7 +7,6 @@ module RTurk
   
   class GrantBonus < Operation
 
-    operation 'GrantBonus'
     attr_accessor :assignment_id, :feedback, :worker_id, :amount, :currency
     require_params :assignment_id, :worker_id, :amount, :feedback
     

data/lib/rturk/operations/reject_assignment.rb

@@ -6,7 +6,6 @@ module RTurk
   
   class RejectAssignment < Operation
 
-    operation 'RejectAssignment'
     attr_accessor :assignment_id, :feedback
     require_params :assignment_id, :feedback
     

data/lib/rturk/operations/unblock_worker.rb

@@ -0,0 +1,23 @@
+# Operation to block a worker
+#
+# The worker does not see the reason you gave. It's for your records
+# only.
+
+
+module RTurk
+  class UnblockWorker < Operation
+
+    attr_accessor :worker_id, :reason
+    require_params :worker_id
+    
+    def to_params
+      {'WorkerId' => self.worker_id,
+        'Reason' => self.reason}
+    end
+    
+  end
+  def self.UnblockWorker(*args)
+    RTurk::UnblockWorker.create(*args)
+  end
+
+end

data/lib/rturk/requester.rb

@@ -30,7 +30,7 @@ module RTurk
         signature = sign(credentials.secret_key, params['Service'], params['Operation'], params["Timestamp"])
         params['Signature'] = signature
         querystring = params.collect { |key, value| [CGI.escape(key.to_s), CGI.escape(value.to_s)].join('=') }.join('&') # order doesn't matter for the actual request
-        RTurk.log.debug "Sending request:\n\t #{credentials.host}?#{querystring}"
+        RTurk.logger.debug "Sending request:\n\t #{credentials.host}?#{querystring}"
         RestClient.get("#{credentials.host}?#{querystring}")
       end
 

data/rturk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rturk}
-  s.version = "2.0.1"
+  s.version = "2.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Percival"]
-  s.date = %q{2009-10-26}
+  s.date = %q{2009-10-27}
   s.email = %q{mark@mpercival.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
      "lib/rturk/macros.rb",
      "lib/rturk/operation.rb",
      "lib/rturk/operations/approve_assignment.rb",
+     "lib/rturk/operations/block_worker.rb",
      "lib/rturk/operations/create_hit.rb",
      "lib/rturk/operations/disable_hit.rb",
      "lib/rturk/operations/dispose_hit.rb",
@@ -51,6 +52,7 @@ Gem::Specification.new do |s|
      "lib/rturk/operations/get_reviewable_hits.rb",
      "lib/rturk/operations/grant_bonus.rb",
      "lib/rturk/operations/reject_assignment.rb",
+     "lib/rturk/operations/unblock_worker.rb",
      "lib/rturk/requester.rb",
      "lib/rturk/response.rb",
      "lib/rturk/responses/create_hit_response.rb",
@@ -68,6 +70,7 @@ Gem::Specification.new do |s|
      "spec/builders/qualifications_spec.rb",
      "spec/builders/question_spec.rb",
      "spec/fake_responses/approve_assignment.xml",
+     "spec/fake_responses/block_worker.xml",
      "spec/fake_responses/create_hit.xml",
      "spec/fake_responses/disable_hit.xml",
      "spec/fake_responses/dispose_hit.xml",
@@ -80,8 +83,10 @@ Gem::Specification.new do |s|
      "spec/fake_responses/grant_bonus.xml",
      "spec/fake_responses/invalid_credentials.xml",
      "spec/fake_responses/reject_assignment.xml",
+     "spec/fake_responses/unblock_worker.xml",
      "spec/mturk.sample.yml",
      "spec/operations/approve_assignment_spec.rb",
+     "spec/operations/block_worker_spec.rb",
      "spec/operations/create_hit_spec.rb",
      "spec/operations/disable_hit_spec.rb",
      "spec/operations/dispose_hit_spec.rb",
@@ -92,6 +97,7 @@ Gem::Specification.new do |s|
      "spec/operations/get_reviewable_hits_spec.rb",
      "spec/operations/grant_bonus_spec.rb",
      "spec/operations/reject_assignment_spec.rb",
+     "spec/operations/unblock_worker_spec.rb",
      "spec/requester_spec.rb",
      "spec/response_spec.rb",
      "spec/rturk_spec.rb",
@@ -112,6 +118,7 @@ Gem::Specification.new do |s|
      "spec/builders/qualifications_spec.rb",
      "spec/builders/question_spec.rb",
      "spec/operations/approve_assignment_spec.rb",
+     "spec/operations/block_worker_spec.rb",
      "spec/operations/create_hit_spec.rb",
      "spec/operations/disable_hit_spec.rb",
      "spec/operations/dispose_hit_spec.rb",
@@ -122,6 +129,7 @@ Gem::Specification.new do |s|
      "spec/operations/get_reviewable_hits_spec.rb",
      "spec/operations/grant_bonus_spec.rb",
      "spec/operations/reject_assignment_spec.rb",
+     "spec/operations/unblock_worker_spec.rb",
      "spec/requester_spec.rb",
      "spec/response_spec.rb",
      "spec/rturk_spec.rb",

data/spec/fake_responses/block_worker.xml

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

data/spec/fake_responses/unblock_worker.xml

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

data/spec/operations/block_worker_spec.rb

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

data/spec/operations/unblock_worker_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rturk
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors: 
 - Mark Percival
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-26 00:00:00 -04:00
+date: 2009-10-27 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -48,6 +48,7 @@ files:
 - lib/rturk/macros.rb
 - lib/rturk/operation.rb
 - lib/rturk/operations/approve_assignment.rb
+- lib/rturk/operations/block_worker.rb
 - lib/rturk/operations/create_hit.rb
 - lib/rturk/operations/disable_hit.rb
 - lib/rturk/operations/dispose_hit.rb
@@ -58,6 +59,7 @@ files:
 - lib/rturk/operations/get_reviewable_hits.rb
 - lib/rturk/operations/grant_bonus.rb
 - lib/rturk/operations/reject_assignment.rb
+- lib/rturk/operations/unblock_worker.rb
 - lib/rturk/requester.rb
 - lib/rturk/response.rb
 - lib/rturk/responses/create_hit_response.rb
@@ -75,6 +77,7 @@ files:
 - spec/builders/qualifications_spec.rb
 - spec/builders/question_spec.rb
 - spec/fake_responses/approve_assignment.xml
+- spec/fake_responses/block_worker.xml
 - spec/fake_responses/create_hit.xml
 - spec/fake_responses/disable_hit.xml
 - spec/fake_responses/dispose_hit.xml
@@ -87,8 +90,10 @@ files:
 - spec/fake_responses/grant_bonus.xml
 - spec/fake_responses/invalid_credentials.xml
 - spec/fake_responses/reject_assignment.xml
+- spec/fake_responses/unblock_worker.xml
 - spec/mturk.sample.yml
 - spec/operations/approve_assignment_spec.rb
+- spec/operations/block_worker_spec.rb
 - spec/operations/create_hit_spec.rb
 - spec/operations/disable_hit_spec.rb
 - spec/operations/dispose_hit_spec.rb
@@ -99,6 +104,7 @@ files:
 - spec/operations/get_reviewable_hits_spec.rb
 - spec/operations/grant_bonus_spec.rb
 - spec/operations/reject_assignment_spec.rb
+- spec/operations/unblock_worker_spec.rb
 - spec/requester_spec.rb
 - spec/response_spec.rb
 - spec/rturk_spec.rb
@@ -141,6 +147,7 @@ test_files:
 - spec/builders/qualifications_spec.rb
 - spec/builders/question_spec.rb
 - spec/operations/approve_assignment_spec.rb
+- spec/operations/block_worker_spec.rb
 - spec/operations/create_hit_spec.rb
 - spec/operations/disable_hit_spec.rb
 - spec/operations/dispose_hit_spec.rb
@@ -151,6 +158,7 @@ test_files:
 - spec/operations/get_reviewable_hits_spec.rb
 - spec/operations/grant_bonus_spec.rb
 - spec/operations/reject_assignment_spec.rb
+- spec/operations/unblock_worker_spec.rb
 - spec/requester_spec.rb
 - spec/response_spec.rb
 - spec/rturk_spec.rb