rturk 1.0.5 → 2.0.0

data/examples/external_page.rb

@@ -1,33 +0,0 @@
-require '../lib/rturk'
-
-props = {:Title=>"Write a twitter update", 
-         :MaxAssignments=>1, :LifetimeInSeconds=>3600, 
-         :Reward=>{:Amount=>0.10, :CurrencyCode=>"USD"}, 
-         :Keywords=>"twitter, blogging, writing, english", 
-         :Description=>"Simply write a twitter update for me",
-         :RequesterAnnotation=>"OptionalNote",
-         :AssignmentDurationInSeconds=>3600, :AutoApprovalDelayInSeconds=>3600, 
-         :QualificationRequirement=>[{
-           :QualificationTypeId=>"000000000000000000L0", 
-           :IntegerValue=>90, 
-           :Comparator=>"GreaterThan", 
-           :RequiredToPreview=>"false"
-           }]
-        }
-root = File.expand_path(File.dirname(__FILE__))
-aws = YAML.load(File.open(File.join(root, 'mturk.yml')))
-@turk = RTurk::Requester.new(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
-page = RTurk::ExternalQuestionBuilder.build("http://s3.amazonaws.com/mpercival.com/newtweet.html", :id => 'foo')
-
-puts "*" * 80
-puts "This is the XML created for the external page question \n #{page}"
-
-puts "*" * 80
-hit = @turk.create_hit(props, page)
-puts "And the response from CreateHIT operation"
-p hit
-
-puts "*" * 80
-puts "Created a new HIT which can be found at #{@turk.url_for_hit_type(hit['HIT']['HITTypeId'])}"
-
-File.open(File.join(root ,"last_hit"), "w") {|f| f.write(hit['HIT']['HITId']) }

data/lib/rturk/answer.rb

@@ -1,20 +0,0 @@
-module RTurk
-  class Answer
-    
-    def self.parse(xml)
-      answer = XmlSimple.xml_in(xml, {'ForceArray' => false})
-      response = {}
-      answers = answer['Answer']
-      answers = Array.new(1) { answers } unless answers.instance_of? Array
-      answers.each do |a|
-        question = a['QuestionIdentifier']
-        a.delete('QuestionIdentifier')
-        a.each_value do |v|
-          response[question] = v
-        end
-      end
-      response
-    end
-    
-  end
-end

data/lib/rturk/custom_operations.rb

@@ -1,80 +0,0 @@
-module RTurk::CustomOperations
-  # Overides createHIT to allow for easier entry
-  def create_hit(props, page)
-    props = format_props(props)
-    props = props.merge(:Question => page, :Operation => 'CreateHIT')
-    request(props)
-  end
-
-  # Attempt to expire hit, then approve assignments, and finally dispose of
-  def kill_hit(hit_id)
-    forceExpireHIT(:HITId => hit_id)
-    get_assignments_for_hit(hit_id).each do |assignment|
-      approveAssignment(:AssignmentId => assignment[:AssignmentId])
-    end
-    disposeHIT(:HITId => hit_id)
-  end
-
-  # Wipe out all HIT's associated with this account
-  def blank_slate
-    search_response = searchHITs(:PageSize => 100)
-    if search_results = search_response['SearchHITsResult']['HIT']
-      search_results.each do |hit|
-        kill_hit(hit['HITId'])
-      end
-    end
-  end
-
-
-  def get_assignments_for_hit(hit)
-    response = request(:Operation => 'GetAssignmentsForHIT', :HITId => hit)
-    assignments = []
-    if response['GetAssignmentsForHITResult']['Assignment'].instance_of?(Array)
-      response['GetAssignmentsForHITResult']['Assignment'].each do |assignment|
-        answer = RTurk::Answer.parse(assignment['Answer'])
-        assignment.delete('Answer')
-        assignment['Answer'] = answer
-        assignments << assignment
-      end
-    else
-      if assignment = response['GetAssignmentsForHITResult']['Assignment']
-        answer = RTurk::Answer.parse(response['GetAssignmentsForHITResult']['Assignment']['Answer'])
-        assignment.delete('Answer')
-        assignment['Answer'] = answer
-        assignments << assignment
-      end
-    end
-    assignments
-  end
-
-  def url_for_hit(hit_id)
-    url_for_hit_type(getHIT(:HITId => hit_id)[:HITTypeId])
-  end
-
-  def url_for_hit_type(hit_type_id)
-    if @host =~ /sandbox/
-      "http://workersandbox.mturk.com/mturk/preview?groupId=#{hit_type_id}" # Sandbox Url
-    else
-      "http://mturk.com/mturk/preview?groupId=#{hit_type_id}" # Production Url
-    end
-  end
-
-  private
-
-  def format_props(params)
-    reward = params[:Reward]
-    qualifiers = params[:QualificationRequirement]
-    params.delete(:Reward)
-    params.delete(:QualificationRequirement)
-    params.merge!('Reward.1.Amount' => reward[:Amount], 'Reward.1.CurrencyCode' => reward[:CurrencyCode])
-    qualifiers.each_with_index do |qualifier, i|
-      params["QualificationRequirement.#{i+1}.QualificationTypeId"] = qualifier[:QualificationTypeId]
-      params["QualificationRequirement.#{i+1}.Comparator"] = qualifier[:Comparator]
-      params["QualificationRequirement.#{i+1}.IntegerValue"] = qualifier[:IntegerValue] if qualifier[:IntegerValue]
-      params["QualificationRequirement.#{i+1}.LocaleValue.Country"] = qualifier[:Country] if qualifier[:Country]
-      params["QualificationRequirement.#{i+1}.RequiredToPreview"] = qualifier[:RequiredToPreview]
-    end
-    params
-  end
-
-end

data/lib/rturk/external_question_builder.rb

@@ -1,22 +0,0 @@
-module RTurk
-  class ExternalQuestionBuilder
-    
-    
-    def self.build(url, opts = {})
-      frame_height = opts[:frame_height] || 400
-      opts.delete(:frame_height)
-      querystring = opts.collect { |key, value| [CGI.escape(key.to_s), CGI.escape(value.to_s)].join('=') }.join('&')
-      url = opts.empty? ? url : "#{url}?#{querystring}"
-      xml = <<-XML
-<ExternalQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd">
-	<ExternalURL>#{url}</ExternalURL>	
-	<FrameHeight>#{frame_height}</FrameHeight>
-</ExternalQuestion>
-      XML
-      xml
-    end
-    
-  end
-  
-  
-end

data/spec/answer_spec.rb

@@ -1,24 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-
-describe RTurk::Answer do
-  
-  before(:all) do
-    @answer =  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
-    <QuestionFormAnswers xmlns=\"http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd\">
-    <Answer>\n<QuestionIdentifier>tweet</QuestionIdentifier>\n<FreeText>Spec example</FreeText>\n</Answer>
-    <Answer>\n<QuestionIdentifier>Submit</QuestionIdentifier>\n<FreeText>Submit</FreeText>\n</Answer>
-    <Answer>\n<QuestionIdentifier>Foo</QuestionIdentifier>\n<RandomSelector>Bar</RandomSelector>\n</Answer>
-    </QuestionFormAnswers>\n"
-    @answer2 = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
-    <QuestionFormAnswers xmlns=\"http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2005-10-01/QuestionFormAnswers.xsd\">
-    <Answer>\n<QuestionIdentifier>tweet</QuestionIdentifier>\n<FreeText>Spec example</FreeText>\n</Answer>
-    </QuestionFormAnswers>\n"
-  end
-  
-  it "should parse an answer" do
-    RTurk::Answer.parse(@answer).should == {'Submit' => 'Submit', 'tweet' => 'Spec example', 'Foo' => 'Bar'}
-    RTurk::Answer.parse(@answer2).should == {'tweet' => 'Spec example'}
-  end
-  
-end

data/spec/external_question_spec.rb

@@ -1,27 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-
-describe RTurk::ExternalQuestionBuilder do
-
-  
-  it "should build a question with params" do
-    RTurk::ExternalQuestionBuilder.build('http://google.com/', :id => 'foo').should == 
-    <<-XML
-<ExternalQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd">
-	<ExternalURL>http://google.com/?id=foo</ExternalURL>	
-	<FrameHeight>400</FrameHeight>
-</ExternalQuestion>
-    XML
-  end
-  
-  it "should build a question without params" do
-    RTurk::ExternalQuestionBuilder.build('http://google.com/').should == 
-    <<-XML
-<ExternalQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2006-07-14/ExternalQuestion.xsd">
-	<ExternalURL>http://google.com/</ExternalURL>	
-	<FrameHeight>400</FrameHeight>
-</ExternalQuestion>
-    XML
-  end
-  
-end