rturk 2.0.2 → 2.0.3

data/lib/rturk/operations/register_hit_type.rb

@@ -0,0 +1,68 @@
+module RTurk
+  class RegisterHITType < Operation
+
+    attr_accessor :title, :keywords, :description, :reward, :currency, :assignments
+    attr_accessor :lifetime, :duration, :auto_approval, :note
+
+    # @param [Symbol, Hash] qualification_key opts The unique qualification key
+    # @option opts [Hash] :comparator A comparator and value e.g. :gt => 80
+    # @option opts [Boolean] :boolean true or false
+    # @option opts [Symbol] :exists A comparator without a value
+    # @return [RTurk::Qualifications]
+    def qualifications
+      @qualifications ||= RTurk::Qualifications.new
+    end
+
+    # Gives us access to a question builder attached to this HIT
+    #
+    # @param [String, Hash] URL Params, if none is passed, simply returns the question
+    # @return [RTurk::Question] The question if instantiated or nil
+    def question(*args)
+      unless args.empty?
+        @question ||= RTurk::Question.new(*args)
+      else
+        @question
+      end
+    end
+
+    # Returns parameters specific to this instance
+    #
+    # @return [Hash]
+    #   Any class level default parameters get loaded in at
+    #   the time of request
+    def to_params
+      map_params.merge(qualifications.to_params)
+    end
+
+    def parse(response)
+      RTurk::RegisterHITTypeResponse.new(response)
+    end
+
+    # More complicated validation run before request
+    #
+    def validate
+      unless  title && reward && question && description
+        raise RTurk::MissingParameters, "You're missing some required parameters"
+      end
+    end
+
+    private
+
+      def map_params
+        {'Title'=>self.title,
+         'MaxAssignments' => (self.assignments || 1),
+         'LifetimeInSeconds'=> (self.lifetime || 3600),
+         'AssignmentDurationInSeconds' => (self.duration || 86400),
+         'Reward.Amount' => self.reward,
+         'Reward.CurrencyCode' => (self.currency || 'USD'),
+         'Keywords' => self.keywords,
+         'Description' => self.description,
+         'Question' => self.question.to_params,
+         'RequesterAnnotation' => note}
+      end
+
+  end
+  def self.RegisterHITType(*args, &blk)
+    RTurk::RegisterHITType.create(*args, &blk)
+  end
+end

data/lib/rturk/operations/search_hits.rb

@@ -0,0 +1,44 @@
+module RTurk
+  class SearchHITs < Operation
+    # You can call this operation without any parameters and get an unsorted
+    # list or you can pass in a :sort_by => {:title => :ascending}
+    #
+    # You can sort by
+    #   :title
+    #   :reward
+    #   :expiration
+    #   :created_at
+    #   :enumeration
+    
+    attr_accessor :sort_property, :sort_order, :page_size, :page_number, :sort_by
+    
+    SORT_BY = { :title => 'Title', :reward => 'Reward', :expiration => 'Expiration', :created_at => 'CreationTime', :enumeration => 'Enumeration'}
+    SORT_ORDER = {:ascending => 'Ascending', :descending => 'Descending', :asc => 'Ascending', :desc => 'Descending'}
+    
+    def parse(xml)
+      RTurk::SearchHITsResponse.new(xml)
+    end
+    
+    def to_params
+      self.set_sort_by
+      {
+        'SortProperty' => self.sort_property,
+        'SortDirection' => self.sort_order,
+        'PageSize' => (self.page_size || 100),
+        'PageNumber' => (self.page_number || 1)
+      }
+    end
+    
+    def set_sort_by
+      if @sort_by
+        @sort_property = SORT_BY[@sort_by.keys.first]
+        @sort_order = SORT_ORDER[@sort_by.values.first]
+      end
+    end
+    
+  end
+  def self.SearchHITs
+    RTurk::SearchHITs.create
+  end
+
+end

data/lib/rturk/parser.rb

