shared_workforce 0.1.0 → 0.1.1

data/README.markdown

@@ -0,0 +1,150 @@
+Shared Workforce Client
+=======================
+
+Shared Workforce is a platform for managing and completing repetitive tasks that require human intelligence. For example, tagging photos, approving text and answering simple questions.
+
+It differs from other similar services in the following ways:
+
+* All tasks should be very simple and typically take no more than 10-15 seconds. (larger tasks can be broken down in to smaller ones). 
+* Tasks are displayed from a selection of pre-defined formats.
+* Very simple integration via this ruby gem or the straight forward REST API.
+
+The service is currently in private beta. You can apply for an invitation at [sharedworkforce.com](http://www.sharedworkforce.com).
+
+Getting started
+===============
+
+### Step 1 - get an API key
+
+Register for a beta invitation at [sharedworkforce.com](http://www.sharedworkforce.com). Once you are invited, you can create your account and retrieve your API key - which will look something like this:
+
+    acdc30b2-14c5-46ee-ba35-11d50edc65ec
+
+### Step 2 - add the gem
+  
+Add shared_workforce to your Gemfile:
+
+    gem "shared_workforce"
+
+Or, for Rails 2.x add the gem to your environment.rb
+
+    config.gem "shared_workforce"
+
+Create config/initializers/shared_workforce.rb
+
+    SharedWorkforce.configure do |config|
+      config.api_key = "your-api-key"
+      config.callback_host = "http://your-website-host"
+    end
+
+If you're not using Rails, simply require the gem or include it in your Gemfile, set the client configuration settings as above.
+
+### Step 3 - define tasks
+
+Create a directory called 'tasks' in the root of your app. This is where you define your tasks - all files in this directory will be loaded.
+
+If, for example, you would like to have a photo tagged on upload, create your first task in a file called tasks/tag_photo.rb
+
+    SharedWorkforce::Task.define "Tag photo" do |t|
+  
+      t.directions = "Look at this photo. Please tick all that apply."
+      t.answer_options = ['Offensive', 'Contains Nudity', 'Blurry or low quality']
+      t.answer_type = :tags
+      t.responses_required = 1
+      t.replace = true
+
+      t.on_completion do |result|
+        photo = Photo.find(result.callback_params['photo_id'])
+        if result.answers.include?('Offensive')
+          photo.hide!
+          photo.add_comment("Photo hidden because it was offensive")
+        elsif result.answers.include?('Contains Nudity')
+          photo.refer!
+          photo.add_comment("Photo referred because it contains nudity")
+        else
+          photo.approve!
+        end
+      end
+
+    end
+
+### Step 4 - request tasks
+
+Publishing tasks is simply a case of calling SharedWorkforce::Task.request(name, options).  If you are using Rails, this could be done in an after save callback on a model:
+
+    class Photo < ActiveRecord::Base
+    
+      after_create :request_tags
+    
+      def request_tags
+        SharedWorkforce::Task.request "Tag photo", {:image_url => self.url, :callback_params => { :photo_id => self.id} }
+      end
+    end
+
+
+That's it - once your task is completed the callback you have defined in the task definition will be called. Everything you define in the :callback_params option will be sent back to your callback as shown in the example.
+
+Advanced definition options
+----------------------------------------
+
+### Task types
+
+SharedWorkforce currently supports 2 types of task. :tags (multiple select) and :choice (single answer from a list of options).  Free-form input is planned in the near future.
+
+    SharedWorkforce::Task.define |t|
+      t.answer_type = #:tags or :choice
+    end
+
+###Multiple responses
+
+SharedWorkforce supports multiple responses for each task. The callback method provides you with an array of responses from multiple workers. You can create your own logic to decide what to do. This is useful if you want to prevent destructive action unless a number of workers agree.
+
+    SharedWorkforce::Task.define "Tag photo" do |t|
+  
+      t.directions = "Look at this photo. Please tick all that apply."
+      t.answer_options = ['Offensive', 'Contains Nudity', 'Blurry or low quality']
+      t.answer_type = :tags
+      t.responses_required = 3
+
+      t.on_completion do |result|
+        photo = Photo.find(result.callback_params['photo_id'])
+        photo.hide! if result.answers.all? { |a| a == 'Contains Nudity' }
+      end
+
+    end
+
+###Replacing tasks
+
+The "replace" option allows you to overwrite or update any existing tasks with the same name and callback params. This could be useful in the example to handle the situation where a user re-uploads their photo - you may only care about the latest one.
+
+    SharedWorkforce::Task.define "Tag photo" do |t|
+      ...
+      t.replace=true
+      ...  
+    end
+
+###Cancelling tasks
+
+You can cancel tasks when they are no longer relevant.
+ 
+    class Photo < ActiveRecord::Base
+      after_destroy :cancel_tagging_request
+
+      def cancel_tagging_request
+        SharedWorkforce::Task.cancel "Classify photo", :callback_params=>{:photo_id=>self.id})
+      end
+    end
+
+###Testing and development
+
+You can black-hole requests to SharedWorkforce for testing and development by adding the following configuration option in your initializer:
+
+    SharedWorkforce.configure do |config|
+      config.request_class = SharedWorkforce::TaskRequest::BlackHole
+    end
+
+License
+-----------
+
+The SharedWorkforce Client is (c) [Pigment](http://www.thinkpigment.com) and released under the MIT license
+

data/lib/shared_workforce/client.rb

@@ -1,15 +1,7 @@
 module SharedWorkforce
   class Client
-  
-    @http_end_point = "http://hci.heroku.com"
-    @load_path = "tasks"
-  
     class << self
-      attr_accessor :api_key
       attr_accessor :load_path
-      attr_accessor :http_end_point
-      attr_accessor :callback_host
-      attr_accessor :callback_path
       
       def version
         SharedWorkforce::VERSION
@@ -20,15 +12,6 @@ module SharedWorkforce
           load file
         end
       end
-      
-      def callback_url
-        callback_host + '/' + callback_path
-      end
-      
-      def callback_path
-        "hci_task_result"
-      end
     end
-  
   end
 end

data/lib/shared_workforce/configuration.rb

@@ -0,0 +1,26 @@
+module SharedWorkforce
+  class Configuration
+    
+    attr_accessor :api_key
+    attr_accessor :load_path
+    attr_accessor :http_end_point
+    attr_accessor :callback_host
+    attr_accessor :request_class
+    attr_writer :callback_path
+    
+    def initialize
+      @http_end_point = "http://api.sharedworkforce.com"
+      @load_path = "tasks"
+      @request_class = TaskRequest::Http
+    end
+    
+    def callback_url
+      callback_host.to_s + '/' + callback_path.to_s
+    end
+    
+    def callback_path
+      @callback_path ||= "hci_task_result"
+    end 
+    
+  end
+end

data/lib/shared_workforce/end_point.rb

@@ -6,7 +6,7 @@ module SharedWorkforce
     end
 
     def call(env)
-      if env["PATH_INFO"] =~ /^\/#{Client.callback_path}/
+      if env["PATH_INFO"] =~ /^\/#{callback_path}/
         process_request(env)
       else
         @app.call(env)
@@ -29,6 +29,10 @@ module SharedWorkforce
         [""]  
       ]
     end
+    
+    def callback_path
+      SharedWorkforce.configuration.callback_path
+    end
 
   end
 end

data/lib/shared_workforce/frameworks/rails.rb

@@ -1,13 +1,13 @@
 if defined?(ActionController::Metal)
   class Railtie < Rails::Railtie
     initializer :load_hci do |app|
-      SharedWorkforce::Client.load_path = Rails.root + SharedWorkforce::Client.load_path
+      SharedWorkforce::Client.load_path = Rails.root + SharedWorkforce.configuration.load_path
       SharedWorkforce::Client.load!
     end
   end
 else
   Rails.configuration.after_initialize do
-    SharedWorkforce::Client.load_path = Rails.root + SharedWorkforce::Client.load_path
+    SharedWorkforce::Client.load_path = Rails.root + SharedWorkforce.configuration.load_path
     SharedWorkforce::Client.load!
   end
 end

data/lib/shared_workforce/task.rb

@@ -10,9 +10,6 @@ module SharedWorkforce
       end
 
       def define(name, &block)
-        raise ConfigurationError, "Please set your SharedWorkforce api key with SharedWorkforce::Client.api_key = 'your-api-key-here'" unless Client.api_key
-        raise ConfigurationError, "Please set your callback URL with SharedWorkforce::Client.callback_host = 'www.your-domain-name.com'" unless Client.callback_host
-        
         task = self.new
         task.name = name
         yield task
@@ -50,12 +47,12 @@ module SharedWorkforce
     end
   
     def request(options)
-      task_request = TaskRequest.new(self, options)
+      task_request = remote_request(self, options)
       task_request.create
     end
     
     def cancel(options)
-      task_request = TaskRequest.new(self, options)
+      task_request = remote_request(self, options)
       task_request.cancel
     end
   
@@ -67,7 +64,7 @@ module SharedWorkforce
         :answer_options => answer_options,
         :responses_required => responses_required,
         :answer_type => answer_type.to_s,
-        :callback_url => Client.callback_url,
+        :callback_url => callback_url,
         :replace => replace
       }
     end
