cloudfactory 0.1.9 → 0.1.10

data/lib/cf/input_format.rb

@@ -14,18 +14,19 @@ module CF
     # ID of an input_format 
     attr_accessor :id
     
-    # ID of Line with which input_format is associated
+    # Title of Line with which input_format is associated
     attr_accessor :line_title, :errors
     
     # ==Initializes a new input_format
-    # * Syntax for creating new input_format: <b>InputFormat.new(</b> Hash <b>)</b>
     # ===Usage Example:
     #   line = CF::Line.create("Digitize", "Survey")
     #
-    #   attrs = {:line => line,
+    #   attrs = 
+    #   {
     #     :name => "image_url",
     #     :required => true,
-    #     :valid_type => "url"} 
+    #     :valid_type => "url"
+    #   } 
     #   
     #   input_format = CF::InputFormat.new(attrs) 
     #   line.input_formats input_format
@@ -51,14 +52,17 @@ module CF
     end
     
     # ==Returns all the input headers of a specific line
+    # ===Usage Example:
     #   line = CF::Line.new("Digitize Card","Survey")
     #
-    #   attrs_1 = {:line => line,
+    #   attrs_1 = 
+    #   {
     #     :name => "image_url",
     #     :required => true, 
     #     :valid_type => "url"
     #   }
-    #   attrs_2 = {:line => line,
+    #   attrs_2 = 
+    #   {
     #     :name => "text_url", 
     #     :required => true, 
     #     :valid_type => "url"
@@ -74,61 +78,5 @@ module CF
     def self.all(line)
       get("/lines/#{CF.account_name}/#{line.title.downcase}/input_formats.json")
     end
-    
-    # ==Returns a particular input header of a specific line
-    # ===Usage example
-    #   line = CF::Line.new("Digitize Card","Survey")
-    #   attrs = {:line => line,
-    #     :name => "image_url_type",
-    #     :required => true, 
-    #     :valid_type => "url"
-    #   }
-    #      
-    #   input_format = CF::InputFormat.new(attrs)
-    #   line.input_formats input_format
-    #   input_format = line.input_formats[0]
-    #   
-    #   got_input_format = input_format.get
-    def get
-      self.class.get("/lines/#{line_id}/input_formats/#{id}.json")
-    end
-    
-    # ==Updates input header
-    # ===Usage example
-    #   line = CF::Line.new("Digitize Card","Survey")
-    #   attrs = {:line => line,
-    #     :name => "image_url_type", 
-    #     :required => true, 
-    #     :valid_type => "url"
-    #   }
-    #   
-    #   input_format = CF::InputFormat.new(attrs)
-    #   line.input_formats input_format
-    #   input_format = line.input_formats[0]
-    #
-    #   updated_input_format = input_format.update({:name => "jackpot", :field_type => "lottery"})
-    def update(options={})
-      @name              = options[:name]
-      @required           = options[:required]
-      @valid_type  = options[:valid_type]
-      self.class.put("/lines/#{line_id}/input_formats/#{id}.json", :input_format => {:name => @name, :required => @required, :valid_type => @valid_type})
-    end
-    
-    #   line = CF::Line.new("Digitize Card","Survey")
-    #   attrs = {:line => line,
-    #     :name => "image_url_type", 
-    #     :required => true, 
-    #     :valid_type => "url"
-    #   }
-    #   
-    #   input_format = CF::InputFormat.new(attrs)
-    #   line.input_formats input_format
-    #
-    #   input_format = line.input_formats[0]
-    #   input_format.delete
-    # deletes input header
-    def delete
-      self.class.delete("/lines/#{line_id}/input_formats/#{id}.json")
-    end
   end
 end

data/lib/cf/line.rb

@@ -6,12 +6,12 @@ module CF
     # Title of the Line
     attr_accessor :title
 
-    # Category Name is required for the category which is categorized according to ID, e.g. "4dc8ad6572f8be0600000001"
+    # Department Name for Line
     attr_accessor :department_name
 
     # Public is a boolean attribute which when set to true becomes public & vice-versa
     #
-    # Public attribute is optional
+    # Public attribute is optional, by default it's true
     attr_accessor :public
 
     # Description attribute describes about the line
@@ -19,22 +19,19 @@ module CF
     # Description attribute is optional
     attr_accessor :description
 
-    # id attribute is for the line_id & is required to be stored for making Api calls
-    attr_accessor :id
-
     # stations contained within line object
     attr_accessor :stations
 
     # input_formats contained within line object
     attr_accessor :input_formats
+    
+    # Contains Error Messages
     attr_accessor :errors
-    #attr_accessor :input_format_instance
-    #attr_accessor :station_instance
 
     # ==Initializes a new line
     # ==Usage of line.new("line_name")
     #
