cloudfactory 0.5.1 → 0.5.2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.5.2 (2012-03-1)
+* Badge made reusability under same account
+* Added options for starting production with gold-standard
+* variable pricing
+
 ## 0.5.1 (2012-02-22)
 * Bug fixed for problem in options with block DSL
 * Default Worker Pool changed to mTurk

data/lib/cf/badge.rb

@@ -20,7 +20,7 @@ module CF
 
     def initialize(options={})
       options.symbolize_keys!
-      if (!options.blank? && options[:test_attributes][:form_attributes].present?)
+      if options[:test_attributes] && options[:test_attributes][:form_attributes]
         form =  options[:test_attributes][:form_attributes]
         if( form[:type] == "CustomTaskForm" && form[:file])
           raw_html = ""
@@ -32,11 +32,9 @@ module CF
         options[:test_attributes][:form_attributes].merge!({:_type =>"TaskForm"}) if form[:type] == "TaskForm"
       end
       @settings = options
-      @station = options[:station] if options[:station].nil? ? nil : options[:station]
-      @line = options[:line] if options[:line].nil? ? nil : options[:line]
-      if !@line.nil? && @station
-        options.delete(:station) if @settings[:station].present?
-        options.delete(:line)
+      @station = options.delete(:station)
+      @line = options.delete(:line)
+      if @line.present? && @station.present?
         request =
         {
           :body =>
@@ -46,9 +44,9 @@ module CF
           }
         }
 
-          resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@line.title.downcase}/stations/#{@station.index}/badges.json",request)
-          @station.badges = self
-          self.errors = resp.parsed_response['error']['message'] if resp.code != 200
+        resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@line.title.downcase}/stations/#{@station.index}/badges.json",request)
+        @station.badges = self
+        self.errors = resp.parsed_response['error']['message'] if resp.code != 200
       end
     end
 

data/lib/cf/cli/line.rb

@@ -26,7 +26,7 @@ module Cf # :nodoc: all
   class Line < Thor # :nodoc: all
     include Cf::Config
     include Cf::LineYamlValidator
-    
+
     desc "line generate LINE-TITLE", "generates a line template at <line-title>/line.yml"
     method_option :force, :type => :boolean, :default => false, :aliases => "-f", :desc => "force to overwrite the files if the line already exists, default is false"
 
@@ -47,7 +47,7 @@ module Cf # :nodoc: all
         say "Title for the line is required.", :red
       end
     end
-    
+
     desc "line delete", "delete the current line at http://cloudfactory.com"
     method_option :line, :type => :string, :aliases => "-l", :desc => "specify the line-title to delete"
     method_option :force, :type => :boolean, :aliases => "-f", :default => false, :desc => "force delete the line"
@@ -119,7 +119,7 @@ module Cf # :nodoc: all
             say("!!! Warning !!!\nThe following are the existing production runs based on this line.", :yellow)
             existing_runs = Cf::Production.new([],{'line' => line_title, 'all' => true})
             existing_runs.list
-          
+
             say("\n!!! Warning !!!\nDeleting this line will also delete all the existing production runs based on this line.\n", :yellow)
             delete_forcefully = agree("Do you still want to delete this line? [y/n] ")
             say("\n")
@@ -134,14 +134,14 @@ module Cf # :nodoc: all
           end
         end
       end
-      
+
       def display_error(line_title, error_message)
         say("Error: #{error_message}", :red)
         rollback(line_title)
         exit(1)
       end
     }
-    
+
     method_option :force, :type => :boolean, :default => false, :aliases => "-f", :desc => "force to overwrite the line if the line already exists, default is false"
     desc "line create", "takes the line.yml and creates a new line at http://cloudfactory.com"
     def create
@@ -327,13 +327,16 @@ module Cf # :nodoc: all
           if badges
             say "Adding Badges to station", :green
             badges.each do |s_badge|