@@ -89,7 +86,15 @@ module SharedWorkforce
     def fail!(results)
       @on_failure_proc.call(results) if @on_failure_proc
     end
-  
-  
+    
+    private
+    
+    def callback_url
+      SharedWorkforce.configuration.callback_url
+    end
+    
+    def remote_request(*args)
+      SharedWorkforce.configuration.request_class.new(*args)
+    end
   end
 end

data/lib/shared_workforce/task_request/black_hole.rb

@@ -0,0 +1,7 @@
+require 'rest_client'
+module SharedWorkforce
+  class TaskRequest::BlackHole < TaskRequest  
+    def create; end
+    def cancel; end
+  end
+end

data/lib/shared_workforce/task_request/http.rb

@@ -0,0 +1,19 @@
+require 'rest_client'
+module SharedWorkforce
+  class TaskRequest::Http < TaskRequest
+    
+    def initialize(*args)
+      raise ConfigurationError, "Please set your SharedWorkforce api key with SharedWorkforce::Client.api_key = 'your-api-key-here'" unless SharedWorkforce.configuration.api_key
+      raise ConfigurationError, "Please set your callback URL with SharedWorkforce::Client.callback_host = 'www.your-domain-name.com'" unless SharedWorkforce.configuration.callback_host
+      super(*args)
+    end
+    
+    def create
+      RestClient.post("#{http_end_point}/tasks", *request_params)
+    end
+  
+    def cancel
+      RestClient.post("#{http_end_point}/tasks/cancel", *request_params)
+    end
+  end
+end

