shared_workforce 0.2.2 → 0.2.3

data/lib/shared_workforce/end_point.rb

@@ -1,26 +1,26 @@
 module SharedWorkforce
   class EndPoint
 
-    def initialize(app)
+    def initialize(app = nil)
       @app = app
     end
 
     def call(env)
       if env["PATH_INFO"] =~ /^\/#{callback_path}/
-        process_request(env)
+        Rack::Request.new(env)
+        process_response(req.body.read)
       else
-        @app.call(env)
+        @app.call(env) if @app.respond_to? :call
       end
-
     end
 
-    private
-
-    def process_request(env)
-      req = Rack::Request.new(env)
-      body = JSON.parse(req.body.read)
-      puts "processing task callback"
+    def process_response(body)
+      body = JSON.parse(body)
+      puts "Processing Shared Workforce task callback"
       puts body.inspect
+      
+      raise SecurityTransgression unless valid_api_key?(body['api_key'])
+      
       SharedWorkforce::TaskResult.new(body).process!
     
       [ 200,
@@ -34,5 +34,11 @@ module SharedWorkforce
       SharedWorkforce.configuration.callback_path
     end
 
+    private
+
+    def valid_api_key?(key)
+      key == SharedWorkforce.configuration.api_key
+    end
+
   end
 end

data/lib/shared_workforce/exceptions.rb

@@ -2,4 +2,5 @@ module SharedWorkforce
   class Error < RuntimeError; end
   class ConfigurationError < Error; end
   class TaskNotFound < Error; end
+  class SecurityTransgression < Error; end
 end

data/lib/shared_workforce/task.rb

@@ -11,6 +11,7 @@ module SharedWorkforce
         :replace,
         :answer_options,
         :image_url,
+        :image_crop_ratio,
         :text,
         :on_success,
         :on_failure,

data/lib/shared_workforce/task_response.rb

@@ -6,15 +6,16 @@ module SharedWorkforce
     end
     
     def to_hash
-      {:answer=>answer, :answered_by=>username}
+      {:answer=>answer, :answered_by=>username, :new_image_url=>new_image_url}.reject {|k,v| v.nil? }.with_indifferent_access
     end
 
-    attr_accessor :answer, :callback_params, :username
+    attr_accessor :answer, :callback_params, :username, :new_image_url
     
     def initialize(params)
       @answer = params['answer']
       @callback_params = params['callback_params']
       @username = params['username']
+      @new_image_url = params['new_image_url']
     end
   
   end

data/lib/shared_workforce/task_result.rb

@@ -1,17 +1,28 @@
 module SharedWorkforce
   class TaskResult
    
-    attr_accessor :callback_params
+    attr_reader :callback_params
     attr_accessor :responses
     attr_accessor :name
     attr_accessor :status
+    attr_accessor :task_hash
     
     def initialize(params)
       params = params.with_indifferent_access
-      self.callback_params = params[:callback_params]
-      @responses = TaskResponse.create_collection_from_array(params[:responses]) if params[:responses]
+      
+      self.task_hash = if params[:task]
+        params[:task]
+      else
+        params
+      end
+      
+      @responses = TaskResponse.create_collection_from_array(task_hash[:responses]) if task_hash[:responses]
       self.name = callback_params[:_task][:class_name] if callback_params && callback_params[:_task] && callback_params[:_task][:class_name]
     end
+
+    def callback_params
+      task_hash[:callback_params]
+    end
     
     def responses
       @responses.map(&:to_hash)

data/lib/shared_workforce/version.rb

@@ -1,4 +1,4 @@
 module SharedWorkforce
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 
 end

data/spec/end_point_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'rack'
+describe "EndPoint" do
+
+  describe "#process_request" do
+    it "should not raise a security transgression with a valid api key" do
+      lambda {
+        SharedWorkforce::EndPoint.new.process_response({:api_key => SharedWorkforce.configuration.api_key}.to_json)
+      }.should_not raise_error(SharedWorkforce::SecurityTransgression)
+    end
+
+    it "should raise a security transgression with an invalid api key" do
+      lambda {
+        SharedWorkforce::EndPoint.new.process_response({:api_key=>'GIBBERISH'}.to_json)
+      }.should raise_error(SharedWorkforce::SecurityTransgression)
+    end
+
+    it "should raise a security transgression with a missing api key" do
+      lambda {
+        SharedWorkforce::EndPoint.new.process_response({}.to_json)
+      }.should raise_error(SharedWorkforce::SecurityTransgression)
+    end
+  end
+
+end

data/spec/task_request/http_spec.rb

@@ -5,7 +5,7 @@ describe "TaskRequest::Http" do
     it "should invoke a task request" do
       
       task = ApprovePhotoTask.new
-      task_request = SharedWorkforce::TaskRequest::Http.new(task, :image_url=>"http://www.google.com/logo.png", :callback_params=>{:resource_id=>'1234'})
+      task_request = SharedWorkforce::TaskRequest::Http.new(task, :image_url=>"http://www.google.com/logo.png", :image_crop_ratio=>1.7, :callback_params=>{:resource_id=>'1234'})
     
       stub_request(:post, "api.sharedworkforce.com/tasks")
       task_request.create
@@ -14,6 +14,7 @@ describe "TaskRequest::Http" do
           'title'=>"Approve Photo",
           'instruction'=>"Please classify this photo by choosing the appropriate tickboxes.",
           'image_url'=>"http://www.google.com/logo.png",
+          'image_crop_ratio'=>1.7,
           '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',

data/spec/task_response_spec.rb

@@ -14,4 +14,21 @@ describe "TaskResponse" do
       r[1].username.should == "frodo"
     end
   end
+
+  describe "#to_hash" do
+    it "should include answered_by" do
+      t = SharedWorkforce::TaskResponse.new('username'=>'bilbo')
+      t.to_hash[:answered_by].should == 'bilbo'
+    end
+
+    it "should include new_image_url" do
+      t = SharedWorkforce::TaskResponse.new('new_image_url'=>'http://www.example.com/image.jpg')
+      t.to_hash[:new_image_url].should == 'http://www.example.com/image.jpg'
+    end
+
+    it "should have indifferent access" do
+      t = SharedWorkforce::TaskResponse.new('new_image_url'=>'http://www.example.com/image.jpg')
+      t.to_hash['new_image_url'].should == 'http://www.example.com/image.jpg'
+    end
+  end
 end

data/spec/task_result_spec.rb

@@ -1,37 +1,67 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "TaskResult" do
+
+  before(:each) do
+    @task_result_hash = {
+      'task' => { 
+        'name'=>"Approve photo please",
+        'callback_params' => 
+        {
+          '_task'=>{'class_name'=>'ApprovePhotoTask'},
+          'resource_id' => '2',
+        },
+        'responses' => [{'answer' => 'yes'}]
+      }
+    }
+  end
+
   describe "#process!" do
     it "should invoke Task#process_result" do
       ApprovePhotoTask.any_instance.should_receive(:process_result).once
-      SharedWorkforce::TaskResult.new({'callback_params'=>{'_task'=>{'class_name'=>'ApprovePhotoTask'}, 'resource_id' => '2', 'responses'=>[{'answer'=>'yes'}], 'name'=>"Approve photo please"}}).process!
+      SharedWorkforce::TaskResult.new(@task_result_hash).process!
     end
   end
   
   describe "#responses" do
     it "should convert the result to a hash" 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"
+        {'task' => 
+          {
+            'name'=>"Approve photo",
+            'callback_params'=>{'resource_id' => '2'},
+            'responses'=>[
+              {'answer'=>'yes', 'username'=>'bilbo'},
+              {'answer'=>'no', 'username'=>'frodo'},
+              {'answer'=>'yes', 'username'=>'sam'}
+            ]
+          }
         }
       )
 
       r.responses.should == [
-        {:answer=>'yes', :answered_by=>'bilbo'},
-        {:answer=>'no', :answered_by=>'frodo'},
-        {:answer=>'yes', :answered_by=>'sam'}
+        {'answer'=>'yes', 'answered_by'=>'bilbo'},
+        {'answer'=>'no', 'answered_by'=>'frodo'},
+        {'answer'=>'yes', 'answered_by'=>'sam'}
       ]
     end
   end
