cloudfactory 0.1.12 → 0.1.13

data/fixtures/input_data/test.csv

@@ -1,2 +1,2 @@
-Company,Website,meta_data_company
-Apple,apple.com,Apple
+Company,Website
+Apple,apple.com

data/lib/cf.rb

@@ -90,4 +90,5 @@ require "#{directory}/cf/custom_task_form"
 require "#{directory}/cf/run"
 require "#{directory}/cf/department"
 require "#{directory}/cf/final_output"
-require "#{directory}/cf/robot_worker"
+require "#{directory}/cf/robot_worker"
+require "#{directory}/cf/version"

data/lib/cf/cli.rb

@@ -18,6 +18,7 @@ require "#{cli_directory}/config"
 require "#{cli_directory}/line"
 require "#{cli_directory}/form"
 require "#{cli_directory}/production"
+require "#{cli_directory}/line_yaml_validator"
 
 if ENV['TEST']
   require 'ruby-debug'
@@ -28,6 +29,8 @@ module Cf # :nodoc: all
     include Thor::Actions
     include Cf::Config
     
+    map "-v" => :version
+    
     desc "login", "Setup the cloudfactory credentials"
     def login
       email = ask("Enter your email:")
@@ -128,5 +131,9 @@ module Cf # :nodoc: all
       end
     end
     
+    desc "version", "Shows the current version of cloudfactory gem"
+    def version
+      say("Version: #{CF::VERSION}")
+    end
   end
 end

data/lib/cf/cli/line.rb

@@ -100,7 +100,15 @@ module Cf # :nodoc: all
         say "The line.yml file does not exist in this directory", :red
         return
       end
-
+      
+      errors = LineYamlValidator.validate(yaml_source)
+      
+      if errors.present?
+        say("Invalid line.yml file. Correct its structure as per the errors shown below.", :red)
+        errors.each {|error| say("  #{error}", :cyan)}
+        exit(1)
+      end
+      
       set_target_uri(false)
       set_api_key(yaml_source)
 

data/lib/cf/cli/line_yaml_validator.rb

