rturk 1.0.5 → 2.0.0

data/lib/rturk/operations/dispose_hit.rb

@@ -0,0 +1,19 @@
+# http://docs.amazonwebservices.com/AWSMturkAPI/2008-08-02/ApiReference_DisposeHITOperation.html
+module RTurk
+  class DisposeHIT < Operation
+    
+    operation 'DisposeHIT'
+    require_params :hit_id
+    attr_accessor :hit_id
+    
+    def to_params
+      {'HITId' => self.hit_id}
+    end
+    
+  end
+  
+  def self.DisposeHIT(*args, &blk)
+    RTurk::DisposeHIT.create(*args, &blk)
+  end
+  
+end

data/lib/rturk/operations/force_expire_hit.rb

@@ -0,0 +1,18 @@
+module RTurk
+  class ForceExpireHIT < Operation
+
+    operation 'ForceExpireHIT'
+    require_params :hit_id
+    attr_accessor :hit_id
+    
+    def to_params
+      {'HITId' => self.hit_id}
+    end
+    
+  end
+  
+  def self.ForceExpireHIT(*args, &blk)
+    RTurk::ForceExpireHIT.create(*args, &blk)
+  end
+  
+end

data/lib/rturk/operations/get_account_balance.rb

@@ -0,0 +1,15 @@
+module RTurk
+  class GetAccountBalance < Operation
+
+    operation 'GetAccountBalance'
+    
+    def parse(xml)
+       RTurk::GetAccountBalanceResponse.new(xml)
+    end
+    
+  end
+  def self.GetAccountBalance
+    RTurk::GetAccountBalance.create
+  end
+
+end

data/lib/rturk/operations/get_assignments_for_hit.rb

@@ -0,0 +1,24 @@
+module RTurk
+  class GetAssignmentsForHIT < Operation
+
+    operation 'GetAssignmentsForHIT'
+    require_params :hit_id
+    
+    attr_accessor :hit_id, :page_size, :page_number
+    
+    def parse(xml)
+      GetAssignmentsForHITResponse.new(xml)
+    end
+    
+    def to_params
+      {'HITId' => hit_id,
+       'PageSize' => (page_size || 100),
+       'PageNumber' => page_number}
+    end
+
+  end
+  def self.GetAssignmentsForHIT(*args, &blk)
+    RTurk::GetAssignmentsForHIT.create(*args, &blk)
+  end
+
+end

data/lib/rturk/operations/get_hit.rb

@@ -0,0 +1,21 @@
+module RTurk
+  class GetHIT < Operation
+
+    operation 'GetHIT'
+    require_params :hit_id
+    attr_accessor :hit_id
+    
+    def parse(xml)
+      RTurk::GetHITResponse.new(xml)
+    end
+    
+    def to_params
+      {"HITId" => self.hit_id}
+    end
+    
+  end
+  def self.GetHIT(*args, &blk)
+    RTurk::GetHIT.create(*args, &blk)
+  end
+
+end

data/lib/rturk/operations/get_reviewable_hits.rb

@@ -0,0 +1,23 @@
+module RTurk
+  class GetReviewableHITs < Operation
+
+    operation 'GetReviewableHITs'
+    attr_accessor :page_size, :page_number
+    
+    def parse(xml)
+      RTurk::GetReviewableHITsResponse.new(xml)
+    end
+    
+    def to_params
+      {
+       'PageSize' => (page_size || 100),
+       'PageNumber' => (page_number || 1)
+       }
+    end
+
+  end
+  def self.GetReviewableHITs(*args, &blk)
+    RTurk::GetReviewableHITs.create(*args, &blk)
+  end
+
+end

data/lib/rturk/operations/grant_bonus.rb

@@ -0,0 +1,26 @@
+module RTurk
+  
+  # == Grant Bonus operation
+  #
+  # Grants a worker a bonus
+  #
+  
+  class GrantBonus < Operation
+
+    operation 'GrantBonus'
+    attr_accessor :assignment_id, :feedback, :worker_id, :amount, :currency
+    require_params :assignment_id, :worker_id, :amount, :feedback
+    
+    def to_params
+      {'AssignmentId' => self.assignment_id,
+        'BonusAmount.1.Amount' => self.amount,
+        'BonusAmount.1.CurrencyCode' => (self.currency || 'USD'),
+        'RequesterFeedback' => self.feedback}
+    end
+    
+  end
+  def self.GrantBonus(*args)
+    RTurk::GrantBonus.create(*args)
+  end
+
+end

data/lib/rturk/operations/reject_assignment.rb

