cloudfactory 0.6.4 → 0.7

data/lib/cf/cli/badge_yaml_validator.rb

@@ -0,0 +1,18 @@
+module Cf
+  module BadgeYamlValidator
+
+    def validate(yaml_path)
+      errors = []
+      badge = YAML::load(File.read(yaml_path).strip)
+      if badge.class == Hash
+        errors << "Form for the badge is missing" unless badge["form"]
+        errors << "Name of the badge is missing"  unless badge["name"]
+        errors << "Description for the badge is missing" unless badge["description"]
+        errors << "Known answers for the badge must be array of hashes" unless badge["known_answers"].class == Array
+      else
+        errors << "badge mut be hash"
+      end
+      errors
+    end
+  end
+end

data/lib/cf/cli/line.rb

@@ -239,20 +239,14 @@ module Cf # :nodoc: all
           number = worker['num_workers']
           reward = worker['reward']
           worker_type = worker['worker_type']
+
+          ##### Add badge to the station ########
+
           if worker_type == "human"
-            skill_badges = worker['skill_badges']
+            badges = station_file['station']['badges']
             stat_badge = worker['stat_badge']
-            if stat_badge.nil?
-              human_worker = CF::HumanWorker.new({:station => s, :number => number, :reward => reward})
-            else
-              human_worker = CF::HumanWorker.new({:station => s, :number => number, :reward => reward, :stat_badge => stat_badge})
-            end
 
-            if worker['skill_badges'].present?
-              skill_badges.each do |badge|
-                human_worker.badge = badge
-              end
-            end
+            human_worker =  CF::HumanWorker.new({:station => s, :number => number, :reward => reward, :badge => badges, :stat_badge => stat_badge})
 
             say_status "worker", "#{number} Cloud #{pluralize(number, "Worker")} with reward of #{reward} #{pluralize(reward, "cent")}"
             display_error(line_title, "#{human_worker.errors}") if human_worker.errors.present?
@@ -266,6 +260,7 @@ module Cf # :nodoc: all
             display_error(line_title, "Invalid worker type: #{worker_type}")
           end
 
+
           # Creation of Form
           # Creation of TaskForm
           if station_file['station']['task_form'].present?
@@ -298,6 +293,15 @@ module Cf # :nodoc: all
             display_error(line_title, "#{form.errors}") if form.errors.present?
           end
 
+          # print if the badge for the station exist NOTE: addition of the badge is done above.
+          # it is printed here for better UI
+          if badges
+            say "Adding Badges For Station#{index}", :green
+            badges.each do |name|
+              say_status "-", "#{name}"
+            end
+          end
+
           #check the presence of gold standard and create goldstandards for the station
           gold_standards = station_file['station']['gold_standards']
           if gold_standards
@@ -323,29 +327,6 @@ module Cf # :nodoc: all
               end
             end
           end
-
-          #######create badge #########
-          badges = station_file['station']['badges']
-          if badges
-            say "Adding Badges to station", :green
-            badges.each do |s_badge|
-              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 }))
-              say_status "Badge","'#{s_badge["name"] }'"
-              display_error(line_title, "#{badge.errors}") if badge.errors.present?
-            end
-          end
         end
       end
 
@@ -370,17 +351,17 @@ module Cf # :nodoc: all
           end
         end
         if gold_standards.class == Hash#gold_standards["file"]
-           gold_standard = CF::GoldStandard.new(gold_standards.merge!({:line => line}))
-           say_status "GoldStandard from file", "'#{gold_standards[:file]}'"
-           display_error(line_title, "#{gold_standard.errors}") if gold_standard.errors.present?
-        else
-        gold_standards.each do |gold_options|
-          gold_standard = CF::GoldStandard.new(gold_options.merge(:line => line))
-          say_status "GoldStandard", "'#{gold_options["name"]}'"
+          gold_standard = CF::GoldStandard.new(gold_standards.merge!({:line => line}))
+          say_status "GoldStandard from file", "'#{gold_standards[:file]}'"
           display_error(line_title, "#{gold_standard.errors}") if gold_standard.errors.present?
+        else
+          gold_standards.each do |gold_options|
+            gold_standard = CF::GoldStandard.new(gold_options.merge(:line => line))
+            say_status "GoldStandard", "'#{gold_options["name"]}'"
+            display_error(line_title, "#{gold_standard.errors}") if gold_standard.errors.present?
+          end
         end
       end
-      end
 
       say " ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁", :white
       say "Line was successfully created.", :green

data/lib/cf/cli/production.rb

@@ -194,7 +194,7 @@ module Cf # :nodoc: all
     no_tasks do
       def display_success_run(run)
         say("Run created successfully.", :green)
-        say("View your production at:\n\thttp://#{CF.account_name}.#{CF.api_url.split("/")[-2]}/runs/#{CF.account_name}/#{run.title}/workerpool_preview\n", :green)
+        say("View your production at:\n\thttp://#{CF.account_name}.#{CF.api_url.split("/")[-2]}/runs/#{CF.account_name}/#{run.title}\n", :green)
       end
     end
 