@@ -0,0 +1,183 @@
+module Cf
+  class LineYamlValidator
+    
+    def self.validate(yaml_path)
+      line_dump = YAML::load(File.read(yaml_path))
+      errors = []
+      # Checking Department
+      if line_dump['department'].nil?
+        errors << "The line Department is missing!"
+      end
+
+      # Checking Input Formats
+      input_formats = line_dump['input_formats']
+      if input_formats.nil?
+        errors << "The Input Format is missing!"
+      else
+        if input_formats.class == Array
+          input_formats.each_with_index do |input_format, index|
+            name = input_format['name']
+            required = input_format['required']
+            valid_type = input_format['valid_type']
+            if name.nil?
+              errors << "Input Format name is missing in Block #{index+1}!"
+            end
+          end
+        end
+      end
+
+      # Checking Stations
+      stations = line_dump['stations']
+      if stations.nil?
+        errors << "Station is missing!"
+      else
+        if stations.class == Array
+          if stations.first['station'].nil?
+            errors << "Station Settings missing!"
+          else
+            stations.each_with_index do |station, i|
+              station_index = station['station']['station_index']
+              errors << "Station Index is missing in Block station #{i+1}!" if station_index.nil?
+
+              station_type = station['station']['station_type']
+              errors << "Station type is missing in Block station #{i+1}!" if station_type.nil?
+
+              if station_type == "tournament"
+                jury_worker = station['station']['jury_worker']
+                if jury_worker.nil?
+                  errors << "Jury worker setting is missing in Block station #{i+1}!"
+                elsif !jury_worker.nil?
+                  reward = jury_worker['reward']
+                  errors << "Reward for worker is missing in Block station #{i+1}!" if reward.nil?
+                  errors << "Reward Must be greater than 0 in Block station #{i+1}!" if !reward.nil? && reward < 1
+                end
+              end
+              # Checking Worker
+              worker = station['station']['worker']
+              if worker.class != Hash
+                errors << "Worker is missing in Block station #{i+1}!" 
+              elsif worker.class == Hash
+                # Checking Worker type
+                worker.each_pair do |k, v|
+                  errors << "Should not be an array" if v.class == Array && k != "skill_badges"
+                end
+                worker_type = worker['worker_type']
+                if worker_type.nil?
+                  errors << "Worker Type is missing!"
+                else
+                  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 missingin Block station #{i+1}!" if settings.nil?
+                    end
+                  elsif worker_type == "human" 
+                    # Checking number of workers if worker_type == "human"
+                    num_workers = worker['num_workers']
+                    if num_workers.nil?
+                      errors << "Number of workers not specified in Block station #{i+1}!"
+                    else
+                      errors << "Number of workers must be greater than 0 in Block station #{i+1}!" if num_workers < 1
+                    end
+
+                    # 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}!" 
+                    else
+                      errors << "Reward of workers must be greater than 0 in Block station #{i+1}!" if reward < 1
+                    end
+                  end
+                end
+              end
+
+              # Checking Stat_badge
+              stat_badge = station['station']['worker']['stat_badge']
+              if !stat_badge.nil?
+                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 1000 in Block #{badge_index+1}!" if max_badges < 1000 && !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']
+                if task_form.nil?
+                  custom_task_form = station['station']['custom_task_form']
+                  if custom_task_form.nil?
+                    errors << "Form is missing in Block station #{i+1}!"
+                  elsif custom_task_form.class == Hash
+                    form_title = custom_task_form['form_title']
+                    errors << "Form Title is missing in Block station #{i+1}!" if form_title.nil?
+
+                    instruction = custom_task_form['instruction']
+                    errors << "Form Instruction is missing in Block station #{i+1}!" if instruction.nil?
+                  end
+                elsif task_form.class == Hash
+                  form_title = task_form['form_title']
+                  errors << "Form Title is missing in Block station #{i+1}!" if form_title.nil?
+
+                  instruction = task_form['instruction']
+                  errors << "Form Instruction is missing in Block station #{i+1}!" if instruction.nil?
+
+                  # Checking Form Fields
+                  form_fields = task_form['form_fields']
+                  errors << "Form Field is missing in Block station #{i+1}!" if form_fields.nil?
+                  if form_fields.class == Array
+                    form_fields.each_with_index do |form_field, index|
+                      field_label = form_field['label']
+                      errors << "Label is missing in block #{index+1} of Form Field within Station #{i+1}!" if field_label.nil?
+                      required = form_field['required']
+                      field_type = form_field['field_type']
+                      if !field_type.nil?
+                        unless %w(short_answer long_answer radio_button check_box select_box).include?(field_type)
+                          errors << "Field Type of Form Field is invalid in Block #{index+1} of station Block #{i+1}!"
+                        end
+                        if field_type == "radio_button" || field_type == "select_box"
+                          option_values = form_field['option_values']
+                          if option_values.nil?
+                            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}!"  
+                            end
+                          end
+                        end
+                      end
+                    end
+                  else
+                    errors << "Form fields must be an array for Station #{i+1}!"
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      return errors
+    end
+    
+  end
+end

data/lib/cf/cli/production.rb

@@ -125,5 +125,22 @@ module Cf # :nodoc: all
       say("\n")
       say(runs_table)
     end
+    
+    desc "production resume", "resume a paused production run"
+    method_option :run_title, :type => :string, :required => true, :aliases => "-r", :desc => "the title of the run to resume"
+    def resume
+      set_target_uri(false)
+      set_api_key
+      CF.account_name = CF::Account.info.name
+      result = CF::Run.resume(options['run_title'].parameterize)
+
+      if result.error.present?
+        say("Error: #{result.error.message}", :red) and exit(1)
+      end
+
+      # if result.status == "resumed"
+      say("Run with title \"#{result.title}\" is resumed!", :green)
+      # end
+    end    
   end
 end

data/lib/cf/line.rb

@@ -60,14 +60,6 @@ module CF
         if type == "Improve" && self.stations.size < 1
           raise ImproveStationNotAllowed.new("You cannot add Improve Station as a first station of a line")
         else
-          request_general = 
-          {
-            :body => 
-            {
-              :api_key => CF.api_key,
-              :station => {:type => type, :input_formats => @station_input_formats}
-            }
-          }
           if type == "Tournament"
             @jury_worker = stations.jury_worker
             @auto_judge = stations.auto_judge