@@ -0,0 +1,23 @@
+module RTurk
+  
+  # == Reject Assignment
+  # 
+  # Operation to reject a workers assignment, requires a reason
+  
+  class RejectAssignment < Operation
+
+    operation 'RejectAssignment'
+    attr_accessor :assignment_id, :feedback
+    require_params :assignment_id, :feedback
+    
+    def to_params
+      {'AssignmentId' => self.assignment_id,
+        'RequesterFeedback' => self.feedback}
+    end
+    
+  end
+  def self.RejectAssignment(*args)
+    RTurk::RejectAssignment.create(*args)
+  end
+
+end

data/lib/rturk/requester.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'cgi'
 require 'digest/sha1'
 require 'base64'
@@ -6,85 +5,68 @@ require 'time'
 require 'base64'
 require 'digest/sha1'
 require 'restclient'
-require 'xmlsimple'
 
 module RTurk
   class Requester
-    include RTurk::Utilities 
-    include RTurk::CustomOperations
 
-    SANDBOX = 'http://mechanicalturk.sandbox.amazonaws.com/'
-    PRODUCTION = 'http://mechanicalturk.amazonaws.com/'
-
-    attr_reader :access_key, :secret_key, :host
-
-    def initialize(access_key, secret_key, opts ={})
-      @access_key = access_key
-      @secret_key = secret_key
-      @host = opts[:sandbox] ? SANDBOX : PRODUCTION
-    end
-    
-    def raw_request(params = {})
-      params = stringify_keys(params)
-      base_params = {
-        'Service'=>'AWSMechanicalTurkRequester',
-        'AWSAccessKeyId' => self.access_key,
-        'Timestamp' => Time.now.iso8601,
-        'Version' => '2008-08-02'
-      }
-
-      params.merge!(base_params)
-      signature = sign(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
-
-      response = RestClient.get("#{self.host}?#{querystring}")
-    end
-
-    def request(params = {})
-      response = self.raw_request(params)
-      XmlSimple.xml_in(response.to_s, {'ForceArray' => false})
-    end
-    
-    def environment
-      @host.match(/sandbox/) ? 'sandbox' : 'production'
-    end
-
-    def method_missing(method, opts)
-      method = method.to_s
-      method = method[0,1].upcase + method[1,method.size-1]
-      opts.merge!(:Operation => method)
-      request(opts)
-    end
-
-    private
-
-    def sign(service,method,time)
-      msg = "#{service}#{method}#{time}"
-      return hmac_sha1( self.secret_key, msg )
+    class << self
+      include RTurk::Utilities
+      
+      # @param [Hash] params
+      # @option [String] 'Operation' The operation - Required
+      # @option [String] Any Pass any other params and they will be included in the request
+      #
+      def request(params = {})
+        params.delete_if {|k,v| v.nil? }
+        params = stringify_keys(params)
+        base_params = {
+          'Service'=>'AWSMechanicalTurkRequester',
+          'AWSAccessKeyId' => credentials.access_key,
+          'Timestamp' => Time.now.iso8601,
+          'Version' => '2008-08-02'
+        }
+
+        params.merge!(base_params)
+        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}"
+        RestClient.get("#{credentials.host}?#{querystring}")
+      end
+
+      private
+      
+        def credentials
+          RTurk
+        end
+
+        def sign(secret_key, service,method,time)
+          msg = "#{service}#{method}#{time}"
+          return hmac_sha1(secret_key, msg )
+        end
+
+        def hmac_sha1(key, s)
+          ipad = [].fill(0x36, 0, 64)
+          opad = [].fill(0x5C, 0, 64)
+          key = key.unpack("C*")
+          key += [].fill(0, 0, 64-key.length) if key.length < 64
+
+          inner = []
+          64.times { |i| inner.push(key[i] ^ ipad[i]) }
+          inner += s.unpack("C*")
+
+          outer = []
+          64.times { |i| outer.push(key[i] ^ opad[i]) }
+          outer = outer.pack("c*")
+          outer += Digest::SHA1.digest(inner.pack("c*"))
+
+          return Base64::encode64(Digest::SHA1.digest(outer)).chomp
+        end
     end
-
-
-
-    def hmac_sha1(key, s)
-      ipad = [].fill(0x36, 0, 64)
-      opad = [].fill(0x5C, 0, 64)
-      key = key.unpack("C*")
-      key += [].fill(0, 0, 64-key.length) if key.length < 64
-
-      inner = []
-      64.times { |i| inner.push(key[i] ^ ipad[i]) }
-      inner += s.unpack("C*")
-
-      outer = []
-      64.times { |i| outer.push(key[i] ^ opad[i]) }
-      outer = outer.pack("c*")
-      outer += Digest::SHA1.digest(inner.pack("c*"))
-
-      return Base64::encode64(Digest::SHA1.digest(outer)).chomp
-    end
-
-
   end
-end
+  
+  def self.Request(*args)
+    RTurk::Requester.request(*args)
+  end
 
