shared_workforce 0.2.13 → 0.2.14

data/lib/shared_workforce/configuration.rb

@@ -10,7 +10,7 @@ module SharedWorkforce
     attr_accessor :request_class
     
     def initialize
-      @http_end_point = "http://api.sharedworkforce.com"
+      @http_end_point = "https://api.sharedworkforce.com"
       @request_class = default_request_class
     end
     
@@ -35,7 +35,7 @@ module SharedWorkforce
     end
 
     def valid?
-      @api_key.present?
+      api_key.present?
     end
 
     private

data/lib/shared_workforce/task.rb

@@ -14,6 +14,7 @@ module SharedWorkforce
         :image_url,
         :image_crop_ratio,
         :text,
+        :html,
         :on_success,
         :on_failure,
         :on_complete
@@ -133,6 +134,7 @@ module SharedWorkforce
         :callback_url => callback_url,
         :replace => replace,
         :text => text,
+        :html => html,
         :callback_params => attributes
       }.reject {|k,v| v.nil? }
     end

data/lib/shared_workforce/version.rb

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

data/spec/configuration_spec.rb

@@ -6,35 +6,31 @@ describe "Configuration" do
 
 	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
+			with_env 'SHAREDWORKFORCE_API_KEY', 'API_KEY_FROM_ENV' do
+			 configuration.api_key.should == "API_KEY_FROM_ENV"
+			end
 		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
+			with_env 'SHAREDWORKFORCE_API_KEY', 'API_KEY_FROM_ENV' do
+  			configuration.api_key = "CUSTOM_API_KEY"
+  			configuration.api_key.should == "CUSTOM_API_KEY"
+      end
 		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
+			with_env 'SHAREDWORKFORCE_CALLBACK_HOST', "http://env.example.com" do
+			  configuration.callback_host.should == "http://env.example.com"
+			end
 		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
+			with_env 'SHAREDWORKFORCE_CALLBACK_HOST', "env.example.com" do
+  			configuration.callback_host = "custom.example.com"
+  			configuration.callback_host.should == "custom.example.com"
+      end
 		end
 	end
 	
@@ -72,9 +68,23 @@ describe "Configuration" do
 
 	describe "#valid" do
 		it "should be false if no api key is set" do
-			configuration.api_key = nil
-			configuration.should_not be_valid
+			with_env 'SHAREDWORKFORCE_API_KEY', nil do
+			  configuration.should_not be_valid
+      end
 		end
+
+    it "should be true if the api key is set in ENV" do
+      with_env 'SHAREDWORKFORCE_API_KEY', 'SOMETHING' do
+        configuration.should be_valid
+      end
+    end
 	end
+
+  def with_env(key, value, &block)
+    old_value = ENV[key]
+    ENV[key] = value
+    yield
+    ENV[key] = old_value
+  end
  
 end

data/spec/task_request/http_spec.rb

@@ -7,9 +7,9 @@ describe "TaskRequest::Http" do
       task = ApprovePhotoTask.new
       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")
+      stub_request(:post, "https://api.sharedworkforce.com/tasks")
       task_request.create
