cloudfactory 0.0.13

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

@@ -0,0 +1,26 @@
+<div id="station_2_instructions" class="station_2 cf_form_instruction">
+  <ul>
+    <!-- <li>Sample bullet list of instruction</li> -->
+    <li>Find study information of the following CEO</li>
+  </ul>
+</div>
+
+<div id="station_2_form" class="station_2 cf_form_content">
+  <label>{{ceo-name}}</label>
+  <label>{{company}}</label>
+
+  <div id = "field-panel">
+    <p>
+      <label>Qualification</label>
+      <select id="qualification" name="output[qualification]">
+        <option>Masters</option>
+        <option>Bachelors</option>
+        <option>Other</option>
+      </select>
+    </p>
+    <p>
+      <label>University</label>
+      <input id="university" type="text" name="output[university]" data-valid-type="general" />
+    </p>
+  </div>
+</div>

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

@@ -0,0 +1,7 @@
+<script src="http://code.jquery.com/jquery-latest.js"></script>
+
+<script type="text/javascript">
+    $(document).ready(function(){
+        $('<p class="appended_para">I paragraph, appended here via jquery</p>').appendTo("#field-panel");
+    });
+</script>

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

@@ -0,0 +1,67 @@
+# ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁
+# Assembly Line: <%= title.underscore.dasherize %>
+# ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁ ☁
+# 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://developers.cloudfactory.com/account#settings)
+api_key: fill_in_your_api_key
+title: <%= title.underscore.dasherize %>
+description: A sample line generated via CLI to use both standard and custom form.
+department: Data Processing  # Digitization, Web Research, etc
+
+# Line Input Formats (see http://developers.cloudfactory.com/lines/yaml.html#line-input-formats)
+# input_formats:
+#   - name: company
+#     required: true
+#     valid_type: general  # general, url, date, email, ...
+
+# Stations (see http://developers.cloudfactory.com/lines/yaml.html#stations)
+# stations:
+#   # Sample Station #1: Human Worker
+#   - station:
+#       station_index: 1
+#       station_type: work   # work, improve, tournament
+#       # Worker (see http://developers.cloudfactory.com/lines/yaml.html#workers)
+#       worker:
+#         worker_type: human   # "human" or name of robot (google_translate_robot, etc)
+#         num_workers: 2
+#         reward: 5
+#       # Task Form (see http://developers.cloudfactory.com/lines/yaml.html#task-forms)
+#       task_form:
+#         form_title: Research to find CEO of a company.
+#         instruction: Enter name and email of the CEO for the company below
+#         form_fields:
+#           - label: CEO Name
+#             field_type: short_answer
+#             required: true
+#           - label: CEO Email
+#             field_type: email
+#             required: true
+
+#   # Sample Station #2: Robot Worker
+#   - station:
+#       station_index: 2
+#       station_type: work   # work, improve, tournament
+#       # Worker (see http://developers.cloudfactory.com/lines/yaml.html#workers)
+#       worker:
+#         worker_type: google_translate_robot   # "human" or name of robot (content_scraper_robot, etc)
+#       # Robot Settings (see http://developers.cloudfactory.com/robots/)
+#       settings:
+#         data: ["{sentence}"]
+#         from: en
+#         to:   fr
+#
+#   # Sample Station #3: Tournament
+#   - station:
+#       station_index: 3
+#       station_type: tournament
+#       worker:
+#         worker_type: human
+#         num_workers: 2
+#         reward: 3
+#       custom_task_form:
+#         form_title: Get study background
+#         instruction: Find qualification info of given CEO
+#         html: form.html
+#         css: form.css
+#         js: form.js

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

@@ -0,0 +1,3 @@
+company,website
+Apple,http://apple.com
+Google,http://google.com

data/lib/cf/client.rb

@@ -0,0 +1,56 @@
+module CF
+  module Client
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def default_params
+        {:api_key => CF.api_key}
+      end
+
+      def get(*args)
+        handle_response RestClient.get("#{CF.api_url}#{CF.api_version}#{args.first}", :params => default_params, :accept => 'json'){ |response, request, result| response }
+      end
+
+      def post(*args)
+        handle_response  RestClient.post("#{CF.api_url}#{CF.api_version}#{args.first}", args.last.merge!(default_params), :accept => 'json'){ |response, request, result| response }
+      end
+
+      def put(*args)
+        handle_response  RestClient.put("#{CF.api_url}#{CF.api_version}#{args.first}", args.last.merge!(default_params), :accept => 'json'){ |response, request, result| response }
+      end
+
+      def delete(*args)
+        handle_response  RestClient.delete("#{CF.api_url}#{CF.api_version}#{args.first}?api_key=#{CF.api_key}", :accept => 'json'){ |response, request, result| response }
+      end
+
+      def handle_response(response)
+        # FIX: raise the exception along with the response error message
+        # Ref: http://www.simonecarletti.com/blog/2009/12/inside-ruby-on-rails-rescuable-and-rescue_from/
+        # case response.code
+        # when 401; raise Unauthorized.new
+        # when 403; raise RateLimitExceeded.new
+        # when 404; raise ::CF::NotFound.new(response)
+        # when 400...500; raise ClientError.new
+        # when 500...600; raise ServerError.new(response.code)
+        # else; response
+        # end
+        unless response.length == 2
+          parsed_response = JSON.load(response)
+          if parsed_response.is_a?(Array)
+            parsed_response.map{|item| Hashie::Mash.new(item)}
+          else
+            parsed_resp = parsed_response.merge("code" => response.code)
+            new_response = parsed_resp.inject({ }) do |x, (k,v)|
+              x[k.sub(/\A_/, '')] = v
+              x
+            end
+            Hashie::Mash.new(new_response)
+          end
+        else
+          response
+        end
+      end
+    end
+  end
+end

