rturk 2.10.3 → 2.11.0

data/lib/rturk/operations/register_hit_type.rb

@@ -1,7 +1,7 @@
 module RTurk
   class RegisterHITType < Operation
 
-    attr_accessor :title, :description, :reward, :currency, :duration, :keywords, :auto_approval
+    attr_accessor :title, :description, :reward, :currency, :duration, :keywords, :auto_approval_delay
 
 
     # @param [Symbol, Hash] qualification_key opts The unique qualification key
@@ -54,7 +54,7 @@ module RTurk
           'Reward.Amount' => reward,
           'Reward.CurrencyCode' => (currency || 'USD'),
           'Keywords' => keyword_string,
-          'AutoApprovalDelayInSeconds' => auto_approval }
+          'AutoApprovalDelayInSeconds' => auto_approval_delay }
       end
   end
 

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

@@ -27,9 +27,9 @@
 # </GetAssignmentsForHITResult>
 
 module RTurk
-  
+
   class GetAssignmentsForHITResponse < Response
-    
+
     def assignments
       @assignments ||= []
       @xml.xpath('//Assignment').each do |assignment_xml|
@@ -37,7 +37,23 @@ module RTurk
       end
       @assignments
     end
-    
+
+    # todo: test
+    def total_num_results
+      @xml.xpath('//TotalNumResults').inner_text.to_i
+    end
+
+    # todo: test
+    def num_results
+      @xml.xpath('//NumResults').inner_text.to_i
+    end
+
+    # todo: test
+    def page_number
+      @xml.xpath('//PageNumber').inner_text.to_i
+    end
+
+
   end
-  
-end
+
+end

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

@@ -49,7 +49,7 @@ module RTurk
                 :auto_approval_delay, :description, :reward, :lifetime, :annotation,
                 :similar_hits_count, :assignments_pending_count, :assignments_available_count,
                 :assignments_completed_count, :question_external_url, :qualification_requirement_comparator,
-                :qualification_requirement_value
+                :qualification_requirement_value, :question
 
     def initialize(response)
       @raw_xml = response.body
@@ -78,7 +78,8 @@ module RTurk
         :assignments_completed_count => 'NumberOfAssignmentsCompleted',
         :question_external_url => 'Question/*/*[1]',
         :qualification_requirement_comparator => 'QualificationRequirement/Comparator',
-        :qualification_requirement_value => 'QualificationRequirement/IntegerValue'
+        :qualification_requirement_value => 'QualificationRequirement/IntegerValue',
+        :question => 'Question'
       )
 
       @keywords = @keywords.split(', ') if @keywords

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

@@ -17,15 +17,30 @@
 # </GetReviewableHITsResult>
 
 module RTurk
-  
+
   class GetReviewableHITsResponse < Response
-    
+
     def hit_ids
       @xml.xpath('//HIT').inject([]) do |arr, hit_xml|
         arr << hit_xml.inner_text.strip; arr
       end
     end
-    
+
+    # todo: test
+    def total_num_results
+      @xml.xpath('//TotalNumResults').inner_text.to_i
+    end
+
+    # todo: test
+    def num_results
+      @xml.xpath('//NumResults').inner_text.to_i
+    end
+
+    # todo: test
+    def page_number
+      @xml.xpath('//PageNumber').inner_text.to_i
+    end
+
   end
-  
-end
+
+end

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

@@ -6,7 +6,7 @@ module RTurk
   #   <NumResults>2</NumResults>
   #   <TotalNumResults>2</TotalNumResults>
   #   <PageNumber>1</PageNumber>
-  # 
+  #
   #   <HIT>
   #     <HITId>GBHZVQX3EHXZ2AYDY2T0</HITId>
   #     <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId>
@@ -27,7 +27,7 @@ module RTurk
   #     <NumberOfAssignmentsAvailable>0</NumberOfAssignmentsAvailable>
   #     <NumberOfAssignmentsCompleted>1</NumberOfAssignmentsCompleted>
   #   </HIT>
-  # 
+  #
   #   <HIT>
   #     <HITId>ZZRZPTY4ERDZWJ868JCZ</HITId>
   #     <HITTypeId>NYVZTQ1QVKJZXCYZCZVZ</HITTypeId>
@@ -49,9 +49,9 @@ module RTurk
   #     <NumberOfAssignmentsCompleted>0</NumberOfAssignmentsCompleted>
   #   </HIT>
   # </SearchHITsResult>
-  
+
   class SearchHITsResponse < Response
-    
+
     def hits
       @hits ||= begin
         @xml.xpath('//HIT').inject([]) do |arr, hit_xml|
@@ -59,7 +59,23 @@ module RTurk
         end
       end
     end
