cloudfactory 0.4.4 → 0.4.5

data/lib/cf/cli/line_yaml_validator.rb

@@ -61,7 +61,7 @@ module Cf
                 # Checking Worker
                 worker = station['station']['worker']
                 if worker.class != Hash
-                  errors << "Worker is missing in Block station #{i+1}!" 
+                  errors << "Worker is missing in Block station #{i+1}!"
                   return errors
                 elsif worker.class == Hash
                   # Checking Worker type
@@ -72,14 +72,14 @@ module Cf
                   if worker_type.nil?
                     errors << "Worker Type is missing!"
                   else
-                    if worker_type != "human" 
+                    if worker_type != "human"
                       errors << "Worker type is invalid in Block station #{i+1}!" if worker_type.split("_").last != "robot"
                       if worker_type.split("_").last == "robot"
                         settings = worker['settings']
                         errors << "Settings for the robot worker is missing in Block station #{i+1}!" if settings.nil?
                         errors << "Settings for the robot worker is invalid in Block station #{i+1}!" if settings.class != Hash
                       end
-                    elsif worker_type == "human" 
+                    elsif worker_type == "human"
                       # Checking number of workers if worker_type == "human"
                       num_workers = worker['num_workers']
                       if num_workers.nil?
@@ -91,7 +91,7 @@ module Cf
                       # Checking reward of workers if worker_type == "human"
                       reward = worker['reward']
                       if reward.nil?
-                        errors << "Reward of workers not specified in Block station #{i+1}!" 
+                        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
                       end
@@ -106,29 +106,6 @@ module Cf
                     errors << "Stat badge setting is invalid in Block station #{i+1}!" if stat_badge.class != Hash
                   end
 
-                  # Checking skill_badge
-                  skill_badges = station['station']['worker']['skill_badges']
-                  if !skill_badges.nil?
-                    errors << "Skill badge settings is invalid in Block station #{i+1}!" if skill_badges.class != Array
-                    skill_badges.each_with_index do |badge, badge_index|
-                      badge_title = badge['title']
-                      badge_description = badge['description']
-                      max_badges = badge['max_badges']
-                      badge_test = badge['test']
-                      test_input = badge_test['input'] if badge_test.class == Hash
-                      expected_output = badge_test['expected_output'] if badge_test.class == Hash
-                      errors << "Skill badge title is Missing in Block #{badge_index+1}!" if badge_title.nil?
-                      errors << "Skill badge Description is Missing in Block #{badge_index+1}!" if badge_description.nil?
-                      errors << "Skill badge max_badges must be greater than 100 in Block #{badge_index+1}!" if max_badges < 100 && !max_badges.nil?
-                      errors << "Skill badge Test is Missing in Block #{badge_index+1}!" if badge_test.nil?
-                      errors << "Skill badge Test is Invalid (must be Hash) in Block #{badge_index+1}!" if badge_test.class != Hash && !badge_test.nil?
-                      errors << "Skill badge Test input is Missing in Block #{badge_index+1}!" if test_input.nil? && !badge_test.nil?
-                      errors << "Skill badge Test input is Invalid (must be Hash) in Block #{badge_index+1}!" if  test_input.class != Hash && !test_input.nil? && !badge_test.nil?
-                      errors << "Skill badge Test expected_output is Missing in Block #{badge_index+1}!" if expected_output.nil? && !badge_test.nil?
-                      errors << "Skill badge Test expected_output is Invalid (must be an array) in Block #{badge_index+1}!" if expected_output.class != Array && !expected_output.nil? && !badge_test.nil?
-                    end
-                  end
-
                   # Checking TaskForm
                   if worker_type == "human"
                     task_form = station['station']['task_form']
@@ -142,9 +119,9 @@ module Cf
 
                         instruction = custom_task_form['instruction']
                         errors << "Form Instruction is missing in Block station #{i+1}!" if instruction.nil?
-                      
+
                         errors << "station#{i+1}.html is missing in folder #{Dir.pwd} !" if !File.exist?("station#{i+1}.html")
-                                              # 
+                                              #
                                               # if File.exist?("#{Dir.pwd}")
                                               #   station_source = "#{Dir.pwd}/station_#{i+1}"
                                               #   errors << "station#{i+1} is missing in folder #{Dir.pwd}/station_#{i+1} !" if !File.exist?("station#{i+1}.html")
