rturk 2.10.3 → 2.11.0

data/spec/example_question_form.xml

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

data/spec/operations/create_hit_spec.rb

@@ -12,20 +12,37 @@ describe "using mechanical turk with RTurk" do
 
   it "should let me build and send a hit" do
     hit = RTurk::CreateHIT.new(:title => "Look at some pictures from 4Chan") do |hit|
-      hit.assignments = 5
+      hit.max_assignments = 5
       hit.description = 'blah'
       hit.question("http://mpercival.com", :frame_height => 600)
       hit.reward = 0.05
       hit.qualifications.add :approval_rate, {:gt => 80}
     end
-    hit.assignments.should eql(5)
+    hit.max_assignments.should eql(5)
+    response = hit.request
+    response.hit_id.should_not be_nil
+  end
+
+  it "should fail if I don't provide required params" do
+    lambda do
+      hit = RTurk::CreateHIT.new(:title => "Look at some pictures from 4Chan")
+      hit.request
+    end.should raise_error "Parameters: 'description, reward, question'"  # Rspec is being too clever here
+  end
+
+  it "should let me build and send a hit with mostly default values" do
+    hit = RTurk::CreateHIT.new(:title => "Look at some pictures from 4Chan") do |hit|
+      hit.description = 'blah'
+      hit.question("http://mpercival.com", :frame_height => 600)
+      hit.reward = 0.05
+    end
     response = hit.request
     response.hit_id.should_not be_nil
   end
 
   it "should let me create a hit" do
     response = RTurk::CreateHIT(:title => "Look at some pictures from 4Chan") do |hit|
-      hit.assignments = 5
+      hit.max_assignments = 5
       hit.description = 'blah'
       hit.question("http://mpercival.com", :test => 'b')
       hit.reward = 0.05
@@ -37,7 +54,7 @@ describe "using mechanical turk with RTurk" do
   it "should let me create a hit with just option arguments" do
     hit = RTurk::CreateHIT.new(:title => "Look at some pictures from 4Chan",
                                :description => "Pics from the b-tards",
-                               :assignments => 5,
+                               :max_assignments => 5,
                                :reward => nil,
                                :question => 'http://mpercival.com?picture=1',
                                :qualifications => [
@@ -45,14 +62,14 @@ describe "using mechanical turk with RTurk" do
                                  [:adult, true]
                                ]
                                )
-    hit.assignments.should eql(5)
+    hit.max_assignments.should eql(5)
     hit.qualifications.qualifications.size.should eql(2)
     lambda{hit.request}.should raise_error RTurk::MissingParameters
   end
 
   it "should rerturn a CreateHITResponse after the request" do
     response = RTurk::CreateHIT(:title => "Look at some pictures from 4Chan") do |hit|
-      hit.assignments = 5
+      hit.max_assignments = 5
       hit.description = "foo"
       hit.question("http://mpercival.com", :test => 'b')
       hit.reward = 0.05
@@ -63,4 +80,14 @@ describe "using mechanical turk with RTurk" do
     response.type_id.should == 'NYVZTQ1QVKJZXCYZCZVZ'
   end
 
+  it "should let me build and send a hit with an internal question" do
+    hit = RTurk::CreateHIT.new(:title => "Who is your favorite Beatle?") do |hit|
+      hit.description = 'blah'
+      hit.reward = 0.05
+      hit.question_form ExampleQuestionForm.new
+    end
+    response = hit.request
+    response.hit_id.should_not be_nil
+  end
+
 end

data/spec/requester_spec.rb

@@ -13,6 +13,14 @@ describe RTurk::Requester do
     RTurk::Requester.request(:Operation => 'GetHIT', 'HITId' => 'test')
   end
 
+  it "should use UTC and ISO8601 format for the timestamp" do
+    now = Time.now
+    utc = now.utc
+    Time.should_receive(:now).and_return(now)  # freeze time for a moment
+    RestClient.should_receive(:post).with(/amazonaws/, /Timestamp=#{CGI.escape(utc.iso8601)}/)
+    RTurk::Requester.request(:Operation => 'GetHIT', 'HITId' => 'test')
+  end
+
   it "should build a correct querystring with one value per key" do
     params = {
       :Operation => 'GetHIT',

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 SPEC_ROOT = File.expand_path(File.dirname(__FILE__)) unless defined? SPEC_ROOT
 $: << SPEC_ROOT
-$: << File.join(File.dirname(__FILE__), '..', 'lib')
+$: << File.join(SPEC_ROOT, '..', 'lib')
+
 require 'rubygems'
 require 'spec'
 require 'yaml'
@@ -35,3 +36,5 @@ end
 Spec::Runner.configure do |config|
 
 end
+
+require 'example_question_form'

metadata

@@ -1,15 +1,9 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rturk
-version: !ruby/object:Gem::Version 
-  hash: 33
-  prerelease: 
-  segments: 
-  - 2
-  - 10
-  - 3
-  version: 2.10.3
+version: !ruby/object:Gem::Version
+  version: 2.11.0
 platform: ruby
-authors: 
+authors:
 - Mark Percival
 - Zach Hale
 - David Balatero
@@ -17,112 +11,117 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-08-19 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 6
-        - 7
-        version: 1.6.7
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 5
-        - 10
-        version: 1.5.10
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: erector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 1
-        - 3
-        - 1
+      - !ruby/object:Gem::Version
         version: 1.3.1
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: mk@mdp.im
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.markdown
-files: 
+files:
 - .gitignore
 - .gitmodules
+- .rspec
 - .travis.yml
 - .yardoc
 - CHANGELOG.markdown
@@ -228,10 +227,12 @@ files:
 - lib/rturk/adapters/assignment.rb
 - lib/rturk/adapters/hit.rb
 - lib/rturk/adapters/worker.rb
+- lib/rturk/builders/answer_key_builder.rb
+- lib/rturk/builders/external_question_builder.rb
 - lib/rturk/builders/notification_builder.rb
 - lib/rturk/builders/qualification_builder.rb
 - lib/rturk/builders/qualifications_builder.rb
-- lib/rturk/builders/question_builder.rb
+- lib/rturk/builders/question_form_builder.rb
 - lib/rturk/errors.rb
 - lib/rturk/logger.rb
 - lib/rturk/macros.rb
@@ -299,10 +300,14 @@ files:
 - rturk.gemspec
 - spec/adapters/assignment_spec.rb
 - spec/adapters/hit_spec.rb
+- spec/builders/answer_key_builder_spec.rb
+- spec/builders/external_question_spec.rb
 - spec/builders/notification_builder_spec.rb
 - spec/builders/qualification_spec.rb
 - spec/builders/qualifications_spec.rb
-- spec/builders/question_spec.rb
+- spec/builders/question_form_builder_spec.rb
+- spec/example_question_form.rb
+- spec/example_question_form.xml
 - spec/fake_responses/approve_assignment.xml
 - spec/fake_responses/approve_rejected_assignment.xml
 - spec/fake_responses/assign_qualification.xml
@@ -384,39 +389,27 @@ files:
 - spec/spec_helper.rb
 - spec/tmp
 - spec/xml_parse_spec.rb
-has_rdoc: true
 homepage: http://github.com/mdp/rturk
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: pulley
-rubygems_version: 1.6.2
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Mechanical Turk API Wrapper
 test_files: []
-