data/lib/shared_workforce/task_request/task_request.rb

@@ -0,0 +1,29 @@
+require 'json'
+module SharedWorkforce
+  class TaskRequest
+    
+    def initialize(task, params)
+      @task = task
+      @params = params
+    end
+    
+    private
+    
+    def request_params
+      [{:task=>@task.to_hash.merge(@params).merge(:callback_url=>callback_url), :api_key=>api_key}.to_json, {:content_type => :json, :accept => :json}]
+    end
+    
+    def http_end_point
+      SharedWorkforce.configuration.http_end_point
+    end
+    
+    def callback_url
+      SharedWorkforce.configuration.callback_url
+    end
+    
+    def api_key
+      SharedWorkforce.configuration.api_key
+    end
+    
+  end
+end

data/lib/shared_workforce/version.rb

@@ -1,4 +1,4 @@
 module SharedWorkforce
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 
 end

data/lib/shared_workforce.rb

@@ -1,9 +1,29 @@
+require 'shared_workforce/configuration'
 require 'shared_workforce/exceptions'
 require 'shared_workforce/client'
 require 'shared_workforce/version'
 require 'shared_workforce/task'
-require 'shared_workforce/task_request'
+require 'shared_workforce/task_request/task_request'
+require 'shared_workforce/task_request/black_hole'
+require 'shared_workforce/task_request/http'
 require 'shared_workforce/task_result'
 require 'shared_workforce/task_response'
 require 'shared_workforce/end_point'