-              form = s_badge["test_attributes"]["form_attributes"]
-              unless form.blank?
-                if form["type"] == "CustomTaskForm"
-                  file = File.read("#{line_source}/#{form["file"]}") || File.read("#{line_source}/badges/station#{station_file['station']['station_index']}.html")
-                  s_badge["test_attributes"]["form_attributes"].merge!({:raw_html => file, :_type =>"CustomTaskForm" })
-                else
-                  s_badge["test_attributes"]["form_attributes"].merge!({:_type =>"TaskForm" })
+              if s_badge.length == 1 && s_badge.keys.include?("name")
+              else
+                form = s_badge["test_attributes"]["form_attributes"]
+                unless form.blank?
+                  if form["type"] == "CustomTaskForm"
+                    file = File.read("#{line_source}/#{form["file"]}") || File.read("#{line_source}/badges/station#{station_file['station']['station_index']}.html")
+                    s_badge["test_attributes"]["form_attributes"].merge!({:raw_html => file, :_type =>"CustomTaskForm" })
+                  else
+                    s_badge["test_attributes"]["form_attributes"].merge!({:_type =>"TaskForm" })
+                  end
                 end
               end
               badge = CF::Badge.new(s_badge.merge({:line => line,:station => s }))
@@ -393,7 +396,7 @@ module Cf # :nodoc: all
       set_target_uri(false)
       set_api_key(yaml_source)
       CF.account_name = CF::Account.info['name']
-      
+
       if options.all
         resp_lines = CF::Line.all(:page => 'all')
         current_page = 1
@@ -410,7 +413,7 @@ module Cf # :nodoc: all
       lines = resp_lines['lines'].presence
       say "\n"
       say("You don't have any lines to list", :yellow) and return if lines.blank?
-      
+
       if resp_lines['total_pages']
         say("Showing page #{current_page} of #{resp_lines['total_pages']}\tTotal lines: #{resp_lines['total_lines']}")
       end
@@ -436,7 +439,7 @@ module Cf # :nodoc: all
     desc "line details", "list the details of the line"
     method_option :line, :type => :string, :aliases => "-l", :desc => "specify the line-title to inspect"
     # method_option :verbose, :type => :boolean, :aliases => "-v", :desc => "gives the detailed structure of the line"
-    def details 
+    def details
       if options['line'].blank?
         line_source = Dir.pwd
         yaml_source = "#{line_source}/line.yml"
@@ -453,7 +456,7 @@ module Cf # :nodoc: all
         CF.account_name = CF::Account.info['name']
         line_title = options['line'].parameterize
       end
-      
+
       line = CF::Line.inspect(line_title)
       line = Hashie::Mash.new(line)
       if line.error.blank?

data/lib/cf/cli/line_yaml_validator.rb

@@ -51,7 +51,7 @@ module Cf
                   elsif !jury_worker.nil?
                     reward = jury_worker['reward']
                     errors << "Reward for Jury worker is missing in block of Tournament Station #{i+1}!" if reward.nil?
-                    errors << "Reward Must be greater than 0 in Block station #{i+1}!" if !reward.nil? && reward < 1
+                    # errors << "Reward Must be greater than 0 in Block station #{i+1}!" if !reward.nil? && reward < 1
                   end
                   acceptance_ratio = station['station']['acceptance_ratio']
                   if !acceptance_ratio.nil?
@@ -92,8 +92,8 @@ module Cf
                       reward = worker['reward']
                       if reward.nil?
                         errors << "Reward of workers not specified in Block station #{i+1}!"
-                      else
-                        errors << "Reward of workers must be greater than 0 in Block station #{i+1}!" if reward < 1
+                      # else
+                        # errors << "Reward of workers must be greater than 0 in Block station #{i+1}!" if reward < 1
                       end
                     end
                   end

data/lib/cf/cli/production.rb

@@ -66,6 +66,7 @@ module Cf # :nodoc: all
 
     desc "production start <run-title>", "creates a production run with input data file at input/<run-title>.csv for more option 'cf production help start'"
     method_option :input_data, :type => :string, :aliases => "-i", :desc => "the name of the input data file"
+    method_option :gold_standards, :type => :string, :aliases => "-g", :desc => "number of goldstandard for the run"
     method_option :live, :type => :boolean, :default => false, :desc => "specifies sandbox or live mode"
     method_option :line, :type => :string, :aliases => "-l", :desc => "public line to use to do the production run. the format should be <account_name>/<line-title> e.g. millisami/brandiator"
     def start(title=nil)
