kempelen 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0019e4a7473ffb6cdc3f9690ead7c38798595428
-  data.tar.gz: 11ba138ac706191202d17bf67501155165b8453f
+  metadata.gz: d2bdc0755db7490260e513d2822a15b02bbbd079
+  data.tar.gz: c3a7c293995763cbd61561e1b85b37bac6083eda
 SHA512:
-  metadata.gz: b9ef9fe82a4f029127bc964cc8e4d20216f493ad2ae5f08fe3d09fb8a293ea54593035db3ab671265bcf47ad3d0fa4f9810273d6e882ff8e0804790dce8cd825
-  data.tar.gz: d33a443095ee2de4501456bde4c44c69ea4e266443e25a99b8c081c7bf09ddfe3efc9b260967646f71170a87af2212a605156a38f19a3df93d631f6c10839dad
+  metadata.gz: c87d9d47d4c4022c629e05e4366fb58d405e15872b1d2117e8b6a3a0d996a27172e2a21daffd8a8e30aa0a584bbb42ac6a8bb9f38d4bf7451e0648aeb6629481
+  data.tar.gz: 72d675d6293cfe78fac9447cc27443d4d11b40eb7afe0dab1771147b299da09eb6dd20bc6bcb5b270a69c6e940e7a2b6437c7cbb884c49b369627099ecd78258

data/examples/get_hit.rb

@@ -9,7 +9,8 @@ if ARGV.length < 3
   exit
 end
 
-@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :production)
+@client.debug_output = $stdout
 @operation = Kempelen::API::Operations::GetHit.new(@client, ARGV[2])
 
 get_hit_response = @operation.perform_operation

data/examples/notify_workers.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'kempelen'
+require 'httparty'
+
+if ARGV.length < 3
+  puts "notify_workers.rb <ACCESS_KEY> <SECRET_KEY> <WORKER_ID> <SUBJECT> <MESSAGE>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@operation = Kempelen::API::Operations::NotifyWorkers.new(@client, [ARGV[2]], "Test Message", "This is a test message")
+
+result = @operation.perform_operation
+puts result.inspect

data/kempelen.gemspec

@@ -24,12 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "httparty", "~> 0.13.6"
 
   spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 11.1"
   spec.add_development_dependency "minitest", "~> 5.8.0"
   spec.add_development_dependency "minitest-reporters", "~> 1.1.6"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-minitest"
   spec.add_development_dependency "coveralls"
 end

data/lib/kempelen.rb

@@ -29,6 +29,7 @@ require "kempelen/API/operations/reject_assignment"
 require "kempelen/API/operations/get_assignments_for_hit"
 require "kempelen/API/operations/set_hit_as_reviewing"
 require "kempelen/API/operations/register_hit_type"
+require "kempelen/API/operations/notify_workers"
 
 module Kempelen
   # Your code goes here...

data/lib/kempelen/API/client.rb

@@ -10,6 +10,9 @@ module Kempelen
       # Mechanical Turk environment to make API calls to - defaults to :production.
       attr_reader :environment
 
