RubyGems - cloudfactory - Versions diffs - 0.1.9 → 0.1.10 - Mend

cloudfactory 0.1.9 → 0.1.10

Files changed (42) hide show

data/cf.gemspec +1 -0
data/features/error_custom_task_form.feature +117 -0
data/features/error_form_field.feature +58 -0
data/features/error_task_form.feature +64 -0
data/features/errors.feature +192 -0
data/features/run.feature +136 -121
data/features/support/cli_steps.rb +44 -0
data/features/support/env.rb +2 -2
data/lib/cf.rb +3 -4
data/lib/cf/account.rb +12 -1
data/lib/cf/cli.rb +2 -2
data/lib/cf/cli/config.rb +2 -2
data/lib/cf/cli/form.rb +5 -5
data/lib/cf/cli/line.rb +40 -16
data/lib/cf/cli/production.rb +50 -18
data/lib/cf/cli/templates/sample-line/form.css +41 -17
data/lib/cf/cli/templates/sample-line/form.html +27 -18
data/lib/cf/cli/templates/sample-line/form.js +12 -3
data/lib/cf/cli/templates/sample-line/line.yml.erb +42 -32
data/lib/cf/client.rb +3 -3
data/lib/cf/custom_task_form.rb +21 -91
data/lib/cf/department.rb +1 -10
data/lib/cf/final_output.rb +2 -16
data/lib/cf/form_field.rb +11 -6
data/lib/cf/human_worker.rb +93 -1
data/lib/cf/input_format.rb +10 -62
data/lib/cf/line.rb +46 -37
data/lib/cf/robot_worker.rb +63 -2
data/lib/cf/run.rb +37 -66
data/lib/cf/station.rb +42 -104
data/lib/cf/task_form.rb +17 -56
data/lib/cf/version.rb +2 -2
data/lib/generators/cf/form/form_generator.rb +3 -3
data/lib/generators/cf/install/install_generator.rb +3 -3
data/spec/custom_task_form_spec.rb +169 -1
data/spec/generators/form_generator_spec.rb +2 -2
data/spec/generators/install_generator_spec.rb +2 -2
data/spec/run_spec.rb +3 -3
data/spec/spec_helper.rb +1 -0
data/spec/station_spec.rb +13 -1
data/spec/task_form_spec.rb +38 -6
metadata +63 -44

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

@@ -1,20 +1,29 @@
-<div id="station_2_instructions" class="station_2 cf_form_instruction">
-  <ul>
-    <li>Go to the <a href="http://www.facebook.com/search.php?type=users">people search in Facebook</a>.</li>
-    <li>Enter the <strong>location</strong> below and hit enter to search</li>
-    <li>Now go through and find the hottest date that is <span id="gender">{{gender}}</span> and looks about <span id="age">{{age}}</span> years old.</li>
-    <li>After you have searched through many and found the best date, paste their Facebook URL into the field below.</li>
-  </ul>
-</div>
+<body>
+<div id="wrapper">
+  <div id="header">
+    Be a Match Maker
+  </div>
+  <div id="instructions">
+    <h2>Instructions:</h2>
+    <ul>
+      <li><a target="_blank" href="http://wink.com/people/l/{{location}}/s/single/g/{{gender}}/a/{{age}}">Click this link.</a></li>
+      <li>Then enter the url of hottest date found</li>
+    </ul>
+  </div>
-<div id="station_2_form" class="station_2 cf_form_content">
-  <div id = "field-panel">
-    <p>
-      <form>
-        <label>Facebook Profile URL of hottest date found</label><br />
-        <input id="fb_url" type="text" name="output[fb_url]" data-valid-type="general" /></br>
-        <input type="submit" value="submit" />
-      </form>
-    </p>
+  <div id="station_2_form">
+    <div id = "field-panel">
+      <p>
+        <form>
+          <label>Enter URL of hottest date found</label><br />
+          <input id="fb_url" type="text" name="output[url]" data-valid-type="general"/>
+          <input type="submit" value="submit" />
+        </form>
+      </p>
+    </div>
   </div>