-    #     line = Line.new("Digit", "Survey")
+    #     line = Line.new("line_name", "Survey")
     def initialize(title, department_name, options={})
       @input_formats =[]
       @stations =[]
@@ -48,8 +45,9 @@ module CF
       end
     end
 
-    # ==Usage of line.stations << station
-    #   line = CF::Line.new("line name")
+    # ==Adds station in a line
+    # ===Usage Example:
+    #   line = CF::Line.new("line_name", "Department_name")
     #   station = CF::Station.new({:type => "Work"})
     #   line.stations station
     #
@@ -101,30 +99,23 @@ module CF
       end
     end
 
-    def << stations #:nodoc:
-      type = stations.type
-      @stations << stations
-      resp = CF::Station.post("/lines/#{self.id}/stations.json", :station => {:type => type})
-    end
-
-
     def stations=(stations) # :nodoc:
       @stations << stations
-      #resp = CF::Station.post("/lines/#{id}/stations.json", :station => {:type => stations.type})
-      #@station_id = resp._id
     end
 
     # ==Initializes a new line
-    # ==Usage of line.create("line_name") do |block|
+    # ===Usage Example:
+    #
     # ===creating Line within block using variable
-    #   Line.create("line_name") do |line|
-    #     CF::InputFormat.new({:line => line, :label => "image_url", :field_type => "text_data", :value => "http://s3.amazon.com/bizcardarmy/medium/1.jpg", :required => true, :validation_format => "url"})
+    #   Line.create("line_name", "Department_name") do |line|
+    #     CF::InputFormat.new({:line => line, :label => "image_url", :required => true, :valid_type => "url"})
     #     CF::Station.new({:line => line, :type => "Work"})
     #   end
     #
-    # ===OR creating without variable
-    #   CF::Line.create("line_name") do
-    #     CF::InputFormat.new({:line => self, :label => "image_url", :field_type => "text_data", :value => "http://s3.amazon.com/bizcardarmy/medium/1.jpg", :required => true, :validation_format => "url"})
+    # ==OR
+    # ===creating without variable
+    #   CF::Line.create("line_name", "Department_name") do
+    #     CF::InputFormat.new({:line => self, :label => "image_url", :required => true, :valid_type => "url"})
     #     CF::Station.new({:line => self, :type => "Work"})
     #   end
     def self.create(title, department_name, options={}, &block)
@@ -139,10 +130,11 @@ module CF
       line
     end
 
-    # ==Usage of line.input_formats(input_format)
+    # ==Adds input format in a line
+    # ===Usage Example:
     #   line = Line.new("line name", "Survey")
     #
-    #   input_format = CF::InputFormat.new({:label => "image_url", :field_type => "text_data", :value => "http://s3.amazon.com/bizcardarmy/medium/1.jpg", :required => true, :validation_format => "url"})
+    #   input_format = CF::InputFormat.new({:label => "image_url", :required => true, :valid_type => "url"})
     #   line.input_formats input_format
     # * returns
     # line.input_formats as an array of input_formats
@@ -163,14 +155,17 @@ module CF
       else
         @input_formats
       end
+      
     end
     def input_formats=(input_formats_value) # :nodoc:
       @input_formats << input_formats_value
     end
 
     # ==Returns the content of a line by making an Api call
-    # ===Syntax for get_line method is
+    # ===Usage Example:
     #   CF::Line.info(line)
+    # ==OR
+    #   CF::Line.info("line_title")
     def self.info(line)
       if line.class == CF::Line
         resp = get("/lines/#{CF.account_name}/#{line.title.downcase}.json")
@@ -180,11 +175,18 @@ module CF
     end
 
     # ==Finds a line
-    # ===Syntax for find method is
-    #   CF::Line.find(line.id)
-    def self.find(line_id)
-      get("/lines/#{line_id}.json")
+    # ===Usage Example:
+    #   CF::Line.find(line)
+    # ==OR
+    #   CF::Line.find("line_title")
+    def self.find(line)
+      if line.class == CF::Line
+        resp = get("/lines/#{CF.account_name}/#{line.title.downcase}.json")
+      else
+        resp = get("/lines/#{CF.account_name}/#{line.downcase}.json")
+      end
     end
+    
     # ==Returns all the lines of an account
     # ===Syntax for all method is
     #   CF::Line.all
@@ -192,11 +194,14 @@ module CF
       get("/lines/#{CF.account_name}.json")
     end
     
+    # ==Returns all the stations of a line
+    # ===Usage Example:
+    #   CF::Line.get_stations
     def get_stations
       CF::Station.get("/lines/#{ACCOUNT_NAME}/#{self.title.downcase}/stations.json")
     end