+
+  describe "#task_attributes" do
+    it "should assign the task hash" do
+      task = SharedWorkforce::TaskResult.new(@task_result_hash)
+      task.task_hash.should == @task_result_hash['task']
+    end
+
+    it "should accept a task that is not nested in a :task key (backwards compatibility)" do
+      task = SharedWorkforce::TaskResult.new(@task_result_hash['task'])
+      task.task_hash.should == @task_result_hash['task']
+    end
+  end
   
   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 = SharedWorkforce::TaskResult.new('task'=>{'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

data/spec/task_spec.rb

@@ -15,6 +15,8 @@ describe "Task" do
       instruction 'Please classify this photo by choosing the appropriate tickboxes.'
       responses_required 3
       image_url "http://www.google.com/logo.png"
+      answer_type :crop
+      image_crop_ratio 1.7
 
       answer_options ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways']
 
@@ -35,6 +37,7 @@ describe "Task" do
     task.title.should == "Approve Photo"
     task.responses_required.should == 3
     task.image_url.should == "http://www.google.com/logo.png"
+    task.image_crop_ratio.should == 1.7
     task.answer_options.should == ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways']
   end
 
@@ -85,7 +88,7 @@ describe "Task" do
       task_class = Class.new { include SharedWorkforce::Task; on_success :do_work; def do_work(*args); end; def setup(*args); end }
       task_class.any_instance.should_receive(:success!)
       task_class.any_instance.should_receive(:complete!)
-      task = task_class.new(SharedWorkforce::TaskResult.new({'callback_params'=>{'key'=>'value'}}))
+      task = task_class.new(SharedWorkforce::TaskResult.new({'task'=>{'callback_params'=>{'key'=>'value'}}}))
       task.attributes[:key].should == 'value'
     end
   end
@@ -152,7 +155,7 @@ describe "Task" do
       end
 
       it "should pass the resource to the callback method as the first argument and the result as the second argument" do
-        result = SharedWorkforce::TaskResult.new(:callback_params=>@task.attributes)
+        result = SharedWorkforce::TaskResult.new({'task'=>{'callback_params'=>@task.attributes}})
         @task.should_receive(:do_work).with(@resource, @result.responses)
         @task.success!(@result)
       end
@@ -290,13 +293,13 @@ describe "Task" do
     it "should return the resource from the callback params" do
       class ResourceFinder; def self.find(id); return "#{id}ABCD"; end; end
       task_class = Class.new { include SharedWorkforce::Task }
-      task = task_class.new(SharedWorkforce::TaskResult.new({'callback_params'=>{'_task'=>{'resource'=>{'class_name'=>'ResourceFinder', 'id' => '2'}}}}))
+      task = task_class.new(SharedWorkforce::TaskResult.new({'api_key'=>SharedWorkforce.configuration.api_key, 'task'=>{'callback_params'=>{'_task'=>{'resource'=>{'class_name'=>'ResourceFinder', 'id' => '2'}}}}}))
       task.resource.should == "2ABCD"
     end
 
     it "should return nil if the callback params do not specify a resource" do
       task_class = Class.new { include SharedWorkforce::Task }
-      task = task_class.new(SharedWorkforce::TaskResult.new({'callback_params'=>{}}))
+      task = task_class.new(SharedWorkforce::TaskResult.new({'api_key'=>SharedWorkforce.configuration.api_key, 'task'=>{'callback_params'=>{}}}))
       task.resource.should == nil
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shared_workforce
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-27 00:00:00.000000000 Z
+date: 2012-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70130604732600 !ruby/object:Gem::Requirement
+  requirement: &70269574726440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70130604732600
+  version_requirements: *70269574726440
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70130604732120 !ruby/object:Gem::Requirement
+  requirement: &70269574725980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70130604732120
+  version_requirements: *70269574725980
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70130604731700 !ruby/object:Gem::Requirement
+  requirement: &70269574725520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70130604731700
+  version_requirements: *70269574725520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70130604731020 !ruby/object:Gem::Requirement
+  requirement: &70269574724960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.2.9
   type: :development
   prerelease: false
-  version_requirements: *70130604731020
+  version_requirements: *70269574724960
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70130604719020 !ruby/object:Gem::Requirement
+  requirement: &70269574724540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70130604719020
+  version_requirements: *70269574724540
 description: Shared Workforce is a service and simple API for human intelligence tasks
 email:
 - sam@samoliver.com
@@ -96,6 +96,7 @@ files:
 - shared_workforce.gemspec
 - spec/.rspec
 - spec/client_spec.rb
+- spec/end_point_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration_helper.rb
 - spec/task_request/black_hole_spec.rb
@@ -130,6 +131,7 @@ specification_version: 3
 summary: Shared Workforce Client
 test_files:
 - spec/client_spec.rb
+- spec/end_point_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration_helper.rb
 - spec/task_request/black_hole_spec.rb