@@ -149,8 +150,9 @@ module Cf # :nodoc: all
         say("The input data file named #{input_data} is missing", :red) and return
       end
 
+      gold_standards = options[:gold_standards]
       say "Creating a production run with title #{run_title}", :green
-      run = CF::Run.create(line_title, run_title, input_data_file)
+      run = CF::Run.create(line_title, run_title, input_data_file, gold_standards)
       if run.errors.blank?
         display_success_run(run)
       else

data/lib/cf/run.rb

@@ -26,7 +26,7 @@ module CF
     # ==OR
     # You can pass line object instead of passing line title:
     #   run = CF::Run.new(line_object, "run name", file_path)
-    def initialize(line, title, input)
+    def initialize(line, title, input, gold_standards = nil)
       if line.class == CF::Line || line.class == Hashie::Mash
         @line = line
         @line_title = line.title
@@ -41,24 +41,25 @@ module CF
       @title = title
       if File.exist?(input.to_s)
         @file = input
+        @gold_standards = gold_standards
         @param_data = File.new(input, 'rb')
         @param_for_input = :file
         if line.class == String && line.split("/").count == 2
-          resp = self.class.post("/lines/#{@account}/#{@line_title.downcase}/runs.json", {:data => {:run => {:title => @title}}, @param_for_input => @param_data})
+          resp = self.class.post("/lines/#{@account}/#{@line_title.downcase}/runs.json", {:data => {:run => {:title => @title, :gold_standards => @gold_standards }}, @param_for_input => @param_data})
         else
-          resp = self.class.post("/lines/#{CF.account_name}/#{@line_title.downcase}/runs.json", {:data => {:run => {:title => @title}}, @param_for_input => @param_data})
+          resp = self.class.post("/lines/#{CF.account_name}/#{@line_title.downcase}/runs.json", {:data => {:run => {:title => @title, :gold_standards => @gold_standards}}, @param_for_input => @param_data})
         end
         self.errors = resp['error']['message'] if resp['code'] != 200
       else
         @input = input
         @param_data = input
         @param_for_input = :inputs
-        options = 
+        options =
         {
-          :body => 
+          :body =>
           {
             :api_key => CF.api_key,
-            :data =>{:run => { :title => @title }, :inputs => @param_data}
+            :data =>{:run => { :title => @title, :gold_standards => @gold_standards }, :inputs => @param_data}
           }
         }
         if line.class == String && line.split("/").count == 2
@@ -80,10 +81,10 @@ module CF
     # ==OR
     # You can pass line object instead passing line title:
     #   run = CF::Run.new(line_object, "run name", file_path)
-    def self.create(line, title, file)
-      Run.new(line, title, file)
+    def self.create(line, title, file, gold_standards = nil)
+      Run.new(line, title, file, gold_standards)
     end
-    
+
     # ==Adds units to an existing production Run
     # ===Usage Example:
     #   units = CF::Run.add_units({:run_title => "title", :file => "path_of_file"})

data/lib/cf/station.rb

@@ -376,7 +376,7 @@ module CF
     def badges badge = nil
       line_title = line["title"] || line.title
       if badge
-        if badge.settings[:test_attributes][:form_attributes].present?
+        if badge.settings[:test_attributes] && badge.settings[:test_attributes][:form_attributes].present?
           form =  badge.settings[:test_attributes][:form_attributes]
           if( form[:type] == "CustomTaskForm" && form[:file])
             raw_html = ""

data/lib/cf/version.rb

@@ -1,3 +1,3 @@
 module CF # :nodoc: all
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/spec/badges_spec.rb

