turkee_rails4 2.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce03796671683cc390e66bc19f2f8703b10c051d
+  data.tar.gz: e0af93f03975d1bb1b1f68dbce29ffb37a75b749
+SHA512:
+  metadata.gz: 2351f036ba8ac21f4812071119da5b2e3241ba7a78c37116153da27a711a1df32e87faaed77599ef04b0fb5ea210347485d541ce90f341fd06768482116f4305
+  data.tar.gz: d6700bf4f27a04c70b1cc43a394950c90ba558c65b5bed4ba450256e406bac57aa9214144ccaae9a295ee5be9935a7a3b8d6ae2582f9cdc758ec9171de41faad

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,27 @@
+## MAC OS
+.DS_Store
+
+*.gem
+build.sh
+
+## TEXTMATE
+*.tmproj
+tmtags
+*.log
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+.idea
+
+## PROJECT::SPECIFIC

data/.travis.yml

@@ -0,0 +1,8 @@
+env:
+  - "RAILS_VERSION=3.1.0"
+  - "RAILS_VERSION=3.2.0"
+  - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=master"
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+gemspec
+
+rails_version = ENV["RAILS_VERSION"] || "default"
+
+rails = case rails_version
+when "master"
+  {github: "rails/rails"}
+when "default"
+  "~> 4.0.0"
+else
+  "~> #{rails_version}"
+end

data/Gemfile.lock

