cloudfactory 0.0.13

data/lib/cf/cli/line.rb

@@ -0,0 +1,237 @@
+# encoding: utf-8
+require 'thor/group'
+
+module Cf
+  class Newline < Thor::Group
+    include Thor::Actions
+    include Cf::Config
+    source_root File.expand_path('../templates/', __FILE__)
+    argument :title, :type => :string, :desc => "The line title"
+    argument :yaml_destination, :type => :string, :required => true
+
+    def generate_line_template
+      arr = yaml_destination.split("/")
+      arr.pop
+      line_destination = arr.join("/")
+      template("sample-line/line.yml.erb", yaml_destination)
+      copy_file("sample-line/form.css",    "#{line_destination}/station_2/form.css")
+      copy_file("sample-line/form.html",   "#{line_destination}/station_2/form.html")
+      copy_file("sample-line/form.js",     "#{line_destination}/station_2/form.js")
+      copy_file("sample-line/sample-line.csv",        "#{line_destination}/input/#{title.underscore.dasherize}.csv")
+      FileUtils.mkdir("#{line_destination}/output")
+    end
+  end
+end
+
+
+module Cf
+  class Line < Thor
+    include Cf::Config
+    desc "line generate LINE-TITLE", "generates a line template at <line-title>/line.yml"
+    method_option :force, :type => :boolean, :default => false, :aliases => "-f", :desc => "force to overwrite the files if the line already exists, default is false"
+    # method_option :with_custom_form, :type => :boolean, :default => false, :aliases => "-wcf", :desc => "generate the template with custom task form and the sample files, default is true"
+
+    def generate(title=nil)
+      if title.present?
+        line_destination = "#{title.underscore.dasherize}"
+        yaml_destination = "#{line_destination}/line.yml"
+        FileUtils.rm_rf(line_destination, :verbose => true) if options.force? && File.exist?(line_destination)
+        if File.exist?(line_destination)
+          say "Skipping #{yaml_destination} because it already exists.\nUse the -f flag to force it to overwrite or check and delete it manually.", :red
+        else
+          say "Generating #{yaml_destination}", :green
+          Cf::Newline.start([title, yaml_destination])
+          say "A new line named #{line_destination} generated.", :green
+          say "Modify the #{yaml_destination} file and you can create this line with: cf line create", :yellow
+        end
+      else
+        say "Title for the line is required.", :red
+      end
+    end
+
+    desc "line delete", "delete the line at http://cloudfactory.com"
+    def delete
+      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) and return
+      end
+
+      set_target_uri(false)
+      if set_api_key(yaml_source)
+        CF.account_name = CF::Account.info.name
+        line_dump = YAML::load(File.open(yaml_source))
+        line_title = line_dump['title']
+
+        CF::Line.destroy(line_title)
+        say("The line #{line_title} was deleted successfully!", :yellow)
+      else
+        say("The api_key is missing in the line.yml file", :red)
+      end
+    end
+
+    desc "line create", "takes the yaml file at line.yml and creates a new line at http://cloudfactory.com"
+    def create
+      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
+
+        line_dump = YAML::load(File.open(yaml_source))
+        line_title = line_dump['title'].parameterize
+        line_description = line_dump['description']
+        line_department = line_dump['department']
+        line = CF::Line.new(line_title, line_department, :description => line_description)
+
+        unless line.errors.blank?
+          say("#{line.errors.message}", :red) and return
+        end
+
+        say "Creating new assembly line: #{line.title}", :green
+        say "Adding InputFormats", :green
+
+        # Creation of InputFormat from yaml file
+        input_formats = line_dump['input_formats']
+        input_formats.each do |input_format|
+          attrs = {
+            :name => input_format['name'],
+            :required => input_format['required'],
+            :valid_type => input_format['valid_type']
+          }
+          input_format_for_line = CF::InputFormat.new(attrs)
+          line.input_formats input_format_for_line
+          say_status "input", "#{attrs[:name]}"
+        end
+
+        # Creation of Station
+        stations = line_dump['stations']
+        stations.each do |station_file|
+          type = station_file['station']['station_type']
+          index = station_file['station']['station_index']
+          input_formats_for_station = station_file['station']['input_formats']
+          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}
+          else
+            station_params = {:line => line, :type => type, :input_formats => input_formats_for_station}
+          end
+          station = CF::Station.create(station_params) do |s|
+            #say "New Station has been created of type => #{s.type}", :green
+            say "Adding Station #{index}: #{s.type}", :green
+            # For Worker
+            worker = station_file['station']['worker']
+            number = worker['num_workers']
+            reward = worker['reward']
+            worker_type = worker['worker_type']
+            if worker_type == "human"
+              skill_badges = worker['skill_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
+              #say "New Worker has been created of type => #{worker_type}, Number => #{number} and Reward => #{reward}", :green
+              say_status "worker", "#{number} Cloud #{pluralize(number, "Worker")} with reward of #{reward} #{pluralize(reward, "cent")}"
+            else
+              settings = worker['settings']
+              robot_worker = CF::RobotWorker.create({:station => s, :type => worker_type, :settings => settings})
+
+              #say "New Worker has been created of type => #{worker_type} and settings => #{worker['settings']}", :green
+              say_status "robot", "Robot worker: #{worker_type}"
+            end
+
+            # Creation of Form
+            # Creation of TaskForm
+            if station_file['station']['task_form'].present?
+              title = station_file['station']['task_form']['form_title']
+              instruction = station_file['station']['task_form']['instruction']
+              form = CF::TaskForm.create({:station => s, :title => title, :instruction => instruction}) do |f|
+                # Creation of FormFields
+                station_file['station']['task_form']['form_fields'].each do |form_field|
+                  form_field_params = form_field.merge(:form => f)
+                  field = CF::FormField.new(form_field_params.symbolize_keys)
+                end
+                say_status "form", "TaskForm '#{f.title}'"
+              end
+
+            elsif station_file['station']['custom_task_form'].present?
+              # Creation of CustomTaskForm
+              title = station_file['station']['custom_task_form']['form_title']
+              instruction = station_file['station']['custom_task_form']['instruction']
+
+              html_file = station_file['station']['custom_task_form']['html']
+              html = File.read("#{line_source}/station_#{station_file['station']['station_index']}/#{html_file}")
+              css_file = station_file['station']['custom_task_form']['css']
+              css = File.read("#{line_source}/station_#{station_file['station']['station_index']}/#{css_file}")
+              js_file = station_file['station']['custom_task_form']['js']
+              js = File.read("#{line_source}/station_#{station_file['station']['station_index']}/#{js_file}")
+              form = CF::CustomTaskForm.create({:station => s, :title => title, :instruction => instruction, :raw_html => html, :raw_css => css, :raw_javascript => js})
+
+              say_status "form", "CustomTaskForm '#{form.title}'"
+            end
+
+          end
+        end
+        say " ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁", :white
+        say "Line was successfully created.", :green
+        say "View your line at http://#{CF.account_name}.#{CF.api_url.split("/")[-2]}/lines/#{CF.account_name}/#{line.title}", :yellow
+        say "\nNow you can do production runs with: cf production start <your_run_title>", :green
+        say "Note: Make sure your-run-title.csv file is in the input directory.", :green
+      else
+        say "The api_key is missing in the line.yml file", :red
+      end
+    end
+
+    desc "line list", "List your lines"
+    def list
+      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) and return
+      end
+
+      set_target_uri(false)
+      if set_api_key(yaml_source)
+        CF.account_name = CF::Account.info.name
+        lines = CF::Line.all
+        lines.sort! {|a, b| a[:name] <=> b[:name] }
+        say "\n"
+        say("No Lines", :yellow) if lines.blank?
+
+        lines_table = table do |t|
+          t.headings = ["Line Title", 'URL']
+          lines.each do |line|
+            t << [line.title, "http://#{CF.account_name}.cloudfactory.com/lines/#{CF.account_name}/#{line.title.parameterize}"]
+          end
+        end
+        say(lines_table)
+      else
+        say("The api_key is missing in the line.yml file", :red)
+      end
+    end
+
+    # helper function like in Rails
+    def pluralize(number, text)
+      return text.pluralize if number != 1
+      text
+    end
+
+  end
+end