@@ -27,7 +27,7 @@ describe CF::Badge do
           @badge = CF::Badge.create({
             :line => line,
             :station => s,
-            :name           => "Tomb Digitizer#{Time.now}",
+            :name           => "Tomb Digitizer#{Time.now.day}",
             :description    => "This badge qualifies you to work on tomb digitization tasks.",
             :max_badges     => 100,
             :gold_standards => ["#{@gold_standard.settings[:name]}"],
@@ -42,6 +42,53 @@ describe CF::Badge do
           end
         end
 
+        it "should reuse the badge with in the account and  badge to the station in DSL way" do
+          WebMock.allow_net_connect!
+          title = "line_title#{Time.new.strftime('%Y%b%d-%H%M%S')}".downcase
+          sleep 1
+          line = CF::Line.create(title,"Digitization") do |l|
+            CF::InputFormat.new({:line => l, :name => "Company", :required => true, :valid_type => "general"})
+            CF::InputFormat.new({:line => l, :name => "Website", :required => true, :valid_type => "url"})
+          end
+          station = CF::Station.create({:line => line, :type => "work"}) do |s|
+            CF::HumanWorker.new({:station => s, :number => 1, :reward => 10})
+            CF::TaskForm.create({:station => s, :title => "Enter text from a business card image", :instruction => "Describe"}) do |i|
+              CF::FormField.new({:form => i, :label => "First Name", :field_type => "short_answer", :required => "true"})
+              CF::FormField.new({:form => i, :label => "Middle Name", :field_type => "short_answer"})
+              CF::FormField.new({:form => i, :label => "Last Name", :field_type => "short_answer", :required => "true"})
+            end
+            @gold_standard = CF::GoldStandard.new({ :line => line,
+              :station => s,
+              :name => "easy_#{Time.now}",
+              :input => {'image_url' => "http://onwired.com/images/portfolio/linda-stanley-business-card.jpg"},
+              :expected_output => {"first_name" => {"value" => "John"}, "last_name" => {"value" => "Lennon"}, "company" => {"value" => "Sprout"}}
+              })
+
+              @badge = CF::Badge.create({
+                :line => line,
+                :station => s,
+                :name           => "timromero#{Time.now.day}",
+                :description    => "This badge qualifies you to work on tomb digitization tasks.",
+                :max_badges     => 100,
+                :gold_standards => ["#{@gold_standard.settings[:name]}"],
+                :test_attributes =>
+                {
+                  :type => "default",
+                  :retries => 10,
+                  :pass_percentage => 100,
+                  :check_manually => true
+                }
+                })
+
+                @badge = CF::Badge.create({
+                  :line => line,
+                  :station => s,
+                  :name    => "Tomb Digitizer#{Time.now.day}"
+                  })
+              end
+            end
+
+
         it "should add a badge to the station in plain ruby way" do
           WebMock.allow_net_connect!
           title = "line_title#{Time.new.strftime('%Y%b%d-%H%M%S')}".downcase
@@ -65,7 +112,7 @@ describe CF::Badge do
               })
             end
             badge = CF::Badge.new({
-              :name           => "Tomb Digitizer#{Time.now}",
+              :name           => "Tomb Digitizereee#{Time.now}",
               :description    => "This badge qualifies you to work on tomb digitization tasks.",
               :max_badges     => 100,
               :gold_standards => ["#{@gold_standard.settings[:name]}"],
@@ -77,7 +124,14 @@ describe CF::Badge do
                 :check_manually => false
               }
               })
+
               @line.stations.first.badges badge
+               badge1 = CF::Badge.new({
+                  :name           => "timromero#{Time.now.day}"
+                  })
+              @line.stations.first.badges badge1
+              @line.stations.first.badges.count.should eql(2)
+              @line.stations.first.badges.last.settings["name"].should eql("timromero#{Time.now.day}")
               @line.stations.first.badges.first.settings["name"].should eq(badge.settings[:name])
               @line.stations.first.badges.first.settings['test']["form"].should eql({"_type"=>"TaskForm", "form_fields"=>[{"label"=>"First Name", "field_type"=>"short_answer", "required"=>true, "position"=>1}, {"label"=>"Middle Name", "field_type"=>"short_answer", "position"=>2}, {"label"=>"Last Name", "field_type"=>"short_answer", "required"=>true, "position"=>3}], "instruction"=>"Describe", "title"=>"Enter text from a business card image"})
 

data/spec/human_worker_spec.rb

@@ -15,7 +15,7 @@ module CF
         end
         line.stations.first.type.should eql("WorkStation")
         line.stations.first.worker.number.should eql(1)