@@ -0,0 +1,121 @@
+PATH
+  remote: .
+  specs:
+    turkee (2.0.2)
+      lockfile
+      rails (>= 3.1.1)
+      rturk (>= 2.4.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
+      mail (~> 2.5.3)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    atomic (1.1.10)
+    builder (3.1.4)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    hike (1.2.3)
+    i18n (0.6.4)
+    lockfile (2.1.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    mime-types (1.23)
+    mini_portile (0.5.1)
+    minitest (4.7.5)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.7)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec-core (2.14.3)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    rspec-rails (2.14.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rturk (2.10.2)
+      nokogiri (>= 1.4.1)
+      rest-client (>= 1.4.0)
+    spork (0.9.2)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    thread_safe (0.1.0)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.14)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_girl (>= 1.3.2)
+  mocha
+  rspec-rails (~> 2.6)
+  spork
+  sqlite3
+  turkee!

data/Guardfile

@@ -0,0 +1,12 @@
+guard 'spork', :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch('spec/spec_helper.rb')
+end
+
+
+guard 'rspec', :version => 2, :cli => "--drb" do
+  watch(%r{^spec/.+_spec\.rb$})
+
+  # lib/
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jim Jones
+
+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.rdoc

@@ -0,0 +1,205 @@
+== RAILS 4 SUPPORT
+Rails 4 support is currently being tested.  To try it out, just use Turkee's master branch. In your Gemfile, add the following :
+    gem 'turkee', :git => 'https://github.com/aantix/turkee.git', branch: 'master'
+    
+== WHAT TURKEE CAN DO
+
+* Perform user feedback studies easily.
+http://i.imgur.com/wIU40BAl.png
+
+* Seamlessly convert your Rails forms for use on Mechanical Turk.
+* Easily import the data posted by the Mechanical Turk workers back into your data models.
+
+External forms are created using a simple form helper.  HITs are created by issuing a rake command.  Retrieving submitted response data and importing that data into your model(s) requires just one more rake command.
+
+
+== INSTALL/UPGRADE
+
+Add turkee to your Gemfile as a gem dependency, then do a 'bundle install':
+
+    gem 'turkee'
+
+
+If you're upgrading Turkee (1.1.1 and prior) or installing for the first time, run:
+
+    rails g turkee --skip
+
+(the skip flag will ensure that you don't overwrite prior Turkee initializers and migrations.)
+
+This will copy the needed migrations and config/initializer into your application directory.
+
+To access the Turkee rake tasks, add the following to your application's Rakefile:
+    require 'tasks/turkee'
+
+If you haven't created a Mechanical Turk account, surf on over to {Amazon's Web Services}[http://aws.amazon.com/] and create an AWS account.
+
+Once you have your account created, you can access your AWS access key and secret access key from {here.}[https://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=access-key]
+
+
+== CONFIGURATION
+
+Inside the config/initializers directory, you'll see the file turkee.rb.  Edit the file with your Amazon credentials.
+
+    AWSACCESSKEYID      = 'XXXXXXXXXXXXXXXXXX'
+    AWSSECRETACCESSKEY  = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYY'
+
+    RTurk::logger.level     = Logger::DEBUG
+    RTurk.setup(AWSACCESSKEYID, AWSSECRETACCESSKEY, :sandbox => (Rails.env == 'production' ? false : true))
+
+Run the migrations :
+
+    rake db:migrate
+
+== MIXED CONTENT WARNINGS
+
+Mechanical Turk will open your forms in an iFrame from a secure URL (ssl).
+If you test locally with localhost, you're going to need to be running SSL so that you don't
+receive a mixed content warning within Chrome and a blank screen.
+Thin allows for local SSL.
+
+    # Gemfile
+    gem 'thin', :group => :development
+
+Then you can start the server by calling :
+
+    thin start --ssl
+
+
+== BASIC FORMS
+
+1) You should disable form controls if the Turker hasn't accepted the HIT.  You can determine this from your controller:
+    class SurveysController < ApplicationController
+
+        def new
+            @disabled      = Turkee::TurkeeFormHelper::disable_form_fields?(params)
+
+            # If you wanted to find the associated turkee_task, you could do a find by hitId
+            #  Not necessary in a simple example.
+            # @turkee_task   = Turkee::TurkeeTask.find_by_hit_id(params[:hitId]).id rescue nil
+
+            ...
+            @survey        = Survey.new
+        end
+
+2) Change your forms to use the form helper.
+
+    <%= turkee_form_for(@survey, params) do |f| %>
+        <p><%= f.text_area :value, :disabled => @disabled %></p>
+        <p><%= f.submit 'Create', :disabled => @disabled %></p>
+    <% end %>
+
+Using the turkee_form_for helper will post the form to the Mechanical Turk sandbox if you're in development/test mode, otherwise it will be posted to Mechanical Turk production/live site.
+
+
+3) Run the following rake task to post to Mechanical Turk :
+    # Host URL of your application
+    # Title of your HIT
+    # Description of your HIT
+    # Model name of your task form (the New action should be implemented)
+    # Number of assignments for HIT
+    # The reward for a successful completion
+    # The lifetime of the HIT in days (e.g. 5 days)
+
+    rake turkee:post_hit[<Host>, <Title>, <Description>, <Model>, <Number of Assignments>, <Reward>, <Lifetime>]
+
+    e.g. :
+    rake turkee:post_hit["https://www.yourapp.com","Please complete our survey","Tell us your favorite color.","Survey",100,0.05,5,1]
+    ** Do not put spaces before or after commas for the rake task parameters
+
+This will insert a row for the requested HIT into the turkee_tasks table.  The turkee_tasks entry stores (along with the other properties) the HIT URL (e.g. http://workersandbox.mturk.com/mturk/preview?groupId=1HGHJJGHQSJB7WMWJ33YS8WM169XNIL ) and HIT ID (e.g. 1J1EXO8SUQ3URTTUYGHJ7EKUT11 ).  These values are returned from Mechanical Turk when the HIT request is posted.
+
+When a Turk worker views your HIT, the HIT will display your form within an iFrame.  With the above example, Mechanical Turk will open an iFrame for the HIT assignment displaying the form http://www.yourapp.com/surveys/new
+
+== USER FEEDBACK STUDIES
+
+1) Add the following method call to your app/views/layouts/application.html.haml file :
+
+    <%= turkee_study %>
+
+2) Call the create_study rake task :
+
+    rake turkee:create_study[<Application Page URL>, <HIT Title>, <HIT Description>, <Number of Assignments>, <Reward>, <Lifetime of HIT>]
+
+    # 30 Assignments at a quarter each requesting feedback on my site
+    RAILS_ENV=production rake turkee:create_study['https://yoursite.com/page-to-be-test',"Can you help me test my website?","Give feedback below on what you didn't like about my site. Click submit below when you're finished.", 30,0.25, 20]
+
+3) The Turker will see a feedback form overlayed over your website.  Within this textarea, they can provide feedback.
+
+Screenshot:
+
+http://i.imgur.com/wIU40BA.png
+
+== RETRIEVING RESULTS
+
+1) Run the rake task that retrieves the values from Mechanical Turk and stores the user entered values into your model.
+    rake turkee:get_all_results
+
+Rerun this task periodically to retrieve newly entered form values.  You can setup this task as a cronjob to automate this.
+
+    crontab -e
+
+    # E.g. run every five minutes
+    */5 * * * * cd /var/www/your/turk/application && rake turkee:get_all_results
+
+Or you can directly call :
+
+    Turkee::TurkeeTask.process_hits
+
+
+== DATA RETRIEVAL; THE INS AND OUTS
+
+1) When a response is retrieved from Mechanical Turk, Turkee attempts to create a data row for the model specified using the corresponding retrieved data.  If the row cannot be created (input failed model validations), the assignment is rejected.
+As for Mechanical Turk approval, if the row is created and you haven't specified your own custom approve? method for the model, the assignment will automatically be approved. If you'd like to add your own custom approval method, add the approve? instance method to your model.  E.g. :
+    class Survey < ActiveRecord::Base
+      def approve?
+        (!response.blank? && !comment.blank?)
+      end
+    end
+
+2) When all specified assignments for a HIT have been completed, Turkee will attempt to call the optional hit_complete class method for the model.  This can be used for any cleanup logic.  E.g. :
+    class Survey < ActiveRecord::Base
+      def self.hit_complete(turkee_task)
+        #do something
+      end
+    end
+
+3) If all of specified assignments for a HIT have not been completed by the end of the HITs lifetime, Turkee will attempt to call the optional hit_expired class method for the model.  This can be used for any cleanup logic.  E.g. :
+    class Survey < ActiveRecord::Base
+      def self.hit_expired(turkee_task)
+        #do something
+      end
+    end
+
+
+== Advanced Usage
+
+1) You can use the params hash to pass object IDs to your forms.  E.g. if you wanted to setup a form of questions about a given URL (let's call the model UrlSurvey), your code would look something like :
+
+    URL.all do |url|
+        Turkee::TurkeeTask.create_hit(host, "Enter the address displayed for the given url.",
+            hit_description, UrlSurvey, num_assignments, reward,
+            lifetime, duration, {}, {:url_id => url.id}, {})
+    end
+
+Then when displaying your form, you can find the URL object via the params[:url_id] value.
+
+2) You can pass in qualifications to allow only certain Turkers to work on your HIT.
+
+E.g. qualifications = {:approval_rate => {:gt => 70}, :country => {:eql => 'US'}}
+
+    Turkee::TurkeeTask.create_hit(host, hit_title, hit_description, UrlSurvey, num_assignments, reward, lifetime, duration, qualifications, {}, {})
+
+* The rake task does not support the passing of qualifications.
+
+3) Turkee assumes that the form url will be the new action for the class passed to create_hit.  If you have a more complex form url which would be the case for nested resources, you can use the :form_url
+option to designate a form url different from the default.
+
+    form_url = Rails.application.routes.url_helpers.send("new_user_survey_path",@my_survey)
+
+    Turkee::TurkeeTask.create_hit(host, hit_title, hit_description, :Survey, num_assignments, reward,
+        lifetime, duration, {}, {}, {:form_url => form_url})
+
+
+== Copyright
+
+Copyright (c) 2010 - 2012 Jim Jones. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+require 'bundler'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+$:.push File.expand_path("../lib", __FILE__)
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec
+
+begin
+  INSTALL_MESSAGE = %q{
+  ========================================================================
+  Turkee Installation Complete.
+  ------------------------------------------------------------------------
+  If you're upgrading Turkee (1.1.1 and prior) or installing for the first time, run:
+
+    rails g turkee --skip
+
+  For full instructions on gem usage, visit:
+    http://github.com/aantix/turkee#readme
+
+  ** If you like the Turkee gem, please click the "watch" button on the
+  Github project page.  You'll make me smile and feel appreciated. :)
+    http://github.com/aantix/turkee
+
+  ========================================================================
+  }
+
+  Gem::Specification.new do |gem|
+    gem.name = "turkee"
+    gem.summary = "Turkee makes dealing with Amazon's Mechnical Turk a breeze."
+    gem.description = "Turkee will help you to create your Rails forms, post the HITs, and retrieve the user entered values from Mechanical Turk."
+    gem.email = "jjones@aantix.com"
+    gem.homepage = "http://github.com/aantix/turkee"
+    gem.authors = ["Jim Jones"]
+    gem.add_dependency(%q<rails>, [">= 3.1.1"])
+    gem.add_dependency(%q<rturk>, [">= 2.4.0"])
+    gem.add_dependency(%q<lockfile>, [">= 1.4.3"])
+
+    gem.post_install_message = INSTALL_MESSAGE
+    gem.require_path = 'lib'
+    gem.files = %w(MIT-LICENSE README.textile Gemfile Rakefile init.rb) + Dir.glob("{lib,spec}/**/*")
+
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/lib/generators/turkee/templates/add_completed_tasks.rb.erb