-      a_request(:post, "http://api.sharedworkforce.com/tasks").with(:body=>{'task'=>
+      a_request(:post, "https://api.sharedworkforce.com/tasks").with(:body=>{'task'=>
         {
           'title'=>"Approve Photo",
           'instruction'=>"Please classify this photo by choosing the appropriate tickboxes.",
@@ -20,7 +20,8 @@ describe "TaskRequest::Http" do
           'answer_type'=>'tags',
           'callback_url'=>"#{SharedWorkforce.configuration.callback_host}/shared_workforce/task_response",
           'callback_params'=>{'resource_id'=>'1234'},
-          'replace'=>true
+          'replace'=>true,
+          'html'=>'<strong>Custom html</strong>'
         }, :api_key=>'test-api-key'}).should have_been_made.once
     
     end
@@ -41,9 +42,9 @@ describe "TaskRequest::Http" do
 
       task_request = SharedWorkforce::TaskRequest::Http.new(task.new, {:callback_params=>{:resource_id=>'1234'}, :image_url=>"http://www.example.com/image.jpg"})
 
-      stub_request(:post, "api.sharedworkforce.com/tasks")
+      stub_request(:post, "https://api.sharedworkforce.com/tasks")
       task_request.create
-      a_request(:post, "http://api.sharedworkforce.com/tasks").with(:body=>{'task'=>
+      a_request(:post, "https://api.sharedworkforce.com/tasks").with(:body=>{'task'=>
         {
           'title'=>"Approve Photo",
           'instruction'=>"Please classify this photo by choosing the appropriate tickboxes.",
@@ -53,7 +54,7 @@ describe "TaskRequest::Http" do
           'answer_type'=>'tags',
           'callback_url'=>"#{SharedWorkforce.configuration.callback_host}/shared_workforce/task_response",
           'callback_params'=>{'resource_id'=>'1234'},
-          'replace'=>false,
+          'replace'=>false
         }, :api_key=>'test-api-key'}).should have_been_made.once
      end
   end
@@ -63,9 +64,9 @@ describe "TaskRequest::Http" do
     
       task_request = SharedWorkforce::TaskRequest::Http.new(ApprovePhotoTask.new, :callback_params=>{:resource_id=>'1234'})
     
-      stub_request(:post, "api.sharedworkforce.com/tasks/cancel")
+      stub_request(:post, "https://api.sharedworkforce.com/tasks/cancel")
       task_request.cancel
-      a_request(:post, "http://api.sharedworkforce.com/tasks/cancel").with(:body=>{'task'=>
+      a_request(:post, "https://api.sharedworkforce.com/tasks/cancel").with(:body=>{'task'=>
         {
           'title'=>"Approve Photo",
           'instruction'=>"Please classify this photo by choosing the appropriate tickboxes.",
@@ -75,7 +76,8 @@ describe "TaskRequest::Http" do
           'answer_type'=>'tags',
           'callback_url'=>"#{SharedWorkforce.configuration.callback_host}/shared_workforce/task_response",
           'callback_params'=>{'resource_id'=>'1234'},
-          'replace'=>true
+          'replace'=>true,
+          'html'=>'<strong>Custom html</strong>'
         }, :api_key=>'test-api-key'}).should have_been_made.once
     
     end

data/spec/task_request/http_with_poller_spec.rb

@@ -10,11 +10,11 @@ describe "TaskRequest::HttpWithPoller" do
       	:callback_params=>{:resource_id=>'1234'}
       )
 
-			stub_request(:post, "api.sharedworkforce.com/tasks").to_return(:body=>{:id=>123}.to_json)
+			stub_request(:post, "https://api.sharedworkforce.com/tasks").to_return(:body=>{:id=>123}.to_json)
 
 			task_request.create
 
-			a_request(:post, "http://api.sharedworkforce.com/tasks").with(:body=>{'task'=>
+			a_request(:post, "https://api.sharedworkforce.com/tasks").with(:body=>{'task'=>
         {
           'title'=>"Approve Photo",
           'instruction'=>"Please classify this photo by choosing the appropriate tickboxes.",
@@ -27,6 +27,7 @@ describe "TaskRequest::HttpWithPoller" do
           'callback_params'=>{'resource_id'=>'1234'},
           'replace'=>true,
           'callback_enabled'=>false,
+          'html'=>'<strong>Custom html</strong>'
         }, :api_key=>'test-api-key'}).should have_been_made.once
     end
   end

data/spec/task_spec.rb

@@ -18,6 +18,7 @@ describe "Task" do
       answer_type :crop
       image_crop_ratio 1.7
       guidelines "* be careful"
+      html "<strong>Custom html</strong>"
 
       answer_options ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways']
 
@@ -41,6 +42,7 @@ describe "Task" do
     task.image_crop_ratio.should == 1.7
     task.answer_options.should == ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways']
     task.guidelines.should == "* be careful"
+    task.html.should == "<strong>Custom html</strong>"
   end
 
   it "should allow certain default attributes to be overwritten" do
@@ -240,9 +242,9 @@ describe "Task" do
     it "should make a new task http request" do
       task = Class.new { include SharedWorkforce::Task }
 
-      stub_request(:post, "http://api.sharedworkforce.com/tasks")
+      stub_request(:post, "https://api.sharedworkforce.com/tasks")
       task.new.request(:request_id=>'123')
-      a_request(:post, "http://api.sharedworkforce.com/tasks").should have_been_made.once
+      a_request(:post, "https://api.sharedworkforce.com/tasks").should have_been_made.once
     end
   end
   
@@ -250,9 +252,9 @@ describe "Task" do
     it "should send a cancel task http request" do
       task_class = Class.new { include SharedWorkforce::Task }
 
-      stub_request(:post, "http://api.sharedworkforce.com/tasks/cancel")
+      stub_request(:post, "https://api.sharedworkforce.com/tasks/cancel")
       task_class.cancel(@resource_class.new)
-      a_request(:post, "http://api.sharedworkforce.com/tasks/cancel").should have_been_made.once
+      a_request(:post, "https://api.sharedworkforce.com/tasks/cancel").should have_been_made.once
     end
 
     it "should not raise a ConfigurationError if a callback host is not set" do

data/spec/tasks/approve_photo.rb

@@ -9,6 +9,7 @@ class ApprovePhotoTask
   answer_options ['Obscenity', 'Nudity', 'Blurry', 'Upside down or sideways', 'Contains more than one person in the foreground', 'Has people in the background', 'Contains children']
   answer_type :tags
   image_url "http://www.google.com/logo.png"
+  html '<strong>Custom html</strong>'
 
   replace true
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shared_workforce
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-02 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70323744943380 !ruby/object:Gem::Requirement
+  requirement: &70318914187300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323744943380
+  version_requirements: *70318914187300
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70323744942960 !ruby/object:Gem::Requirement
+  requirement: &70318914186880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323744942960
+  version_requirements: *70318914186880
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70323744942540 !ruby/object:Gem::Requirement
+  requirement: &70318914186460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323744942540
+  version_requirements: *70318914186460
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70323744942040 !ruby/object:Gem::Requirement
+  requirement: &70318914185960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.2.9
   type: :development
   prerelease: false
-  version_requirements: *70323744942040
+  version_requirements: *70318914185960
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70323744941620 !ruby/object:Gem::Requirement
+  requirement: &70318914185540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323744941620
+  version_requirements: *70318914185540
 description: Shared Workforce is a service and simple API for human intelligence tasks
 email:
 - sam@samoliver.com