cloudfactory 0.2.5 → 0.2.6

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.2.6 (2011-09-09)
+
+* cf line inspect cmd changed to cf line details because the inspect method is the Ruby's declared method
+* acceptance_ratio parameter added in gem for tournament station
+* while creating a line which has production runs was giving inappropriate messages. its fixed.
+* sample line input file now has our own hosted files
+
 ## 0.2.5 (2011-09-01)
 
 * Broken url after doing production run on date 01 - 09 day. Fixed

data/lib/cf/cli.rb

@@ -33,18 +33,18 @@ module Cf # :nodoc: all
   class CLI < Thor # :nodoc: all
     include Thor::Actions
     include Cf::Config
-    
+
     map "-v" => :version
-    
+
     desc "login", "Setup the cloudfactory credentials"
 
     def login
       email = ask("Enter your email:")
       passwd = ask_password("Enter the password: ")
-      
+
       set_target_uri(false)
       resp = CF::Account.login(email, passwd)
-      
+
       if resp.error.blank? and resp.api_key.present?
         File.open(config_file, 'w') {|f| f.write("#Don't change this file unless you know what you're doing\n" + { :target_url => CF.api_url, :api_version => CF.api_version, :api_key => resp.api_key, :account_name => resp.account_name, :email => email.strip }.to_yaml) }
         say("\nNow you're logged in.\nTo get started, run cf help\n", :green)
@@ -52,7 +52,7 @@ module Cf # :nodoc: all
         say("\n#{resp.error.message}\nTry again with valid one.\n", :red)
       end
     end
-    
+
     no_tasks do
       def ask_password(message)
         ::HighLine.new.ask(message) do |q| 
@@ -60,18 +60,18 @@ module Cf # :nodoc: all
         end
       end
     end
-    
+
     desc "whoami", "to know what credential you are using"
     def whoami
       if File.exists?(config_file)
-          yp = YAML::load(File.open(config_file,'r'))
-          say("\nAccount => #{yp[:account_name]}", :green)
-          say("Email => #{yp[:email]}\n", :green)
+        yp = YAML::load(File.open(config_file,'r'))
+        say("\nAccount => #{yp[:account_name]}", :green)
+        say("Email => #{yp[:email]}\n", :green)
       else
-          say("\nPlease login with cf login\n")
+        say("\nPlease login with cf login\n")
       end
     end
-    
+
     # desc "target", "Setup the cloudfactory credentials. e.g. cf target staging #=> http://sandbox.staging.cloudfactory.com (options: staging/development/production)"
     # def target(target_url=nil)
     #   if target_url.present?
@@ -93,62 +93,62 @@ module Cf # :nodoc: all
 
     desc "form", "Commands to generate custom task forms. For more info, cf form help"
     subcommand "form", Cf::Form
-    
+
     desc "production", "Commands to create production runs. For more info, cf production help"
     # cannot use Run for the class name coz its a reserved word for Thor
     # later it can be replaced with hacked millisami-thor version of the thor library with run-time dependency via Bundler
     subcommand "production", Cf::Production
 
     desc "output <run-title>", "Get the output of run. For more info, cf output help"
+    method_option :run_title, :type => :string, :required => true, :aliases => "-t", :desc => "the index of the station"
     method_option :station_index, :type => :numeric, :aliases => "-s", :desc => "the index of the station"
-    def output(run_title=nil)
+    def output
+      run_title = options['run_title']
       if run_title.present?
         run_title = run_title.parameterize
         line_source = Dir.pwd
         yaml_source = "#{line_source}/line.yml"
 
-        unless File.exist?(yaml_source)
-          say "The line.yml file does not exist in this directory", :red
-          return
-        end
-        
         set_target_uri(false)