-    
+
+    # todo: merge with GetReviewableHITsResponse and GetAssignmentsForHITResponse
+    # todo: test
+    def total_num_results
+      @xml.xpath('//TotalNumResults').inner_text.to_i
+    end
+
+    # todo: test
+    def num_results
+      @xml.xpath('//NumResults').inner_text.to_i
+    end
+
+    # todo: test
+    def page_number
+      @xml.xpath('//PageNumber').inner_text.to_i
+    end
+
   end
-  
-end
+
+end

data/lib/rturk/requester.rb

@@ -66,7 +66,7 @@ module RTurk
           end
         end
 
-        def sign(secret_key, service,method,time)
+        def sign(secret_key, service, method, time)
           msg = "#{service}#{method}#{time}"
           return hmac_sha1(secret_key, msg )
         end

data/lib/rturk/version.rb

@@ -1,3 +1,3 @@
 module RTurk
-  VERSION = "2.10.3"
+  VERSION = "2.11.0"
 end

data/rturk.gemspec

@@ -25,8 +25,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.add_dependency('rest-client', "1.6.7")
-  s.add_dependency('nokogiri', "1.5.10")
+  s.add_dependency('rest-client')
+  s.add_dependency('nokogiri')
+  s.add_dependency('erector')
 
   # Development dependencies
   s.add_development_dependency('rspec', "~> 1.3.1")

data/spec/builders/answer_key_builder_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+require 'rturk/builders/answer_key_builder'
+
+module RTurk
+  describe AnswerKey do
+
+    before(:all) do
+    end
+
+    class SillyAnswerKey < AnswerKey
+      def answer_key_content
+        Question "Why did the chicken cross the road?"
+      end
+    end
+
+    it "is an abstract base class that calls down to 'answer_key_content' in its concrete subclasses" do
+      RTurk::SillyAnswerKey.new.to_xml.should ==
+        "<AnswerKey xmlns=\"#{RTurk::AnswerKey::XMLNS}\">" +
+          "<Question>Why did the chicken cross the road?</Question>" +
+        "</AnswerKey>"
+    end
+
+    # todo: test more
+
+  end
+end

data/spec/builders/{question_spec.rb → external_question_spec.rb}

@@ -1,52 +1,52 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 require 'cgi'
 
-describe RTurk::Question do
-  
+describe RTurk::ExternalQuestion do
+
   before(:all) do
   end
-  
+
   it "should build a question" do
-    question = RTurk::Question.new('http://mpercival.com')
-    question.url.should == 'http://mpercival.com' 
+    question = RTurk::ExternalQuestion.new('http://mpercival.com')
+    question.url.should == 'http://mpercival.com'
     question.frame_height.should == 400
   end
 
   it "should build a question " do
-    question = RTurk::Question.new('http://mpercival.com', :frame_height => 500, :chapter => 1)
+    question = RTurk::ExternalQuestion.new('http://mpercival.com', :frame_height => 500, :chapter => 1)
     question.params[:chapter] = 2
-    question.url.should == 'http://mpercival.com?chapter=2' 
+    question.url.should == 'http://mpercival.com?chapter=2'
     question.frame_height.should == 500
   end
-  
+
   it "should build a question " do
-    question = RTurk::Question.new('http://mpercival.com?myparam=true&anotherparam=12', :frame_height => 500)
+    question = RTurk::ExternalQuestion.new('http://mpercival.com?myparam=true&anotherparam=12', :frame_height => 500)
     question.url.should == 'http://mpercival.com?myparam=true&anotherparam=12'
     question.frame_height.should == 500
   end
-  
+
   it "should build a question with params" do
-    params = RTurk::Question.new('http://google.com/', :id => 'foo').to_params
-    CGI.unescape(params).should == 
+    params = RTurk::ExternalQuestion.new('http://google.com/', :id => 'foo').to_params
+    CGI.unescape(params).should ==
     <<-XML
 <ExternalQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd">
-  <ExternalURL>http://google.com/?id=foo</ExternalURL>	
+  <ExternalURL>http://google.com/?id=foo</ExternalURL>
   <FrameHeight>400</FrameHeight>
 </ExternalQuestion>
     XML
   end
 
   it "should build a question without params" do
-    params = RTurk::Question.new('http://google.com/').to_params
-    CGI.unescape(params).should == 
+    params = RTurk::ExternalQuestion.new('http://google.com/').to_params
+    CGI.unescape(params).should ==
     <<-XML
 <ExternalQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd">
-  <ExternalURL>http://google.com/</ExternalURL>	
+  <ExternalURL>http://google.com/</ExternalURL>
   <FrameHeight>400</FrameHeight>
 </ExternalQuestion>
     XML
   end
-  
-  
-  
-end
+
+
+
+end