@@ -81,6 +73,14 @@ module CF
             }
             resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{self.title.downcase}/stations.json",request_tournament)
           else
+            request_general = 
+            {
+              :body => 
+              {
+                :api_key => CF.api_key,
+                :station => {:type => type, :input_formats => @station_input_formats}
+              }
+            }
             resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{self.title.downcase}/stations.json",request_general)
           end
           station = CF::Station.new()
@@ -157,6 +157,7 @@ module CF
       end
       
     end
+    
     def input_formats=(input_formats_value) # :nodoc:
       @input_formats << input_formats_value
     end

data/lib/cf/run.rb

@@ -27,10 +27,10 @@ module CF
     # 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)
-      if line.class == CF::Line || Hashie::Mash
+      if line.class == CF::Line || line.class == Hashie::Mash
         @line = line
-        @line_title = @line.title
-      else
+        @line_title = line.title
+      elsif line.class == String
         @line_title = line
       end
       @title = title

data/lib/cf/version.rb

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

data/spec/badge_spec.rb

@@ -40,8 +40,8 @@ module CF
           line.stations.first.type.should eql("WorkStation")
           line.stations.first.worker.number.should eql(2)
           line.stations.first.worker.reward.should eql(20)
-          line.stations.first.worker.skill_badges.first.should eql([{"title"=>"Football Fanatic", "description"=>"This qualification allows you to perform work at stations which have this badge.", "score"=>nil, "speed"=>nil, "quality_rating"=>nil, "max_badges"=>3, "skill_test"=>{"score_after"=>"submit", "manual_scoring"=>false, "display_answers"=>false, "edit_answers"=>true, "retries"=>0, "pass_percentage"=>100, "test_units"=>[{"input"=>{"name"=>"Lionel Andres Messi", "country"=>"Argentina"}, "expected_output"=>[{"birthplace"=>"Rosario, Santa Fe, Argentina", "match_options"=>{"tolerance"=>"1", "ignore_case"=>"false"}, "position"=>"CF", "current-club"=>"Barcelona"}], "match_options"=>{"tolerance"=>0, "ignore_case"=>false}}]}}])
-          line.stations.first.worker.skill_badges.last.should eql([{"title"=>"Football Fanatic", "description"=>"This qualification allows you to perform work at stations which have this badge.", "score"=>nil, "speed"=>nil, "quality_rating"=>nil, "max_badges"=>3, "skill_test"=>{"score_after"=>"submit", "manual_scoring"=>false, "display_answers"=>false, "edit_answers"=>true, "retries"=>0, "pass_percentage"=>100, "test_units"=>[{"input"=>{"name"=>"Cristiano Ronaldo", "country"=>"Portugal"}, "expected_output"=>[{"birthplace"=>"Rosario, Santa Fe, Portugal", "match_options"=>{"tolerance"=>"1", "ignore_case"=>"false"}, "position"=>"CF", "current-club"=>"Real Madrid"}], "match_options"=>{"tolerance"=>0, "ignore_case"=>false}}]}}])
+          line.stations.first.worker.skill_badges.first.should eql([{"title"=>"Football Fanatic", "description"=>"This qualification allows you to perform work at stations which have this badge.", "score"=>nil, "quality_rating"=>nil, "max_badges"=>3, "skill_test"=>{"score_after"=>"submit", "manual_scoring"=>false, "display_answers"=>false, "edit_answers"=>true, "retries"=>0, "pass_percentage"=>100, "test_units"=>[{"input"=>{"name"=>"Lionel Andres Messi", "country"=>"Argentina"}, "expected_output"=>[{"birthplace"=>"Rosario, Santa Fe, Argentina", "match_options"=>{"tolerance"=>"1", "ignore_case"=>"false"}, "position"=>"CF", "current-club"=>"Barcelona"}], "match_options"=>{"tolerance"=>0, "ignore_case"=>false}}]}}])
+          line.stations.first.worker.skill_badges.last.should eql([{"title"=>"Football Fanatic", "description"=>"This qualification allows you to perform work at stations which have this badge.", "score"=>nil, "quality_rating"=>nil, "max_badges"=>3, "skill_test"=>{"score_after"=>"submit", "manual_scoring"=>false, "display_answers"=>false, "edit_answers"=>true, "retries"=>0, "pass_percentage"=>100, "test_units"=>[{"input"=>{"name"=>"Cristiano Ronaldo", "country"=>"Portugal"}, "expected_output"=>[{"birthplace"=>"Rosario, Santa Fe, Portugal", "match_options"=>{"tolerance"=>"1", "ignore_case"=>"false"}, "position"=>"CF", "current-club"=>"Real Madrid"}], "match_options"=>{"tolerance"=>0, "ignore_case"=>false}}]}}])
           line.stations.first.worker.stat_badge.should eql({"approval_rating"=>80, "assignment_duration"=>3600, "abandonment_rate"=>30, "country"=>nil})
         end
       end