+      # HTTParty debug options
+      attr_accessor :debug_output
+
       # URLs for Mechanical Turk APIs, indexed by environment.
       SERVICE_URLS = {
         sandbox: 'https://mechanicalturk.sandbox.amazonaws.com'.freeze,
@@ -24,6 +27,7 @@ module Kempelen
         @secret_key = secret_key
 
         @environment = environment.to_sym
+        @debug_output = nil
 
         raise ArgumentError.new("Unknown environment".freeze) if SERVICE_URLS[@environment].nil?
       end
@@ -37,7 +41,7 @@ module Kempelen
       end
 
       def perform_request(query_string, response_object)
-        response = HTTParty.get(query_string)
+        response = HTTParty.get(query_string, debug_output: @debug_output)
         response.parsed_response[response_object]
       end
     end

data/lib/kempelen/API/operations/base.rb

@@ -52,6 +52,9 @@ module Kempelen
                       request_str += "&" unless request_str.empty?
                       request_str += "#{aws_name}.#{idx + 1}.#{k}=#{CGI.escape(v.to_s)}"
                     end
+                  else
+                    request_str += "&" unless request_str.empty?
+                    request_str += "#{aws_name}.#{idx + 1}=#{CGI.escape(hash_value.to_s)}"
                   end
                 end
               end

data/lib/kempelen/API/operations/create_hit.rb

@@ -28,10 +28,14 @@ module Kempelen
 
           @hit_type_id = hit_type_id
           @lifetime_in_seconds = lifetime_in_seconds.to_i
+          @layout_id = nil
+          @requester_annotation = nil
+          @unique_request_token = nil
           @layout_parameters = []
           @max_assignments = 1
           @response_object = AWS_RESPONSE_OBJECT
 
+          @auto_approval_delay = 2592000
           @reward_amount = 0.0
           @currency_code = "USD".freeze
 

data/lib/kempelen/API/operations/notify_workers.rb

@@ -0,0 +1,54 @@
+module Kempelen
+  module API
+    module Operations
+      class NotifyWorkers < Base
+        attr_accessor :message
+        attr_accessor :subject
+        attr_accessor :worker_ids
+
+        AWS_OPERATION_NAME = "NotifyWorkers".freeze
+        AWS_RESPONSE_OBJECT = "NotifyWorkersResponse".freeze
+
+        SUBJECT_MAX_LENGTH = 200
+        MESSAGE_MAX_LENGTH = 4096
+        WORKER_IDS_MAX_LENGTH = 100
+
+        def initialize(client, worker_ids, subject, message)
+          super(client)
+
+          @operation_name = AWS_OPERATION_NAME
+          @subject = subject.strip
+          @message = message
+          @worker_ids = worker_ids
+        end
+
+        def valid_arguments?
+          @subject.length <= SUBJECT_MAX_LENGTH and 
+            @subject.length > 0 and
+            @message.length <= MESSAGE_MAX_LENGTH and 
+            @message.length > 0 and
+            @worker_ids.length <= WORKER_IDS_MAX_LENGTH and
+            @worker_ids.length > 0
+        end
+
+        def create_parameters
+          raise "Argument size restrictions violated" unless valid_arguments?
+
+          @parameters[:subject] = @subject
+          @parameters[:message_text] = @message
+          @parameters[:worker_ids] = @worker_ids
+
+          super 
+        end
+
+        def perform_operation
+          create_request_string
+
+          super
+
+          Kempelen::API::Responses::EmptyResponse.new(@raw_response)
+        end
+      end
+    end
+  end
+end

data/lib/kempelen/API/operations/parameters.rb

@@ -29,13 +29,16 @@ module Kempelen
         assignment_duration: "AssignmentDurationInSeconds".freeze,
         keywords: "Keywords".freeze,
         auto_approval_delay: "AutoApprovalDelayInSeconds".freeze,
-        qualification_requirement: "QualificationRequirement".freeze
+        qualification_requirement: "QualificationRequirement".freeze,
+        subject: "Subject".freeze,
+        message_text: "MessageText".freeze
       }
 
       ARRAY_PARAMETERS = {
         qualification_requirements: "QualificationRequirement".freeze,
         layout_parameters: "HITLayoutParameter".freeze,
-        reward_amount: "Reward".freeze
+        reward_amount: "Reward".freeze,
+        worker_ids: "WorkerId".freeze
       }
     end
   end

data/lib/kempelen/API/operations/register_hit_type.rb

@@ -21,6 +21,7 @@ module Kempelen
           @description = description
           @reward = reward
           @assignment_duration = assignment_duration
+          @auto_approval_delay = 2592000
           @keywords = []
 
           yield self unless block == nil

data/lib/kempelen/version.rb

@@ -1,3 +1,3 @@
 module Kempelen
-  VERSION = "1.0.4"
+  VERSION = "1.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kempelen
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Brian Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -136,34 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +174,7 @@ files:
 - examples/get_assignments_for_hit.rb
 - examples/get_hit.rb
 - examples/get_reviewable_hits.rb
+- examples/notify_workers.rb
 - examples/reject_assignment.rb
 - examples/set_hit_as_reviewing.rb
 - kempelen.gemspec
@@ -221,6 +194,7 @@ files:
 - lib/kempelen/API/operations/get_hit.rb
 - lib/kempelen/API/operations/get_reviewable_hits.rb
 - lib/kempelen/API/operations/hit_operation.rb
+- lib/kempelen/API/operations/notify_workers.rb
 - lib/kempelen/API/operations/parameters.rb
 - lib/kempelen/API/operations/register_hit_type.rb
 - lib/kempelen/API/operations/reject_assignment.rb
@@ -253,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby integration with Amazon's Mechanical Turk