-require 'shared_workforce/frameworks/rails' if defined?(Rails)
+require 'shared_workforce/frameworks/rails' if defined?(Rails)
+
+module SharedWorkforce
+  
+  class << self
+    
+    attr_writer :configuration
+    
+    def configure
+      yield(configuration); nil
+    end
+
+    def configuration
+      @configuration ||= SharedWorkforce::Configuration.new
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -5,6 +5,10 @@ require 'rspec'
 require 'rspec/autorun'
 require 'webmock/rspec'
 
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.expand_path('../support', __FILE__), '**/*.rb')].each {|f| require f}
+
 RSpec.configure do |config|
   config.color_enabled = true
   config.after :each do
@@ -12,8 +16,10 @@ RSpec.configure do |config|
   end
   
   config.before :each do
-    SharedWorkforce::Client.api_key = "test-api-key"
-    SharedWorkforce::Client.callback_host = "www.example.com"
+    SharedWorkforce.configure do |config|
+      config.api_key = "test-api-key"
+      config.callback_host = "www.example.com"
+    end
   end
 end
 

data/spec/support/configuration_helper.rb

@@ -0,0 +1,17 @@
+module ConfigurationHelper
+  def configure(&block)
+    SharedWorkforce.configure(&block)
+  end
+
+  def with_configuration(&block)
+    old_configuration = SharedWorkforce.configuration
+    SharedWorkforce.configuration = SharedWorkforce::Configuration.new
+    yield(SharedWorkforce.configuration)
+  ensure
+    SharedWorkforce.configuration = old_configuration
+  end
+end
+
+RSpec.configure do |config|
+  config.include ConfigurationHelper
+end

data/spec/task_request/black_hole_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "TaskRequest::BlackHole" do
+  describe "#create" do
+    it "should not make an HTTP request" do
+      task_request = SharedWorkforce::TaskRequest::BlackHole.new(SharedWorkforce::Task.find("Approve photo"), :callback_params=>{:resource_id=>'1234'})
+      task_request.create
+      a_request(:any, "api.sharedworkforce.com/tasks").should_not have_been_made
+    end
+  end 
+  
+  describe "#cancel" do
+    it "should not make an HTTP request" do
+      task_request = SharedWorkforce::TaskRequest::BlackHole.new(SharedWorkforce::Task.find("Approve photo"), :callback_params=>{:resource_id=>'1234'})
+      task_request.create
+      a_request(:any, "api.sharedworkforce.com/tasks/cancel").should_not have_been_made
+    end
+  end
+end

data/spec/task_request/http_spec.rb

