cloudfactory 0.0.13

data/lib/cf/station.rb

@@ -0,0 +1,340 @@
+module CF
+  class Station
+    require 'httparty'
+    include Client
+
+    # type of the station, e.g. station = Station.new(line, {:type => "Work"})
+    attr_accessor :type
+
+    # line attribute is parent attribute for station & is required for making Api call
+    attr_accessor :line_title
+
+    # ID of the station
+    attr_accessor :id, :extra, :except, :index, :line, :station_input_formats, :jury_worker, :auto_judge, :errors
+
+    # ==Initializes a new station
+    # ===Usage Example
+    #   line = CF::Line.new("Digitize", "Survey")
+    #   station = CF::Station.new({:line => line, :type => "Work"})
+    def initialize(options={})
+      @input_formats =[]
+      @line_title = options[:line].nil? ? nil : options[:line].title
+      @type = options[:type].nil? ? nil : options[:type].camelize
+      @jury_worker = options[:jury_worker]
+      @auto_judge = options[:auto_judge]
+      @station_input_formats = options[:input_formats]
+      @line_instance = options[:line]
+      request_general = 
+      {
+        :body => 
+        {
+          :api_key => CF.api_key,
+          :station => {:type => @type, :input_formats => @station_input_formats}
+        }
+      }
+      request_tournament = 
+      {
+        :body => 
+        {
+          :api_key => CF.api_key,
+          :station => {:type => @type, :jury_worker => @jury_worker, :auto_judge => @auto_judge, :input_formats => @station_input_formats}
+        }
+      }
+      if @line_title
+        if @type == "Improve"
+          line = options[:line]
+          if line.stations.size < 1
+            raise ImproveStationNotAllowed.new("You cannot add Improve Station as a first station of a line")
+          else
+            resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@line_instance.title.downcase}/stations.json",request_general)
+          end
+        elsif @type == "Tournament"
+          resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@line_instance.title.downcase}/stations.json",request_tournament)
+        else
+          resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@line_instance.title.downcase}/stations.json",request_general)
+        end
+        resp.to_hash.each_pair do |k,v|
+          self.send("#{k}=",v) if self.respond_to?(k)
+        end
+        @line_instance.stations = self
+        if resp.response.code != "200"
+          self.errors = resp.parsed_response['error']['message']
+        end
+      end
+    end
+
+    # ==Initializes a new station within block
+    # ===Usage Example
+    # ===Creating station using block variable
+    #   line = CF::Line.create("Digitize Card","Digitization") do |l|
+    #     CF::InputFormat.new({:line => l, :label => "Company", :field_type => "text_data", :value => "Google", :required => true, :validation_format => "general"})
+    #     CF::InputFormat.new({:line => l, :label => "Website", :field_type => "text_data", :value => "www.google.com", :required => true, :validation_format => "url"})
+    #     CF::Station.create({:line => l, :type => "work") do |s|
+    #       CF::HumanWorker.new({:station => s, :number => 1, :reward => 20)
+    #       CF::Form.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"})
+    #         CF::FormField.new({:form => i, :label => "Middle Name", :field_type => "SA"})
+    #         CF::FormField.new({:form => i, :label => "Last Name", :field_type => "SA", :required => "true"})
+    #       end
+    #     end
+    #   end
+    #
+    # ===OR creating without variable within block
+    #   line = CF::Line.create("Digitize Card","Digitization") do
+    #     CF::InputFormat.new({:line => self, :label => "Company", :field_type => "text_data", :value => "Google", :required => true, :validation_format => "general"})
+    #     CF::InputFormat.new({:line => self, :label => "Website", :field_type => "text_data", :value => "www.google.com", :required => true, :validation_format => "url"})
+    #     CF::Station.create({:line => self, :type => "work") do
+    #       CF::HumanWorker.new({:station => self, :number => 1, :reward => 20)
+    #       CF::Form.create({:station => self, :title => "Enter text from a business card image", :description => "Describe"}) do
+    #         CF::FormField.new({:form => self, :label => "First Name", :field_type => "SA", :required => "true"})
+    #         CF::FormField.new({:form => self, :label => "Middle Name", :field_type => "SA"})
+    #         CF::FormField.new({:form => self, :label => "Last Name", :field_type => "SA", :required => "true"})
+    #       end
+    #     end
+    #   end
+    def self.create(options, &block)
+      station = Station.new(options)
+      if block.arity >= 1
+        block.call(station)
+      else
+        station.instance_eval &block
+      end
+      station
+    end
+
+    # ==Creates new form for station object
+    # ===Usage of worker method for "station" object
+    #   line = CF::Line.new("line name", "Survey")
+    #   station = CF::Station.new({:type => "work"})
+    #   line.stations station
+    #   human_worker = CF::HumanWorker.new({:number => 1, :reawrd => 20})
+    #   line.stations.first.worker human_worker
+    def worker worker_instance = nil
+      if worker_instance
+        @worker_instance = worker_instance
+      else
+        @worker_instance
+      end
+    end
+
+    def worker=(worker_instance) # :nodoc:
+      worker_type = worker_instance.class.to_s.split("::").last
+      if worker_type == "HumanWorker"
+        if worker_instance.station
+          @worker_instance = worker_instance
+        else
+          number = worker_instance.number
+          reward = worker_instance.reward
+          badge = worker_instance.badge
+          stat_badge = worker_instance.stat_badge
+          if badge.nil? && 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 => stat_badge
+              }
+            }
+          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.skill_badges << resp.parsed_response['skill_badges']
+          if resp.code != 200
+            worker.errors = resp.parsed_response['error']['message']
+          end
+          @worker_instance = worker
+        end
+
+      elsif worker_type == "RobotWorker"
+        if worker_instance.station
+          @worker_instance = worker_instance
+        else
+          @settings = worker_instance.settings
+          @type = worker_instance.type
+          request = @settings.merge(:type => @type)
+          resp = CF::RobotWorker.post("/lines/#{CF.account_name}/#{self.line_title.downcase}/stations/#{self.index}/workers.json", :worker => request)
+          worker = CF::RobotWorker.new({})
+          worker.settings = @settings
+          worker.type = @type
+          worker.number = resp.number
+          worker.reward = resp.reward
+          if resp.code != 200
+            worker.errors = resp.error.message
+          end
+          @worker_instance = worker
+        end
+      end
+    end
+
+    # ==Creates new form for station object
+    # ===Usage of Instruction method for "station" object
+    #   line = CF::Line.new("line name", "Survey")
+    #   station = CF::Station.new({:type => "work"})
+    #   line.stations station
+    #   standard_form = CF::Form.new({:title => "title", :description => "description"})
+    #   line.stations.first.form form
+    def form form_instance = nil
+      if form_instance
+        @form_instance = form_instance
+      else
+        @form_instance
+      end
+    end
+
+    def form=(form_instance) # :nodoc:
+      if form_instance.class == Hash
+        form_type = form_instance['_type']
+        @form = eval(form_type.camelize).new({})
+        form_instance.to_hash.each_pair do |k,v|
+          @form.send("#{k}=",v) if @form.respond_to?(k)
+        end
+      else
+        @form = form_instance
+      end
+
+      if @form.station
+        @form_instance = @form
+      else
+        @title = @form.title
+        @instruction = @form.instruction
+        type = @form.class.to_s.split("::").last
+        form = @form.class.new({})
+        if type == "CustomTaskForm"
+          @html = @form.raw_html
+          @css = @form.raw_css
+          @javascript = @form.raw_javascript
+          @resp = CF::CustomTaskForm.post("/lines/#{CF.account_name}/#{self.line_title.downcase}/stations/#{self.index}/form.json", :form => {:title => @title, :instruction => @instruction, :_type => "CustomTaskForm", :raw_html => @html, :raw_css => @css, :raw_javascript => @javascript})
+        else
+          @resp = CF::TaskForm.post("/lines/#{CF.account_name}/#{self.line_title.downcase}/stations/#{self.index}/form.json", :form => {:title => @title, :instruction => @instruction, :_type => type}) 
+        end
+        @resp.to_hash.each_pair do |k,v|
+          form.send("#{k}=",v) if form.respond_to?(k)
+        end
+        form.station = self
+        @form_instance = form
+      end
+    end
+
+    # ==Usage of line.input_formats(input_format)
+    #   line = CF::Line.new("line name", "Survey")
+    #   station = CF::Station.new({:type => "work"})
+    #   line.stations station
+    #   input_format = CF::InputFormat.new({:line => l, :label => "Website", :field_type => "text_data", :value => "www.google.com", :required => true, :validation_format => "url"})
+    #   line.stations.first.input_formats input_format
+    # * returns
+    # line.stationss.first.input_formats as an array of input_formats
+    def input_formats input_formats_value = nil
+      if input_formats_value
+        name = input_formats_value.name
+        required = input_formats_value.required
+        valid_type = input_formats_value.valid_type
+        resp = CF::InputFormat.post("/lines/#{CF.account_name}/#{self.line_title.downcase}/input_formats.json", :input_format => {:name => name, :required => required, :valid_type => valid_type})
+        input_format = CF::InputFormat.new()
+        resp.input_format.to_hash.each_pair do |k,v|
+          input_format.send("#{k}=",v) if input_format.respond_to?(k)
+        end
+        @input_formats << input_format
+      else
+        @input_formats.first
+      end
+    end
+    def input_formats=(input_formats_value) # :nodoc:
+      @input_formats << input_formats_value
+    end
+    # ==Updates Standard Instruction of a station
+    # ===Usage example
+    #   line = CF::Line.create("Digitize Card","Digitization") do |l|
+    #     CF::Station.create({:line => l, :type => "work") do |s|
+    #       CF::HumanWorker.new({:station => s, :number => 1, :reward => 20)
+    #     end
+    #   end
+    #   line.stations[0].update_form({:title => "Enter phone number from a business card image", :description => "Call"})
+    def update_form(options={})
+      @title       = options[:title]
+      @description = options[:description]
+      self.class.put("/stations/#{self.id}/form.json", :form => {:title => @title, :description => @description, :type => "Form"})
+    end
+
+    # ==Returns a particular station of a line
+    # ===Usage example for get_station() method
+    #   line = CF::Line.create("Digitize Card", "4dc8ad6572f8be0600000001")
+    #   station = CF::Station.new({:line => line, :type => "Work"})
+    #   line.stations station
+    #
+    #   got_station = line.stations[0].get
+    # returns the station object
+    def get
+      resp = self.class.get("/lines/#{CF.account_name}/#{self.line_title.downcase}/stations/#{self.index}.json")
+      return resp
+    end
+
+    # ==Returns information of form
+    # ===Usage example
+    #   line = CF::Line.create("Digitize Card","Digitization") do |l|
+    #     CF::InputFormat.new({:line => l, :label => "Company", :field_type => "text_data", :value => "Google", :required => true, :validation_format => "general"})
+    #     CF::InputFormat.new({:line => l, :label => "Website", :field_type => "text_data", :value => "www.google.com", :required => true, :validation_format => "url"})
+    #     CF::Station.create({:line => l, :type => "work") do |s|
+    #       CF::HumanWorker.new({:station => s, :number => 1, :reward => 20)
+    #       CF::Form.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"})
+    #         CF::FormField.new({:form => i, :label => "Middle Name", :field_type => "SA"})
+    #         CF::FormField.new({:form => i, :label => "Last Name", :field_type => "SA", :required => "true"})
+    #       end
+    #     end
+    #   end
+    #
+    #   @got_form = line.stations[0].get_form
+    def get_form
+      self.class.get("/lines/#{CF.account_name}/#{self.line_title.downcase}/stations/#{self.index}/form.json")
+    end
+
+    # ==Returns all the stations associated with a particular line
+    # ===Usage example for station.all method is
+    #   line = CF::Line.create("Digitize Card","Digitization") do |l|
+    #     CF::InputFormat.new({:line => l, :label => "Company", :field_type => "text_data", :value => "Google", :required => true, :validation_format => "general"})
+    #     CF::InputFormat.new({:line => l, :label => "Website", :field_type => "text_data", :value => "www.google.com", :required => true, :validation_format => "url"})
+    #     CF::Station.create({:line => l, :type => "work") do |s|
+    #       CF::HumanWorker.new({:station => s, :number => 1, :reward => 20)
+    #       CF::Form.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"})
+    #         CF::FormField.new({:form => i, :label => "Middle Name", :field_type => "SA"})
+    #         CF::FormField.new({:form => i, :label => "Last Name", :field_type => "SA", :required => "true"})
+    #       end
+    #     end
+    #   end
+    #
+    #   CF::Station.all(line)
+    # returns all stations
+    def self.all(line)
+      get("/lines/#{CF.account_name}/#{line.title.downcase}/stations.json")
+    end
+
+    # ==Deletes a station
+    # * We need to pass line object with which desired station associated with as an argument to delete a station
+    # ===Usage example for delete method
+    #   line = CF::Line.new("Digitize Card", "4dc8ad6572f8be0600000001")
+    #   station = CF::Station.new({:line =. line, :type => "Work"})
+    #   line.stations station
+    #
+    #   station.delete
+    def delete
+      self.class.delete("/lines/#{CF.account_name}/#{self.line_title.downcase}/stations/#{self.index}.json")
+    end
+  end
+end