data/spec/concept_tagging_robot_spec.rb

@@ -10,7 +10,7 @@ module CF
           line = CF::Line.create("concept_tagging_robot","Digitization") do |l|
             CF::InputFormat.new({:line => l, :name => "url", :valid_type => "url", :required => "true"})
             CF::Station.create({:line => l, :type => "work"}) do |s|
-              CF::RobotWorker.create({:station => s, :type => "concept_tagging_robot", :settings => {:url => ["{url}"]}})
+              CF::RobotWorker.create({:station => s, :type => "concept_tagging_robot", :settings => {:url => ["{{url}}"]}})
             end
           end
           run = CF::Run.create(line, "concept_tagging_robot_run", [{"url"=>"www.mosexindex.com"}])
@@ -18,9 +18,9 @@ module CF
           output.first.final_output.first.concept_tagging_of_url.should eql(["Canada", "English language"])
           output.first.final_output.first.concept_tagging_relevance_of_url.should eql([89.5153, 79.0912])
           line.stations.first.worker.class.should eql(CF::RobotWorker)
-          line.stations.first.worker.reward.should eql(1)
+          line.stations.first.worker.reward.should eql(0.5)
           line.stations.first.worker.number.should eql(1)
-          line.stations.first.worker.settings.should eql({:url => ["{url}"]})
+          line.stations.first.worker.settings.should eql({:url => ["{{url}}"]})
           line.stations.first.worker.type.should eql("ConceptTaggingRobot")
         end
       end
@@ -35,7 +35,7 @@ module CF
           station = CF::Station.new({:type => "work"})
           line.stations station
 
-          worker = CF::RobotWorker.create({:type => "concept_tagging_robot", :settings => {:url => ["{url}"]}})
+          worker = CF::RobotWorker.create({:type => "concept_tagging_robot", :settings => {:url => ["{{url}}"]}})
           line.stations.first.worker = worker
 
           run = CF::Run.create(line, "concept_tagging_robot_run_1", [{"url"=>"www.mosexindex.com"}])
@@ -43,9 +43,9 @@ module CF
           output.first.final_output.first.concept_tagging_of_url.should eql(["Canada", "English language"])
           output.first.final_output.first.concept_tagging_relevance_of_url.should eql([89.5153, 79.0912])
           line.stations.first.worker.class.should eql(CF::RobotWorker)
-          line.stations.first.worker.reward.should eql(1)
+          line.stations.first.worker.reward.should eql(0.5)
           line.stations.first.worker.number.should eql(1)
-          line.stations.first.worker.settings.should eql({:url => ["{url}"]})
+          line.stations.first.worker.settings.should eql({:url => ["{{url}}"]})
           line.stations.first.worker.type.should eql("ConceptTaggingRobot")
         end
       end

data/spec/content_scraping_robot_spec.rb

@@ -17,10 +17,9 @@ module CF
           
           output = run.final_output
           output.first.final_output.first.scraped_link_from_document.should eql([["http://www.cloudfactory.com", "http://www.bizcardarmy.com"]])
-          output.first.final_output.first.query.should eql("1st 2 links after Sprout products")
 
           line.stations.first.worker.class.should eql(CF::RobotWorker)