@@ -0,0 +1,125 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "TaskRequest::Http" do
+  describe "#create" do
+    it "should invoke a task request" do
+  
+        task = SharedWorkforce::Task.define "Approve photo" do |h|
+
+        h.directions = "Please classify this photo by choosing the appropriate tickboxes."
+        h.image_url = "http://www.google.com/logo.png"
+        h.answer_type = "tags"
+        h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
+        h.responses_required = 3
+        h.replace = false
+      
+        h.on_completion do |result|
+          puts "Complete"
+        end
+
+        h.on_failure do |result|
+          puts "Failed"
+        end
+
+      end
+    
+      task_request = SharedWorkforce::TaskRequest::Http.new(task, :callback_params=>{:resource_id=>'1234'})
+    
+      stub_request(:post, "api.sharedworkforce.com/tasks")
+      task_request.create
+      a_request(:post, "http://api.sharedworkforce.com/tasks").with(:body=>{'task'=>
+        {
+          'name'=>"Approve photo",
+          'directions'=>"Please classify this photo by choosing the appropriate tickboxes.",
+          'image_url'=>"http://www.google.com/logo.png",
+          'answer_options'=> ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children'],
+          'responses_required'=>3,
+          'answer_type'=>'tags',
+          'callback_url'=>"#{SharedWorkforce.configuration.callback_host}/hci_task_result",
+          'callback_params'=>{'resource_id'=>'1234'},
+          'replace'=>false
+        }, :api_key=>'test-api-key'}).should have_been_made.once
+    
+    end
+    
+    it "should allow options to be overridden when making the request" do
+
+       task = SharedWorkforce::Task.define "Approve photo" do |h|
+
+         h.directions = "Please classify this photo by choosing the appropriate tickboxes."
+         h.image_url = "http://www.google.com/logo.png"
+         h.answer_type = "tags"
+         h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
+         h.responses_required = 3
+
+         h.on_completion do |result|
+           puts "Complete"
+         end
+
+         h.on_failure do |result|
+           puts "Failed"
+         end
+
+       end
+
+       task_request = SharedWorkforce::TaskRequest::Http.new(task, {:callback_params=>{:resource_id=>'1234'}, :image_url=>"http://www.example.com/image.jpg"})
+
+       stub_request(:post, "api.sharedworkforce.com/tasks")
+       task_request.create
+       a_request(:post, "http://api.sharedworkforce.com/tasks").with(:body=>{'task'=>
+         {
+           'name'=>"Approve photo",
+           'directions'=>"Please classify this photo by choosing the appropriate tickboxes.",
+           'image_url'=>"http://www.example.com/image.jpg",
+           'answer_options'=> ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children'],
+           'responses_required'=>3,
+           'answer_type'=>'tags',
+           'callback_url'=>"#{SharedWorkforce.configuration.callback_host}/hci_task_result",
+           'callback_params'=>{'resource_id'=>'1234'},
+           'replace'=>false,
+         }, :api_key=>'test-api-key'}).should have_been_made.once
+     end
+  end
+  
+  describe "#cancel" do
+    it "should invoke a task cancellation" do
+    
+      task = SharedWorkforce::Task.define "Approve photo" do |h|
+
+        h.directions = "Please classify this photo by choosing the appropriate tickboxes."
+        h.image_url = "http://www.google.com/logo.png"
+        h.answer_type = "tags"
+        h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
+        h.responses_required = 3
+        h.replace = false
+      
+        h.on_completion do |result|
+          puts "Complete"
+        end
+
+        h.on_failure do |result|
+          puts "Failed"
+        end
+
+      end
+    
+      task_request = SharedWorkforce::TaskRequest::Http.new(task, :callback_params=>{:resource_id=>'1234'})
+    
+      stub_request(:post, "api.sharedworkforce.com/tasks/cancel")
+      task_request.cancel
+      a_request(:post, "http://api.sharedworkforce.com/tasks/cancel").with(:body=>{'task'=>
+        {
+          'name'=>"Approve photo",
+          'directions'=>"Please classify this photo by choosing the appropriate tickboxes.",
+          'image_url'=>"http://www.google.com/logo.png",
+          'answer_options'=> ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children'],
+          'responses_required'=>3,
+          'answer_type'=>'tags',
+          'callback_url'=>"#{SharedWorkforce.configuration.callback_host}/hci_task_result",
+          'callback_params'=>{'resource_id'=>'1234'},
+          'replace'=>false
+        }, :api_key=>'test-api-key'}).should have_been_made.once
+    
+    end
+  end 
+end

data/spec/task_response_spec.rb

@@ -1,15 +1,17 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "TaskResponse" do
-  it "should create responses from an array" do
-    r = SharedWorkforce::TaskResponse.create_collection_from_array([{'answer'=>'answer 1'}, {'answer'=>'answer 2'}])
-    r[0].answer.should == "answer 1"
-    r[1].answer.should == "answer 2"
-  end
+  describe ".create_collection_from_array" do
+    it "should create responses from an array" do
+      r = SharedWorkforce::TaskResponse.create_collection_from_array([{'answer'=>'answer 1'}, {'answer'=>'answer 2'}])
+      r[0].answer.should == "answer 1"
+      r[1].answer.should == "answer 2"
+    end
   
