kempelen 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57a5100dbaffa8a8c325dc3521423734b2fac35f
+  data.tar.gz: e2f33c5193e3a6511b5068b616983a029d7e6eb8
+SHA512:
+  metadata.gz: bfb94c173d2e08a31f1abc6a5972f87f1e0e365c53485c1b2987d1ee32d558d3007340d3291e8bfc2a48ff3c442e6b5b03fa77df1d561397662975edfc32aa6f
+  data.tar.gz: e3a71009a1ba5f18dde351a6de2ff7cae18534aaa1c0f2b512d2e1d9ac059a5b32b19d5bc6cefdeeef40276f9e390610cd6521cfc4dfd33062505c036427d3be

data/.gitignore

@@ -0,0 +1,19 @@
+# Local config
+/.bundle/
+/.yardoc
+.ruby-version
+
+# Generated
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Editor files
+.*.swp
+.idea
+*.iml
+.DS_Store

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+ruby '2.2.2'
+
+# Specify your gem's dependencies in kempelen.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 ForeFront Labs
+
+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/README.md

@@ -0,0 +1,59 @@
+# Kempelen
+
+[![Circle CI](https://img.shields.io/circleci/project/forefrontlabs/kempelen.svg)](https://circleci.com/gh/forefrontlabs/kempelen/tree/master)
+[![Coverage Status](https://coveralls.io/repos/forefrontlabs/kempelen/badge.svg?branch=master&service=github)](https://coveralls.io/github/forefrontlabs/kempelen?branch=master)
+[![Code Climate](https://codeclimate.com/github/forefrontlabs/kempelen/badges/gpa.svg)](https://codeclimate.com/github/forefrontlabs/kempelen)
+[![Gemnasium](https://img.shields.io/gemnasium/forefrontlabs/kempelen.svg)](https://gemnasium.com/forefrontlabs/kempelen)
+
+Kempelen is a modern Mechanical Turk integration gem.
+
+Note that note all usage cases are covered by this gem at this time.  It is focused on the use cases we needed right now.  More cases will be added in the future.  If you need something right now, feel free to push us a pull request (see Contributing below).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kempelen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kempelen
+
+## Usage
+
+In general:
+
+  * Create a client
+  * Create an operation
+  * `result = operation.perform_operation`
+  * Work with the result
+
+See the examples directory for some specific examples of usage.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to 
+run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new 
+version, update the version number in `version.rb`, and then run `bundle exec rake release`, which 
+will create a git tag for the version, push git commits and tags, and push the `.gem` file 
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/forefrontlabs/kempelen](https://gemnasium.com/forefrontlabs/kempelen). 
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to 
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+
+desc "Open an pry session preloaded with this gem"
+task :console do
+  begin
+    require 'pry'
+    require 'kempelen'
+    
+
+    def reload!
+      files = $LOADED_FEATURES.select { |feat| feat =~ /\/kempelen\// }
+      files.each { |file| load file }
+    end
+    
+    ARGV.clear
+    Pry.start
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kempelen"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/approve_assignment.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 "approve_assignment.rb <ACCESS_KEY> <SECRET_KEY> <HIT_ID>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@operation = Kempelen::API::Operations::ApproveAssignment.new(@client, ARGV[2])
+
+get_response = @operation.perform_operation
+puts get_response.inspect

data/examples/create_hit.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'kempelen'
+require 'httparty'
+
+if ARGV.length < 4
+  puts "create_hit.rb <ACCESS_KEY> <SECRET_KEY> <HIT_TYPE_ID> <LAYOUT_ID>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+
+@operation = Kempelen::API::Operations::CreateHit.new(@client, ARGV[2], 3600) do |op|
+  op.layout_id = ARGV[3]
+  op.add_layout_parameter "link", "http://alt-usage-english.org/can_a_cat_man.wav"
+end
+
+create_hit_response = @operation.perform_operation
+puts create_hit_response.inspect

data/examples/force_expire_hit.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 "force_expire_hit.rb <ACCESS_KEY> <SECRET_KEY> <HIT_ID>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@operation = Kempelen::API::Operations::ForceExpireHit.new(@client, ARGV[2])
+
+force_expire_hit_response = @operation.perform_operation
+puts force_expire_hit_response.inspect

data/examples/get_account_balance.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'kempelen'
+require 'httparty'
+
+if ARGV.length < 2
+  puts "get_account_balance.rb <ACCESS_KEY> <SECRET_KEY>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@operation = Kempelen::API::Operations::GetAccountBalance.new(@client)
+
+get_account_balance_response = @operation.perform_operation
+puts get_account_balance_response.inspect

data/examples/get_assignments_for_hit.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 "get_assignments_for_hit.rb <ACCESS_KEY> <SECRET_KEY> <HIT_ID>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@operation = Kempelen::API::Operations::GetAssignmentsForHit.new(@client, ARGV[2])
+
+get_hit_response = @operation.perform_operation
+puts get_hit_response.inspect

data/examples/get_hit.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 "get_hit.rb <ACCESS_KEY> <SECRET_KEY> <HIT_ID>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@operation = Kempelen::API::Operations::GetHit.new(@client, ARGV[2])
+
+get_hit_response = @operation.perform_operation
+puts get_hit_response.inspect

data/examples/get_reviewable_hits.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 "get_hit.rb <ACCESS_KEY> <SECRET_KEY> <HIT_TYPE_ID>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@operation = Kempelen::API::Operations::GetReviewableHits.new(@client, ARGV[2])
+
+get_reviewable_hits = @operation.perform_operation
+puts get_reviewable_hits.inspect

data/examples/reject_assignment.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 "reject_assignment.rb <ACCESS_KEY> <SECRET_KEY> <HIT_ID>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@operation = Kempelen::API::Operations::RejectAssignment.new(@client, ARGV[2])
+
+get_response = @operation.perform_operation
+puts get_response.inspect

data/examples/set_hit_as_reviewing.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 "set_hit_as_reviewing.rb <ACCESS_KEY> <SECRET_KEY> <HIT_ID>"
+  exit
+end
+
+@client = Kempelen::API::Client.new(ARGV[0], ARGV[1], :sandbox)
+@operation = Kempelen::API::Operations::SetHitAsReviewing.new(@client, ARGV[2])
+
+set_hit_as_reviewing = @operation.perform_operation
+puts set_hit_as_reviewing.inspect

data/kempelen.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kempelen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kempelen"
+  spec.version       = Kempelen::VERSION
+  spec.authors       = ["Brian Nelson"]
+  spec.email         = ["brian@forefrontlabs.com"]
+
+  spec.summary       = %q{Ruby integration with Amazon's Mechanical Turk}
+  spec.description   = %q{Modern Ruby integration with Amazon's Mechanical Turk.}
+  spec.homepage      = "https://github.com/forefrontlabs/kempelen"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby-hmac", "~> 0.4.0"
+  spec.add_dependency "nori", "~> 2.6.0"
+  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 "minitest", "~> 5.8.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0.20"
+  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