-</div>
+  <div id="footer">
+    Copyright(c)
+  </div>
+</div>
+</body>

data/lib/cf/cli/templates/sample-line/form.js CHANGED Viewed

@@ -1,7 +1,16 @@
 <script src="http://code.jquery.com/jquery-latest.js"></script>
 <script type="text/javascript">
-    $(document).ready(function() {
-				($('span#gender').text().toLowerCase() == "female") ? "MALE":"FEMALE"
-    });
+     $(document).ready(function() {
+	        var url = $("#instructions a").attr('href');
+	        var splitted_url = url.split("/");
+	        var gender = splitted_url[splitted_url.length - 3];
+	        var new_gender = gender.toLowerCase() == "male" ? "female" : "male";
+	        splitted_url[splitted_url.length - 3] = new_gender;
+	        var age = splitted_url[splitted_url.length - 1];
+	        age = decodeURI(age).split(" ")[0];
+	        splitted_url[splitted_url.length - 1] = age;
+	        var new_url = splitted_url.join("/");
+	        $("#instructions a").attr('href',new_url);
+	    });
 </script>

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

@@ -1,78 +1,87 @@
 # ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁
 # Assembly Line: <%= title.underscore.dasherize %>
 # ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁
-# See docs at http://cloudfactory.com/developers/lines/yaml.html
-# See example lines at http://cloudfactory.com/developers/lines/examples.html
-# Run `cf login` OR manually specify your API key below (See http://cloudfactory.com/developers/account#settings)
+# See docs at http://cloudfactory.com/developers/
+# See example lines at http://cloudfactory.com/developers/lines/
+# Run `cf login` OR manually specify your API key below (See http://cloudfactory.com/developers/resources/account.html)
 # api_key: fill_in_your_api_key #(optional)
 title: <%= title.underscore.dasherize %>
 description: A shiny new assembly line ready for you to customize. Right now it is finding people dates (uncomment and try for fun) but you should just replace everything below accordingly for your line.
-# Department to build line in (See http://cloudfactory.com/developers/lines/yaml.html#departments)
+# Department to build line in (See http://cloudfactory.com/developers/resources/department.html)
 department: Web Research
-# Line Input Formats (see http://cloudfactory.com/developers/lines/yaml.html#line-input-formats)
+# Line Input Formats (see http://cloudfactory.com/developers/resources/input_format.html)
 input_formats:
 #   - name: email
 #     required: true
-#     valid_type: email         # general, url, date, email, ...
+#     valid_type: email         # email, url, number, date, phone
 #   - name: location
 #     required: true
-#     valid_type: general       # general, url, date, email, ...
+#     valid_type: text          # email, url, number, date, phone
 #   - name: photo
 #     required: true
-#     valid_type: url           # general, url, date, email, ...
-#
-# # Stations (see http://cloudfactory.com/developers/lines/yaml.html#stations)
+#     valid_type: url           # email, url, number, date, phone
+# # Stations (see http://cloudfactory.com/developers/resources/station.html)
 stations:
 #   # Sample Station #1: WORKER looks at photo of person seeking a date and determines their gender and approximate age
 #   - station:
 #       station_index: 1
 #       station_type: work      # work, improve, tournament
-#       # Worker (see http://cloudfactory.com/developers/lines/yaml.html#workers)
+#       # Worker (see http://cloudfactory.com/developers/resources/worker.html)
 #       worker:
 #         worker_type: human    # "human" or name of robot (google_translate_robot, etc)
 #         num_workers: 1
-#         reward: 5
-#       # Task Form (see http://cloudfactory.com/developers/lines/yaml.html#task-forms)
+#         reward: 2
+#       # Task Form (see http://cloudfactory.com/developers/resources/task_form.html)
 #       task_form:
 #         form_title: Look at a photo to determine the person's gender and approximate age
 #         instruction: Click the photo link and then enter the person's gender and approximate age in the form below
 #         form_fields:
 #           - label: Gender