-  it "should accept and store a username" do
-    r = SharedWorkforce::TaskResponse.create_collection_from_array([{'answer'=>'answer 1', 'username'=>'bilbo'}, {'answer'=>'answer 2', 'username'=>'frodo'}])
-    r[0].username.should == "bilbo"
-    r[1].username.should == "frodo"
+    it "should accept and store a username" do
+      r = SharedWorkforce::TaskResponse.create_collection_from_array([{'answer'=>'answer 1', 'username'=>'bilbo'}, {'answer'=>'answer 2', 'username'=>'frodo'}])
+      r[0].username.should == "bilbo"
+      r[1].username.should == "frodo"
+    end
   end
 end

data/spec/task_result_spec.rb

@@ -1,40 +1,44 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "TaskResult" do
-  
-  it "should invoke a tasks complete callback" do
-    
-    resources = {}
-    resources['1'] = OpenStruct.new(:approved=>false)
-    resources['2'] = OpenStruct.new(:approved=>false)
-    resources['3'] = OpenStruct.new(:approved=>false)
-      
-    task = SharedWorkforce::Task.define("Approve photo") do |h|
+  describe "#process!" do
+    it "should invoke a tasks complete callback" do
       
-      h.on_completion do |result|
-        if result.responses.first.answer == 'yes'
-          resources[result.callback_params['resource_id']].approved = true
+      resources = {}
+      resources['1'] = OpenStruct.new(:approved=>false)
+      resources['2'] = OpenStruct.new(:approved=>false)
+      resources['3'] = OpenStruct.new(:approved=>false)
+        
+      task = SharedWorkforce::Task.define("Approve photo") do |h|
+        
+        h.on_completion do |result|
+          if result.responses.first.answer == 'yes'
+            resources[result.callback_params['resource_id']].approved = true
+          end
         end
+        
       end
       
+      SharedWorkforce::TaskResult.new({'callback_params'=>{'resource_id' => '2'}, 'responses'=>[{'answer'=>'yes'}], 'name'=>"Approve photo"}).process!
+      
+      resources['1'].approved.should == false
+      resources['2'].approved.should == true
+      resources['3'].approved.should == false
+      
     end
-    
-    SharedWorkforce::TaskResult.new({'callback_params'=>{'resource_id' => '2'}, 'responses'=>[{'answer'=>'yes'}], 'name'=>"Approve photo"}).process!
-    
-    resources['1'].approved.should == false
-    resources['2'].approved.should == true
-    resources['3'].approved.should == false
-    
   end
   
-  it "should collect the answers" do  
-    r = SharedWorkforce::TaskResult.new({'callback_params'=>{'resource_id' => '2'}, 'responses'=>[{'answer'=>'yes'}, {'answer'=>'no'}, {'answer'=>'yes'}], 'name'=>"Approve photo"})
-    r.answers.should == ['yes', 'no', 'yes']
+  describe "#answers" do
+    it "should collect the answers" do  
+      r = SharedWorkforce::TaskResult.new({'callback_params'=>{'resource_id' => '2'}, 'responses'=>[{'answer'=>'yes'}, {'answer'=>'no'}, {'answer'=>'yes'}], 'name'=>"Approve photo"})
+      r.answers.should == ['yes', 'no', 'yes']
+    end
   end
   
-  it "should collect the usernames" do  
-    r = SharedWorkforce::TaskResult.new({'callback_params'=>{'resource_id' => '2'}, 'responses'=>[{'answer'=>'yes', 'username'=>'bilbo'}, {'answer'=>'no', 'username'=>'frodo'}, {'answer'=>'yes', 'username'=>'sam'}], 'name'=>"Approve photo"})
-    r.usernames.should == ['bilbo', 'frodo', 'sam']
+  describe "#usernames" do
+    it "should collect the usernames" do  
+      r = SharedWorkforce::TaskResult.new({'callback_params'=>{'resource_id' => '2'}, 'responses'=>[{'answer'=>'yes', 'username'=>'bilbo'}, {'answer'=>'no', 'username'=>'frodo'}, {'answer'=>'yes', 'username'=>'sam'}], 'name'=>"Approve photo"})
+      r.usernames.should == ['bilbo', 'frodo', 'sam']
+    end
   end
-  
-end
+end

data/spec/task_spec.rb

