RubyGems - markpercival-rturk - Versions diffs - 1.0.2 → 1.0.3 - Mend

markpercival-rturk 1.0.2 → 1.0.3

Files changed (20) hide show

data/.gitignore +3 -0
data/LICENSE +20 -0
data/VERSION +1 -0
data/examples/blank_slate.rb +6 -0
data/examples/external_page.rb +33 -0
data/examples/mturk.sample.yml +8 -0
data/examples/newtweet.html +91 -0
data/examples/review_answer.rb +8 -0
data/lib/rturk/answer.rb +18 -0
data/lib/rturk/custom_operations.rb +80 -0
data/lib/rturk/external_question_builder.rb +22 -0
data/lib/rturk/requester.rb +90 -0
data/lib/rturk/utilities.rb +17 -0
data/lib/rturk.rb +11 -0
data/spec/answer_spec.rb +19 -0
data/spec/external_question_spec.rb +27 -0
data/spec/mturk.sample.yml +8 -0
data/spec/requester_spec.rb +28 -0
data/spec/spec_helper.rb +9 -0
metadata +41 -34

data/.gitignore ADDED Viewed

@@ -0,0 +1,3 @@
+mturk.yml
+*.gem
+examples/last_hit

data/LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark Percival
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 1.0.3

data/examples/blank_slate.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require '../lib/rturk'
+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)
+@turk.blank_slate

data/examples/external_page.rb ADDED Viewed

@@ -0,0 +1,33 @@
+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/examples/mturk.sample.yml ADDED Viewed

@@ -0,0 +1,8 @@
+# Your AWSAccessKeyId ( leave commented to use global default )
+AWSAccessKeyId: 01234567890ABCD
+# Your AWSAccessKey ( leave commented to use global default )
+AWSAccessKey: SECRETKEYSECRETKEY
+# Host to talk to ( Prod or Sandbox )
+Host: Sandbox

data/examples/newtweet.html ADDED Viewed

@@ -0,0 +1,91 @@
+<!-- This file needs to be hosted on an external server.  -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+  <title>Title, an XHTML requirement. This message brought to you by the W3C</title>
+  <script type='text/javascript'>
+  /*<![CDATA[*/
+  //
+  // This method Gets URL Parameters (GUP)
+  //
+  function gup( name )
+  {
+    var regexS = "[\\?&]"+name+"=([^&#]*)";
+    var regex = new RegExp( regexS );
+    var tmpURL = window.location.href;
+    var results = regex.exec( tmpURL );
+    if( results == null )
+      return "";
+    else
+      return results[1];
+  }
+  //
+  // This method decodes the query parameters that were URL-encoded
+  //
+  function decode(strToDecode)
+  {
+    var encoded = strToDecode;
+    return unescape(encoded.replace(/\+/g,  " "));
+  }
+  function lengthCheck()
+  {
+    if (document.getElementById('tweet').value.length > 120) {
+      alert("Must be less than 140 characters! Currently " + document.getElementById('tweet').value.length);
+      return false;
+    }
+  }
+  /*]]>*/
+  </script>
+</head>
+<body>
+<form id="mturk_form" method="post" action="http://www.mturk.com/mturk/externalSubmit" onSubmit="return lengthCheck()">
+<input type="hidden" id="assignmentId" name="assignmentId" value="" />
+<h1>Help me write a clever twitter update</h1>
+<p />
+<h2>Criteria</h2>
+<ul>
+  <li>You should be familiar with Twitter and microblogging</li>
+  <li>MUST BE LESS THAN 120 CHARACTERS</li>
+  <li>Could be about an interesting topic or current event</li>
+  <li>Could also make up something about what I'm currently doing</li>
+  <li>Should not be vulgar or crass</li>
+  <li>Should fool people into thinking I am clever and witty</li>
+</ul>
+<textarea rows="4" cols="40" tabindex="1" autocomplete="off" name="tweet" id="tweet"></textarea>
+<p/>
+<input id="submitButton" type="submit" name="Submit" value="Submit" />
+<p/>
+</form>
+<script type='text/javascript'>
+    /*<![CDATA[*/
+    document.getElementById('assignmentId').value = gup('assignmentId');
+    //
+    // Check if the worker is PREVIEWING the HIT or if they've ACCEPTED the HIT
+    //
+    if (gup('assignmentId') == "ASSIGNMENT_ID_NOT_AVAILABLE")
+    {
+      // If we're previewing, disable the button and give it a helpful message
+      document.getElementById('submitButton').disabled = true;
+      document.getElementById('submitButton').value = "You must ACCEPT the HIT before you can submit the results.";
+    } else {
+        var form = document.getElementById('mturk_form');
+        if (document.referrer && ( document.referrer.indexOf('workersandbox') != -1) ) {
+            form.action = "http://workersandbox.mturk.com/mturk/externalSubmit";
+        }
+    }
+    /*]]>*/
+</script>
+</body>
+</html>

data/examples/review_answer.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require '../lib/rturk'
+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)
+last_hit = File.open(File.join(root, 'last_hit'), 'r').read
+p @turk.getAssignmentsForHIT(:HITId => last_hit)

data/lib/rturk/answer.rb ADDED Viewed