data/spec/builders/question_form_builder_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+require 'rturk/builders/question_form_builder'
+
+module RTurk
+  describe QuestionForm do
+
+    before(:all) do
+    end
+
+    it "should build a question, using its xml param as the full QuestionForm since it starts with <QuestionForm" do
+      xml = <<-XML
+      <QuestionForm xmlns="#{RTurk::QuestionForm::XMLNS}">
+      [...]
+      </QuestionForm>
+      XML
+      question = RTurk::QuestionForm.new(:xml => xml)
+      question.to_params.should == xml
+    end
+
+    it "should build a question, using its xml param as the QuestionForm content" do
+      question = RTurk::QuestionForm.new(:xml => "[...]")
+      question.to_params.should ==
+        "<QuestionForm xmlns=\"#{RTurk::QuestionForm::XMLNS}\">[...]</QuestionForm>"
+    end
+
+    class SillyQuestionForm < QuestionForm
+      def question_form_content
+        Question "Why did the chicken cross the road?"
+      end
+    end
+
+    it "is an abstract base class that calls down to 'question_form_content' in its concrete subclasses" do
+      RTurk::SillyQuestionForm.new.to_xml.should ==
+        "<QuestionForm xmlns=\"#{RTurk::QuestionForm::XMLNS}\">" +
+          "<Question>Why did the chicken cross the road?</Question>" +
+        "</QuestionForm>"
+    end
+
+    class AnotherSillyQuestionForm < QuestionForm
+      def question_form_content
+        question {
+          question_content {
+            Text "How many licks?" # note: Text vs text vs text_element gotcha
+          }
+          answer_specification {
+            free_text_answer {
+              constraints {
+                is_numeric true
+              }
+            }
+          }
+        }
+      end
+    end
+
+    it "allows snake_case element names" do
+      RTurk::AnotherSillyQuestionForm.new.to_xml.should ==
+        "<QuestionForm xmlns=\"#{RTurk::QuestionForm::XMLNS}\">" +
+          "<Question>" +
+            "<QuestionContent>" +
+              "<Text>How many licks?</Text>" +
+            "</QuestionContent>" +
+            "<AnswerSpecification>" +
+              "<FreeTextAnswer>" +
+                "<Constraints>" +
+                  "<IsNumeric>true</IsNumeric>" +
+                "</Constraints>" +
+              "</FreeTextAnswer>" +
+            "</AnswerSpecification>" +
+          "</Question>" +
+        "</QuestionForm>"
+    end
+
+  end
+end

data/spec/example_question_form.rb

@@ -0,0 +1,106 @@
+class ExampleQuestionForm < RTurk::QuestionForm
+  def question_form_content
+    Overview do
+      Title do
+        text 'Game 01523, "X" to play'
+      end
+      Text do
+        text 'You are helping to decide the next move in a game of Tic-Tac-Toe.  The board looks like this:'
+      end
+      Binary do
+        MimeType do
+          Type do
+            text 'image'
+          end
+          SubType do
+            text 'gif'
+          end
+        end
+        DataURL do
+          text 'http://tictactoe.amazon.com/game/01523/board.gif'
+        end
+        AltText do
+          text 'The game board, with "X" to move.'
+        end
+      end
+      Text do
+        text 'Player "X" has the next move.'
+      end
+    end
+    Question do
+      QuestionIdentifier do
+        text 'nextmove'
+      end
+      DisplayName do
+        text 'The Next Move'
+      end
+      IsRequired do
+        text 'true'
+      end
+      QuestionContent do
+        Text do
+          text 'What are the coordinates of the best move for player "X" in this game?'
+        end
+      end
+      AnswerSpecification do
+        FreeTextAnswer do
+          Constraints do
+            Length :minLength => '2', :maxLength => '2'
+          end
+          DefaultText do
+            text 'C1'
+          end
+        end
+      end
+    end
+    Question do
+      QuestionIdentifier do
+        text 'likelytowin'
+      end
+      DisplayName do
+        text 'The Next Move'
+      end
+      IsRequired do
+        text 'true'
+      end
+      QuestionContent do
+        Text do
+          text 'How likely is it that player "X" will win this game?'
+        end
+      end
+      AnswerSpecification do
+        SelectionAnswer do
+          StyleSuggestion do
+            text 'radiobutton'
+          end
+          Selections do
+            Selection do
+              SelectionIdentifier do
+                text 'notlikely'
+              end
+              Text do
+                text 'Not likely'
+              end
+            end
+            Selection do
+              SelectionIdentifier do
+                text 'unsure'
+              end
+              Text do
+                text 'It could go either way'
+              end
+            end
+            Selection do
+              SelectionIdentifier do
+                text 'likely'
+              end
+              Text do
+                text 'Likely'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end