shared_workforce 0.2.3 → 0.2.4

data/README.markdown

@@ -1,7 +1,7 @@
 Shared Workforce Client
 =======================
 
-[![Build Status](https://secure.travis-ci.org/samoli/shared-workforce.png)](http://travis-ci.org/#!/samoli/shared-workforce)
+[![Build Status](https://secure.travis-ci.org/sharedworkforce/sharedworkforce.png)](http://travis-ci.org/#!/sharedworkforce/sharedworkforce)
 
 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.
 

data/lib/shared_workforce/configuration.rb

@@ -1,11 +1,11 @@
 module SharedWorkforce
   class Configuration
     
-    attr_accessor :api_key
+    attr_writer :callback_host
+    attr_writer :callback_path
+    attr_writer :api_key
     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"
@@ -20,6 +20,14 @@ module SharedWorkforce
       @callback_path ||= "hci_task_result"
     end
 
+    def api_key
+      @api_key ||= ENV['SHAREDWORKFORCE_API_KEY']
+    end
+
+    def callback_host
+      @callback_host ||= ENV['SHAREDWORKFORCE_CALLBACK_HOST']
+    end
+
     private
 
     def default_request_class

data/lib/shared_workforce/task.rb

@@ -7,6 +7,7 @@ module SharedWorkforce
         :title,
         :answer_type,
         :instruction,
+        :guidelines,
         :responses_required,
         :replace,
         :answer_options,
@@ -123,6 +124,7 @@ module SharedWorkforce
       {
         :title => title,
         :instruction => instruction,
+        :guidelines => guidelines,
         :image_url => image_url,
         :answer_options => answer_options,
         :responses_required => responses_required,

data/lib/shared_workforce/version.rb

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

data/spec/configuration_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Configuration" do
+
+	let(:configuration) { SharedWorkforce::Configuration.new }
+
+	describe "#api_key" do
+		it "should use the API key set in ENV['SHAREDWORKFORCE_API_KEY']" do
+			old_env = ENV['SHAREDWORKFORCE_API_KEY']
+			ENV['SHAREDWORKFORCE_API_KEY'] = "API_KEY_FROM_ENV"
+			configuration.api_key.should == "API_KEY_FROM_ENV"
+			ENV['SHAREDWORKFORCE_API_KEY'] = old_env
+		end
+
+		it "should be overridable with a custom value" do
+			old_env = ENV['SHAREDWORKFORCE_API_KEY']
+			ENV['SHAREDWORKFORCE_API_KEY'] = "API_KEY_FROM_ENV"
+			configuration.api_key = "CUSTOM_API_KEY"
+			configuration.api_key.should == "CUSTOM_API_KEY"
+			ENV['SHAREDWORKFORCE_API_KEY'] = old_env
+		end
+	end
+
+	describe "#callback_host" do
+		it "should use the callback host set in ENV['SHAREDWORKFORCE_CALLBACK_HOST']" do
+			old_env = ENV['SHAREDWORKFORCE_CALLBACK_HOST']
+			ENV['SHAREDWORKFORCE_CALLBACK_HOST'] = "http://env.example.com"
+			configuration.callback_host.should == "http://env.example.com"
+			ENV['SHAREDWORKFORCE_CALLBACK_HOST'] = old_env
+		end
+
+		it "should be overridable with a custom value" do
+			old_env = ENV['SHAREDWORKFORCE_CALLBACK_HOST']
+			ENV['SHAREDWORKFORCE_CALLBACK_HOST'] = "env.example.com"
+			configuration.callback_host = "custom.example.com"
+			configuration.callback_host.should == "custom.example.com"
+			ENV['SHAREDWORKFORCE_CALLBACK_HOST'] = old_env
+		end
+	end
+ 
+end

data/spec/end_point_spec.rb

@@ -1,5 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'rack'
+
 describe "EndPoint" do
 
   describe "#process_request" do

data/spec/task_spec.rb

@@ -17,6 +17,7 @@ describe "Task" do
       image_url "http://www.google.com/logo.png"
       answer_type :crop
       image_crop_ratio 1.7
+      guidelines "* be careful"
 
       answer_options ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways']
 
@@ -39,6 +40,7 @@ describe "Task" do
     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']
+    task.guidelines.should == "* be careful"
   end
 
   it "should allow certain default attributes to be overwritten" do
@@ -326,6 +328,12 @@ describe "Task" do
       task.to_hash[:callback_params][:_task][:resource][:class_name].should == "Resource"
       task.to_hash[:callback_params][:_task][:class_name].should == 'ApprovePhotoTask'
     end
+
+    it "should include the guidelines" do
+      task = ApprovePhotoTask.new(@resource_class.new)
+      task.guidelines = "* be careful"
+      task.to_hash[:guidelines].should == '* be careful'
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shared_workforce
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-14 00:00:00.000000000 Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70269574726440 !ruby/object:Gem::Requirement
+  requirement: &70160649037520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70269574726440
+  version_requirements: *70160649037520
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70269574725980 !ruby/object:Gem::Requirement
+  requirement: &70160649037040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70269574725980
+  version_requirements: *70160649037040
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70269574725520 !ruby/object:Gem::Requirement
+  requirement: &70160649036480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70269574725520
+  version_requirements: *70160649036480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70269574724960 !ruby/object:Gem::Requirement
+  requirement: &70160649035640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.2.9
   type: :development
   prerelease: false
-  version_requirements: *70269574724960
+  version_requirements: *70160649035640
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70269574724540 !ruby/object:Gem::Requirement
+  requirement: &70160649034840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70269574724540
+  version_requirements: *70160649034840
 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/configuration_spec.rb
 - spec/end_point_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration_helper.rb
@@ -131,6 +132,7 @@ specification_version: 3
 summary: Shared Workforce Client
 test_files:
 - spec/client_spec.rb
+- spec/configuration_spec.rb
 - spec/end_point_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration_helper.rb