turkee 1.0.4 → 1.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.rdoc

@@ -4,41 +4,47 @@ 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.
 
-== Examples
 
-If you'd like to jump straight into code, check out the {Turkee Iterator}[https://github.com/aantix/Turkee-Iterator] example.
+== Rails 2
 
-== Dependencies
+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.
 
-Make sure that the rturk gem is installed configured with your Amazon Turk credentials. I created a config/initializers/turk_task_config.rb file with the following in it:
 
-    TURKTASK_AWSACCESSKEYID = 'XXXXXXXXXXXXXXXXXX'
-    TURKTASK_AWSACCESSKEY   = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYY'
+== Mechanical Turk API Changes
 
-    RTurk::logger.level     = Logger::DEBUG
-    RTurk.setup(AWSACCESSKEYID, AWSACCESSKEY, :sandbox => (Rails.env == 'production' ? false : true))
-
-== Install
-
-Install the Turkee gem:
+Mechanical Turk is now requiring that the hitId, workerId, and the turkSubmitTo parameters be passed in along with the assignmentId and form parameters.
 
-    sudo gem install turkee
+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.
 
-For Rails 2, add it to your environment.rb configuration as a gem dependency:
 
-    config.gem 'turkee'
+== Install
 
-For Rails 3, add it to your Gemfile as a gem dependency, then do a 'bundle install':
+Add turkee to your Gemfile as a gem dependency, then do a 'bundle install':
 
     gem 'turkee'
 
 To access the Turkee rake tasks, add the following to your application's Rakefile:
     require 'tasks/turkee'
 
-Run the turkee generator from your application directory to copy the needed migrations into your application:
+Run the turkee generator from your application directory to copy the needed migrations and config/initializer into your application:
+
+    rails g 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 that file with your Amazon credenti.
+
+    AWSACCESSKEYID      = 'XXXXXXXXXXXXXXXXXX'
+    AWSSECRETACCESSKEY  = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYY'
+
+    RTurk::logger.level     = Logger::DEBUG
+    RTurk.setup(AWSACCESSKEYID, AWSSECRETACCESSKEY, :sandbox => (Rails.env == 'production' ? false : true))
 
-    ./script/generate turkee    # Rails 2
-    rails g turkee              # Rails 3
 
 == Use
 
@@ -50,8 +56,7 @@ Run the turkee generator from your application directory to copy the needed migr
     class SurveysController < ApplicationController
 
         def new
-            @assignment_id = params[:assignmentId]
-            @disabled      = Turkee::TurkeeFormHelper::disable_form_fields?(@assignment_id)
+            @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.
@@ -62,7 +67,8 @@ Run the turkee generator from your application directory to copy the needed migr
         end
 
 3) Change your forms to use the form helper.
-    <% turkee_form_for(@survey, @assignment_id) do |f| %>
+
+    <% turkee_form_for(@survey, params) do |f| %>
         <p><%= f.text_area :value, :disabled => @disabled %></p>
         <p><%= f.submit 'Create', :disabled => @disabled %></p>
     <% end %>

data/Rakefile

@@ -28,11 +28,12 @@ begin
     gem.email = "jjones@aantix.com"
     gem.homepage = "http://github.com/aantix/turkee"
     gem.authors = ["Jim Jones"]