-        line.stations.first.worker.reward.should eql(20)
+        line.stations.first.worker.reward.should eql("20")
       end
 
       it "in block DSL way with invalid data and should set the error" do

data/spec/line_spec.rb

@@ -126,7 +126,7 @@ describe CF::Line do
       line.input_formats.first.name.should eql("image_url")
       line.stations.first.type.should eq("WorkStation")
       line.stations.first.worker.number.should eq(1)
-      line.stations.first.worker.reward.should eq(20)
+      line.stations.first.worker.reward.should eq("20")
       line.stations.first.form.title.should eq("Enter text from a business card image")
       line.stations.first.form.instruction.should eq("Describe")
       line.stations.first.form.form_fields.first.label.should eq("First Name")
@@ -258,7 +258,7 @@ describe CF::Line do
       line.input_formats.first.name.should eql("image_url")
       line.stations.first.type.should eq("WorkStation")
       line.stations.first.worker.number.should eq(1)
-      line.stations.first.worker.reward.should eq(20)
+      line.stations.first.worker.reward.should eq("20")
       line.stations.first.form.title.should eq("Enter text from a business card image")
       line.stations.first.form.instruction.should eq("Describe")
       line.stations.first.form.form_fields[0].label.should eq("First Name")
@@ -297,7 +297,7 @@ describe CF::Line do
       line.stations.first.worker = worker
       line.stations.first.type.should eql("WorkStation")
       line.stations.first.worker.number.should eql(1)
-      line.stations.first.worker.reward.should eql(20)
+      line.stations.first.worker.reward.should eql("20")
     end
 
     it "should create a TaskForm within station" do
@@ -549,7 +549,7 @@ describe CF::Line do
       line.input_formats.first.name.should eql("Company")
       line.stations.first.type.should eq("WorkStation")
       line.stations.first.worker.number.should eq(1)
-      line.stations.first.worker.reward.should eq(10)
+      line.stations.first.worker.reward.should eq("10")
       line.output_formats.settings.should eql({:station_1 => [{:name => "First Name"}],:station_2 => [{:name => "Mobile", :except => true}]})
     end
 
@@ -583,7 +583,7 @@ describe CF::Line do
       line.input_formats.first.name.should eql("Company")
       line.stations.first.type.should eq("WorkStation")
       line.stations.first.worker.number.should eq(1)
-      line.stations.first.worker.reward.should eq(10)
+      line.stations.first.worker.reward.should eq("10")
       line.output_formats.settings.should eql({:station_1 => [{:name => "First Name"}],:station_2 => [{:name => "Mobile", :except => true}]})
     end
 
@@ -603,7 +603,7 @@ describe CF::Line do
       line.input_formats.first.name.should eql("Company")
       line.stations.first.type.should eq("WorkStation")
       line.stations.first.worker.number.should eq(1)
-      line.stations.first.worker.reward.should eq(10)
+      line.stations.first.worker.reward.should eq("10")
       line.output_formats.errors.should eql("Line is not complete or valid")
     end
   end

data/spec/run_spec.rb

@@ -30,7 +30,7 @@ module CF
         line.stations[0].type.should eq("WorkStation")
 
         line.stations[0].worker.number.should eq(1)
-        line.stations[0].worker.reward.should eq(20)
+        line.stations[0].worker.reward.should eq("20")
 
         line.stations[0].form.title.should eq("Enter text from a business card image")
         line.stations[0].form.instruction.should eq("Describe")
@@ -141,7 +141,7 @@ module CF
         line.input_formats[1].required.should eq(true)
 
         line.stations.first.worker.number.should eql(1)
-        line.stations.first.worker.reward.should eql(20)
+        line.stations.first.worker.reward.should eql("20")
 
         line.stations.first.form.title.should eql("Enter text from a business card image")
         line.stations.first.form.instruction.should eql("Describe")

data/spec/stat_badge_spec.rb

@@ -16,7 +16,7 @@ module CF
         end
         line.stations.first.type.should eql("WorkStation")
         line.stations.first.worker.number.should eql(1)