@@ -91,17 +91,23 @@ describe "Task" do
   end
   
   it "should raise a ConfigurationError if a callback host is not set" do
-    SharedWorkforce::Client.callback_host = nil
-    lambda {
-      SharedWorkforce::Task.define("Approve photo") { }
-    }.should raise_error SharedWorkforce::ConfigurationError
+    SharedWorkforce::Task.define("Approve photo") {}
+    with_configuration do |config|
+      config.callback_host = nil
+      lambda {
+        SharedWorkforce::Task.request("Approve photo", {})
+      }.should raise_error SharedWorkforce::ConfigurationError
+    end
   end
   
   it "should raise a ConfigurationError if an API key is not set" do
-    SharedWorkforce::Client.api_key = nil
-    lambda {
-      SharedWorkforce::Task.define("Approve photo") { }
-    }.should raise_error SharedWorkforce::ConfigurationError
+    SharedWorkforce::Task.define("Approve photo") {}
+    with_configuration do |config|
+      config.api_key = nil
+      lambda {
+        SharedWorkforce::Task.request("Approve photo", {})
+      }.should raise_error SharedWorkforce::ConfigurationError
+    end
   end
 end
 

metadata

@@ -2,7 +2,7 @@
 name: shared_workforce
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Sam Oliver
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-13 00:00:00 +01:00
+date: 2011-05-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,15 +69,18 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README.rdoc
+- README.markdown
 - Rakefile
 - lib/shared_workforce.rb
 - lib/shared_workforce/client.rb
+- lib/shared_workforce/configuration.rb
 - lib/shared_workforce/end_point.rb
 - lib/shared_workforce/exceptions.rb
 - lib/shared_workforce/frameworks/rails.rb
 - lib/shared_workforce/task.rb
-- lib/shared_workforce/task_request.rb
+- lib/shared_workforce/task_request/black_hole.rb
+- lib/shared_workforce/task_request/http.rb
+- lib/shared_workforce/task_request/task_request.rb
 - lib/shared_workforce/task_response.rb
 - lib/shared_workforce/task_result.rb
 - lib/shared_workforce/version.rb
@@ -85,7 +88,9 @@ files:
 - spec/.rspec
 - spec/client_spec.rb
 - spec/spec_helper.rb
-- spec/task_request_spec.rb
+- spec/support/configuration_helper.rb
+- spec/task_request/black_hole_spec.rb
+- spec/task_request/http_spec.rb
 - spec/task_response_spec.rb
 - spec/task_result_spec.rb
 - spec/task_spec.rb
@@ -121,7 +126,9 @@ summary: Shared Workforce Client
 test_files: 
 - spec/client_spec.rb
 - spec/spec_helper.rb
-- spec/task_request_spec.rb
+- spec/support/configuration_helper.rb
+- spec/task_request/black_hole_spec.rb
+- spec/task_request/http_spec.rb
 - spec/task_response_spec.rb
 - spec/task_result_spec.rb
 - spec/task_spec.rb

data/lib/shared_workforce/task_request.rb

@@ -1,27 +0,0 @@
-require 'rest_client'
-require 'json'
-module SharedWorkforce
-  class TaskRequest
-  
-    def initialize(task, params)
-      @task = task
-      @params = params
-      @http_end_point = Client.http_end_point
-    end
-  
-    def create
-      RestClient.post("#{@http_end_point}/tasks", *request_params)
-    end
-    
-    def cancel
-      RestClient.post("#{@http_end_point}/tasks/cancel", *request_params)
-    end
-    
-    private
-    
-    def request_params
-      [{:task=>@task.to_hash.merge(@params).merge(:callback_url=>Client.callback_url), :api_key=>Client.api_key}.to_json, {:content_type => :json, :accept => :json}]
-    end
-    
-  end
-end

data/spec/task_request_spec.rb