-    gem.add_development_dependency "rturk", ">= 2.3.0"
-    gem.add_development_dependency "lockfile", ">= 1.4.3"
+    gem.add_dependency(%q<rails>, [">= 3.0.7"])
+    gem.add_dependency(%q<rturk>, [">= 2.3.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 Rakefile init.rb) + Dir.glob("{generators,lib,spec}/**/*")
+    gem.files = %w(MIT-LICENSE README.textile Gemfile Rakefile init.rb) + Dir.glob("{lib,spec}/**/*")
     
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   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/turkee_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class TurkeeGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  desc "Creates initializer and migrations."
+  
+  def create_initializer
+    template "turkee.rb", "config/initializers/turkee.rb"
+  end
+  
+  def create_migrations
+    migration_template "turkee_migration.rb.erb", "db/migrate/create_turkee_tasks.rb"
+    
+    # Need this sleep so that we don't get the same migration timestamp for both migrations
+    sleep 1
+    
+    migration_template "turkee_imported_assignments.rb.erb", "db/migrate/create_turkee_imported_assignments.rb"
+  end
+end

data/lib/tasks/turkee.rb

@@ -1,8 +1,8 @@
 require 'rake'
 require 'turkee'
 
-include ActionController::PolymorphicRoutes
-include ActionView::Helpers::UrlHelper
+#include ActionController::PolymorphicRoutes
+#include ActionView::Helpers::UrlHelper
 
 # clear && rake turkee:post_hit['Test title','Test desc','Joke',3,0.05,1] --trace
 

data/lib/turkee.rb

@@ -17,7 +17,7 @@ module Turkee
     # belongs_to :task, :polymorphic => true
     HIT_FRAMEHEIGHT     = 1000
 
-    named_scope :unprocessed_hits, :conditions => ['complete = ?', false]
+    scope :unprocessed_hits, :conditions => ['complete = ?', false]
 
     # Use this method to go out and retrieve the data for all of the posted Turk Tasks.
     #  Each specific TurkeeTask object (determined by task_type field) is in charge of
@@ -159,9 +159,11 @@ module Turkee
     end
 
     def self.form_url(host, typ)
-      @app ||= ActionController::Integration::Session.new
+      @app ||= ActionController::Integration::Session.new(Rails.application)
       #@app.send("new_#{typ.to_s.underscore}_url(:host => '#{host}')")  # Not sure why app does respond when :host is passed...
-      (host + @app.send("new_#{typ.to_s.underscore}_path")) # Workaround for now. :(
+      url = (host + @app.send("new_#{typ.to_s.underscore}_path")) # Workaround for now. :(
+      puts "form_url = #{url}"
+      url
     end
 
   end
@@ -169,35 +171,42 @@ module Turkee
 
   module TurkeeFormHelper
 
-    # Rails 2.3.8 form_for implementation with the exception of the form action url
+    # Rails 3.0.7 form_for implementation with the exception of the form action url
     # will always point to the Amazon externalSubmit interface and you must pass in the
     # assignment_id parameter.
-    def turkee_form_for(record_or_name_or_array, assignment_id, *args, &proc)
+    def turkee_form_for(record_or_name_or_array, params, *args, &proc)
       raise ArgumentError, "Missing block" unless block_given?
+      raise ArgumentError, "turkee_form_for now requires that you pass in the entire params hash, instead of just the assignmentId value. " unless params.is_a?(Hash)
 
       options = args.extract_options!
 
       case record_or_name_or_array
-        when String, Symbol
-          object_name = record_or_name_or_array
-        when Array
-          object = record_or_name_or_array.last
-          object_name = ActionController::RecordIdentifier.singular_class_name(object)
-          apply_form_for_options!(record_or_name_or_array, options)
-          args.unshift object
-        else
-          object = record_or_name_or_array
-          object_name = ActionController::RecordIdentifier.singular_class_name(object)
-          apply_form_for_options!([object], options)
-          args.unshift object
+      when String, Symbol
+        ActiveSupport::Deprecation.warn("Using form_for(:name, @resource) is deprecated. Please use form_for(@resource, :as => :name) instead.", caller) unless args.empty?
+        object_name = record_or_name_or_array
+      when Array
+        object = record_or_name_or_array.last
+        object_name = options[:as] || ActiveModel::Naming.singular(object)
+        apply_form_for_options!(record_or_name_or_array, options)
+        args.unshift object
+      else
+        object = record_or_name_or_array
+        object_name = options[:as] || ActiveModel::Naming.singular(object)
+        apply_form_for_options!([object], options)
+        args.unshift object
       end
 
-      # concat(form_tag(options.delete(:url) || {}, options.delete(:html) || {}))
-      concat(form_tag(mturk_url, options.delete(:html) || {}))
-      concat("<input type=\"hidden\" id=\"assignmentId\" name=\"assignmentId\" value=\"#{assignment_id}\"/>")
-      fields_for(object_name, *(args << options), &proc)
-      concat('</form>'.html_safe)
-      self
+      (options[:html] ||= {})[:remote] = true if options.delete(:remote)
+
+      output = form_tag(mturk_url, options.delete(:html) || {})
+      params.each do |k,v|
+        unless k =~ /^action$/i || k =~ /^controller$/i
+          output.safe_concat("<input type=\"hidden\" id=\"#{k}\" name=\"#{CGI.escape(k)}\" value=\"#{CGI.escape(v)}\"/>")
+        end
+      end
+      options[:disabled] = true if params[:assignmentId].nil? || Turkee::TurkeeFormHelper::disable_form_fields?(params[:assignmentId])
+      output << fields_for(object_name, *(args << options), &proc)
+      output.safe_concat('</form>')
     end
 
     # Returns the external Mechanical Turk url used to post form data based on whether RTurk is cofigured
@@ -207,10 +216,10 @@ module Turkee
     end
 
     # Returns whether the form fields should be disabled or not (based on the assignment_id)
-    def self.disable_form_fields?(assignment_id)
+    def self.disable_form_fields?(assignment)
+      assignment_id = assignment.is_a?(Hash) ? assignment[:assignmentId] : assignment
       (assignment_id.nil? || assignment_id == 'ASSIGNMENT_ID_NOT_AVAILABLE')
     end
-
   end
 
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: turkee
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 4
-  version: 1.0.4
+  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jim Jones
@@ -15,41 +10,52 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-03 00:00:00 -08:00
-default_executable: 
+date: 2011-05-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rturk
-  prerelease: false
+  name: turkee
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
-        version: 2.3.0
-  type: :development
+        version: "0"
+  type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: lockfile
-  prerelease: false
+  name: rails
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 4
-        - 3
-        version: 1.4.3
-  type: :development
+        version: 3.0.7
+  type: :runtime
+  prerelease: false
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rturk
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: lockfile
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
 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
 executables: []
@@ -60,10 +66,12 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- Gemfile
 - Rakefile
-- generators/turkee/templates/turkee_imported_assignments.rb.erb
-- generators/turkee/templates/turkee_migration.rb.erb
-- generators/turkee/turkee_generator.rb
+- lib/generators/turkee/templates/turkee.rb
+- lib/generators/turkee/templates/turkee_imported_assignments.rb.erb
+- lib/generators/turkee/templates/turkee_migration.rb.erb
+- lib/generators/turkee/turkee_generator.rb
 - lib/tasks/turkee.rb
 - lib/turkee.rb
 - spec/spec.opts
@@ -71,13 +79,12 @@ files:
 - spec/turkee_spec.rb
 - LICENSE
 - README.rdoc
-has_rdoc: true
 homepage: http://github.com/aantix/turkee
 licenses: []
 
 post_install_message: "\n  ========================================================================\n  Turkee Installation Complete.\n  ------------------------------------------------------------------------\n\n  For instructions on gem usage, visit:\n    http://github.com/aantix/turkee#readme\n\n  ** If you like the Turkee gem, please click the \"watch\" button on the\n  Github project page.  You'll make me smile and feel appreciated. :)\n    http://github.com/aantix/turkee\n\n  ========================================================================\n  -- Gobble, gobble.\n  "
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -85,26 +92,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.1
 signing_key: 
 specification_version: 3
 summary: Turkee makes dealing with Amazon's Mechnical Turk a breeze.
-test_files: 
-- spec/spec_helper.rb
-- spec/turkee_spec.rb
+test_files: []
+

data/generators/turkee/turkee_generator.rb

@@ -1,15 +0,0 @@
-class TurkeeGenerator < Rails::Generator::Base
-
-  def manifest
-    record do |m|
-      m.migration_template "turkee_migration.rb.erb", File.join('db', 'migrate'), :migration_file_name => 'create_turkee_tasks'
-      m.sleep 1   # Need this sleep so that we don't get the same migration timestamp for both migrations
-      m.migration_template "turkee_imported_assignments.rb.erb", File.join('db', 'migrate'), :migration_file_name => 'create_turkee_imported_assignments'
-    end
-  end
-
-  def banner
-    %{Usage: #{$0} #{spec.name}\nCopies needed migrations to project.}
-  end
-
-end