-    # ==Return all the lines whose public value is set true
-    # ===Syntax for public_lines method is
+    # ==Return all the public lines
+    # ===Usage Example:
     #   CF::Line.public_lines
     def self.public_lines
       get("/public_lines.json")
@@ -207,7 +212,7 @@ module CF
     #   line = CF::Line.new("Digitize Card", "Survey")
     #   line.update({:title => "New Title"})
     # * This changes the title of the "line" object from "Digitize Card" to "New Title"
-    def update(options={})
+    def update(options={}) # :nodoc:
       old_title = self.title
       @title = options[:title]
       @department_name = options[:department_name]
@@ -217,13 +222,17 @@ module CF
     end
 
     # ==Deletes a line
-    # ===Syantax for delete method
+    # ===Usage Example:
     #   line = CF::Line.new("Digitize Card", "Survey")
-    #   line.delete
+    #   line.destroy
     def destroy
       self.class.delete("/lines/#{CF.account_name}/#{self.title.downcase}.json")
     end
     
+    # ==Deletes a line by passing it's title
+    # ===Usage Example:
+    #   line = CF::Line.new("line_title", "Survey")
+    #   CF::Line.destroy("line_title")
     def self.destroy(title)
       delete("/lines/#{CF.account_name}/#{title.downcase}.json")
     end

data/lib/cf/robot_worker.rb

@@ -3,9 +3,46 @@ module CF
     require 'httparty'
     include Client
 
-    # type of the station, e.g. station = Station.new(line, {:type => "Work"})
-    attr_accessor :settings, :type, :errors, :station, :number, :reward
+    # settings for robot worker of the station, e.g. robot_worker = CF::RobotWorker.new({:type => "sentiment_robot", :settings => {:document => ["{url}"], :sanitize => true}})
+    attr_accessor :settings
+    
+    # Type of robot worker
+    attr_accessor :type
+    
+    # Contains Error message if any 
+    attr_accessor :errors
+    
+    # Station attribute with which robot worker will be associated
+    attr_accessor :station
+    
+    attr_accessor :number # :nodoc:
+    
+    # Reward for the Robot Worker; Every Robot Worker have their fixed Reward by default
+    attr_accessor :reward
 
+    # ==Initialize new Robot Worker
+    # ===Usage Example:
+    #
+    # ===In Block DSL way
+    #   line = CF::Line.create("sentiment_robot","Digitization") do |l|
+    #     CF::InputFormat.new({:line => l, :name => "url", :valid_type => "url", :required => "true"})
+    #     CF::Station.create({:line => l, :type => "work"}) do |s|
+    #       CF::RobotWorker.new({:station => s, :settings => {:document => "{url}", :sanitize => true}, :type => "sentiment_robot"})
+    #     end
+    #   end
+    #
+    # ==OR
+    #
+    # ===In Plain Ruby way 
+    #   line = CF::Line.new("sentiment_robot_1","Digitization")
+    #   input_format = CF::InputFormat.new({:name => "url", :required => true, :valid_type => "url"})
+    #   line.input_formats input_format
+    # 
+    #   station = CF::Station.new({:type => "work"})
+    #   line.stations station
+    # 
+    #   worker =  CF::RobotWorker.new({:settings => {:document => "{url}", :sanitize => true}, :type => "sentiment_robot"})
+    #   line.stations.first.worker = worker
     def initialize(options={})
       @type = options[:type].nil? ? nil : options[:type].camelize
       @settings = options[:settings]
@@ -24,6 +61,30 @@ module CF
       end
     end
     
+    
+    # ==Create a new Robot Worker
+    # ===Usage Example:
+    #
+    # ===In Block DSL way
+    #   line = CF::Line.create("sentiment_robot","Digitization") do |l|
+    #     CF::InputFormat.new({:line => l, :name => "url", :valid_type => "url", :required => "true"})
+    #     CF::Station.create({:line => l, :type => "work"}) do |s|
+    #       CF::RobotWorker.create({:station => s, :settings => {:document => "{url}", :sanitize => true}, :type => "sentiment_robot"})
+    #     end
+    #   end
+    #
+    # ==OR
+    #
+    # ===In Plain Ruby way 
+    #   line = CF::Line.new("sentiment_robot_1","Digitization")
+    #   input_format = CF::InputFormat.new({:name => "url", :required => true, :valid_type => "url"})
+    #   line.input_formats input_format
+    # 
+    #   station = CF::Station.new({:type => "work"})
+    #   line.stations station
+    # 
+    #   worker =  CF::RobotWorker.create({:settings => {:document => "{url}", :sanitize => true}, :type => "sentiment_robot"})
+    #   line.stations.first.worker = worker   
     def self.create(options)
       RobotWorker.new(options)
     end