@@ -0,0 +1,17 @@
+class AddCompletedTasks< ActiveRecord::Migration
+
+  def self.up
+    unless column_exists? :turkee_tasks, :completed_assignments
+      add_column :turkee_tasks, :completed_assignments, :integer, :default => 0
+    end
+
+    unless column_exists? :turkee_tasks, :hit_num_assignments
+      add_column :turkee_tasks, :hit_num_assignments, :integer
+    end
+
+  end
+
+  def self.down
+  end
+end
+

data/lib/generators/turkee/templates/add_expired.rb.erb

@@ -0,0 +1,15 @@
+class AddExpired < ActiveRecord::Migration
+
+  def self.up
+    unless column_exists? :turkee_tasks, :expired
+      add_column :turkee_tasks, :expired, :integer
+    end
+  end
+
+  def self.down
+    if column_exists? :turkee_tasks, :expired
+	  remove_column :turkee_tasks, :expired
+	end
+  end
+end
+

data/lib/generators/turkee/templates/add_hit_duration.rb.erb

@@ -0,0 +1,15 @@
+class AddHitDuration < ActiveRecord::Migration
+
+  def self.up
+    unless column_exists? :turkee_tasks, :hit_duration
+      add_column :turkee_tasks, :hit_duration, :integer
+    end
+  end
+
+  def self.down
+    if column_exists? :turkee_tasks, :hit_duration
+	  remove_column :turkee_tasks, :hit_duration
+	end
+  end
+end
+

