mturk 1.8.1

data/lib/amazon/webservices/util/request_signer.rb

@@ -0,0 +1,42 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+require 'base64'
+require 'digest/sha1'
+
+module Amazon
+module WebServices
+module Util
+
+module RequestSigner
+
+  def RequestSigner.sign(service,method,time,key)
+    msg = "#{service}#{method}#{time}"
+    return hmac_sha1( key, msg )
+  end
+
+
+  private
+
+  def RequestSigner.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 # Amazon::MTS::Util::RequestSigner
+end # Amazon::MTS::Util
+end # Amazon::MTS
+end # Amazon

data/lib/amazon/webservices/util/rest_transport.rb

@@ -0,0 +1,120 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+require 'cgi'
+require 'net/https'
+require 'rubygems'
+require 'nokogiri'
+require 'amazon/webservices/util/xml_simplifier'
+
+module Amazon
+module WebServices
+module Util
+
+class RESTTransport
+
+  REQUIRED_PARAMETERS = [:Endpoint]
+
+  def self.canPost?
+    Net::HTTP.respond_to? :post_form
+  end
+
+  def initialize( args )
+    missing_parameters = REQUIRED_PARAMETERS - args.keys
+    raise "Missing paramters: #{missing_parameters.join(',')}" unless missing_parameters.empty?
+    @uri = URI.parse( args[:Endpoint] )
+    @httpMethod = resolveHTTPMethod( args[:RestStyle] )
+    @version = args[:Version]
+    @ssl = (@uri.scheme == 'https') || (@uri.port == 443) || args[:UseSSL]
+    @skip_ssl_verify = args[:SkipSSLCheck]
+
+    agent = ::MTurk::agent( args[:SoftwareName] )
+    @headers = {
+      'User-Agent' => agent,
+      'X-Amazon-Software' => agent,
+      'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8',
+    }
+  end
+
+  def resolveHTTPMethod( method )
+    case method.to_s.upcase
+    when "GET"
+      return :GET
+    when "POST"
+      raise "Your version of Ruby does not support HTTP Post" unless RESTTransport.canPost?
+      return :POST
+    else
+      return ( RESTTransport.canPost? ? :POST : :GET )
+    end
+  end
+
+  def method_missing( method, *args )
+    params = { :Operation => method, :Version => @version }
+    params.merge!( args[0].delete( :Request )[0] )
+    params.merge!( args[0] )
+
+    http = Net::HTTP.new( @uri.host, @uri.port )
+    if @ssl
+      http.use_ssl = true
+      if @skip_ssl_verify
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      else
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+    end
+
+    req = nil
+    if @httpMethod == :GET
+      req = Net::HTTP::Get.new( @uri.request_uri + toQueryString(params), @headers )
+    else
+      req = Net::HTTP::Post.new( @uri.request_uri, @headers )
+      req.form_data = toPostParams( params )
+      req['Content-Type'] = @headers['Content-Type'] # necessary because req.form_data resets Content-Type header
+    end
+
+    res = http.start { |conn|
+      conn.request(req)
+    }.body
+
+    xml = Nokogiri::XML( res )
+    XMLSimplifier.simplify xml
+  end
+
+  private
+
+  def toQueryString(params)
+    queryString = ""
+    each_http_param(params) { |key,value|
+      queryString << ( '&' + key + '=' + CGI.escape(value) )
+    }
+    return queryString
+  end
+
+  def toPostParams(params)
+    postParams = {}
+    each_http_param(params) { |key,value|
+      postParams[key] = value }
+    return postParams
+  end
+
+  def each_http_param(params,&block)
+    params.each {|k,v| each_http_param_helper( k, v, false, &block ) unless v.nil? }
+  end
+
+  def each_http_param_helper(key,value,num=false,&block)
+    key = key.to_s
+    case value.class.to_s
+    when 'Array'
+      value.each_with_index { |v,i| each_http_param_helper( "#{key}.#{i+1}", v, true, &block ) unless v.nil? }
+    when 'Hash'
+      value.each { |k,v| each_http_param_helper( "#{key}#{num ? '.' : '.1.'}#{k}", v, false, &block ) unless v.nil? }
+    else
+      yield key, value.to_s
+    end
+  end
+
+end # RESTTransport
+
+end # Amazon::WebServices::Util
+end # Amazon::WebServices
+end # Amazon

data/lib/amazon/webservices/util/soap_simplifier.rb