data/lib/cf/cli/production.rb

@@ -0,0 +1,62 @@
+require 'thor/group'
+
+module Cf
+  class Production < Thor
+    include Cf::Config
+
+    desc "production start <run-title>", "creates a production run with input data file at input/<run-title>.csv"
+    method_option :input_data, :type => :string, :aliases => "-i", :desc => "the name of the input data file"
+    method_option :live, :type => :boolean, :default => false, :aliases => "-l", :desc => "force the host to set to live mturk environment"
+    def start(title=nil)
+      
+      if title.nil?
+        say("The run title is required to start the production.", :red) and return
+      end
+      
+      run_title         = title.parameterize
+      line_destination  = Dir.pwd
+      yaml_source       = "#{line_destination}/line.yml"
+      
+      unless File.exist?("#{yaml_source}")
+        say("The current directory is not a valid line directory.", :red) and return
+      end
+
+      line_yaml_dump = YAML::load(File.open(yaml_source))
+      line_title = line_yaml_dump['title'].parameterize
+
+      if !options[:input_data].nil? 
+        input_data = "input/#{options[:input_data]}"
+      else
+        input_data = "input/#{run_title}.csv"
+      end
+      
+      unless File.exist?(input_data)
+        say("The input data csv file named #{input_data} is missing.", :red) and return
+      end
+
+      set_target_uri(options[:live])
+      # before starting the run creation process, we need to make sure whether the line exists or not
+      # if not, then we got to first create the line and then do the production run
+      # else we just simply do the production run
+      if set_api_key(yaml_source)
+        CF.account_name = CF::Account.info.name
+        line = CF::Line.info(line_title)
+        input_data_path = "#{Dir.pwd}/#{input_data}"
+        if line.error.blank?
+          say "Creating a production run with title #{run_title}", :green
+          run = CF::Run.create(line, run_title, input_data_path)
+          say "A run with title #{run.title} created successfully."
+        else
+          # first create line
+          say "Creating the line: #{line_title}", :green
+          Cf::Line.new.create
+          # Now create a production run with the title run_title
+          run = CF::Run.create(CF::Line.info(line_title), run_title, input_data_path)
+          say "A run with title #{run.title} using the line #{line_title} was successfully created."
+        end
+      else
+        say "The api_key is missing in the line.yml file", :red
+      end
+    end
+  end
+end