-#             field_type: RB
+#             field_type: radio_button    # short_answer, long_answer, radio_button, check_box, select_box
 #             required: true
 #             option_values:
 #               - male
 #               - female
 #               - not sure
 #           - label: Age
-#             field_type: SB
+#             field_type: select_box      # short_answer, long_answer, radio_button, check_box, select_box
 #             required: true
 #             option_values:
-#               - Under 18
-#               - 18 to 30
-#               - 30 to 45
-#               - 45 to 60
-#               - Over 60
+#                - 13 to 18
+#                - 19 to 24
+#                - 25 to 29
+#                - 30 to 34
+#                - 35 to 39
+#                - 40 to 49
+#                - 50 to 59
+#                - 60 and up
+#
 #
 #   # Sample Station #2: TOURNAMENT to find the best local person on facebook that matches the right gender and age
 #   - station:
 #       station_index: 2
 #       station_type: tournament  # work, improve, tournament
+#       input_formats:
+#         station_0:
+#           - name: location
+#       worker:
+#         worker_type: human      # "human" or name of the robot (google_translate_robot, etc)
+#         num_workers: 2
+#         reward: 2
 #       jury_worker:
 #         max_judges: 8
-#         reward: 3
+#         reward: 2
 #       auto_judge:
 #         enabled: true
-#       worker:
-#         worker_type: human      # "human" or name of robot (google_translate_robot, etc)
-#         num_workers: 3
-#         reward: 3
 #       custom_task_form:
-#         form_title: Do a search on Facebook
-#         instruction: Search on Facebook to find the best date in a certain location and age group
+#         form_title: Clink a link and paste in url
+#         instruction: Look through search results and find the best date
 #         html: form.html
 #         css: form.css
 #         js: form.js
@@ -81,11 +90,12 @@ stations:
 #   - station:
 #       station_index: 3
 #       station_type: work        # work, improve, tournament
-#       # Worker (see http://cloudfactory.com/developers/lines/yaml.html#workers)
+#       input_formats:
+#         station_0:
+#           - name: email
+#       # Worker (see http://cloudfactory.com/developers/resources/worker.html)
 #       worker:
 #         worker_type: mailer_robot
 #         settings:
-#           to: {{email}}
-#           template: '<html><body><h1>We have searched high and low to find a sweet date for you. Now the rest is up to you - head to their facebook page and request them as a friend: {{fb_url}}</h1><p>Good luck!!!!</p></body></html>'
-#           template_variables:
-#             fb_url: {{fb_url}}
+#           to: ["{{email}}"]
+#           template: '<html><body><h1>We have searched high and low to find a sweet date for you. Now the rest is up to you - head to their facebook page and request them as a friend: {{url}}</h1><p>Good luck!!!!</p></body></html>'

data/lib/cf/client.rb CHANGED Viewed

@@ -1,7 +1,7 @@
-module CF
-  module Client
+module CF # :nodoc: all
+  module Client # :nodoc: all
-    extend ActiveSupport::Concern
+    extend ActiveSupport::Concern
     module ClassMethods
       def default_params

data/lib/cf/custom_task_form.rb CHANGED Viewed

@@ -20,13 +20,17 @@ module CF
     # station attribute is required for association with custom_from object
     attr_accessor :station
+    # Contains Error message if any
+    attr_accessor :errors
     # ==Initializes a new CustomForm
-    # ==Usage custom_instruction.new(hash):
+    # ===Usage custom_instruction.new(hash):
     #
-    #     attrs = {:title => "Enter text from a business card image",
-    #         :description => "Describe"}
+    #     html = 'html_content'
+    #     css = 'css_content'
+    #     javascript = 'javascript_content'
     #