data/lib/cf/cli/templates/sample-line/badge.yml.erb

@@ -0,0 +1,38 @@
+
+# name of the badge that you want to create
+name: <%= name %>
+
+# description of the badge
+description: This badge allow to do the tasks for <%= name %>.
+
+# numbers of worker who can take the badge
+max_badge_assignments: 5
+
+# number of retries that the worker get at the time of taking the badge
+retries_allowed: 5
+
+# the value in percentage that the worker must score to pass the test
+pass_percentage: 80
+
+# time assigned for badge test
+assignment_duration: 3600
+
+# checking badge answers that worker has submitted
+check_manually: false
+
+# number of day after which the worker can again take the badge exam
+allow_retake_after: 30
+
+# form for the badge. It should be html format if it is a custom form
+form: form.html
+
+# the hash of question and answers for the badge
+known_answers:
+  - input:
+      image_url: http://www.crystalinks.com/newton.jpg
+    expected_output:
+      gender: Male
+  - input:
+      image_url: http://www.sportosporto.pl/Hobby/Witryny3b_07/Vinci/images/7la.jpg
+    expected_output:
+      gender: Female

data/lib/cf/cli/templates/sample-line/form.html

@@ -64,7 +64,7 @@
     <h2>Instructions:</h2>
     <ul>
       <li><img src="{{image_url}}" /></li>
-      <li>Then enter the url of hottest date found</li>
+      <li>Determine the gender for the given image.</li>
     </ul>
   </div>
 
@@ -72,38 +72,12 @@
     <div id = "field-panel">
       <p>
         <form>
-
           <label>Gender</label><br />
           <select id="gender_option" name="output[gender]">
             <option value="Male">Male</option>
             <option value="Female">Female</option>
           </select>
           <br />
-
-          <label>How rich?</label><br />
-          <select id="rich_option" name="output[rich]">
-            <option value="1">1</option>
-            <option value="2">2</option>
-            <option value="3">3</option>
-          </select>
-          <br />
-
-          <label>How Kind?</label><br />
-          <select id="kind_option" name="output[kind]">
-            <option value="1">1</option>
-            <option value="2">2</option>
-            <option value="3">3</option>
-          </select>
-          <br />
-
-          <label>How Attractive?</label><br />
-          <select id="attractive_option" name="output[attractive]">
-            <option value="1">1</option>
-            <option value="2">2</option>
-            <option value="3">3</option>
-          </select>
-          <br />
-
           <input type="submit" value="submit" />
 
         </form>

data/lib/cf/cli/templates/sample-line/line.yml.erb

@@ -28,8 +28,10 @@ stations:
       # Worker (see http://cloudfactory.com/developers/resources/worker.html)
       worker:
         worker_type: human    # "human" or name of robot (google_translate_robot, etc)
-        num_workers: 2
+        num_workers: 1
         reward: 2
+      badges:
+         - Web Research
       custom_task_form:
         form_title: Clink a link and paste in url
         instruction: Look through search results and find the best date

data/lib/cf/custom_task_form.rb

@@ -59,7 +59,7 @@ module CF
         :body =>
         {
           :api_key => CF.api_key,
-          :form =>  {:title => form_content["form_title"], :instruction => form_content["instruction"], :_type => "CustomTaskForm", :raw_html => form_content["html"]},
+          :form =>  {:title => form_content["title"], :instruction => form_content["instruction"], :_type => "CustomTaskForm", :raw_html => form_content["raw_html"]},
           :station_index => station_index
         }
       }

data/lib/cf/help.txt

@@ -26,37 +26,37 @@ Login
 
 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
+    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
+    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 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
+    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 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
+    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 gold_standards 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
+    cf production help [sub-command]                                               # List all help related to production subcommands
 
 Output:
   Usage:
@@ -64,4 +64,16 @@ Output:
   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
+    cf output help [sub-command]                                                    # List all help related to output subcommands
+
+Badge:
+  Usage:
+    cf badge create <badge_name>                                                    # Takes the badge.yml from badge_name directory and create a badge
+    cf badge delete <badge name>                                                    # Delete the given badge within your account.
+    cf badge generate <badge_name>                                                  # Generate a new badge template.
+    cf badge list                                                                   # List all badges associated within your account. Use 'cf badge list <badge_name>' for single badge.
+    cf badge update <badge_name>                                                    # Takes the badge.yml from badge_name directory and update the badge
+  Description:
+    Commands to manage the badges.
+  More:
+    cf help [COMMAND]                                                               # Describe subcommands or one specific subcommand

data/lib/cf/human_worker.rb

@@ -45,7 +45,7 @@ module CF
     attr_accessor :errors
 
     # Badge setting for "worker" object