@@ -0,0 +1,8 @@
+module RTurk
+  
+  class Parser
+    include XMLUtilities
+    
+  end
+  
+end

data/lib/rturk/parsers/answer_parser.rb

@@ -0,0 +1,29 @@
+module RTurk
+
+  class AnswerParser
+
+    require 'cgi'
+
+    def self.parse(xml)
+      answer_xml = Nokogiri::XML(CGI.unescapeHTML(xml.to_s))
+      answer_hash = {}
+      answers = answer_xml.xpath('//xmlns:Answer')
+      answers.each do |answer|
+        key, value = nil, nil
+        answer.children.each do |child|
+          next if child.blank?
+          if child.name == 'QuestionIdentifier'
+            key = child.inner_text
+          else
+            value = child.inner_text
+          end
+        end
+        answer_hash[key] = value
+      end
+      answer_hash
+    end
+
+
+  end
+
+end

data/lib/rturk/parsers/assignment_parser.rb

@@ -0,0 +1,49 @@
+# Parses:
+# <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>
+
+module RTurk
+  
+  class AssignmentParser < RTurk::Parser
+    
+    attr_reader :assignment_id, :hit_id, :worker_id, :status, :accepted_at, :submitted_at,
+                :approved_at, :auto_approval_time
+
+    def initialize(assignment_xml)
+      @xml_obj = assignment_xml
+      map_content(@xml_obj,
+                  :assignment_id => 'AssignmentId',
+                  :hit_id => 'HITId',
+                  :worker_id => 'WorkerId',
+                  :status => 'AssignmentStatus',
+                  :accepted_at => 'AcceptTime',
+                  :submitted_at => 'SubmitTime',
+                  :approved_at => 'ApprovalTime',
+                  :auto_approval_time => 'AutoApprovalTime'
+                  )
+    end
+    
+    def answers
+      AnswerParser.parse(@xml_obj.xpath('Answer').children)
+    end
+    
+  end
+  
+end

data/lib/rturk/parsers/hit_parser.rb

@@ -0,0 +1,50 @@
+#   <HIT>
+#     <HITId>ZZRZPTY4ERDZWJ868JCZ</HITId>
+#     <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId>
+#     <CreationTime>2009-07-07T00:56:40Z</CreationTime>
+#     <Title>Location</Title>
+#     <Description>Select the image that best represents</Description>
+#     <HITStatus>Assignable</HITStatus>
+#     <MaxAssignments>1</MaxAssignments>
+#     <Reward>
+#       <Amount>5.00</Amount>
+#       <CurrencyCode>USD</CurrencyCode>
+#       <FormattedPrice>$5.00</FormattedPrice>
+#     </Reward>
+#     <AutoApprovalDelayInSeconds>2592000</AutoApprovalDelayInSeconds>
+#     <Expiration>2009-07-14T00:56:40Z</Expiration>
+#     <AssignmentDurationInSeconds>30</AssignmentDurationInSeconds>
+#     <NumberOfAssignmentsPending>0</NumberOfAssignmentsPending>
+#     <NumberOfAssignmentsAvailable>1</NumberOfAssignmentsAvailable>
+#     <NumberOfAssignmentsCompleted>0</NumberOfAssignmentsCompleted>
+#   </HIT>
+
+module RTurk
+  
+  class HITParser < RTurk::Parser
+    
+    attr_reader :id, :type_id, :status, :title, :created_at, :expires_at, :assignments_duration, 
+                :reward_amount, :max_assignments, :pending_assignments, :available_assignments, 
+                :completed_assignments, :auto_approval_delay
+    
+    def initialize(hit_xml)
+      @xml_obj = hit_xml
+      map_content(@xml_obj,
+                  :id => 'HITId',
+                  :type_id => 'HITTypeId',
+                  :status => 'HITStatus',
+                  :title => 'Title',
+                  :created_at => 'CreationTime',
+                  :expires_at => 'Expiration',
+                  :assignments_duration => 'AssignmentDurationInSeconds',
+                  :reward_amount => 'Reward/Amount',
+                  :max_assignments => 'MaxAssignments',
+                  :pending_assignments => 'NumberOfAssignmentsPending',
+                  :available_assignments => 'NumberOfAssignmentsAvailable',
+                  :completed_assignments => 'NumberOfAssignmentsCompleted',
+                  :auto_approval_delay => 'AutoApprovalDelayInSeconds')
+    end
+    
+  end
+  
+end