-    #     instruction = CustomForm.new(attrs)
+    #     instruction = CF::CustomTaskForm.new({:title => "Enter text from a business card image", :instruction => "Describe", :raw_html => html, :raw_css => css, :raw_javascript => javascript})
     def initialize(options={})
       @station     = options[:station]
       @title       = options[:title]
@@ -35,102 +39,28 @@ module CF
       @raw_css = options[:raw_css]
       @raw_javascript = options[:raw_javascript]
       if @station
-        @resp = self.class.post("/lines/#{CF.account_name}/#{@station.line_title.downcase}/stations/#{@station.index}/form.json", :form => {:title => @title, :instruction => @instruction, :_type => "CustomTaskForm", :raw_html => @raw_html, :raw_css => @raw_css, :raw_javascript => @raw_javascript})
-        # custom task form response not well formatted
-        # @id = @resp.from.id
-        custom_form = CF::CustomTaskForm.new({})
-        @resp.to_hash.each_pair do |k,v|
-          custom_form.send("#{k}=",v) if custom_form.respond_to?(k)
+        resp = self.class.post("/lines/#{CF.account_name}/#{@station.line_title.downcase}/stations/#{@station.index}/form.json", :form => {:title => @title, :instruction => @instruction, :_type => "CustomTaskForm", :raw_html => @raw_html, :raw_css => @raw_css, :raw_javascript => @raw_javascript})
+        resp.to_hash.each_pair do |k,v|
+          self.send("#{k}=",v) if self.respond_to?(k)
+        end
+        if resp.code != 200
+          self.errors = resp.error.message
         end
-        custom_form.station = @station
-        @station.form = custom_form
+        @station.form = self
+        return self
       end
     end
     # ==Initializes a new CustomForm within block using Variable
-    # ==Usage of custom_instruction.create(instruction):
-    # ===Creating CustomForm using block variable
-    #     attrs = {:title => "Enter text from a business card image",
-    #         :description => "Describe"}
-    #
-    #     html_content = '<div>.........</div>'
-    #
-    #     css_content = 'body {background:#fbfbfb;}
-    #          #instructions{
-    #           text-align:center;
-    #         }.....'
+    # ===Usage custom_instruction.create(hash):
     #
-    #     javascript_content = '<script>.........</script>'
+    #     html = 'html_content'
+    #     css = 'css_content'
+    #     javascript = 'javascript_content'
     #
-    #     instruction = CustomForm.create(instruction) do |i|
-    #       i.html = html_content
-    #        i.css = css_content
-    #        i.javascript = javascript_content
-    #      end
-    #
-    # ===OR without block variable
-    #     instruction = CustomForm.create(instruction) do
-    #       html html_content
-    #       css css_content
-    #       javascript javascript_content
-    #     end
+    #     instruction = CF::CustomTaskForm.create({:title => "Enter text from a business card image", :instruction => "Describe", :raw_html => html, :raw_css => css, :raw_javascript => javascript})
     def self.create(form)
       instruction = CustomTaskForm.new(form)
-      # if block.arity >= 1
-      #         block.call(instruction)
-      #       else
-      #         instruction.instance_eval &block
-      #       end
-      #       instruction
-    end
-    # ==Usage of instruction.html:
-    #     html_content = '<div>.........</div>'
-    #
-    #     instruction.html = html_content
-    #
-    def html html_content = nil
-      if html_content
-        @html_content = html_content
-      else
-        @html_content
-      end
-    end
-    def html=(html_content) # :nodoc:
-      @html_content = html_content
-    end
-    # ==Usage of instruction.css:
-    #     css_content = 'body {background:#fbfbfb;}
-    #         #instructions{
-    #           text-align:center;
-    #         }.....'
-    #
-    #     instruction.css = css_content
-    def css css_content = nil
-      if css_content
-        @css_content = css_content
-      else
-        @css_content
-      end
-    end
-    def css=(css_content) # :nodoc:
-      @css_content = css_content
-    end
-    # ==Usage of instruction.javascript:
-    #     javascript_content = '<script>.........</script>'
-    #
-    #     instruction.html = javascript_content
-    def javascript javascript_content = nil
-      if javascript_content
-        @javascript_content = javascript_content
-      else
-        @javascript_content
-      end
-    end
-    def javascript=(javascript_content) # :nodoc:
-      @javascript_content = javascript_content
     end
   end
 end