-    attr_accessor :badge
+    attr_accessor :badges
 
     # ==Initializes a new "worker" object
     # ==Usage of HumanWorker.new(hash):
@@ -72,34 +72,26 @@ module CF
       @station = options[:station]
       @number  = options[:number].nil? ? 1 : options[:number]
       @reward  = options[:reward]
-      @stat_badge = options[:stat_badge].nil? ? nil : options[:stat_badge]
+      @stat_badge = options[:stat_badge]
+      @badges = options[:badge]
       if @station
-        if options[:stat_badge].nil?
-          request =
-          {
-            :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"},
-              :stat_badge => options[:stat_badge]
-            }
+            :api_key => CF.api_key,
+            :worker => {:number => @number, :reward => @reward, :type => "HumanWorker"},
+            :badge => options[: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']
+        self.badges = resp.parsed_response['badges']
 
         if resp.code != 200
           self.errors = resp.parsed_response['error']['message']
@@ -109,52 +101,8 @@ module CF
       end
     end
 
-    # ==Creation a new "worker" object with Badge
-    # ==Usage Example:
-    # ==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 =>
-    #       {
-    #         :input => {:name => "Lionel Andres Messi", :country => "Argentina"},
-    #         :expected_output =>
-    #         [
-    #           {:birthplace => "Rosario, Santa Fe, Argentina",:match_options => {:tolerance => 10, :ignore_case => true }},
-    #           {:position => "CF",:match_options => {:tolerance => 1 }},
-    #           {:"current-club" => "Barcelona",:match_options => {:tolerance => 1, :ignore_case => false }}
-    #         ]
-    #       }
-    #   }
-    #   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 =
-      {
-        :body =>
-        {
-          :api_key => CF.api_key,
-          :skill_badge => badge
-        }
-      }
-      resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@station.line['title'].downcase}/stations/#{@station.index}/workers/#{self.id}/badge.json",request)
-      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}, :errors => #{self.errors}}"
+      "{:id => => #{self.id}, :number => #{self.number}, :reward => #{self.reward}, :stat_badge => #{self.stat_badge}, :errors => #{self.errors},:badges =>#{self.badges}}"
     end
   end
 end

data/lib/cf/station.rb

@@ -179,32 +179,26 @@ module CF
           number = worker_instance.number
           reward = worker_instance.reward
           stat_badge = worker_instance.stat_badge
-          if stat_badge.nil?
-            request =
-            {
-              :body =>
-              {
-                :api_key => CF.api_key,
-                :worker => {:number => number, :reward => reward, :type => "HumanWorker"}
-              }
-            }
-          else
-            request =
+          badges = worker_instance.badges
+
+          request =
+          {
+            :body =>
             {
-              :body =>
-              {
-                :api_key => CF.api_key,
-                :worker => {:number => number, :reward => reward, :type => "HumanWorker"},
-                :stat_badge => stat_badge
-              }
+              :api_key => CF.api_key,
+              :worker => {:number => number, :reward => reward, :type => "HumanWorker"},
+              :stat_badge => stat_badge,
+              :badge => badges
             }
-          end
+          }
+
           resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{self.line_title.downcase}/stations/#{self.index}/workers.json",request)
           worker = CF::HumanWorker.new({})
           worker.id =  resp.parsed_response['id']
           worker.number =  resp.parsed_response['number']
           worker.reward =  resp.parsed_response['reward']
           worker.stat_badge =  resp.parsed_response['stat_badge']
+          worker.badges =  resp.parsed_response['badges']
           if resp.code != 200
             worker.errors = resp.parsed_response['error']['message']
           end
@@ -374,45 +368,5 @@ module CF
     def gold_standards=(gold_standard) # :nodoc:
       @gold_standards << gold_standard
     end
-
-    #specify the badges for the station
-    # ===Usage Example:
-    # CF::Badge.new({:line => line, :station => s,:name => "Tomb Digitizer", :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}})
-    def badges badge = nil
-      line_title = line["title"] || line.title
-      if badge
-        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 = ""
-            File.open("#{form[:file]}").each_line do |line|
-              raw_html += line
-            end
-            badge.settings[:test_attributes][:form_attributes].merge!({:raw_html => raw_html,:_type =>"CustomTaskForm"})
-          end
-          badge.settings[:test_attributes][:form_attributes].merge!({:_type =>"TaskForm"}) if form[:type] == "TaskForm"
-        end
-        request =
-        {
-          :body =>
-          {
-            :api_key => CF.api_key,
-            :badge => badge.settings
-          }
-        }
-        resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{line_title.downcase}/stations/#{self.index}/badges.json",request)
-        badge = CF::Badge.new()
-        badge.settings.merge!(resp.to_hash)
-        self.errors = resp.parsed_response['error']['message'] if resp.code != 200
-        @badges << badge
-      else
-        @badges
-      end
-    end
-
-    def badges=(badge)
-      @badges << badge
-    end
-
   end
 end