@@ -0,0 +1,48 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+module Amazon
+module WebServices
+module Util
+
+class SOAPSimplifier
+
+  # simplify(item) -- convert a soap object into a simple nested hash
+  def self.simplify(item)
+    case item.class.to_s
+    when 'SOAP::Mapping::Object'
+      simple = {}
+      item.__xmlattr.each {|name,at| simple["*#{name}*"] = simplify(at)}
+      item.__xmlele.each { |element|
+        # element consists of a QName and a payload
+        name = element[0].name
+        payload = simplify(element[1])
+        simple[name.to_sym] = payload
+      }
+      simple
+    when 'Array'
+      item.collect {|i| simplify(i) }
+    else
+      str = item.to_s
+      case str
+      when /^(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)Z$/
+        Time.gm($1,$2,$3,$4,$5,$6)
+      when /^\d+$/
+        if str.to_i.to_s == str
+          str.to_i
+        else
+          str
+        end
+      when /^\d+\.\d+$/
+        str.to_f
+      else
+        str
+      end
+    end
+  end
+
+end # Amazon::WebServices::Util::SoapSimplifier
+
+end # Amazon::WebServices::Util
+end # Amazon::WebServices
+end # Amazon

data/lib/amazon/webservices/util/soap_transport.rb

@@ -0,0 +1,20 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+module Amazon
+module WebServices
+module Util
+
+class SOAPTransport
+
+  def initialize(args)
+    raise 'SOAP no longer supported'
+  end
+
+  def self.canSOAP? ; false ; end
+
+end # SOAPTransport
+
+end # Amazon::WebServices::Util
+end # Amazon::WebServices
+end # Amazon

data/lib/amazon/webservices/util/soap_transport_header_handler.rb

@@ -0,0 +1,27 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+require 'soap/header/simplehandler.rb'
+require 'xsd/qname.rb'
+
+module Amazon
+module WebServices
+module Util
+
+class SOAPTransportHeaderHandler < SOAP::Header::SimpleHandler
+
+  def initialize(ns, tag, value)
+    super(XSD::QName.new(ns, tag))
+    @tag = tag
+    @value = value
+  end
+
+  def on_simple_outbound
+    @value
+  end
+
+end # SOAPTransportHeaderHandler
+
+end # Amazon::WebServices::Util
+end # Amazon::WebServices
+end # Amazon

data/lib/amazon/webservices/util/unknown_result_exception.rb

@@ -0,0 +1,27 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+module Amazon
+module WebServices
+module Util
+
+# This exception is thrown when we don't know if a service call succeeded or not
+class UnknownResultException < RuntimeError
+
+  attr_reader :method, :args, :exception
+
+  def initialize( exception, method, args={} )
+    @method = method
+    @args = args
+    @exception = exception
+  end
+
+  def to_s
+    "UnknownResultException: got #{@exception} calling #{@method}"
+  end
+
+end
+
+end # Amazon::WebServices::Util
+end # Amazon::WebServices
+end # Amazon

data/lib/amazon/webservices/util/validation_exception.rb

@@ -0,0 +1,55 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+module Amazon
+module WebServices
+module Util
+
+class ValidationException < RuntimeError
+
+  attr_reader :message, :description, :result
+
+  def initialize( result, message=nil )
+    @result = result
+
+    @message = [
+      message,
+      get_nested_key( result, :OperationRequest, :Errors, :Error, :Code ),
+      get_nested_key( result, :Request, :Errors, :Error, :Code ),
+      get_nested_key( result, :Errors, :Error, :Code ),
+    ].detect { |v| !v.nil? }
+
+    @description = [
+      get_nested_key( result, :OperationRequest, :Errors, :Error, :Message ),
+      get_nested_key( result, :Request, :Errors, :Error, :Message ),
+      get_nested_key( result, :Errors, :Error, :Message ),
+    ].detect { |v| !v.nil? }
+
+  end
+
+  def to_s
+    "ValidationException: #{message}"
+  end
+
+  private
+
+  def get_nested_key( hash, *keys )
+    return nil unless hash.kind_of?(Hash)
+    result = hash
+    if hash.key? keys.first
+      keys.each do |key|
+        return nil unless result.kind_of?(Hash)
+        result = result[key]
+      end
+      return result
+    else
+      nested = hash.collect { |k,v| get_nested_key( v, *keys ) }
+      return ([nested].flatten - [nil]).first
+    end
+  end
+
+end
+
+end # Amazon::WebServices::Util
+end # Amazon::WebServices
+end # Amazon

data/lib/amazon/webservices/util/xml_simplifier.rb