-        line.stations.first.worker.reward.should eql(20)
+        line.stations.first.worker.reward.should eql("20")
         line.stations.first.worker.stat_badge.should eql({"approval_rating"=>40, "assignment_duration"=>1800, "abandonment_rate"=>30, "country"=>nil})
       end
 
@@ -37,7 +37,7 @@ module CF
 
         line.stations.first.type.should eql("WorkStation")
         line.stations.first.worker.number.should eql(1)
-        line.stations.first.worker.reward.should eql(20)
+        line.stations.first.worker.reward.should eql("20")
         line.stations.first.worker.stat_badge.should eql({"approval_rating"=>40, "assignment_duration"=>1800, "abandonment_rate"=>30, "country"=>nil})
       end
     end

data/spec/station_spec.rb

@@ -30,7 +30,7 @@ describe CF::Station do
       end
       line.stations.first.type.should eq("WorkStation")
       line.stations.first.worker.number.should eql(1)
-      line.stations.first.worker.reward.should eql(20)
+      line.stations.first.worker.reward.should eql("20")
       line.stations.first.form.title.should eq("Enter text from a business card image")
       line.stations.first.form.instruction.should eq("Describe")
       line.stations.first.form.form_fields[0].label.should eq("First Name")
@@ -55,7 +55,7 @@ describe CF::Station do
       end
       line.stations.first.type.should eq("WorkStation")
       line.stations.first.worker.number.should eql(1)
-      line.stations.first.worker.reward.should eql(20)
+      line.stations.first.worker.reward.should eql("20")
       line.stations.first.form.title.should eq("Enter text from a business card image")
       line.stations.first.form.instruction.should eq("Describe")
       line.stations.first.form.form_fields[0].label.should eq("First Name")
@@ -79,7 +79,7 @@ describe CF::Station do
         end
       end
       line.stations.first.type.should eq("TournamentStation")
-      line.stations.first.jury_worker.should eql({"max_judges"=>10, "confidence_level"=>0.65, "tournament_restarts"=>0, "number"=>2})
+      line.stations.first.jury_worker.should eql({"max_judges"=>10, "tournament_restarts"=>0, "number"=>2})
       line.stations.first.auto_judge.should eql({"enabled"=>true, "finalize_percentage"=>51})
       line.stations.first.worker.number.should eql(3)
       line.stations.first.worker.reward.should eql(20)
@@ -96,7 +96,7 @@ describe CF::Station do
       sleep 1
       line = CF::Line.new(title, "Digitization")
       CF::InputFormat.new({:line => line, :name => "image_url", :required => true, :valid_type => "url"})
-      station = CF::Station.new({:type => "improve"}) 
+      station = CF::Station.new({:type => "improve"})
       expect { line.stations station }.to raise_error(CF::ImproveStationNotAllowed)
     end
 
@@ -123,7 +123,7 @@ describe CF::Station do
           CF::HumanWorker.new({:station => s, :number => 2, :reward => 20})
         end
       end
-      line.stations.first.to_s.should eql("{:type => TournamentStation, :index => 1, :line_title => #{title}, :station_input_formats => , :jury_worker => {\"max_judges\"=>10, \"confidence_level\"=>0.65, \"tournament_restarts\"=>0, \"number\"=>2}, auto_judge => {\"enabled\"=>true, \"finalize_percentage\"=>51}, :errors => }")
+      line.stations.first.to_s.should eql("{:type => TournamentStation, :index => 1, :line_title => #{title}, :station_input_formats => , :jury_worker => {\"max_judges\"=>10,  \"tournament_restarts\"=>0, \"number\"=>2}, auto_judge => {\"enabled\"=>true, \"finalize_percentage\"=>51}, :errors => }")
     end
   end
 
@@ -270,7 +270,7 @@ describe CF::Station do
       line.stations.first.type.should eql("WorkStation")
       line.stations.first.batch_size.should eql(3)
       line.stations.first.worker.number.should eql(1)
-      line.stations.first.worker.reward.should eql(20)
+      line.stations.first.worker.reward.should eql("20")
     end
 
     it "for work station in Plain Ruby way" do

metadata

@@ -2,7 +2,7 @@
 name: cloudfactory
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - CloudFactory.com
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-22 00:00:00 Z
+date: 2012-03-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: i18n