data/lib/cf/department.rb CHANGED Viewed

@@ -1,11 +1,8 @@
 module CF
   class Department
     include Client
-    # Id of the specific Category
-    attr_accessor :department_name
-    # Category name
+    # Department name
     attr_accessor :name
     # ==Returns all Department
@@ -14,11 +11,5 @@ module CF
     def self.all
       response = get("/departments.json")
     end
-    # Returns all lines of a specific Department
-    def self.get_lines_of_department(department_name)
-      @department_name = department_name
-      get("/departments/#{@department_name}.json")
-    end
   end
 end

data/lib/cf/final_output.rb CHANGED Viewed

@@ -1,20 +1,6 @@
-module CF
-  class FinalOutput
+module CF # :nodoc:
+  class FinalOutput # :nodoc:
     include Client
     attr_accessor :final_outputs, :unit_id, :final_output, :output
-    # def self.get_result(run_id)
-    #       resp = get("/runs/#{run_id}/results.json")
-    #
-    #       @final_output =[]
-    #       resp.each do |r|
-    #         result = self.new()
-    #         r.to_hash.each_pair do |k,v|
-    #           result.send("#{k}=",v) if result.respond_to?(k)
-    #         end
-    #         @results << result
-    #       end
-    #       return @results
-    #     end
   end
 end

data/lib/cf/form_field.rb CHANGED Viewed

@@ -3,10 +3,10 @@ module CF
     require 'httparty'
     include Client
-    # Label for "form_field" object, e.g. :label => "First Name"
+    # Label for "form" object, e.g. :label => "First Name"
     attr_accessor :label
-    # field_type for "form_field" object, e.g. :field_type => "SA"
+    # field_type for "form" object, e.g. :field_type => "SA"
     attr_accessor :field_type
     # required boolean either true or false, e.g. :required => "true" & if false then you don't need to mention
@@ -17,13 +17,18 @@ module CF
     # station id attribute required for API Calls
     attr_accessor :station_id
-    attr_accessor :form_field_params, :errors
+    # Parameters for form fields
+    attr_accessor :form_field_params
+    # Contains error message
+    attr_accessor :errors
-    # ==Initializes a new "form_field" object
-    # ==Usage of form_field.new(hash):
+    # ==Initializes a new "form" object
+    # ===Usage of form.new(hash):
     #   line = CF::Line.create("Digitize", "Survey") do |l|
     #     CF::Station.create({:line => l, :type => "work"}) do |s|
-    #       CF::StandardInstruction.create({:station => s, :title => "Enter text from a business card image", :description => "Describe"}) do |i|
+    #       CF::TaskForm.create({:station => s, :title => "Enter text from a business card image", :instruction => "Describe"}) do |i|
     #         CF::FormField.new({:form => i, :label => "First Name", :field_type => "SA", :required => "true"})
     #       end
     #     end

data/lib/cf/human_worker.rb CHANGED Viewed

@@ -4,7 +4,69 @@ module CF
     require 'httparty'
     extend ActiveSupport::Concern
-    attr_accessor :id, :number, :reward, :station, :stat_badge, :skill_badges, :errors, :badge
+    # 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 =
+    #   {
+    #       :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 }}
+    #         ]
+    #       }
+    #   }
+    #
+    # worker = CF::HumanWorker.new({:number => 2, :reward => 20, :skill_badge => badge_settings})
+    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
+    # ==Usage of HumanWorker.new(hash):
+    #
+    # ==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
+    #   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 = []
@@ -51,6 +113,36 @@ 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 =
       {