shared_workforce 0.2.10 → 0.2.11

data/README.markdown

@@ -11,13 +11,11 @@ You can view a live demo sandbox app at [http://catsify.herokuapp.com](http://ca
 
 The service is currently in private beta and is available as a [Heroku add-on](https://addons.heroku.com/sharedworkforce). You can apply for an invitation at [sharedworkforce.com](http://www.sharedworkforce.com).
 
-Getting started with Heroku
-===========================
 
-Getting started with [Heroku][http://www.heroku.com] takes less than 5 minutes. The best way to get started is to follow the README on the [demo app source code](https://github.com/sharedworkforce/sharedworkforce-demo-rails).
+Getting started
+===============
 
-Getting started without Heroku
-==============================
+_**Note to Heroku users:** Getting started with [Heroku](http://www.heroku.com]) takes less than 5 minutes. The best way to get started is to follow the README on the [demo app source code](https://github.com/sharedworkforce/sharedworkforce-demo-rails)._
 
 ### Step 1 - get an API key
 

data/lib/shared_workforce.rb

@@ -16,9 +16,8 @@ require 'active_support/inflector'
 require 'active_support/core_ext/hash/indifferent_access'
 
 module SharedWorkforce
-  
-  class << self
     
+  class << self
     attr_writer :configuration
     
     def configure
@@ -28,6 +27,10 @@ module SharedWorkforce
     def configuration
       @configuration ||= SharedWorkforce::Configuration.new
     end
+
+    def logger
+      @configuration.logger
+    end
   end
-  
+
 end

data/lib/shared_workforce/configuration.rb

@@ -4,6 +4,8 @@ module SharedWorkforce
     attr_writer :callback_host
     attr_writer :callback_path
     attr_writer :api_key
+    attr_writer :logger
+
     attr_accessor :http_end_point
     attr_accessor :request_class
     
@@ -28,6 +30,10 @@ module SharedWorkforce
       @callback_host ||= ENV['SHAREDWORKFORCE_CALLBACK_HOST']
     end
 
+    def logger
+      @logger ||= (rails_logger || default_logger)
+    end
+
     private
 
     def default_request_class
@@ -43,6 +49,17 @@ module SharedWorkforce
         TaskRequest::Http
       end
     end
-    
+
+    def rails_logger
+      (defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger) ||
+      (defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER.respond_to?(:debug) && RAILS_DEFAULT_LOGGER)
+    end
+
+    def default_logger
+      require 'logger'
+      l = ::Logger.new($stdout)
+      l.level = ::Logger::INFO
+      l
+    end
   end
 end

data/lib/shared_workforce/end_point.rb

@@ -15,8 +15,8 @@ module SharedWorkforce
 
     def process_response(body)
       body = JSON.parse(body)
-      puts "Processing Shared Workforce task callback"
-      puts body.inspect
+      SharedWorkforce.logger.info "Processing Shared Workforce task callback"
+      SharedWorkforce.logger.info { body.inspect }
       
       raise SecurityTransgression unless valid_api_key?(body['api_key'])
       

data/lib/shared_workforce/frameworks/rails.rb

@@ -2,7 +2,11 @@ if defined?(ActionController::Metal)
   class Railtie < Rails::Railtie
     initializer 'shared_workforce' do |app|      
       app.config.middleware.use SharedWorkforce::EndPoint
-      SharedWorkforce::ResponsePoller.start if Rails.env.development?
+      if Rails.env.development?
+      	# Stop log buffering when using Foreman in development
+        $stdout.sync = true
+        SharedWorkforce::ResponsePoller.start
+      end
     end
   end
 end

data/lib/shared_workforce/response_poller.rb

@@ -1,21 +1,20 @@
 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 initialize
-      $stdout.sync = true
-    end
-
     def start(interval)
       Thread.abort_on_exception = true
       Thread.new do
-        puts "SharedWorkforce: Checking every #{interval} seconds for new responses."
+        SharedWorkforce.logger.info "SharedWorkforce: Checking every #{interval} seconds for new responses."
         
         while true
-          puts "SharedWorkforce: Checking for new task responses."
+          SharedWorkforce.logger.info "SharedWorkforce: Checking for new task responses."
           process_tasks completed_tasks
           sleep interval
         end
@@ -27,7 +26,7 @@ module SharedWorkforce
     def process_tasks(tasks)
       tasks.each do |task|
         if task['state'] == "completed"
-          puts "SharedWorkforce: Task complete. Getting responses."
+          SharedWorkforce.logger.info "SharedWorkforce: Task complete. Getting responses."
           responses = collect_responses(task['id'])
           SharedWorkforce::TaskResult.new(responses).process!
         end

data/lib/shared_workforce/task.rb

@@ -1,6 +1,6 @@
 module SharedWorkforce
   module Task
-
+    
     def self.included(base)
       base.extend(ClassMethods)
       base.default_attributes(

data/lib/shared_workforce/task_request/http_with_poller.rb

@@ -1,15 +1,7 @@
 require 'rest_client'
 module SharedWorkforce
-  class TaskRequest::HttpWithPoller < TaskRequest
-
-    def create
-      task = JSON.parse(RestClient.post("#{http_end_point}/tasks", *request_params))
-    end
-  
-    def cancel
-      RestClient.post("#{http_end_point}/tasks/cancel", *request_params)
-    end
-
+  class TaskRequest::HttpWithPoller < 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}]
     end

data/lib/shared_workforce/version.rb

@@ -1,4 +1,4 @@
 module SharedWorkforce
-  VERSION = "0.2.10"
+  VERSION = "0.2.11"
 
 end

data/spec/configuration_spec.rb

@@ -46,5 +46,28 @@ describe "Configuration" do
 		end
 	  
 	end
+
+	describe "#logger" do
+		it "should default to rails logger" do
+			logger_double = double(:logger)
+			configuration.stub(:rails_logger).and_return(logger_double)
+			configuration.logger.should == logger_double
+		end
+
+		it "should fallback to a default logger" do
+			logger_double = double(:logger)
+			configuration.stub(:rails_logger).and_return(nil)
+			configuration.stub(:default_logger).and_return(logger_double)
+			configuration.logger.should == logger_double
+		end
+
+		it "should be overridden by a custom logger" do
+			logger_double = double(:logger)
+			configuration.stub(:rails_logger).and_return(double(:rails_logger))
+			configuration.logger = logger_double
+			
+			configuration.logger.should == logger_double
+		end
+	end
  
 end

data/spec/shared_workforce_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SharedWorkforce" do
+  describe "#logger" do
+    it "should return the configured logger" do
+      with_configuration do |c|
+        c.logger = logger = double(:logger)
+
+        SharedWorkforce.logger.should == logger
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shared_workforce
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000 Z
+date: 2012-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70320585942740 !ruby/object:Gem::Requirement
+  requirement: &70125168657440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70320585942740
+  version_requirements: *70125168657440
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70320585942320 !ruby/object:Gem::Requirement
+  requirement: &70125168672660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70320585942320
+  version_requirements: *70125168672660
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70320585941900 !ruby/object:Gem::Requirement
+  requirement: &70125168669900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70320585941900
+  version_requirements: *70125168669900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70320585941400 !ruby/object:Gem::Requirement
+  requirement: &70125168665380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.2.9
   type: :development
   prerelease: false
-  version_requirements: *70320585941400
+  version_requirements: *70125168665380
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70320585940980 !ruby/object:Gem::Requirement
+  requirement: &70125168676340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70320585940980
+  version_requirements: *70125168676340
 description: Shared Workforce is a service and simple API for human intelligence tasks
 email:
 - sam@samoliver.com
@@ -98,6 +98,7 @@ files:
 - spec/client_spec.rb
 - spec/configuration_spec.rb
 - spec/end_point_spec.rb
+- spec/shared_workforce_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration_helper.rb
 - spec/task_request/black_hole_spec.rb
@@ -135,6 +136,7 @@ test_files:
 - spec/client_spec.rb
 - spec/configuration_spec.rb
 - spec/end_point_spec.rb
+- spec/shared_workforce_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration_helper.rb
 - spec/task_request/black_hole_spec.rb