turkee-mongoid 2.0.2

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,136 @@
+PATH
+  remote: .
+  specs:
+    turkee (2.0.2)
+      lockfile
+      mongoid (>= 4.0.0.alpha1)
+      rails (>= 4.0.0)
+      rturk (>= 2.4.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.0.2)
+      actionpack (= 4.0.2)
+      mail (~> 2.5.4)
+    actionpack (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    bson (2.0.0)
+    builder (3.1.4)
+    connection_pool (1.2.0)
+    diff-lcs (1.2.5)
+    erector (0.9.0)
+      treetop (>= 1.2.3)
+    erubis (2.7.0)
+    factory_girl (4.3.0)
+      activesupport (>= 3.0.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    lockfile (2.1.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    mime-types (1.25.1)
+    mini_portile (0.5.2)
+    minitest (4.7.5)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    mongoid (4.0.0.alpha1)
+      activemodel (~> 4.0.0)
+      moped (~> 2.0.beta4)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.37)
+    moped (2.0.0.beta4)
+      bson (~> 2.0)
+      connection_pool (~> 1.2)
+      optionable (~> 0.2.0)
+    multi_json (1.8.2)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    optionable (0.2.0)
+    origin (1.1.0)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.2)
+      actionmailer (= 4.0.2)
+      actionpack (= 4.0.2)
+      activerecord (= 4.0.2)
+      activesupport (= 4.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.2)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.2)
+      actionpack (= 4.0.2)
+      activesupport (= 4.0.2)
+      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.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    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.12.1)
+      erector
+      nokogiri
+      rest-client
+    spork (0.9.2)
+    sprockets (2.10.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_girl (>= 4.3.0)
+  mocha
+  rspec-rails (~> 2.14.0)
+  spork
+  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,188 @@
+Turkee 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.
+
+Turkee Mongoid (c) 2013 Numerico
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.rdoc

@@ -0,0 +1,219 @@
+== MONGOID
+
+This is a Mongoid port of Turkee gem, for the original one and credits see {aantix/turkee}[https://github.com/aantix/turkee] 
+
+== MAINTENANCE
+
+  To be honest, this gem won't get much maintenance.
+
+  If Turkee adds new features, please fork this repository and:  
+
+  1) Add Turkee as a remote:
+
+      git remote add turkee git@github.com:aantix/turkee.git
+      
+  2) Pull it
+
+      git pull turkee master
+
+  3) Run tests
+
+      bundle exec rspec
+
+  Any new features would then appear, with new tests failing probably: that's where you comme into scene ;)
+
+== 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
+
+== 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})
+
+
+== Gotchas
+
+1) The application that hosts your external forms preferably should have an https interface (you're going to have to buy an SSL certificate).  If the forms are hosted on an unsecured host (http), because Mechanical Turk defaults to https, you're going to receive the ugly popup from IE regarding "mixed content" (http://msdn.microsoft.com/en-us/library/ee264315%28v=vs.85%29.aspx).
+
+
+== Copyright
+
+Copyright (c) 2010 - 2012 Jim Jones. See LICENSE for details.