-          line.stations.first.worker.reward.should eql(10)
+          line.stations.first.worker.reward.should eql(0.5)
           line.stations.first.worker.number.should eql(1)
           line.stations.first.worker.settings.should eql({:document => ["http://www.sprout-technology.com"], :query => "1st 2 links after Sprout products"})
           line.stations.first.worker.type.should eql("ContentScrapingRobot")
@@ -44,10 +43,9 @@ module CF
           
           output = run.final_output
           output.first.final_output.first.scraped_link_from_document.should eql([["http://www.cloudfactory.com", "http://www.bizcardarmy.com"]])
-          output.first.final_output.first.query.should eql("1st 2 links after Sprout products")
 
           line.stations.first.worker.class.should eql(CF::RobotWorker)
-          line.stations.first.worker.reward.should eql(10)
+          line.stations.first.worker.reward.should eql(0.5)
           line.stations.first.worker.number.should eql(1)
           line.stations.first.worker.settings.should eql({:document => ["http://www.sprout-technology.com"], :query => "1st 2 links after Sprout products"})
           line.stations.first.worker.type.should eql("ContentScrapingRobot")

data/spec/custom_task_form_spec.rb

@@ -78,14 +78,14 @@ describe CF::CustomTaskForm do
         line = CF::Line.create("Digitizecustomform11", "Digitization") do
           CF::InputFormat.new({:line => self, :name => "Name", :required => true, :valid_format => "general"})
           CF::InputFormat.new({:line => self, :name => "Contact", :required => true, :valid_type => "url"})
-          CF::Station.create({:line => self, :type => "tournament", :max_judges => 10, :auto_judge => true}) do |s|
+          CF::Station.create({:line => self, :type => "work"}) do |s|
             CF::HumanWorker.new({:station => s, :number => 3, :reward => 20})
             CF::CustomTaskForm.create({:station => s, :title => "Enter text from a business card image", :instruction => "Describe", :raw_html => html, :raw_css => css, :raw_javascript => javascript})
           end
         end
         line.title.should eql("Digitizecustomform11")
         line.department_name.should eql("Digitization")
-        line.stations.first.type.should eql("TournamentStation")
+        line.stations.first.type.should eql("WorkStation")
         CGI.unescape_html(line.stations.first.form.raw_html).should eql(html)
         CGI.unescape_html(line.stations.first.form.raw_css).should eql(css)
         CGI.unescape_html(line.stations.first.form.raw_javascript).should eql(javascript)
@@ -94,7 +94,7 @@ describe CF::CustomTaskForm do
     
     it "in plain ruby way" do
       VCR.use_cassette "custom-task-form/plain/create", :record => :new_episodes do
-      html =   '<div id="form-content">
+      html =   '<form><div id="form-content">
                   <div id="instructions">
                     <ul>
                       <li>Look at the business card properly and fill in asked data.</li>
@@ -108,18 +108,18 @@ describe CF::CustomTaskForm do
                     </div>
                     <div id = "field-panel">
                       Name<br />
-                      <input class="input-field first_name" type="text" name="final_output[first_name]" />
-                      <input class="input-field middle_name" type="text" name="final_output[middle_name]" />
-                      <input class="input-field last_name" type="text" name="final_output[last_name]" /><br />
+                      <input class="input-field first_name" type="text" name="output[first_name]" />
+                      <input class="input-field middle_name" type="text" name="output[middle_name]" />
+                      <input class="input-field last_name" type="text" name="output[last_name]" /><br />
 
                       <br />Contact<br />
-                      <input class="input-field email" type="text" name="final_output[email]" placeholder="Email"/>
-                      <input class="input-field phone" type="text" name="final_output[phone]" placeholder="Phone"/>
-                      <input class="input-field mobile" type="text" name="final_output[mobile]" placeholder="Mobile"/><br />
+                      <input class="input-field email" type="text" name="output[email]" placeholder="Email"/>
+                      <input class="input-field phone" type="text" name="output[phone]" placeholder="Phone"/>
+                      <input class="input-field mobile" type="text" name="output[mobile]" placeholder="Mobile"/><br />
 
                     </div>
                   </div>
-                </div>'
+                </div></form>'
                 
         css = '<style>body {background:#fbfbfb;}
                 #instructions{