@@ -176,7 +153,7 @@ module Cf
                                 errors << "Option values is required for field_type => #{field_type} in block #{index+1} of Form Field within Station #{i+1} !"
                               elsif !option_values.nil?
                                 if option_values.class != Array
-                                  errors << "Option values must be an array for field_type => #{field_type} in block #{index+1} of Form Field within Station #{i+1}!"  
+                                  errors << "Option values must be an array for field_type => #{field_type} in block #{index+1} of Form Field within Station #{i+1}!"
                                 end
                               end
                             end

data/lib/cf/cli/production.rb

@@ -10,11 +10,65 @@ module Cf # :nodoc: all
       end
     end
 
-    desc "production start <run-title>", "creates a production run with input data file at input/<run-title>.csv"
+    desc "production start_test <run-title> -g<number-of-goldstandrds-to-be-added>", "creates a production run with given line goldstandards as units"
+    method_option :gold_standards_inputs, :type => :string, :aliases => "-g", :desc => "number of goldstandard as input 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_test(title=nil)
+      line_destination  = Dir.pwd
+      yaml_source       = "#{line_destination}/line.yml"
+
+      set_target_uri(options[:live])
+      set_api_key
+      CF.account_name = CF::Account.info['name']
+
+      if options[:line].present?
+        line = CF::Line.find(options[:line])
+        if line.nil?
+          say("Line named #{options[:line]} does not exist !!!", :red) and exit(1)
+        else
+          line = Hashie::Mash.new(line)
+          line_title = options[:line]
+        end
+      elsif File.exist?("#{yaml_source}")
+        line_yaml_dump = YAML::load(File.read(yaml_source).strip)
+        line_title = line_yaml_dump['title'].parameterize
+        line = CF::Line.find(line_title)
+        if line.nil?
+          say("Line named #{options[:line]} does not exist !!!", :red) and exit(1)
+        else
+          line = Hashie::Mash.new(line)
+        end
+      else
+        say("Looks like you're not in the Line directory or did not provide the line title to use the line", :red) and return
+      end
+
+      if title.nil?
+        if line_title =~  /\w\/\w/
+          run_title       = "#{line_title.split("/").last}-#{Time.new.strftime('%Y%b%d-%H%M%S')}".downcase
+        else
+          run_title       = "#{line_title}-#{Time.new.strftime('%Y%b%d-%H%M%S')}".downcase
+        end
+      else
+        run_title       = "#{title.parameterize}-#{Time.new.strftime('%Y%b%d-%H%M%S')}".downcase
+      end
+
+      gold_standard_inputs = options[:gold_standards_inputs]
+      say "Creating a test production run with title #{run_title}", :green
+      run = CF::TestRun.new(line_title, run_title, gold_standard_inputs)
+      if run.errors.blank?
+        display_success_run(run)
+      else
+        say("Error: #{run.errors}", :red)
+      end
+
+    end
+
+    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 :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)      
+    def start(title=nil)
       line_destination  = Dir.pwd
       yaml_source       = "#{line_destination}/line.yml"
 
@@ -32,7 +86,7 @@ module Cf # :nodoc: all
         end
       elsif File.exist?("#{yaml_source}")
         line_yaml_dump = YAML::load(File.read(yaml_source).strip)
-        line_title = line_yaml_dump['title'].parameterize        
+        line_title = line_yaml_dump['title'].parameterize
         line = CF::Line.find(line_title)
         if line.nil?
           say("Line named #{options[:line]} does not exist !!!", :red) and exit(1)
@@ -162,7 +216,7 @@ module Cf # :nodoc: all
       if resp_runs.has_key?("total_runs") && resp_runs['total_runs']==0
         say("\nRun list is empty.\n", :yellow) and return
       end
-      
+
       if resp_runs['total_pages']
         say("\nShowing page #{current_page} of #{resp_runs['total_pages']} (Total runs: #{resp_runs['total_runs']})")
       end
@@ -198,7 +252,7 @@ module Cf # :nodoc: all
       # if result.status == "resumed"
       say("Run with title \"#{result['title']}\" is resumed!", :green)
       # end
-    end   
+    end
 
     desc "production add_units", "add units to already existing production run"
     method_option :run_title, :type => :string, :required => true, :aliases => "-t", :desc => "the title of the run to resume"
