turkee-mongoid 2.0.2

data/spec/dummy/public/javascripts/rails.js

@@ -0,0 +1,191 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var csrf_meta_tag = $$('meta[name=csrf-token]')[0];
+
+      if (csrf_meta_tag) {
+        var header = 'X-CSRF-Token',
+            token = csrf_meta_tag.readAttribute('content');
+
+        if (!request.options.requestHeaders) {
+          request.options.requestHeaders = {};
+        }
+        request.options.requestHeaders[header] = token;
+      }
+    }
+  });
+})();

data/spec/dummy/public/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/factories/survey_factory.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :survey do |s|
+    s.answer "The answer"
+    s.created_at Time.now
+    s.updated_at Time.now
+  end
+end

data/spec/factories/turkee_task_factory.rb

@@ -0,0 +1,21 @@
+require 'turkee'
+FactoryGirl.define do
+  factory :turkee_task, :class => Turkee::TurkeeTask do |s|
+    s.hit_url "http://workersandbox.mturk.com/mturk/preview?groupId=248SVGULF395SZ65OC6S6NYNJDXAO5"
+    s.sandbox true
+    s.task_type "TestTask"
+    s.hit_title "Test Title"
+    s.hit_description "Test Desc"
+    s.hit_id "123"
+    s.hit_reward 0.05
+    s.completed_assignments 0
+    s.hit_num_assignments 100
+    s.hit_lifetime 1
+    s.hit_duration 1
+    s.form_url "http://localhost/test_task/new"
+    s.complete false
+    s.expired false
+    s.created_at Time.now
+    s.updated_at Time.now
+  end
+end

data/spec/helpers/turkee_forms_helper_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Turkee::TurkeeFormHelper, :type => :helper do
+  describe "mturk_url" do
+    it "should return sandbox" do
+      RTurk.stub(:sandbox?).and_return true
+      mturk_url.should match /workersandbox.mturk.com/
+    end
+    it "should return production url" do
+      RTurk.stub(:sandbox?).and_return false
+      mturk_url.should match /www.mturk.com/
+    end
+  end
+
+  describe "turkee_study" do
+    before do
+      @task = create(:turkee_task)
+      RTurk.stub(:sandbox?).and_return true
+
+      helper.stub(:params).and_return({:assignmentId => '123456', :workerId => '987654'})
+      @study_form = helper.turkee_study
+    end
+
+    it "includes the description, textarea" do
+      @study_form.should match(/Test Desc/)
+      @study_form.should match(/feedback/)
+      @study_form.should match(/textarea/)
+      @study_form.should match(/workersandbox.mturk.com/)
+    end
+
+    it "the form points to the sandbox" do
+      @study_form = turkee_study
+      @study_form.should match(/workersandbox.mturk.com/)
+    end
+
+    it "still includes the necessary assignmentId and workerId" do
+      @study_form.should match(/assignmentId/)
+      @study_form.should match(/workerId/)
+    end
+
+  end
+
+  describe "turkee_form_for" do
+    before do
+      @survey = create(:survey)
+      RTurk.stub(:sandbox?).and_return true
+
+      params = {:assignmentId => '123456', :workerId => '987654'}
+      @survey_form = helper.turkee_form_for(@survey, params) do |f|
+        f.text_field :answer
+      end
+    end
+
+    it "displays the passed in assignmentId and workerId " do
+      @survey_form.should match(/answer/)
+      @survey_form.should match(/type=\"text\"/)
+      @survey_form.should match(/assignmentId/)
+      @survey_form.should match(/workerId/)
+    end
+
+    it "the intial turkee_form_for saved the assignmentId and workerId to a cookie for later retrieval" do
+      helper.cookies['assignmentId'].should == '123456'
+      helper.cookies['workerId'].should == '987654'
+
+      # Subsequent requests should still return form fields for assignmentId
+      survey_form = helper.turkee_form_for(@survey, {}) do |f|
+        f.text_field :answer
+      end
+      survey_form.should match(/123456/)
+      survey_form.should match(/987654/)
+      survey_form.should match(/assignmentId/)
+      survey_form.should match(/workerId/)
+    end
+  end
+end

data/spec/models/turkee_study_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Turkee::TurkeeStudy do
+
+  describe "approve?" do
+    before do
+      @study = Turkee::TurkeeStudy.new(:feedback => "I really loved the site.  I will tell my mom about it.",
+                                       :gold_response => 'the')
+    end
+    it "approves the task" do
+      @study.approve?.should be_true
+    end
+
+    it "rejects the task" do
+      @study.gold_response = "loved"
+      @study.approve?.should be_false
+    end
+  end
+end

data/spec/models/turkee_task_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+describe Turkee::TurkeeTask do
+
+  class TestTask
+    include Mongoid::Document
+
+    def self.abstract_class
+      true
+    end
+    attr_accessor :description
+  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
+
+      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 model" do
+      returned_data = {:submit => 'Create', "test_task" => {:description => "desc"}}
+      Turkee::TurkeeTask.find_model(returned_data).should == TestTask
+    end
+
+    it "should return a nil" 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"}
+      Turkee::TurkeeTask.assignment_params(answers).should == "test2=this+is+a+test&test=abc"
+    end
+  end
+
+  describe "#submitted" do
+    it "should return true for a submitted status" do
+      Turkee::TurkeeTask.submitted?("Submitted").should == true
+    end
+  end
+end