shared_workforce 0.2.14 → 0.3.0

data/README.markdown

@@ -81,6 +81,14 @@ end
 ```
 _**Note:** the task definition includes a `setup` method which is called automatically whenever the task is initialized. In the example, the task's `image_url` (the image shown to the worker) is set from the photo model's url attribute. Any of the task's attributes can be set this way._
 
+Class level attributes are a handy way of defining data that doesn't change between each task.
+Attributes set on the instance will always override attributes set at the class level.
+
+In most cases, you'll want to explicitly set default task values at the class level
+(like `title` and `instruction`). Setting `text`
+and `image_url` values (i.e. the content in question) will usually be done in
+the `setup` method.</p>
+
 Once you have created a task definition, you can request real human responses for a model instance by calling its `create` method. This can be done in an `after_create` callback in one of your Active Record models. This will be covered in more detail in the next section.
 
 ### Step 4 - request tasks
@@ -102,6 +110,16 @@ _**Note:** In the example, the photo model instance (self) is used an argument t
 
 When the response(s) from the human workers are collected, the method specified in the `on_success` attribute in your task definition will be called. Typically this will take about 15 minutes. You can check the [Shared Workforce web site](http://www.sharedworkforce.com) for an up to date status on the current response time.
 
+### Step 5 - collect responses
+
+A rake task is provided for collecting the responses *during development*.
+
+```
+$ rake sw:collect
+```
+
+There is no requirement to run the rake task in production. The webhook will be used to deliver the task responses.
+
 ### Unit testing
 
 You can test your task definition by calling its methods directly.

data/lib/shared_workforce/configuration.rb

@@ -31,7 +31,7 @@ module SharedWorkforce
     end
 
     def logger
-      @logger ||= (rails_logger || default_logger)
+      @logger ||= default_logger
     end
 
     def valid?
@@ -43,7 +43,7 @@ module SharedWorkforce
     def default_request_class
       if defined?(Rails)
         if Rails.env.development?
-          TaskRequest::HttpWithPoller
+          TaskRequest::HttpWithoutCallbacks
         elsif Rails.env.test?
           TaskRequest::BlackHole
         else
@@ -60,10 +60,14 @@ module SharedWorkforce
     end
 
     def default_logger
-      require 'logger'
-      l = ::Logger.new($stdout)
-      l.level = ::Logger::INFO
-      l
+      if !rails_logger || (defined?(Rails) && Rails.env.development?)
+        require 'logger'
+        l = ::Logger.new($stdout)
+        l.level = ::Logger::INFO
+        l
+      else
+        rails_logger
+      end
     end
   end
 end

data/lib/shared_workforce/frameworks/rails.rb

@@ -7,12 +7,15 @@ if defined?(ActionController::Metal)
         	if SharedWorkforce.configuration.valid?
             # Stop log buffering when using Foreman in development
             $stdout.sync = true
-            SharedWorkforce::ResponsePoller.start
           else
             puts 'Shared Workforce: API key not configured.'
           end
         end
       end
     end
+
+    rake_tasks do
+      load "shared_workforce/tasks/collect.rake" if Rails.env.development?
+    end
   end
 end

data/lib/shared_workforce/response_collector.rb

@@ -0,0 +1,50 @@
+module SharedWorkforce
+  class ResponseCollector
+
+    attr_accessor :interval
+
+    def self.start(interval=nil)
+      new.start(interval)
+    end
+
+    def start(interval)
+      @interval = interval   
+      process_tasks completed_tasks
+      sleep interval if interval
+    end
+
+    private
+
+    def process_tasks(tasks)
+      if tasks.any?
+        tasks.each do |task|
+          if task['state'] == "completed"
+            SharedWorkforce.logger.info "=> #{task['title']} (#{task['id']}) complete. Loading responses."
+            responses = collect_responses(task['id'])
+
+            SharedWorkforce::TaskResult.new(responses).process!
+            SharedWorkforce.logger.info "=> Done."
+          end
+        end
+      elsif !interval
+        SharedWorkforce.logger.info "=> No responses to collect."
+      end
+    end
+
+    def completed_tasks
+      JSON.parse(RestClient.get("#{SharedWorkforce.configuration.http_end_point}/tasks/unreturned", {
+        'X-API-Key'=>SharedWorkforce.configuration.api_key,
+        :content_type => :json,
+        :accept => :json
+      }))
+    end
+
+    def collect_responses(id)
+      JSON.parse(RestClient.get("#{SharedWorkforce.configuration.http_end_point}/tasks/#{id}/responses/collect", {
+        'X-API-Key'=>SharedWorkforce.configuration.api_key,
+        :content_type => :json,
+        :accept => :json
+      }))
+    end
+  end
+end

data/lib/shared_workforce/task.rb

@@ -90,6 +90,7 @@ module SharedWorkforce
     end
 
     def process_result(result)
+      SharedWorkforce.logger.info("Shared Workforce: processing responses for #{title}")
       initialize_attributes(result.callback_params)
       success!(result)
       complete!(result)
@@ -112,6 +113,7 @@ module SharedWorkforce
     end
 
     def request(options = {})
+      SharedWorkforce.logger.info("Shared Workforce: creating task #{title}")
       task_request = remote_request(self, options)
       task_request.create
     end

data/lib/shared_workforce/task_request/{http_with_poller.rb → http_without_callbacks.rb}

@@ -1,6 +1,6 @@
 require 'rest_client'
 module SharedWorkforce
-  class TaskRequest::HttpWithPoller < TaskRequest::Http
+  class TaskRequest::HttpWithoutCallbacks < TaskRequest::Http
   	# Disable callbacks during development
     def request_params
       [{:task=>@task.to_hash.merge(@params).merge(:callback_url=>callback_url, :callback_enabled=>false), :api_key=>api_key}.to_json, {:content_type => :json, :accept => :json}]

data/lib/shared_workforce/tasks/collect.rake

@@ -0,0 +1,19 @@
+desc "Collects completed responses"
+namespace :shared_workforce do
+  task :collect => :environment do
+    $stdout.sync = true
+    puts "=> Please note: expect a delay of about 30 seconds after a task is completed before seeing a response."
+    puts "=> This gives the worker a chance to change their answer."
+    puts "=> Connecting to Shared Workforce..."
+    SharedWorkforce::ResponseCollector.start
+  end
+end
+
+namespace :sw do
+  desc "Alias of shared_workforce:collect"
+  task :collect => "shared_workforce:collect"
+end
+
+namespace :sharedworkforce do
+  task :collect => "shared_workforce:collect"
+end

data/lib/shared_workforce/version.rb

@@ -1,4 +1,4 @@
 module SharedWorkforce
-  VERSION = "0.2.14"
+  VERSION = "0.3.0"
 
 end

data/lib/shared_workforce.rb

@@ -6,11 +6,11 @@ require 'shared_workforce/task'
 require 'shared_workforce/task_request/task_request'
 require 'shared_workforce/task_request/black_hole'
 require 'shared_workforce/task_request/http'
-require 'shared_workforce/task_request/http_with_poller'
+require 'shared_workforce/task_request/http_without_callbacks'
 require 'shared_workforce/task_result'
 require 'shared_workforce/task_response'
 require 'shared_workforce/end_point'
-require 'shared_workforce/response_poller'
+require 'shared_workforce/response_collector'
 require 'shared_workforce/frameworks/rails' if defined?(Rails)
 require 'active_support/inflector'
 require 'active_support/core_ext/hash/indifferent_access'

data/spec/task_request/{http_with_poller_spec.rb → http_without_callbacks_spec.rb}

@@ -1,10 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe "TaskRequest::HttpWithPoller" do
+describe "TaskRequest::HttpWithoutCallbacks" do
   describe "#create" do
     it "should disable callbacks" do
     	task = ApprovePhotoTask.new
-      task_request = SharedWorkforce::TaskRequest::HttpWithPoller.new(task,
+      task_request = SharedWorkforce::TaskRequest::HttpWithoutCallbacks.new(task,
       	:image_url=>"http://www.google.com/logo.png",
       	:image_crop_ratio=>1.7,
       	:callback_params=>{:resource_id=>'1234'}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shared_workforce
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2012-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70318914187300 !ruby/object:Gem::Requirement
+  requirement: &70263277593000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70318914187300
+  version_requirements: *70263277593000
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70318914186880 !ruby/object:Gem::Requirement
+  requirement: &70263277592580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70318914186880
+  version_requirements: *70263277592580
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70318914186460 !ruby/object:Gem::Requirement
+  requirement: &70263277608420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70318914186460
+  version_requirements: *70263277608420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70318914185960 !ruby/object:Gem::Requirement
+  requirement: &70263277607380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.2.9
   type: :development
   prerelease: false
-  version_requirements: *70318914185960
+  version_requirements: *70263277607380
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70318914185540 !ruby/object:Gem::Requirement
+  requirement: &70263277606740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70318914185540
+  version_requirements: *70263277606740
 description: Shared Workforce is a service and simple API for human intelligence tasks
 email:
 - sam@samoliver.com
@@ -84,14 +84,15 @@ files:
 - lib/shared_workforce/end_point.rb
 - lib/shared_workforce/exceptions.rb
 - lib/shared_workforce/frameworks/rails.rb
-- lib/shared_workforce/response_poller.rb
+- lib/shared_workforce/response_collector.rb
 - lib/shared_workforce/task.rb
 - lib/shared_workforce/task_request/black_hole.rb
 - lib/shared_workforce/task_request/http.rb
-- lib/shared_workforce/task_request/http_with_poller.rb
+- lib/shared_workforce/task_request/http_without_callbacks.rb
 - lib/shared_workforce/task_request/task_request.rb
 - lib/shared_workforce/task_response.rb
 - lib/shared_workforce/task_result.rb
+- lib/shared_workforce/tasks/collect.rake
 - lib/shared_workforce/version.rb
 - shared_workforce.gemspec
 - spec/.rspec
@@ -103,7 +104,7 @@ files:
 - spec/support/configuration_helper.rb
 - spec/task_request/black_hole_spec.rb
 - spec/task_request/http_spec.rb
-- spec/task_request/http_with_poller_spec.rb
+- spec/task_request/http_without_callbacks_spec.rb
 - spec/task_response_spec.rb
 - spec/task_result_spec.rb
 - spec/task_spec.rb
@@ -141,7 +142,7 @@ test_files:
 - spec/support/configuration_helper.rb
 - spec/task_request/black_hole_spec.rb
 - spec/task_request/http_spec.rb
-- spec/task_request/http_with_poller_spec.rb
+- spec/task_request/http_without_callbacks_spec.rb
 - spec/task_response_spec.rb
 - spec/task_result_spec.rb
 - spec/task_spec.rb

data/lib/shared_workforce/response_poller.rb

@@ -1,52 +0,0 @@
-module SharedWorkforce
-  class ResponsePoller
-    # The response poller is intended for use during local development only. It 
-    # facilitates real world task responses without needing an open socket for the 
-    # web hooks.
-
-    def self.start(interval=60)
-      new.start(interval)
-    end
-
-    def start(interval)
-      Thread.abort_on_exception = true
-      Thread.new do
-        SharedWorkforce.logger.info "SharedWorkforce: Checking every #{interval} seconds for new responses."
-        
-        while true
-          SharedWorkforce.logger.info "SharedWorkforce: Checking for new task responses."
-          process_tasks completed_tasks
-          sleep interval
-        end
-      end
-    end
-
-    private
-
-    def process_tasks(tasks)
-      tasks.each do |task|
-        if task['state'] == "completed"
-          SharedWorkforce.logger.info "SharedWorkforce: Task complete. Getting responses."
-          responses = collect_responses(task['id'])
-          SharedWorkforce::TaskResult.new(responses).process!
-        end
-      end
-    end
-
-    def completed_tasks
-      JSON.parse(RestClient.get("#{SharedWorkforce.configuration.http_end_point}/tasks/unreturned", {
-        'X-API-Key'=>SharedWorkforce.configuration.api_key,
-        :content_type => :json,
-        :accept => :json
-      }))
-    end
-
-    def collect_responses(id)
-      JSON.parse(RestClient.get("#{SharedWorkforce.configuration.http_end_point}/tasks/#{id}/responses/collect", {
-        'X-API-Key'=>SharedWorkforce.configuration.api_key,
-        :content_type => :json,
-        :accept => :json
-      }))
-    end
-  end
-end