data/lib/generators/turkee/templates/add_imported_assignment_details.rb.erb

@@ -0,0 +1,33 @@
+class AddImportedAssignmentDetails < ActiveRecord::Migration
+
+  def self.up
+    unless column_exists? :turkee_imported_assignments, :turkee_task_id
+      add_column :turkee_imported_assignments, :turkee_task_id, :integer
+      add_index :turkee_imported_assignments, :turkee_task_id, :unique => false
+    end
+
+    unless column_exists? :turkee_imported_assignments, :worker_id
+      add_column :turkee_imported_assignments, :worker_id, :string
+    end
+
+    unless column_exists? :turkee_imported_assignments, :result_id
+      add_column :turkee_imported_assignments, :result_id, :integer
+    end
+  end
+
+  def self.down
+	if column_exists? :turkee_imported_assignments, :turkee_task_id
+      remove_column :turkee_imported_assignments, :turkee_task_id
+      remove_index :turkee_imported_assignments, :turkee_task_id
+    end
+
+    if column_exists? :turkee_imported_assignments, :worker_id
+      remove_column :turkee_imported_assignments, :worker_id
+    end
+
+    if column_exists? :turkee_imported_assignments, :result_id
+      remove_column :turkee_imported_assignments, :result_id
+    end
+  end
+end
+

data/lib/generators/turkee/templates/create_turkee_study.rb.erb

@@ -0,0 +1,18 @@
+class CreateTurkeeStudy < ActiveRecord::Migration
+
+    def self.up
+        create_table "turkee_studies" do |t|
+            t.integer "turkee_task_id"
+            t.text "feedback"
+            t.string "gold_response"
+            t.timestamps
+        end
+
+        add_index :turkee_studies, :turkee_task_id
+    end
+
+    def self.down
+        drop_table :turkee_studies
+    end
+
+end

data/lib/generators/turkee/templates/turkee.rb

@@ -0,0 +1,8 @@
+# Go to this page https://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=access-key
+# to retrieve your AWS/Mechanical Turk access keys.
+
+AWSACCESSKEYID      = 'XXXXXXXXXXXXXXXXXX'
+AWSSECRETACCESSKEY  = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYY'
+
+RTurk::logger.level = Logger::DEBUG
+RTurk.setup(AWSACCESSKEYID, AWSSECRETACCESSKEY, :sandbox => (Rails.env == 'production' ? false : true))

data/lib/generators/turkee/templates/turkee_imported_assignments.rb.erb

@@ -0,0 +1,16 @@
+class CreateTurkeeImportedAssignments < ActiveRecord::Migration
+
+  def self.up
+    create_table "turkee_imported_assignments" do |t|
+      t.string   "assignment_id"
+      t.timestamps
+    end
+
+    add_index :turkee_imported_assignments, :assignment_id, :unique => true
+  end
+
+  def self.down
+    drop_table :turkee_imported_assignments
+  end
+
+end

data/lib/generators/turkee/templates/turkee_migration.rb.erb

@@ -0,0 +1,25 @@
+class CreateTurkeeTasks < ActiveRecord::Migration
+  
+  def self.up
+    create_table "turkee_tasks" do |t|
+      t.string   "hit_url"
+      t.boolean  "sandbox"
+      t.string   "task_type"
+      t.text     "hit_title"
+      t.text     "hit_description"
+      t.string   "hit_id"
+      t.decimal  "hit_reward", :precision => 10, :scale => 2
+      t.integer  "hit_num_assignments"
+      t.integer  "hit_lifetime"
+      t.string   "form_url"
+      t.integer  "completed_assignments", :default => 0
+      t.boolean  "complete"
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :turkee_tasks
+  end
+  
+end