-        if set_api_key(yaml_source)
-          CF.account_name = CF::Account.info.name if CF.account_name.blank?
-          run = CF::Run.find(run_title)
-          if run.errors.blank?
-            say("Fetching output for run: #{run_title}", :green)
-            
-            if options[:station_index].present?
-              # Output for specific station
-              output = CF::Run.output(:title => run_title, :station => options[:station_index])
-            else
-              # Ouput for the whole production run
-              output = CF::Run.final_output(run_title)
-            end
-            res_array = []
-            output.each do |o|
-              res_array << o.to_hash
-            end
+        set_api_key(yaml_source)
+        CF.account_name = CF::Account.info.name
+        run = CF::Run.find(run_title)
+        if run.errors.blank?
+          say("Fetching output for run: #{run_title}", :green)
+
+          if options[:station_index].present?
+            # Output for specific station
+            output = CF::Run.output(:title => run_title, :station => options[:station_index])
+          else
+            # Ouput for the whole production run
+            output = CF::Run.final_output(run_title)
+          end
+          res_array = []
+          output.each do |o|
+            res_array << o.to_hash
+          end
+          if !res_array.empty?
+            res_array.each 
             csv_str = CSVHash(res_array,res_array.first.keys)
-            
-            FileUtils.mkdir("#{line_source}/output") unless Dir.exist?("#{line_source}/output")
+            csv_str = csv_str.gsub("\"\"", '"')
+            FileUtils.mkdir("#{line_source}/output") unless Dir.exist?("#{line_source}/output") if RUBY_VERSION > "1.9"
+            FileUtils.mkdir("#{line_source}/output") unless File.directory?("#{line_source}/output") if RUBY_VERSION < "1.9"
             csv_file_name = "#{line_source}/output/#{run_title}-#{Time.now.strftime("%e %b %Y %H:%m-%S%p").parameterize}.csv"
             File.open(csv_file_name, 'w') {|f| f.write(csv_str) }
             say("Output saved at #{csv_file_name}\n", :yellow)
           else
-            say("Error: #{run.errors.inspect}")
+            say("Run not completed yet", :red)
           end
-          
         else
-          say("\nAPI key missing in line.yml file\n")
+          say("Error: #{run.errors.inspect}", :red)
         end
+
       else
         say("\nThe run title must be provided to get the output.", :red)
         say("\te.g. cf output my-run-title\n", :yellow)
       end
     end
-    
+
     desc "version", "Shows the current version of cloudfactory gem"
     def version
       say("Version: #{CF::VERSION}")

data/lib/cf/cli/line.rb

@@ -113,7 +113,26 @@ module Cf # :nodoc: all
     no_tasks {
       # method to call with line title to delete the line if validation fails during the creation of line
       def rollback(line_title)
-        CF::Line.destroy(line_title)
+        deleted_resp = CF::Line.destroy(line_title)
+        if !deleted_resp.error.nil?
+          if deleted_resp.error.message == "Cannot delete line. You have production runs using this line. Pass force option to enforce deletion."
+            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")
+            if delete_forcefully
+              resp = CF::Line.destroy(line_title, :forced => true)
+              if resp.code != 200
+                say("Error: #{resp.error.message}\n", :red)
+              end
+            else
+              say("Line deletion aborted!\n", :cyan)
+            end
+          end
+        end
       end
       
       def display_error(line_title, error_message)
@@ -203,7 +222,8 @@ module Cf # :nodoc: all
           if type == "tournament"
             jury_worker = station_file['station']['jury_worker']
             auto_judge = station_file['station']['auto_judge']
-            station_params = {:line => line, :type => type, :jury_worker => jury_worker, :auto_judge => auto_judge, :input_formats => input_formats_for_station, :batch_size => batch_size}
+            acceptance_ratio = station_file['station']['acceptance_ratio']
+            station_params = {:line => line, :type => type, :jury_worker => jury_worker, :auto_judge => auto_judge, :input_formats => input_formats_for_station, :batch_size => batch_size, :acceptance_ratio => acceptance_ratio}
           else
             station_params = {:line => line, :type => type, :input_formats => input_formats_for_station, :batch_size => batch_size}
           end
@@ -345,10 +365,10 @@ module Cf # :nodoc: all
       end
     }
 
-    desc "line inspect", "list the details of the line"
+    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 inspect
+    def details 
       if options['line'].blank?
         line_source = Dir.pwd
         yaml_source = "#{line_source}/line.yml"

data/lib/cf/cli/line_yaml_validator.rb

@@ -51,6 +51,8 @@ module Cf
                     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
                   end
+                  acceptance_ratio = station['station']['acceptance_ratio']
+                  errors << "Acceptance ratio must lie between 0 and 1 in Block station #{i+1}!" if !acceptance_ratio.nil? && acceptance_ratio > 1 or acceptance_ratio < 0
                 end
                 # Checking Worker
                 worker = station['station']['worker']