+end

data/lib/rturk/response.rb

@@ -0,0 +1,58 @@
+require 'nokogiri'
+
+module RTurk
+  class Response
+    include RTurk::XmlUtilities
+    
+    #
+    # In some cases we want more than just a hash parsed from the returned
+    # XML. This class is our response object, and it can be extended for more
+    # functionality.
+    #
+    
+    attr_reader :xml, :raw_xml
+    
+    def initialize(response)
+      @raw_xml = response
+      @xml = Nokogiri::XML(@raw_xml)
+      raise_errors
+    end
+    
+    def success?
+      @xml.xpath('//Request/IsValid').inner_text.strip == "True"
+    end
+    
+    def errors
+      errors = []
+      @xml.xpath('//Errors').each do |error|
+        errors << {:code => error.xpath('Error/Code').inner_text,
+          :message => error.xpath('Error/Message').inner_text}
+      end
+      errors
+    end
+    
+    def humanized_errors
+      string = self.errors.inject('') { |str, error|
+        str + "#{error[:code]}: #{error[:message]}"
+      }
+      string
+    end
+    
+    def raise_errors
+      raise InvalidRequest, self.humanized_errors unless self.success?
+    end
+    
+    def [](element_name)
+      self.elements[element_name]
+    end
+    
+    def xpath(*args)
+      self.xml.xpath(*args)
+    end
+    
+    def elements
+      xml_to_hash(@xml)
+    end
+    
+  end
+end

data/lib/rturk/responses/create_hit_response.rb

@@ -0,0 +1,33 @@
+# Parses out the CreateHIT response
+#
+# Example response:
+# <CreateHITResponse>
+#   <OperationRequest>
+#     <RequestId>ece2785b-6292-4b12-a60e-4c34847a7916</RequestId>
+#   </OperationRequest>
+#   <HIT>
+#     <Request>
+#       <IsValid>True</IsValid>
+#     </Request>
+#     <HITId>GBHZVQX3EHXZ2AYDY2T0</HITId>
+#     <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId>
+#   </HIT>
+# </CreateHITResponse>
+
+module RTurk
+  class CreateHITResponse < Response
+    
+    def hit_id
+      @xml.xpath('//HITId').inner_text
+    end
+      
+    def hit_type_id
+      @xml.xpath('//HITTypeId').inner_text
+    end
+    
+    def hit
+      RTurk::Hit.new(self.hit_id, self.hit_type_id)
+    end
+    
+  end
+end

data/lib/rturk/responses/get_account_balance_response.rb

@@ -0,0 +1,11 @@
+module RTurk
+  
+  class GetAccountBalanceResponse < Response
+    
+    def amount
+      @xml.xpath('//AvailableBalance[1]/Amount').inner_text.to_f
+    end
+    
+  end
+  
+end

data/lib/rturk/responses/get_assignments_for_hit_response.rb

@@ -0,0 +1,43 @@
+# <GetAssignmentsForHITResult>
+#   <Request>
+#     <IsValid>True</IsValid>
+#   </Request>
+#   <NumResults>1</NumResults>
+#   <TotalNumResults>1</TotalNumResults>
+#   <PageNumber>1</PageNumber>
+#   <Assignment>
+#     <AssignmentId>GYFTRHZ5J3DZREY48WNZE38ZR9RR1ZPMXGWE7WE0</AssignmentId>
+#     <WorkerId>AD20WXZZP9XXK</WorkerId>
+#     <HITId>GYFTRHZ5J3DZREY48WNZ</HITId>
+#     <AssignmentStatus>Approved</AssignmentStatus>
+#     <AutoApprovalTime>2009-08-12T19:21:54Z</AutoApprovalTime>
+#     <AcceptTime>2009-07-13T19:21:40Z</AcceptTime>
+#     <SubmitTime>2009-07-13T19:21:54Z</SubmitTime>
+#     <ApprovalTime>2009-07-13T19:27:54Z</ApprovalTime>
+#     <Answer>
+#       <?xml version="1.0" encoding="UTF-8"?>
+#       <QuestionFormAnswers xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd">
+#         <Answer>
+#           <QuestionIdentifier>Question100</QuestionIdentifier>
+#           <FreeText>Move to X.</FreeText>
+#         </Answer>
+#       </QuestionFormAnswers>
+#     </Answer>
+#   </Assignment>
+# </GetAssignmentsForHITResult>
+
+module RTurk
+  
+  class GetAssignmentsForHITResponse < Response
+    
+    def assignments
+      assignments = []
+      @xml.xpath('//Assignment').each do |assignment_xml|
+        assignments << RTurk::Assignment.new(assignment_xml)
+      end
+      assignments
+    end
+    
+  end
+  
+end