data/lib/rturk/{response.rb → parsers/response.rb}

@@ -1,8 +1,7 @@
 require 'nokogiri'
 
 module RTurk
-  class Response
-    include RTurk::XmlUtilities
+  class Response < RTurk::Parser
     
     #
     # In some cases we want more than just a hash parsed from the returned
@@ -54,5 +53,11 @@ module RTurk
       xml_to_hash(@xml)
     end
     
+    def method_missing(method)
+      if @attributes && @attributes.include?(method)
+        @attributes[method]
+      end
+    end
+    
   end
 end

data/lib/rturk/{responses → parsers/responses}/create_hit_response.rb

@@ -21,12 +21,12 @@ module RTurk
       @xml.xpath('//HITId').inner_text
     end
       
-    def hit_type_id
+    def type_id
       @xml.xpath('//HITTypeId').inner_text
     end
     
     def hit
-      RTurk::Hit.new(self.hit_id, self.hit_type_id)
+      RTurk::Hit.new(self.hit_id, self)
     end
     
   end

data/lib/rturk/{responses → parsers/responses}/get_assignments_for_hit_response.rb

@@ -31,11 +31,11 @@ module RTurk
   class GetAssignmentsForHITResponse < Response
     
     def assignments
-      assignments = []
+      @assignments ||= []
       @xml.xpath('//Assignment').each do |assignment_xml|
-        assignments << RTurk::Assignment.new(assignment_xml)
+        @assignments << AssignmentParser.new(assignment_xml)
       end
-      assignments
+      @assignments
     end
     
   end

data/lib/rturk/{responses → parsers/responses}/get_hit_response.rb

@@ -46,35 +46,28 @@ module RTurk
   
   class GetHITResponse < Response
     
-    attr_accessor :id, :type_id, :status, :title, :description, :reward, :assignments
-    attr_accessor :similar_hits, :review_status, :expires_at, :auto_approval
+    attr_reader :hit_id, :type_id, :status, :review_status, :title, :created_at, :expires_at,
+                :assignments_duration, :reward_amount, :max_assignments, :auto_approval_delay
     
     def initialize(response)
       @raw_xml = response
       @xml = Nokogiri::XML(@raw_xml)
       raise_errors
       map_content(@xml.xpath('//HIT'),
-        :id => 'HITId',
+        :hit_id => 'HITId',
         :type_id => 'HITTypeId',
         :status => 'HITStatus',
-        :title => "Title",
-        :description => 'Description',
-        :assignments => 'MaxAssignments',
-        :similar_hits => 'NumberOfSimilarHITs',
         :review_status => 'HITReviewStatus',
+        :title => 'Title',
+        :created_at => 'CreationTime',
         :expires_at => 'Expiration',
-        :auto_approval => 'AutoApprovalDelayInSeconds'
+        :assignments_duration => 'AssignmentDurationInSeconds',
+        :reward_amount => 'Reward/Amount',
+        :max_assignments => 'MaxAssignments',
+        :auto_approval_delay => 'AutoApprovalDelayInSeconds'
       )
     end
     
-    def expires_at=(time)
-      @expires_at = Time.parse(time)
-    end
-    
-    def auto_approval=(seconds)
-      @auto_approval = seconds.to_i
-    end
-    
   end
   
 end

data/lib/rturk/{responses → parsers/responses}/get_reviewable_hits_response.rb

@@ -20,12 +20,10 @@ module RTurk
   
   class GetReviewableHITsResponse < Response
     