@@ -223,12 +277,12 @@ module Cf # :nodoc: all
       if units.nil?
         say("Error: Invalid File!", :red) and exit(1)
       else
-        if units['error'].present? 
+        if units['error'].present?
           say("Error: #{units['error']['message']}", :red) and exit(1)
         end
         say("\"#{units['successfull']}\"!", :green)
       end
-    end 
+    end
 
     desc "production delete", "Deletes created Production Run"
     method_option :run_title, :type => :string, :required => true, :aliases => "-t", :desc => "the title of the run to resume"
@@ -237,12 +291,12 @@ module Cf # :nodoc: all
       set_api_key
       CF.account_name = CF::Account.info['name']
       run_title = options[:run_title].parameterize
-      
+
       deleted_run = CF::Run.destroy(run_title)
       if deleted_run['error'].present?
         say("Error: #{deleted_run['error']['message']}", :red) and exit(1)
       end
       say("Run Deleted Successfully entitled: \"#{deleted_run['title']}\"!", :green)
-    end 
+    end
   end
 end

data/lib/cf/gold_standard.rb

@@ -0,0 +1,74 @@
+module CF
+  class GoldStandard
+    require 'httparty'
+    include Client
+
+    # goldstandard settings
+    attr_accessor :settings
+
+    #GoldStandard name
+    attr_accessor :name
+
+    # the input provided to the goldstandard
+    attr_accessor :input
+
+    # ExpectedOutput of the gold-standard with which the actual output is matched
+    attr_accessor :expected_output
+
+    # assignment_duration is the time period that is allocated for the badge test
+    attr_accessor :assignment_duration
+
+    # Contains error message
+    attr_accessor :errors
+
+
+    # ==Initializes a new gold standard
+    # ===Usage Example:
+    # CF::GoldStandard.new({ :line => line,:name => "easy",: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"}}]})
+    # line.gold_standards gold_standard
+
+    def initialize(options={})
+      @settings = options
+      @station = options[:station] if options[:station].present?
+      @line = options[:line] if options[:line].nil? ? nil : options[:line]
+      if !@line.nil? || @station
+        options.delete(:station) if @settings[:station].present?
+        options.delete(:line)
+        if options[:file] || options["file"]
+          options.symbolize_keys!
+          file_upload = File.new(options[:file], 'rb')
+          if @station
+            resp = self.class.post("/lines/#{CF.account_name}/#{@line.title.downcase}/stations/#{@station.index}/gold_standards.json", {:file => file_upload})
+            @station.gold_standards = self
+          else
+            resp = self.class.post("/lines/#{CF.account_name}/#{@line.title.downcase}/gold_standards.json", {:file => file_upload})
+            @line.gold_standards = self
+          end
+        else
+        request =
+        {
+          :body =>
+          {
+            :api_key => CF.api_key,
+            :gold_standard => options
+          }
+        }
+
+        if @station
+          resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@line.title.downcase}/stations/#{@station.index}/gold_standards.json",request)
+          @station.gold_standards = self
+        else
+          resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@line.title.downcase}/gold_standards.json",request)
+          @line.gold_standards = self
+        end
+        self.errors = resp.parsed_response['error']['message'] if resp.code != 200
+        end
+      end
+    end
+
+    def self.create(*args)
+      GoldStandard.new(args.first)
+    end
+
+  end
+end

data/lib/cf/help.txt