data/lib/cf/task_form.rb

@@ -0,0 +1,147 @@
+module CF
+  class TaskForm
+    require 'httparty'
+    include Client
+    
+    # title of the standard_instruction
+    attr_accessor :title
+    
+    # instruction about the instruction
+    attr_accessor :instruction
+    
+    # form_fields for the Form
+    attr_accessor :form_fields
+    
+    # station attributes required to store station information
+    attr_accessor :station
+    
+    # ID of Standard Instruction
+    attr_accessor :id
+
+    # ==Initializes a new Form
+    # ==Usage of standard_instruction.new
+    #   attrs = {:title => "Enter text from a business card image",
+    #       :instruction => "Describe"}
+    #
+    #   instruction = CF::Form.new(attrs)
+    def initialize(options={})
+      @form_fields =[]
+      @station     = options[:station]
+      @title       = options[:title]
+      @instruction = options[:instruction]
+      if !@station.nil?
+        resp = self.class.post("/lines/#{CF.account_name}/#{@station.line['title'].downcase}/stations/#{@station.index}/form.json", :form => {:title => @title, :instruction => @instruction, :_type => "TaskForm"})
+        resp.to_hash.each_pair do |k,v|
+          self.send("#{k}=",v) if self.respond_to?(k)
+        end
+        @station.form = self
+      end
+    end
+    
+    # ==Initializes a new Form within block using Variable
+    # ==Usage of "standard_instruction.create(hash) do |block|"
+    # ===Creating Form using block variable
+    #   line = CF::Line.create("Digitize Card","Digitization") do |l|
+    #     CF::InputHeader.new({:line => l, :label => "Company", :field_type => "text_data", :value => "Google", :required => true, :validation_format => "general"})
+    #     CF::InputHeader.new({:line => l, :label => "Website", :field_type => "text_data", :value => "www.google.com", :required => true, :validation_format => "url"})
+    #     CF::Station.create({:line => l, :type => "work") do |s|
+    #       CF::HumanWorker.new({:station => s, :number => 1, :reward => 20)
+    #       CF::Form.create(:station => s, :title => "Enter text from a business card image", :instruction => "Describe"}) do |i|
+    #         CF::FormField.new({:instruction => i, :label => "First Name", :field_type => "SA", :required => "true"})
+    #         CF::FormField.new({:instruction => i, :label => "Middle Name", :field_type => "SA"})
+    #         CF::FormField.new({:instruction => i, :label => "Last Name", :field_type => "SA", :required => "true"})            
+    #       end
+    #     end
+    #   end
+    #
+    # ===OR without block variable
+    #   line = CF::Line.create("Digitize Card","Digitization") do 
+    #     CF::InputHeader.new({:line => self, :label => "Company", :field_type => "text_data", :value => "Google", :required => true, :validation_format => "general"})
+    #     CF::InputHeader.new({:line => self, :label => "Website", :field_type => "text_data", :value => "www.google.com", :required => true, :validation_format => "url"})
+    #     CF::Station.create({:line => self, :type => "work") do
+    #       CF::HumanWorker.new({:station => self, :number => 1, :reward => 20)
+    #       CF::Form.create(:station => self, :title => "Enter text from a business card image", :instruction => "Describe"}) do
+    #         CF::FormField.new({:instruction => self, :label => "First Name", :field_type => "SA", :required => "true"})
+    #         CF::FormField.new({:instruction => self, :label => "Middle Name", :field_type => "SA"})
+    #         CF::FormField.new({:instruction => self, :label => "Last Name", :field_type => "SA", :required => "true"})            
+    #       end
+    #     end
+    #   end
+    #
+    def self.create(options, &block)
+      form = TaskForm.new(options)
+      if block.arity >= 1
+        block.call(form)
+      else
+        form.instance_eval &block
+      end
+      form
+    end
+    
+    # ==appending different form_fields 
+    # ===Syntax for FormField method is form_fields << form_field_values
+    # ==Usage of form_fields method
+    #   line = CF::Line.create("Digitize Card","Digitization") do |l|
+    #     CF::InputHeader.new({:line => l, :label => "Company", :field_type => "text_data", :value => "Google", :required => true, :validation_format => "general"})
+    #     CF::InputHeader.new({:line => l, :label => "Website", :field_type => "text_data", :value => "www.google.com", :required => true, :validation_format => "url"})
+    #     CF::Station.create({:line => l, :type => "work") do |s|
+    #       CF::HumanWorker.new({:station => s, :number => 1, :reward => 20)
+    #       CF::Form.create(:station => s, :title => "Enter text from a business card image", :instruction => "Describe"}) do |i|
+    #         CF::FormField.new({:instruction => i, :label => "First Name", :field_type => "SA", :required => "true"})
+    #         CF::FormField.new({:instruction => i, :label => "Middle Name", :field_type => "SA"})
+    #         CF::FormField.new({:instruction => i, :label => "Last Name", :field_type => "SA", :required => "true"})            
+    #       end
+    #     end
+    #   end
+    #
+    def form_fields form_fields = nil
+      if form_fields
+        form_field_params = form_fields.form_field_params
+        party_param = 
+        {
+          :body => 
+          {
+            :api_key => CF.api_key,
+            :form_field => form_field_params
+          }
+        }
+        resp =  HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{self.station.line_title.downcase}/stations/#{self.station.index}/form_fields.json",party_param)
+        form_field = CF::FormField.new({})
+        resp.parsed_response.to_hash.each_pair do |k,v|
+          form_field.send("#{k}=",v) if form_field.respond_to?(k)
+        end
+        if resp.code != 200
+          form_field.errors = resp.parsed_response['error']['message']
+        end
+        form_field.form_field_params = form_field_params
+        @form_fields << form_field
+      else
+        @form_fields
+      end
+    end
+    def form_fields=(form_fields) # :nodoc:
+      @form_fields << form_fields
+    end
+    # ==Deletes Standard Instruction of a station
+    # ==Usage example
+    #   line = CF::Line.create("Digitize Card","Digitization") do |l|
+    #     CF::InputHeader.new({:line => l, :label => "Company", :field_type => "text_data", :value => "Google", :required => true, :validation_format => "general"})
+    #     CF::InputHeader.new({:line => l, :label => "Website", :field_type => "text_data", :value => "www.google.com", :required => true, :validation_format => "url"})
+    #     CF::Station.create({:line => l, :type => "work") do |s|
+    #       CF::HumanWorker.new({:station => s, :number => 1, :reward => 20)
+    #       CF::Form.create(:station => s, :title => "Enter text from a business card image", :instruction => "Describe"}) do |i|
+    #         CF::FormField.new({:instruction => i, :label => "First Name", :field_type => "SA", :required => "true"})
+    #         CF::FormField.new({:instruction => i, :label => "Middle Name", :field_type => "SA"})
+    #         CF::FormField.new({:instruction => i, :label => "Last Name", :field_type => "SA", :required => "true"})            
+    #       end
+    #     end
+    #   end
+    #   station = line.stations[0]
+    #
+    #   CF::Form.delete_instruction(station)
+    # deletes standard_instruction of a station
+    def self.delete_instruction(station)
+      delete("/lines/#{CF.account_name}/#{station.line_title.downcase}/stations/#{station.index}/form.json")
+    end
+  end
+end