@@ -0,0 +1,18 @@
+module RTurk
+  class Answer
+    def self.parse(xml)
+      answer = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      response = {}
+      answer['Answer'].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 ADDED Viewed

@@ -0,0 +1,80 @@
+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]
+      params["QualificationRequirement.#{i+1}.RequiredToPreview"] = qualifier[:RequiredToPreview]
+      params["QualificationRequirement.#{i+1}.Locale"] = qualifier[:Locale]
+    end
+    params
+  end
+end

data/lib/rturk/external_question_builder.rb ADDED Viewed

@@ -0,0 +1,22 @@
+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/lib/rturk/requester.rb ADDED Viewed

@@ -0,0 +1,90 @@
+require 'rubygems'
+require 'cgi'
+require 'digest/sha1'
+require 'base64'
+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 )
+    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

data/lib/rturk/utilities.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module RTurk::Utilities
+  def camelize(phrase)
+    phrase.gsub!(/^[a-z]|\_+[a-z]/) { |a| a.upcase }
+    phrase.gsub!(/\_/, '')
+    return phrase
+  end
+  def stringify_keys(ahash)
+    ahash = ahash.inject({}) do |options, (key, value)|
+      options[(key.to_s rescue key) || key] = value
+      options
+    end
+    ahash
+  end
+end

data/lib/rturk.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module RTurk
+end
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'rturk/utilities'
+require 'rturk/custom_operations'
+require 'rturk/answer'
+require 'rturk/external_question_builder'
+require 'rturk/requester'

data/spec/answer_spec.rb ADDED Viewed

@@ -0,0 +1,19 @@
+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"
+  end
+  it "should parse an answer" do
+    RTurk::Answer.parse(@answer).should == {'Submit' => 'Submit', 'tweet' => 'Spec example', 'Foo' => 'Bar'}
+  end
+end

data/spec/external_question_spec.rb ADDED Viewed

@@ -0,0 +1,27 @@
+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

data/spec/mturk.sample.yml ADDED Viewed

@@ -0,0 +1,8 @@
+# Your AWSAccessKeyId ( leave commented to use global default )
+AWSAccessKeyId: 0000000000000000000000S
+# Your AWSAccessKey ( leave commented to use global default )
+AWSAccessKey: YOURSECRETACCESSKEYGOESHERE
+# Host to talk to ( Prod or Sandbox )
+Host: Sandbox

data/spec/requester_spec.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/spec_helper'
+describe RTurk::Requester do
+  before(:all) do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    @turk = RTurk::Requester.new(aws['AWSAccessKeyId'], aws['AWSAccessKey'], :sandbox => true)
+  end
+  it "should perform raw operations" do
+    @turk.request(:Operation => 'GetHIT', 'HITId' => 'test')['HIT']['Request'].include?('Errors').should be_true
+  end
+  it "should also interpret methods as operations" do
+    @turk.getHIT(:HITId => 'test')
+  end
+  it "should return its environment" do
+    @turk.environment.should == 'sandbox'
+  end
+  it "should return its environment as production, the default" do
+    aws = YAML.load(File.open(File.join(SPEC_ROOT, 'mturk.yml')))
+    @turk = RTurk::Requester.new(aws['AWSAccessKeyId'], aws['AWSAccessKey'])
+    @turk.environment.should == 'production'
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,9 @@
+require 'spec'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rturk'
+Spec::Runner.configure do |config|
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markpercival-rturk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Mark Percival
@@ -9,44 +9,45 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-06-20 00:00:00 -07:00
+date: 2009-07-09 00:00:00 -07:00
 default_executable:
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  type: :runtime
-  version_requirement:
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: "0.9"
-    version:
-- !ruby/object:Gem::Dependency
-  name: xml-simple
-  type: :runtime
-  version_requirement:
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.12
-    version:
-description: Mechanical Turk API wrapper - super simple
-email: mark@markpercival.us
+dependencies: []
+description:
+email: mark@mpercival.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
 files:
+- .gitignore
 - README.markdown
-has_rdoc: false
+- VERSION
+- examples/blank_slate.rb
+- examples/external_page.rb
+- examples/mturk.sample.yml
+- examples/newtweet.html
+- examples/review_answer.rb
+- lib/rturk.rb
+- lib/rturk/answer.rb
+- lib/rturk/custom_operations.rb
+- lib/rturk/external_question_builder.rb
+- lib/rturk/requester.rb
+- lib/rturk/utilities.rb
+- spec/answer_spec.rb
+- spec/external_question_spec.rb
+- spec/mturk.sample.yml
+- spec/requester_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+has_rdoc: true
 homepage: http://github.com/markpercival/rturk
 post_install_message:
-rdoc_options: []
+rdoc_options:
+- --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -59,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: "1.3"
+      version: "0"
   version:
 requirements: []
@@ -67,6 +68,12 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key:
 specification_version: 2
-summary: simple Twitter API wrapper
-test_files: []
+summary: Mechanical Turk API Wrapper
+test_files:
+- spec/answer_spec.rb
+- spec/external_question_spec.rb
+- spec/requester_spec.rb
+- spec/spec_helper.rb
+- examples/blank_slate.rb
+- examples/external_page.rb
+- examples/review_answer.rb