-    def hits
-      @hits ||= []
-      @xml.xpath('//HIT').each do |hit_xml|
-        @hits << RTurk::Hit.new(hit_xml.inner_text.strip)
+    def hit_ids
+      @xml.xpath('//HIT').inject([]) do |arr, hit_xml|
+        arr << hit_xml.inner_text.strip; arr
       end
-      @hits
     end
     
   end

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

@@ -0,0 +1,17 @@
+# Parses out the RegisterHITType response
+#
+# Example response:
+# <RegisterHITTypeResult>
+#   <Request>
+#     <IsValid>True</IsValid>
+#   </Request>
+#   <HITTypeId>KZ3GKTRXBWGYX8WXBW60</HITTypeId>
+# </RegisterHITTypeResult>
+
+module RTurk
+  class RegisterHITTypeResponse < Response
+    def type_id
+      @xml.xpath('//HITTypeId').inner_text
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module RTurk
+  # <SearchHITsResult>
+  #   <Request>
+  #     <IsValid>True</IsValid>
+  #   </Request>
+  #   <NumResults>2</NumResults>
+  #   <TotalNumResults>2</TotalNumResults>
+  #   <PageNumber>1</PageNumber>
+  # 
+  #   <HIT>
+  #     <HITId>GBHZVQX3EHXZ2AYDY2T0</HITId>
+  #     <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId>
+  #     <CreationTime>2009-04-22T00:17:32Z</CreationTime>
+  #     <Title>Location</Title>
+  #     <Description>Select the image that best represents</Description>
+  #     <HITStatus>Reviewable</HITStatus>
+  #     <MaxAssignments>1</MaxAssignments>
+  #     <Reward>
+  #       <Amount>5.00</Amount>
+  #       <CurrencyCode>USD</CurrencyCode>
+  #       <FormattedPrice>$5.00</FormattedPrice>
+  #     </Reward>
+  #     <AutoApprovalDelayInSeconds>2592000</AutoApprovalDelayInSeconds>
+  #     <Expiration>2009-04-29T00:17:32Z</Expiration>
+  #     <AssignmentDurationInSeconds>30</AssignmentDurationInSeconds>
+  #     <NumberOfAssignmentsPending>0</NumberOfAssignmentsPending>
+  #     <NumberOfAssignmentsAvailable>0</NumberOfAssignmentsAvailable>
+  #     <NumberOfAssignmentsCompleted>1</NumberOfAssignmentsCompleted>
+  #   </HIT>
+  # 
+  #   <HIT>
+  #     <HITId>ZZRZPTY4ERDZWJ868JCZ</HITId>
+  #     <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId>
+  #     <CreationTime>2009-07-07T00:56:40Z</CreationTime>
+  #     <Title>Location</Title>
+  #     <Description>Select the image that best represents</Description>
+  #     <HITStatus>Assignable</HITStatus>
+  #     <MaxAssignments>1</MaxAssignments>
+  #     <Reward>
+  #       <Amount>5.00</Amount>
+  #       <CurrencyCode>USD</CurrencyCode>
+  #       <FormattedPrice>$5.00</FormattedPrice>
+  #     </Reward>
+  #     <AutoApprovalDelayInSeconds>2592000</AutoApprovalDelayInSeconds>
+  #     <Expiration>2009-07-14T00:56:40Z</Expiration>
+  #     <AssignmentDurationInSeconds>30</AssignmentDurationInSeconds>
+  #     <NumberOfAssignmentsPending>0</NumberOfAssignmentsPending>
+  #     <NumberOfAssignmentsAvailable>1</NumberOfAssignmentsAvailable>
+  #     <NumberOfAssignmentsCompleted>0</NumberOfAssignmentsCompleted>
+  #   </HIT>
+  # </SearchHITsResult>
+  
+  class SearchHITsResponse < Response
+    
+    def hits
+      @hits ||= begin
+        @xml.xpath('//HIT').inject([]) do |arr, hit_xml|
+          arr << HITParser.new(hit_xml); arr
+        end
+      end
+    end
+    
+  end
+  
+end