@@ -160,7 +162,7 @@ module Cf
                           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 date email number).include?(field_type)
+                            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"

data/lib/cf/cli/templates/sample-line/sample-line.csv

@@ -1,3 +1,3 @@
 email,location,photo
-mjdavidson@gmail.com,Jacksonville, http://www.studio757blog.com/wp-content/uploads/2008/03/copy-of-3617-500x3001.jpg
-johndavid13@yahoo.com,San Diego, http://us.123rf.com/400wm/400/400/dotshock/dotshock1104/dotshock110400439/9404522-casual-young-man-portrait-waiting-for-date-outdoor-in-nature-at-beautiful-sunny-spring-day.jpg
+julia@doe.com,Jacksonville, http://media-robot.s3.amazonaws.com/BionicWoman.gif
+chuck@noris.com,San Diego, http://media-robot.s3.amazonaws.com/man.jpg

data/lib/cf/line.rb

@@ -67,6 +67,7 @@ module CF
           if type == "Tournament"
             @jury_worker = stations.jury_worker
             @auto_judge = stations.auto_judge
+            @acceptance_ratio = stations.acceptance_ratio
             if @batch_size.nil?
               request_tournament = 
               {
@@ -77,14 +78,25 @@ module CF
                 }
               }
             else
-              request_tournament = 
-              {
-                :body => 
+              if @acceptance_ratio.nil?
+                request_tournament = 
                 {
-                  :api_key => CF.api_key,
-                  :station => {:type => type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats, :batch_size => @batch_size}
+                  :body => 
+                  {
+                    :api_key => CF.api_key,
+                    :station => {:type => type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats, :batch_size => @batch_size}
+                  }
                 }
-              }
+              else
+                request_tournament = 
+                {
+                  :body => 
+                  {
+                    :api_key => CF.api_key,
+                    :station => {:type => type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats, :batch_size => @batch_size, :acceptance_ratio => @acceptance_ratio}
+                  }
+                }
+              end
             end
             resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{self.title.downcase}/stations.json",request_tournament)
           else
@@ -290,7 +302,8 @@ module CF
     # ===Usage Example:
     #   CF::Line.public_lines
     def self.public_lines
-      get("/public_lines.json")
+      resp = get("/public_lines.json")
+      resp.lines
     end
 
     # ==Updates a line

data/lib/cf/station.rb

@@ -44,6 +44,7 @@ module CF
       @station_input_formats = options[:input_formats]
       @line_instance = options[:line]
       @batch_size = options[:batch_size]
+      @acceptance_ratio = options[:acceptance_ratio]
       if @batch_size.nil?
         request_general = 
         {
@@ -53,14 +54,25 @@ module CF
             :station => {:type => @type, :input_formats => @station_input_formats}
           }
         }
-        request_tournament = 
-        {
-          :body => 
+        if @acceptance_ratio.nil?
+          request_tournament = 
           {
-            :api_key => CF.api_key,
-            :station => {:type => @type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats}
+            :body => 
+            {
+              :api_key => CF.api_key,
+              :station => {:type => @type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats}
+            }
           }
-        }
+        else
+          request_tournament = 
+          {
+            :body => 
+            {
+              :api_key => CF.api_key,
+              :station => {:type => @type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats, :acceptance_ratio => @acceptance_ratio}
+            }
+          }
+        end
       else
         request_general = 
         {
@@ -70,14 +82,25 @@ module CF
             :station => {:type => @type, :input_formats => @station_input_formats, :batch_size => @batch_size}
           }
         }
-        request_tournament = 
-        {
-          :body => 
+        if @acceptance_ratio.nil?
+          request_tournament = 
           {
-            :api_key => CF.api_key,
-            :station => {:type => @type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats, :batch_size => @batch_size}
+            :body => 
+            {
+              :api_key => CF.api_key,
+              :station => {:type => @type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats, :batch_size => @batch_size}
+            }
           }
-        }
+        else
+          request_tournament = 
+          {
+            :body => 
+            {
+              :api_key => CF.api_key,
+              :station => {:type => @type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats, :batch_size => @batch_size, :acceptance_ratio => @acceptance_ratio}
+            }
+          }
+        end
       end
       if @line_title
         if @type == "Improve"

data/lib/cf/version.rb

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

data/spec/badge_spec.rb