data/lib/cf/cli/templates/css_file.css.erb

@@ -0,0 +1,22 @@
+body {background:red;}
+
+#instructions{
+	text-align:center;
+}
+
+#image-field-wrapper{
+	min-width:1050px;
+	overflow:hidden;
+}
+
+#field-panel{
+	float:left;
+	padding: 10px 10px 0 10px;
+	min-width:512px;
+	overflow:hidden;
+}
+
+.input-field{
+	width:150px;
+	margin:4px;
+}

data/lib/cf/cli/templates/form_preview.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Form Preview</title>
+    <link href="form.css" media="screen, projection" rel="stylesheet" type="text/css" />
+    <script src="form.js" type="text/javascript"></script>
+  </head>
+  <!--[if lt IE 7 ]> <body class="ie6"> <![endif]-->
+  <!--[if IE 7 ]>    <body class="ie7"> <![endif]-->
+  <!--[if IE 8 ]>    <body class="ie8"> <![endif]-->
+  <!--[if IE 9 ]>    <body class="ie9"> <![endif]-->
+  <!--[if (gt IE 9)|!(IE)]><!--> <body> <!--<![endif]-->
+  <div id="container">
+    <%= form_content %>
+  </div>
+</body>
+</html>

data/lib/cf/cli/templates/html_file.html.erb