data/lib/cf/run.rb

@@ -3,34 +3,29 @@ module CF
     require 'httparty'
     include Client
 
-    # title of the "run" object
+    # Title of the "run" object
     attr_accessor :title
 
-    # file attributes to upload
-    attr_accessor :file, :input
+    # File attribute to upload for Production Run
+    attr_accessor :file
+    
+    # Input to be passed for Production Run
+    attr_accessor :input
 
-    # line attribute with which run is associated
+    # Line attribute with which run is associated
     attr_accessor :line
-
-    attr_accessor :id, :errors
+    
+    # Contains Error Message if any
+    attr_accessor :errors
 
     # ==Initializes a new Run
-    # ==Usage Example:
+    # ===Usage Example:
     #
-    #   line = CF::Line.create("Digitize Card","Digitization") do |l|
-    #     CF::InputHeader.new({:label => "Company", :field_type => "text_data", :value => "Google", :required => true, :validation_format => "general"})
-    #     CF::InputHeader.new({: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::StandardInstruction.create(:station => s, :title => "Enter text from a business card image", :description => "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
+    #   run = CF::Run.new("line_title", "run name", file_path)
     #
-    #   run = CF::Run.new(line, "run name", File.expand_path("../../fixtures/input_data/test.csv", __FILE__))
+    # ==OR
+    # You can pass line object instead of passing line title:
+    #   run = CF::Run.new(line_object, "run name", file_path)
     def initialize(line, title, input)
       if line.class == CF::Line || Hashie::Mash
         @line = line
@@ -67,44 +62,20 @@ module CF
     end
 
     # ==Creates a new Run
-    # ==Usage Example:
+    # ===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::StandardInstruction.create(:station => s, :title => "Enter text from a business card image", :description => "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
+    #   run = CF::Run.new("line_title", "run name", file_path)
     #
-    #   run = CF::Run.create(line, "run name", File.expand_path("../../fixtures/input_data/test.csv", __FILE__))
+    # ==OR
+    # You can pass line object instead passing line title:
+    #   run = CF::Run.new(line_object, "run name", file_path)
     def self.create(line, title, file)
       Run.new(line, title, file)
     end
 
-    def get # :nodoc:
-      self.class.get("/lines/#{@line.id}/runs/#{@id}.json")
-    end
-
-    def self.get_final_output(run_id)
-      resp = get("/runs/#{run_id}/final_outputs.json")
-
-      @final_output =[]
-      resp.each do |r|
-        result = FinalOutput.new()
-        r.to_hash.each_pair do |k,v|
-          result.send("#{k}=",v) if result.respond_to?(k)
-        end
-        @final_output << result
-      end
-      return @final_output
-    end
-
+    # ==Returns Final Output of production Run
+    # ===Usage Example:
+    #   run_object.final_output
     def final_output
       resp = self.class.get("/runs/#{CF.account_name}/#{self.title.downcase}/output.json")
       @final_output =[]
@@ -121,25 +92,18 @@ module CF
       return @final_output
     end
 
+    # ==Returns Final Output of production Run
+    # ===Usage Example:
+    #   CF::Run.final_output("run_title")
     def self.final_output(title)
       resp = get("/runs/#{CF.account_name}/#{title.downcase}/output.json")
       return resp['output']
-      # debugger
-      # @final_output =[]
-      # resp['output'].each do |r|
-      #   result = FinalOutput.new()
-      #   r.to_hash.each_pair do |k,v|
-      #     result.send("#{k}=",v) if result.respond_to?(k)
-      #   end
-      #   # if result.final_output == nil
-      #   #   result.final_output = resp.output
-      #   # end
-      #   @final_output << result
-      # end
-      # debugger
-      # return @final_output
     end
     
+    # ==Returns Output of production Run for any specific Station and for given Run Title
+    # ===Usage Example:
+    #   CF::Run.output({:title => "run_title", :station => 2})
+    # Will return output of second station
     def self.output(options={})
       station_no = options[:station]
       title = options[:title]
@@ -147,12 +111,19 @@ module CF
       return resp['output']
     end
     
+    # ==Returns Output of Run object for any specific Station
+    # ===Usage Example:
+    #   run_object.output(:station => 2)
+    # Will return output of second station
     def output(options={})
       station_no = options[:station]
       resp = self.class.get("/runs/#{CF.account_name}/#{self.title.downcase}/output/#{station_no}.json")
       return resp['output'].first.to_hash
     end
     
+    # ==Searches Run for the given "run_title"
+    # ===Usage Example:
+    #   CF::Run.find("run_title")
     def self.find(title)
       resp = get("/runs/#{CF.account_name}/#{title.downcase}.json")
       if resp.code != 200