turkee 1.2.1 → 1.2.2

data/README.rdoc

@@ -5,18 +5,6 @@ Seamlessly convert your Rails forms for use on Mechanical Turk.  Then, easily im
 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.
 
 
-== Rails 2
-
-I'm no longer supporting Rails 2.x.  If you have Rails 2 changes, message me and we can look to maintaing a Rails 2.x branch.
-
-
-== Mechanical Turk API Changes
-
-Mechanical Turk is now requiring that the hitId, workerId, and the turkSubmitTo parameters be passed in along with the assignmentId and form parameters.
-
-What does this mean for you?  Not much besides the fact that now when you construct your forms using turkee_form_for, you'll be passing in your entire params hash instead of just the assignment_id.  The code snippet below reflect this change.
-
-
 == Install/Upgrade
 
 Add turkee to your Gemfile as a gem dependency, then do a 'bundle install':
@@ -131,6 +119,14 @@ As for Mechanical Turk approval, if the row is created and you haven't specified
       end
     end
 
+9) 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 :

data/Rakefile

@@ -5,6 +5,10 @@ Bundler::GemHelper.install_tasks
 
 $:.push File.expand_path("../lib", __FILE__)
 
+task :default do
+  sh "rspec spec/"
+end
+
 begin
   INSTALL_MESSAGE = %q{
   ========================================================================

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/turkee_generator.rb

@@ -34,6 +34,10 @@ class TurkeeGenerator < Rails::Generators::Base
 
     migration_template "add_hit_duration.rb.erb", "db/migrate/add_hit_duration.rb"
 
+    sleep 1
+
+    migration_template "add_expired.rb.erb", "db/migrate/add_expired.rb"
+
   end
 
   def create_initializer

data/lib/turkee.rb

@@ -12,6 +12,14 @@ module Turkee
   # Model simply tracks what assignments have been imported
   class TurkeeImportedAssignment < ActiveRecord::Base
     attr_accessible :assignment_id, :turkee_task_id, :worker_id, :result_id
+
+    def self.record_imported_assignment(assignment, result, turk)
+      TurkeeImportedAssignment.create!(:assignment_id  => assignment.id,
+                                       :turkee_task_id => turk.id,
+                                       :worker_id      => assignment.worker_id,
+                                       :result_id      => result.id)
+    end
+
   end
 
   class TurkeeTask < ActiveRecord::Base
@@ -36,29 +44,26 @@ module Turkee
           turks.each do |turk|
             hit   = RTurk::Hit.new(turk.hit_id)
 
-            models = Set.new
+            callback_models = Set.new
             hit.assignments.each do |assignment|
               next unless submitted?(assignment.status)
-              next unless TurkeeImportedAssignment.find_by_assignment_id(assignment.id).nil?
-
-              params     = assignment_params(assignment.answers)
-              param_hash = Rack::Utils.parse_nested_query(params)
-              model      = find_model(param_hash)
+              next if assignment_exists?(assignment)
 
+              model, param_hash = map_imported_values(assignment)
               next if model.nil?
-              models << model
+
+              callback_models << model
               
-              logger.debug "param_hash = #{param_hash}"
-              result = model.create(param_hash[model.to_s.underscore])
+              result = save_imported_values(model, param_hash)
 
               # If there's a custom approve? method, see if we should approve the submitted assignment
               #  otherwise just approve it by default
-              process_result(assignment, result, turk)
+              turk.process_result(assignment, result)
 
-              TurkeeImportedAssignment.create!(:assignment_id => assignment.id, :turkee_task_id => turk.id, :worker_id => assignment.worker_id, :result_id => result.id)
+              TurkeeImportedAssignment.record_imported_assignment(assignment, result, turk)
             end
 
-            check_hit_completeness(hit, turk, models)
+            turk.set_expired?(callback_models) if !turk.set_complete?(hit, callback_models)
           end
         end
       rescue Lockfile::MaxTriesLockError => e
@@ -67,9 +72,13 @@ module Turkee
 
     end
 
+    def self.save_imported_values(model, param_hash)
+      model.create(param_hash[model.to_s.underscore])
+    end
+
     # Creates a new Mechanical Turk task on AMZN with the given title, desc, etc
     def self.create_hit(host, hit_title, hit_description, typ, num_assignments, reward, lifetime, duration = nil, qualifications = {}, params = {}, opts = {})
-      model    = Object::const_get(typ)
+      model    = typ.to_s.constantize
       f_url    = build_url(host, model, params, opts)
 
       h = RTurk::Hit.create(:title => hit_title) do |hit|
@@ -112,19 +121,13 @@ module Turkee
         hits.each do |hit|
           begin
             hit.expire!
-
             hit.assignments.each do |assignment|
-
               logger.info "Assignment status : #{assignment.status}"
-
               assignment.approve!('__clear_all_turks__approved__') if assignment.status == 'Submitted'
             end
 
             turkee_task = TurkeeTask.find_by_hit_id(hit.id)
-            if turkee_task
-              turkee_task.complete = true
-              turkee_task.save
-            end
+            turkee_task.complete_task
 
             hit.dispose!
           rescue Exception => e
@@ -136,43 +139,77 @@ module Turkee
 
     end
 
-    private
-
-    def logger
-      @logger ||= Logger.new($stderr)
+    def complete_task
+      self.complete = true
+      save!
     end
 
-    def self.check_hit_completeness(hit, turk, models)
-      logger.debug "#### turk.completed_assignments == turk.hit_num_assignments :: #{turk.completed_assignments} == #{turk.hit_num_assignments}"
-      if turk.completed_assignments == turk.hit_num_assignments
+    def set_complete?(hit, models)
+      if completed_assignments?
         hit.dispose!
-        turk.complete = true
-        turk.save
-        models.each { |model| model.hit_complete(turk) if model.respond_to?(:hit_complete) }
+        complete_task
+        initiate_callback(:hit_complete, models)
+        return true
+      end
+
+      false
+    end
+
+    def set_expired?(models)
+      if expired?
+        self.expired = true
+        save!
+        initiate_callback(:hit_expired, models)
       end
     end
 
+    def initiate_callback(method, models)
+      models.each { |model| model.send(method, self) if model.respond_to?(method) }
+    end
 
-    def self.process_result(assignment, result, turk)
+    def process_result(assignment, result)
       if result.errors.size > 0
         logger.info "Errors : #{result.inspect}"
         assignment.reject!('Failed to enter proper data.')
       elsif result.respond_to?(:approve?)
         logger.debug "Approving : #{result.inspect}"
-        increment_complete_assignments(turk)
+        self.increment_complete_assignments
         result.approve? ? assignment.approve!('') : assignment.reject!('Rejected criteria.')
       else
-        increment_complete_assignments(turk)
+        self.increment_complete_assignments
         assignment.approve!('')
       end
     end
 
-    def self.increment_complete_assignments(turk)
-      # Backward compatibility; completed_assignments may not exist in the table
-      if turk.respond_to?(:completed_assignments)
-        turk.completed_assignments += 1
-        turk.save
-      end
+    def increment_complete_assignments
+      raise "Missing :completed_assignments attribute. Please upgrade Turkee to the most recent version." unless respond_to?(:completed_assignments)
+
+      self.completed_assignments += 1
+      save
+    end
+
+    private
+
+    def logger
+      @logger ||= Logger.new($stderr)
+    end
+
+    def self.map_imported_values(assignment)
+      params     = assignment_params(assignment.answers)
+      param_hash = Rack::Utils.parse_nested_query(params)
+      return find_model(param_hash), param_hash
+    end
+
+    def self.assignment_exists?(assignment)
+      TurkeeImportedAssignment.find_by_assignment_id(assignment.id).present?
+    end
+
+    def completed_assignments?
+      completed_assignments == hit_num_assignments
+    end
+
+    def expired?
+      Time.now >= (created_at + hit_lifetime.days)
     end
 
     def self.task_items(turkee_task)
@@ -194,7 +231,7 @@ module Turkee
     def self.find_model(param_hash)
       param_hash.each do |k, v|
         if v.is_a?(Hash)
-          model = Object::const_get(k.to_s.camelize) rescue next
+          model = k.to_s.camelize.constantize rescue next
           return model if model.descends_from_active_record? rescue next
         end
       end

data/spec/spec_helper.rb

@@ -4,7 +4,6 @@ require "bundler/setup"
 require 'factory_girl'
 require 'rspec'
 require 'spork'
-require 'growl'
 require 'rails'
 require 'rturk'
 require 'lockfile'
@@ -22,9 +21,18 @@ ActiveRecord::Schema.define(:version => 1) do
     t.decimal  "hit_reward", :precision => 10, :scale => 2
     t.integer  "hit_num_assignments"
     t.integer  "hit_lifetime"
-    t.integer  "hit_duration"
     t.string   "form_url"
+    t.integer  "completed_assignments", :default => 0
     t.boolean  "complete"
+    t.boolean  "expired"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+    t.integer  "turkee_flow_id"
+    t.integer  "hit_duration"
+  end
+
+  create_table :surveys do |t|
+    t.string :answer
   end
 end
 

data/spec/turkee_spec.rb

@@ -1,23 +1,125 @@
 require 'spec_helper'
 
-
 describe Turkee::TurkeeTask do
-  #include ActionController::Routing::Routes
   class TestTask < ActiveRecord::Base
-    def self.abstract_class; true; end
+    def self.abstract_class
+      true
+    end
+
     attr_accessor :description
   end
 
-  describe "#process_hits" do
-    before(:each) do
+  class Survey < ActiveRecord::Base
+    def self.abstract_class
+      true
+    end
+
+    def self.hit_complete(hit)
+    end
+  end
+
+  describe ".completed_assignments?" do
+    it "is not complete" do
+      turkee_task = FactoryGirl.create(:turkee_task)
+      turkee_task.send("completed_assignments?").should be_false
+    end
+
+    it "is complete" do
+      turkee_task = FactoryGirl.create(:turkee_task, :completed_assignments => 100)
+      turkee_task.send("completed_assignments?").should be_true
+    end
+  end
 
+  describe ".expired?" do
+    it "is not expired" do
+      turkee_task = FactoryGirl.create(:turkee_task)
+      turkee_task.send("expired?").should be_false
     end
 
+    it "is expired" do
+      turkee_task = FactoryGirl.create(:turkee_task, :created_at => Time.now - 2.days, :hit_lifetime => 1)
+      turkee_task.send("expired?").should be_true
+
+      turkee_task = FactoryGirl.create(:turkee_task, :created_at => Time.now - 1.day, :hit_lifetime => 1)
+      turkee_task.send("expired?").should be_true
+    end
   end
 
+  describe ".set_complete?" do
+    before do
+      @hit = RTurk::Hit.new(123)
+    end
+    context "completed hits" do
+      before do
+        @turkee_task = FactoryGirl.create(:turkee_task,
+                                          :hit_num_assignments => 100,
+                                          :completed_assignments => 100)
+      end
 
-  describe "#find_model" do
+      it "marks the turkee task as complete" do
+        @hit.should_receive(:dispose!).once
+        Survey.should_receive(:hit_complete).once
+        @turkee_task.set_complete?(@hit, [Survey])
+        @turkee_task.complete.should be_true
+      end
+    end
+
+    context "incomplete hits" do
+      before do
+        @turkee_task = FactoryGirl.create(:turkee_task,
+                                          :hit_num_assignments => 99,
+                                          :completed_assignments => 100)
+      end
 
+      it "keeps the turkee task as incomplete" do
+        @hit.should_not_receive(:dispose!)
+        Survey.should_not_receive(:hit_complete)
+        @turkee_task.set_complete?(@hit, [Survey]).should be_false
+        @turkee_task.complete.should be_false
+      end
+    end
+  end
+
+  describe ".set_expired?" do
+    context "unexpired hits" do
+      before do
+        @turkee_task = FactoryGirl.create(:turkee_task)
+      end
+
+      it "keeps the turkee task as unexpired" do
+        Survey.should_not_receive(:hit_expired)
+        @turkee_task.set_expired?([Survey])
+        @turkee_task.expired.should be_false
+      end
+    end
+
+    context "expired hits" do
+      before do
+        @turkee_task = FactoryGirl.create(:turkee_task,
+                                          :created_at => 2.days.ago,
+                                          :hit_lifetime => 1)
+      end
+
+      it "marks the turkee task as expired" do
+        Survey.should_receive(:hit_expired)
+        @turkee_task.set_expired?([Survey]).should be_true
+        @turkee_task.expired.should be_true
+      end
+    end
+  end
+
+  describe ".initiate_callback" do
+    before do
+      @turkee_task = FactoryGirl.create(:turkee_task)
+    end
+    it "calls hit_complete for the given callback model" do
+      Survey.should_receive(:hit_complete).once
+      @turkee_task.initiate_callback(:hit_complete, [Survey])
+    end
+
+  end
+
+  describe "#find_model" do
     it "should return a turkee_task mode " do
       returned_data = {:submit => 'Create', "test_task" => {:description => "desc"}}
       Turkee::TurkeeTask.find_model(returned_data).should == TestTask
@@ -27,9 +129,8 @@ describe Turkee::TurkeeTask do
       returned_data = {:submit => 'Create', "another_task_class" => {:description => "desc"}}
       Turkee::TurkeeTask.find_model(returned_data).should be_nil
     end
-
   end
-  
+
   describe "#assignment_params" do
     it "should encode the params properly" do
       answers = {:test => "abc", :test2 => "this is a test"}
@@ -42,5 +143,4 @@ describe Turkee::TurkeeTask do
       Turkee::TurkeeTask.submitted?("Submitted").should == true
     end
   end
-  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turkee
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-09 00:00:00.000000000 Z
+date: 2013-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lockfile
-  requirement: &70217997125780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70217997125780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70217997123680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 3.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70217997123680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: rturk
-  requirement: &70217997120760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: 2.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70217997120760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70217997119040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70217997119040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70217997114560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70217997114560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &70217997110980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +117,15 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70217997110980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70217997110120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +133,12 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *70217997110120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 description: Turkee will help you to create your Rails forms, post the HITs, and retrieve
   the user entered values from Mechanical Turk.
 email: jjones@aantix.com
@@ -105,6 +156,7 @@ files:
 - lib/generators/turkee/templates/turkee_migration.rb.erb
 - lib/generators/turkee/templates/add_imported_assignment_details.rb.erb
 - lib/generators/turkee/templates/add_hit_duration.rb.erb
+- lib/generators/turkee/templates/add_expired.rb.erb
 - lib/generators/turkee/turkee_generator.rb
 - lib/tasks/turkee.rb
 - lib/turkee.rb
@@ -142,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Turkee makes dealing with Amazon's Mechnical Turk a breeze.