@@ -1,126 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "TaskRequest" do
-  
-  it "should invoke a task request" do
-    
-    task = SharedWorkforce::Task.define "Approve photo" do |h|
-
-      h.directions = "Please classify this photo by choosing the appropriate tickboxes."
-      h.image_url = "http://www.google.com/logo.png"
-      h.answer_type = "tags"
-      h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
-      h.responses_required = 3
-      h.replace = false
-      
-      h.on_completion do |result|
-        puts "Complete"
-      end
-
-      h.on_failure do |result|
-        puts "Failed"
-      end
-
-    end
-    
-    task_request = SharedWorkforce::TaskRequest.new(task, :callback_params=>{:resource_id=>'1234'})
-    
-    stub_request(:post, "hci.heroku.com/tasks")
-    task_request.create
-    a_request(:post, "http://hci.heroku.com/tasks").with(:body=>{'task'=>
-      {
-        'name'=>"Approve photo",
-        'directions'=>"Please classify this photo by choosing the appropriate tickboxes.",
-        'image_url'=>"http://www.google.com/logo.png",
-        'answer_options'=> ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children'],
-        'responses_required'=>3,
-        'answer_type'=>'tags',
-        'callback_url'=>"#{SharedWorkforce::Client.callback_host}/hci_task_result",
-        'callback_params'=>{'resource_id'=>'1234'},
-        'replace'=>false
-      }, :api_key=>'test-api-key'}).should have_been_made.once
-    
-  end
-  
-  
-  it "should invoke a task cancellation" do
-    
-    task = SharedWorkforce::Task.define "Approve photo" do |h|
-
-      h.directions = "Please classify this photo by choosing the appropriate tickboxes."
-      h.image_url = "http://www.google.com/logo.png"
-      h.answer_type = "tags"
-      h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
-      h.responses_required = 3
-      h.replace = false
-      
-      h.on_completion do |result|
-        puts "Complete"
-      end
-
-      h.on_failure do |result|
-        puts "Failed"
-      end
-
-    end
-    
-    task_request = SharedWorkforce::TaskRequest.new(task, :callback_params=>{:resource_id=>'1234'})
-    
-    stub_request(:post, "hci.heroku.com/tasks/cancel")
-    task_request.cancel
-    a_request(:post, "http://hci.heroku.com/tasks/cancel").with(:body=>{'task'=>
-      {
-        'name'=>"Approve photo",
-        'directions'=>"Please classify this photo by choosing the appropriate tickboxes.",
-        'image_url'=>"http://www.google.com/logo.png",
-        'answer_options'=> ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children'],
-        'responses_required'=>3,
-        'answer_type'=>'tags',
-        'callback_url'=>"#{SharedWorkforce::Client.callback_host}/hci_task_result",
-        'callback_params'=>{'resource_id'=>'1234'},
-        'replace'=>false
-      }, :api_key=>'test-api-key'}).should have_been_made.once
-    
-  end
-  
-  it "should allow options to be overridden when making the request" do
-    
-    task = SharedWorkforce::Task.define "Approve photo" do |h|
-
-      h.directions = "Please classify this photo by choosing the appropriate tickboxes."
-      h.image_url = "http://www.google.com/logo.png"
-      h.answer_type = "tags"
-      h.answer_options = ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
-      h.responses_required = 3
-
-      h.on_completion do |result|
-        puts "Complete"
-      end
-
-      h.on_failure do |result|
-        puts "Failed"
-      end
-
-    end
-    
-    task_request = SharedWorkforce::TaskRequest.new(task, {:callback_params=>{:resource_id=>'1234'}, :image_url=>"http://www.example.com/image.jpg"})
-    
-    stub_request(:post, "hci.heroku.com/tasks")
-    task_request.create
-    a_request(:post, "http://hci.heroku.com/tasks").with(:body=>{'task'=>
-      {
-        'name'=>"Approve photo",
-        'directions'=>"Please classify this photo by choosing the appropriate tickboxes.",
-        'image_url'=>"http://www.example.com/image.jpg",
-        'answer_options'=> ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children'],
-        'responses_required'=>3,
-        'answer_type'=>'tags',
-        'callback_url'=>"#{SharedWorkforce::Client.callback_host}/hci_task_result",
-        'callback_params'=>{'resource_id'=>'1234'},
-        'replace'=>false,
-      }, :api_key=>'test-api-key'}).should have_been_made.once
-  end
-  
-end
-
-