@@ -0,0 +1,67 @@
+Tasks:
+
+Help:
+  Usage:
+    cf [command] help
+  Description:
+    Shows all help commands
+
+Version
+  Usage:
+    cf version
+  Description:
+    Shows the current version of cloudfactory gem
+
+UserInfo:
+  Usage:
+    cf whoami
+  Description:
+    to know what credential you are using
+
+Login
+  Usage:
+    cf login
+  Description:
+    Setup the cloudfactory credentials
+
+Form:
+   Usage:
+    cf form generate --fields=key:value --labels=LABELS --station=N               # generates a custom task form at <line-title>/<form-title>.html and its associated css and js files
+    cf form preview -s, --station=N                                               # generates a html file to preview the custom task form
+  Description:
+    Commands to generate custom task forms. For more info, cf form help
+  More:
+    cf form help [sub-command]                                                     #list all help related to form subcommands
+
+Line:
+   Usage:
+    cf line create                                                                 # takes the line.yml and creates a new line at http://cloudfactory.com
+    cf line delete                                                                 # delete the current line at http://cloudfactory.com
+    cf line details                                                                # list the details of the line
+    cf line generate LINE-TITLE                                                    # generates a line template at <line-title>/line.yml
+    cf line list                                                                   # List your lines
+  Description:
+    Commands to manage the Lines. For more info, cf line help
+  More:
+    cf line help [sub-command]                                                     #list all help related to line subcommands
+
+Production:
+  Usage:
+    cf production add_units -i, --input-data=INPUT_DATA -t, --run-title=RUN_TITLE  # add units to already existing production run
+    cf production delete -t, --run-title=RUN_TITLE                                 # Deletes created Production Run
+    cf production list                                                             # list the production runs
+    cf production resume -r, --run-title=RUN_TITLE                                 # resume a paused production run
+    cf production start <run-title>                                                # creates a production run with input data file at input/<run-title>.csv
+    cf production start_test <run-title> -g<number-of-goldstandrds-to-be-added>    # creates a production run with given line goldstandards as units
+  Description:
+    Commands to create production runs. For more info, cf production help
+  More:
+    cf production help [sub-command]                                                #list all help related to production subcommands
+
+Output:
+  Usage:
+    cf output <run-title> -t, --run-title=RUN_TITLE
+  Description:
+    Get the output of run. For more info, cf output help
+  More:
+    cf output help [sub-command]                                                     #list all help related to output subcommands

data/lib/cf/human_worker.rb

@@ -3,33 +3,33 @@ module CF
     include Client
     require 'httparty'
     extend ActiveSupport::Concern
-    
+
     # ID of "Worker" object
     attr_accessor :id
-    
+
     # Number of worker, e.g. :number => 3
     attr_accessor :number
-    
+
     # Reward for worker, e.g. :reward => 10 (reward unit is in cents)
     attr_accessor :reward
-    
+
     # Station attribute for "worker" object
     attr_accessor :station
-    
+
     # Stat Badge for "worker" object, e.g. worker = CF::HumanWorker.new({:number => 2, :reward => 20, :stat_badge => {:approval_rating => 40, :assignment_duration => 1800, :abandonment_rate => 30}})
     attr_accessor :stat_badge
-    
+
     # Skill Badge for "worker" object
     # example:
-    #   badge_settings = 
+    #   badge_settings =
     #   {
-    #       :title => 'Football Fanatic', 
-    #       :description => "This qualification allows you to perform work at stations which have this badge.", 
-    #       :max_badges => 3, 
-    #       :test => 
+    #       :title => 'Football Fanatic',
+    #       :description => "This qualification allows you to perform work at stations which have this badge.",
+    #       :max_badges => 3,
+    #       :test =>
     #       {
     #         :input => {:name => "Lionel Andres Messi", :country => "Argentina"},
-    #         :expected_output => 
+    #         :expected_output =>
     #         [
     #           {:birthplace => "Rosario, Santa Fe, Argentina",:match_options => {:tolerance => 10, :ignore_case => true }},
     #           {:position => "CF",:match_options => {:tolerance => 1 }},
@@ -39,72 +39,68 @@ module CF
     #   }
     #
     # worker = CF::HumanWorker.new({:number => 2, :reward => 20, :skill_badge => badge_settings})
-    attr_accessor :skill_badges
-    
+    # attr_accessor :skill_badges
+
     # Contains Error messages if any for "worker" object
     attr_accessor :errors
-    
+
     # Badge setting for "worker" object
     attr_accessor :badge
-    
-    # ==Initializes a new "worker" object 
+
+    # ==Initializes a new "worker" object
     # ==Usage of HumanWorker.new(hash):
     #
-    # ==In Block DSL way 
-    #   line = CF::Line.create("human_worker", "Survey") do |l|   
+    # ==In Block DSL way
+    #   line = CF::Line.create("human_worker", "Survey") do |l|
     #     CF::Station.create({:line => l, :type => "work"}) do |s|
     #       CF::HumanWorker.new({:station => s, :number => 1, :reward => 10})
     #     end
     #   end
     #
-    # ==In Plain Ruby way 
+    # ==In Plain Ruby way
     #   line = CF::Line.new("human_worker", "Digitization")
     #   input_format = CF::InputFormat.new({:name => "image_url", :required => true, :valid_type => "url"})
     #   line.input_formats input_format