@@ -33,12 +33,12 @@ module CF
           line = CF::Line.create("badge_in_worker", "Digitization") do |l|
             CF::InputFormat.new({:line => l, :name => "image_url", :required => true, :valid_type => "url"})
             CF::Station.create({:line =>l, :type => "work"}) do |s|
-              CF::HumanWorker.new({:station => s, :number => 2, :reward => 20, :skill_badge => badge})
+              CF::HumanWorker.new({:station => s, :number => 1, :reward => 20, :skill_badge => badge})
             end
           end
           line.stations.first.worker.badge = badge_1
           line.stations.first.type.should eql("WorkStation")
-          line.stations.first.worker.number.should eql(2)
+          line.stations.first.worker.number.should eql(1)
           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, "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}}]}}])
@@ -53,11 +53,11 @@ module CF
           line = CF::Line.create("stat_badge_in_worker", "Digitization") do |l|
             CF::InputFormat.new({:line => l, :name => "image_url", :required => true, :valid_type => "url"})
             CF::Station.create({:line =>l, :type => "work"}) do |s|
-              CF::HumanWorker.new({:station => s, :number => 2, :reward => 20, :stat_badge => stat_badge})
+              CF::HumanWorker.new({:station => s, :number => 1, :reward => 20, :stat_badge => stat_badge})
             end
           end
           line.stations.first.type.should eql("WorkStation")
-          line.stations.first.worker.number.should eql(2)
+          line.stations.first.worker.number.should eql(1)
           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
@@ -74,11 +74,11 @@ module CF
           station = CF::Station.new({:type => "work"})
           line.stations station
 
-          worker = CF::HumanWorker.new({:number => 2, :reward => 20, :stat_badge => stat_badge})
+          worker = CF::HumanWorker.new({:number => 1, :reward => 20, :stat_badge => stat_badge})
           line.stations.first.worker = worker
           
           line.stations.first.type.should eql("WorkStation")
-          line.stations.first.worker.number.should eql(2)
+          line.stations.first.worker.number.should eql(1)
           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

data/spec/concept_tagging_robot_spec.rb

@@ -14,6 +14,7 @@ module CF
             end
           end
           run = CF::Run.create(line, "concept_tagging_robot_run", [{"url"=>"www.mosexindex.com"}])
+          # sleep 20 # require delay for final_output's processing
           output = run.final_output
           output.first['concept_tagging_of_url'].should eql(["Canada", "English language"])
           output.first['concept_tagging_relevance_of_url'].should eql([89.5153, 79.0912])
@@ -39,6 +40,7 @@ module CF
           line.stations.first.worker = worker
 
           run = CF::Run.create(line, "concept_tagging_robot_run_1", [{"url"=>"www.mosexindex.com"}])
+          # sleep 20 # require delay for final_output's processing
           output = run.final_output
           output.first['concept_tagging_of_url'].should eql(["Canada", "English language"])
           output.first['concept_tagging_relevance_of_url'].should eql([89.5153, 79.0912])

data/spec/content_scraping_robot_spec.rb

@@ -14,9 +14,10 @@ module CF
             end
           end
           run = CF::Run.create(line, "content_scraping_robot_run", [{"url"=> "http://www.sprout-technology.com"}])
-          
+          # sleep 30
           output = run.final_output
-          output.first['scraped_link_from_document'].should eql([["http://www.cloudfactory.com", "http://www.bizcardarmy.com"]])
+          output.first['scraped_link_from_document'].should eql([""])
+          output.first['scraped_text_from_document'].should eql([""])
 
           line.stations.first.worker.class.should eql(CF::RobotWorker)
           line.stations.first.worker.reward.should eql(0.5)
@@ -40,9 +41,10 @@ module CF
           line.stations.first.worker = worker
 
           run = CF::Run.create(line, "content_scraping_robot_run_1", [{"url"=> "http://www.sprout-technology.com"}])
-          
+          # sleep 30
           output = run.final_output
-          output.first['scraped_link_from_document'].should eql([["http://www.cloudfactory.com", "http://www.bizcardarmy.com"]])
+          output.first['scraped_link_from_document'].should eql([""])
+          output.first['scraped_text_from_document'].should eql([""])
 
           line.stations.first.worker.class.should eql(CF::RobotWorker)
           line.stations.first.worker.reward.should eql(0.5)