@@ -0,0 +1,21 @@
+<div id="station_<%= station %>_instructions" class="station_<%= station %> cf_form_instruction">
+  <ul>
+    <li>Sample bullet list of instruction</li>
+    <li>Sample bullet list of instruction</li>
+    <li>Sample bullet list of instruction</li>
+  </ul>
+</div>
+
+<div id="station_<%= station %>_form" class="station_<%= station %> cf_form_content">
+<%- labels.split(",").each do |label| -%>
+<label>{{<%= label %>}}</label>
+<%- end unless labels.nil? -%>
+
+<div id = "field-panel">
+<%-
+  fields.each_pair do |field_name, field_type|
+-%>
+<p><label><%= field_name %></label><input id="<%= field_name.downcase %>" type="text" name="output[<%= field_name.downcase %>]" data-valid-type="<%= field_type.downcase %>" /></p>
+<%- end unless fields.blank? -%>
+</div>
+</div>

data/lib/cf/cli/templates/js_file.js.erb

@@ -0,0 +1,18 @@
+<script src="http://code.jquery.com/jquery-latest.js"></script>
+<script type="text/javascript" src="http://www.bizcardarmy.com/javascripts/jquery.autocomplete-min.js"></script>
+<script type="text/javascript">
+$(document).ready(function(){
+	autocomplete_fields = ["first_name", "middle_name", "last_name", "company", "job_title", "city", "state", "zip"];
+
+	$.each(autocomplete_fields, function(index, value){
+		var inputField = "input." + value;
+		$(inputField).autocomplete({
+			serviceUrl: "http://www.bizcardarmy.com/cards/return_data_for_autocompletion.json",
+			maxHeight: 400,
+			width: 300,
+			zIndex: 9999,
+			params: { field: value }
+		});
+	});
+});
+</script>

data/lib/cf/cli/templates/line.tt

@@ -0,0 +1,55 @@
+#  ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁
+# See docs at http://developers.cloudfactory.com/lines/yaml.html
+# See examples at http://developers.cloudfactory.com/lines/examples.html
+#
+# Fill in your API key below (see http://cloudfactory.com/account#settings)
+#  ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁
+
+# Line settings (see http://cloudfactory.com/lines/yaml.html#line-settings)
+api_key: fill_in_your_api_key
+title: <%= title.underscore.dasherize %>
+description: Describe the line what its purpose is and what it does. You got the idea, right?
+department: Survey
+
+
+# Line Input Formats (see http://cloudfactory.com/lines/yaml.html#line-input-formats)
+# input_formats:
+#   - name: company
+#     required: true
+#     valid_type: general  # general, url, date, email, ...
+
+# Stations (see http://cloudfactory.com/lines/yaml.html#stations)
+stations:
+  - station:
+      station_index: 1
+      station_type: work
+      # Worker (see http://cloudfactory.com/lines/yaml.html#workers)
+      worker:
+        worker_type: human   # human, impr
+        num_workers: 2
+        reward: 5
+      # Task Form (see http://cloudfactory.com/lines/yaml.html#task-forms)
+      task_form:
+        form_title: Enter text from a business card image for TASKFORM
+        instruction: Read the business card image and the fill the fields for TASKFORM
+        form_fields:
+          - label: CEO Name
+            field_type: short_answer
+            required: true
+          - label: CEO Email
+            field_type: email
+            required: true
+  - station:
+      station_index: 2
+      station_type: work
+      worker:
+        worker_type: human
+        num_workers: 1
+        reward: 3
+      # Custom Task Form (see http://cloudfactory.com/lines/yaml.html#custom-task-form)
+      custom_task_form:
+        form_title: Enter text from a business card image for CUSTOMTASKFORM
+        instruction: Read the business card image and the fill the fields for CUSTOMTASKFORM
+        html: form.html
+        css: form.css
+        js: form.js

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

@@ -0,0 +1,27 @@
+body {background: grey;}
+
+#instructions{
+  text-align:center;
+}
+
+#image-field-wrapper{
+  min-width:1050px;
+  overflow:hidden;
+}
+
+#field-panel{
+  float:left;
+  padding: 10px 10px 0 10px;
+  min-width:512px;
+  overflow:hidden;
+}
+
+.input-field{
+  width:150px;
+  margin:4px;
+}
+
+.appended_para {
+  font-size: 1.5em;
+  font-family: Verdana, Arial;
+}