-    # 
+    #
     #   station = CF::Station.new({:type => "work"})
     #   line.stations station
-    # 
+    #
     #   worker = CF::HumanWorker.new({:number => 2, :reward => 20})
     #   line.stations.first.worker = worker
-    
+
     def initialize(options={})
-      @skill_badges = []
       @station = options[:station]
       @number  = options[:number].nil? ? 1 : options[:number]
       @reward  = options[:reward]
-      @badge = options[:skill_badge].nil? ? nil : options[:skill_badge]
       @stat_badge = options[:stat_badge].nil? ? nil : options[:stat_badge]
       if @station
-        if options[:skill_badge].nil? && options[:stat_badge].nil?
-          request = 
+        if options[:stat_badge].nil?
+          request =
           {
-            :body => 
+            :body =>
             {
               :api_key => CF.api_key,
               :worker => {:number => @number, :reward => @reward, :type => "HumanWorker"}
             }
           }
         else
-          request = 
+          request =
           {
-            :body => 
+            :body =>
             {
               :api_key => CF.api_key,
               :worker => {:number => @number, :reward => @reward, :type => "HumanWorker"},
-              :skill_badge => @badge,
               :stat_badge => options[:stat_badge]
             }
           }
         end
         resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@station.line['title'].downcase}/stations/#{@station.index}/workers.json",request)
-        
+
         self.id =  resp.parsed_response['id']
         self.number =  resp.parsed_response['number']
         self.reward =  resp.parsed_response['reward']
-        self.stat_badge =  resp.parsed_response['stat_badge'] 
-        @skill_badges << resp.parsed_response['skill_badges']
-        
+        self.stat_badge =  resp.parsed_response['stat_badge']
+
         if resp.code != 200
           self.errors = resp.parsed_response['error']['message']
         end
@@ -112,19 +108,19 @@ module CF
         self.station.worker = self
       end
     end
-    
+
     # ==Creation a new "worker" object with Badge
     # ==Usage Example:
-    # ==In Plain Ruby way 
-    #   badge_settings = 
+    # ==In Plain Ruby way
+    #   badge_settings =
     #   {
-    #       :title => 'Football Fanatic', 
-    #       :description => "This qualification allows you to perform work at stations which have this badge.", 
-    #       :max_badges => 3, 
-    #       :test => 
+    #       :title => 'Football Fanatic',
+    #       :description => "This qualification allows you to perform work at stations which have this badge.",
+    #       :max_badges => 3,
+    #       :test =>
     #       {
     #         :input => {:name => "Lionel Andres Messi", :country => "Argentina"},
-    #         :expected_output => 
+    #         :expected_output =>
     #         [
     #           {:birthplace => "Rosario, Santa Fe, Argentina",:match_options => {:tolerance => 10, :ignore_case => true }},
     #           {:position => "CF",:match_options => {:tolerance => 1 }},
@@ -135,18 +131,18 @@ module CF
     #   line = CF::Line.new("human_worker", "Digitization")
     #   input_format = CF::InputFormat.new({:name => "image_url", :required => true, :valid_type => "url"})
     #   line.input_formats input_format
-    # 
+    #
     #   station = CF::Station.new({:type => "work"})
     #   line.stations station
-    # 
+    #
     #   worker = CF::HumanWorker.new({:number => 2, :reward => 20, :skill_badge => skill_badge})
     #   line.stations.first.worker = worker
     #
     #   line.stations.first.worker.badge = badge_settings
     def badge=(badge)
-      request = 
+      request =
       {
-        :body => 
+        :body =>
         {
           :api_key => CF.api_key,
           :skill_badge => badge
@@ -156,9 +152,9 @@ module CF
       self.errors = resp['error']['message'] if resp.code != 200
       self.skill_badges << resp.parsed_response['skill_badges']
     end
-    
+
     def to_s # :nodoc:
-      "{:id => => #{self.id}, :number => #{self.number}, :reward => #{self.reward}, :stat_badge => #{self.stat_badge},  :skill_badges => #{self.skill_badges}, :errors => #{self.errors}}"
+      "{:id => => #{self.id}, :number => #{self.number}, :reward => #{self.reward}, :stat_badge => #{self.stat_badge}, :errors => #{self.errors}}"
     end
   end
 end