@@ -0,0 +1,61 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+require 'rexml/document'
+
+module Amazon
+module WebServices
+module Util
+
+class XMLSimplifier
+
+  # simplify(xml) -- convert an xml document into a simple nested hash
+  def self.simplify(xml)
+    case xml.class.to_s
+    when /Text/
+      {}
+    when /Document/
+      xml.root.children.inject({}) {|data,child| self.merge( data, simplify(child) ) }
+    when /Element/
+      if xml.children.size > 1 || xml.children.first.class.to_s !~ /Text/
+        value = xml.children.inject({}) { |data,child| self.merge( data, simplify(child) ) }
+        { xml.name.to_sym => value }
+      else
+        str = xml.text
+        value = case str
+        when /^(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)Z$/
+          Time.gm($1,$2,$3,$4,$5,$6)
+        when /^-?\d+$/
+          if str.to_i.to_s == str
+            str.to_i
+          else
+            str
+          end
+        when /^-?\d+\.\d+$/
+          str.to_f
+        else
+          str
+        end
+        { xml.name.to_sym => value }
+      end
+    else
+      raise "XMLSimplifier -- failed to simplify: #{xml.inspect}"
+    end
+  end
+
+  def self.merge(hash1, hash2)
+    hash2.each_key { |key|
+      if hash1[key]
+        hash1[key] = [hash1[key], hash2[key]].flatten
+      else
+        hash1[key] = hash2[key]
+      end
+    }
+    hash1
+  end
+
+end # Amazon::WebServices::Util::XMLSimplifier
+
+end # Amazon::WebServices::Util
+end # Amazon::WebServices
+end # Amazon

data/lib/mturk.rb

@@ -0,0 +1,19 @@
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+require 'mturk/version'
+
+module MTurk
+
+  def self.agent(software_name="")
+    version = "ruby-mturk/#{MTurk::VERSION}"
+    if software_name.to_s == ""
+      version
+    else
+      "#{version} #{software_name}"
+    end
+  end
+
+end
+
+require 'amazon/webservices/mechanical_turk_requester'

data/lib/mturk/version.rb

@@ -0,0 +1,6 @@
+# Copyright:: Copyright (c) 2007-2015 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+module MTurk
+  VERSION = '1.8.1'.freeze
+end

data/run_rcov.sh

@@ -0,0 +1 @@
+find test/ -iname '*.rb' | xargs rcov -Ilib -t 

data/samples/best_image/BestImage.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+# Copyright:: Copyright (c) 2007 Amazon Technologies, Inc.
+# License::   Apache License, Version 2.0
+
+begin ; require 'rubygems' ; rescue LoadError ; end
+
+# The Best Image sample application will create a HIT asking a worker
+# to choose the best of three images, given a set of criteria.
+#
+# The following concepts are covered:
+# - Using the <FormattedContent> functionality in QuestionForm
+# - File-based QuestionForm and HIT properties HIT loading
+# - Using a basic system qualification
+
+require 'mturk'
+@mturk = Amazon::WebServices::MechanicalTurkRequester.new :Host => :Sandbox
+
+# Use this line instead if you want to talk to Prod
+#@mturk = Amazon::WebServices::MechanicalTurkRequester.new :Host => :Production
+
+
+# Check to see if your account has sufficient funds
+def hasEnoughFunds?
+  available = @mturk.availableFunds
+  puts "Got account balance: %.2f" % available
+  return available > 0.055
+end
+
+def getHITUrl( hitTypeId )
+  if @mturk.host =~ /sandbox/
+    "http://workersandbox.mturk.com/mturk/preview?groupId=#{hitTypeId}" # Sandbox Url
+  else
+    "http://mturk.com/mturk/preview?groupId=#{hitTypeId}" # Production Url
+  end
+end
+
+# Create the BestImage HIT
+def createBestImage
+
+  # Defining the location of the file containing the QuestionForm and the properties of the HIT
+  rootDir = File.dirname $0;
+  questionFile = rootDir + "/best_image.question";
+  propertiesFile = rootDir + "/best_image.properties";
+
+  # Loading configuration properties from a HIT properties file.
+  # In this sample, the qualification is defined in the properties file.
+  props = Amazon::Util::DataReader.load( propertiesFile, :Properties )
+  props[:Reward] = { :Amount => 0.05, :CurrencyCode => 'USD'}
+  # Loading the question (QuestionForm) file.
+  question = File.read( questionFile )
+  # no validation
+  result = @mturk.createHIT( {:Question => question}.merge(props) )
+  puts "Created HIT: #{result[:HITId]}"
+  puts "Url: #{getHITUrl( result[:HITTypeId] )}"
+
+  # save the HIT Id to a file so we don't lose it...
+  Amazon::Util::DataReader.save( File.join( rootDir, "hits_created" ), [{:HITId => result[:HITId] }], :Tabular )
+end
+
+createBestImage if hasEnoughFunds?