data/lib/cf/custom_task_form.rb

@@ -0,0 +1,136 @@
+module CF
+  class CustomTaskForm
+    include Client
+    
+    # Title of "custom_instruction" object, e.g. :title => "title_name of custom_instruction"
+    attr_accessor :title
+    
+    # Description of "custom_instruction" object, e.g. :description => "description for title of custom_instruction"
+    attr_accessor :instruction
+    
+    # raw_html is an attribute to store the custom html contents
+    attr_accessor :raw_html
+    
+    # raw_css is an attribute to store the custom css contents 
+    attr_accessor :raw_css
+    
+    # raw_javascript is an attribute to store the custom javascript contents
+    attr_accessor :raw_javascript
+    
+    # station attribute is required for association with custom_from object
+    attr_accessor :station
+    
+    # ==Initializes a new CustomForm
+    # ==Usage custom_instruction.new(hash):
+    #
+    #     attrs = {:title => "Enter text from a business card image",
+    #         :description => "Describe"}
+    #
+    #     instruction = CustomForm.new(attrs)
+    def initialize(options={})
+      @station     = options[:station]
+      @title       = options[:title]
+      @instruction = options[:instruction]
+      @raw_html = options[:raw_html]
+      @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)
+        end
+        custom_form.station = @station
+        @station.form = custom_form
+      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;
+    #         }.....'
+    #
+    #     javascript_content = '<script>.........</script>'
+    #
+    #     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
+    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

@@ -0,0 +1,24 @@
+module CF
+  class Department
+    include Client
+
+    # Id of the specific Category
+    attr_accessor :department_name
+    
+    # Category name 
+    attr_accessor :name
+    
+    # ==Returns all Department
+    # ===Usage example
+    #   categories = CF::Department.all
+    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

@@ -0,0 +1,20 @@
+module CF
+  class FinalOutput
+    include Client
+    attr_accessor :meta_data, :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

@@ -0,0 +1,62 @@
+module CF
+  class FormField
+    require 'httparty'
+    include Client
+
+    # Label for "form_field" object, e.g. :label => "First Name"
+    attr_accessor :label
+
+    # field_type for "form_field" 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  
+    attr_accessor :required
+
+    # ID of form field
+    attr_accessor :id
+
+    # station id attribute required for API Calls
+    attr_accessor :station_id
+    attr_accessor :form_field_params, :errors
+
+    # ==Initializes a new "form_field" object
+    # ==Usage of form_field.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::FormField.new({:form => i, :label => "First Name", :field_type => "SA", :required => "true"})
+    #       end
+    #     end
+    #   end
+    def initialize(options={})
+      @form  = options[:form]
+      @label        = options[:label]
+      @field_type   = options[:field_type]
+      @required     = options[:required]
+      
+      if !@form.nil?
+        options.delete(:form)
+        party_param = 
+        {
+          :body => 
+          {
+            :api_key => CF.api_key,
+            :form_field => options
+          }
+        }
+        resp =  HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@form.station.line['title'].downcase}/stations/#{@form.station.index}/form_fields.json",party_param)
+        resp.parsed_response.each_pair do |k,v|
+          self.send("#{k}=",v) if self.respond_to?(k)
+        end
+        if resp.code != 200
+          self.errors = resp.parsed_response['error']['message']
+        end
+        self.form_field_params = options
+        @form.station.form.form_fields = self
+        return self
+      else
+        @form_field_params = options
+      end
+    end
+  end
+end

data/lib/cf/human_worker.rb

@@ -0,0 +1,67 @@
+module CF
+  class HumanWorker
+    include Client
+    require 'httparty'
+    extend ActiveSupport::Concern
+    
+    attr_accessor :id, :number, :reward, :station, :stat_badge, :skill_badges, :errors, :badge
+    
+    def initialize(options={})
+      @skill_badges = []
+      @station = options[:station]
+      @number  = options[:number].nil? ? 1 : options[:number]
+      @reward  = options[:reward]
+      @badge = options[:skill_badge].nil? ? nil : options[:skill_badge]
+      @stat_badge = options[:stat_badge].nil? ? nil : options[:stat_badge]
+      if @station
+        if options[:skill_badge].nil? && options[:stat_badge].nil?
+          request = 
+          {
+            :body => 
+            {
+              :api_key => CF.api_key,
+              :worker => {:number => @number, :reward => @reward, :type => "HumanWorker"}
+            }
+          }
+        else
+          request = 
+          {
+            :body => 
+            {
+              :api_key => CF.api_key,
+              :worker => {:number => @number, :reward => @reward, :type => "HumanWorker"},
+              :skill_badge => @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'] 
+        @skill_badges << resp.parsed_response['skill_badges']
+        
+        if resp.code != 200
+          self.errors = resp.parsed_response['error']['message']
+        end
+        self.station = options[:station]
+        self.station.worker = self
+      end
+    end
+    
+    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.skill_badges << resp.parsed_response['skill_badges']
+    end
+  end
+end