cloudfactory 0.6.4 → 0.7

data/CHANGELOG.md

@@ -1,8 +1,9 @@
-## 0.6.3(2012-6-29)
-* Removed unnecessary requires.
+## 0.7 (2012-07-09)
+* Badge creation, update, deletion and listing added
 
-## 0.6.2(2012-6-29)
+## 0.6(2012-6-29)
 * CustomTaskForm update feature added
+* Give the link to the production run page and not the work preview page when a run is created using the CLI.
 
 ## 0.5.6 (2012-05-17)
 * Priority field added in the line

data/lib/cf/badge.rb

@@ -13,45 +13,146 @@ module CF
     attr_accessor :description
 
     # number of badge provided to the worker
-    attr_accessor :max_badges
+    attr_accessor :max_badge_assignments
+
+    attr_accessor :allow_retake_after
 
     # Contains error message
     attr_accessor :errors
 
     def initialize(options={})
       options.symbolize_keys!
-      if options[:test_attributes] && options[:test_attributes][:form_attributes]
-        form =  options[:test_attributes][:form_attributes]
-        if( form[:type] == "CustomTaskForm" && form[:file])
-          raw_html = ""
-          File.open("#{form[:file]}").each_line do |line|
-            raw_html += line
+      #if the form is provided as a file then explicitly add title and raw_html for the form
+      if options[:form] && options[:form].class != Hash
+        if File.exist?(options[:form])
+          file_type = IO.popen(["file", "--brief", "--mime-type", options[:form]], in: :close, err: :close).read.chomp
+          if file_type == "text/html"
+            options[:form] = {:title => "#{options[:name]}_form",:_type => "CustomTaskForm", :raw_html => File.read(options[:form])}
+          else
+            @errors = ["Wrong type of file for the badge form."]
+            return @errors
+            exit(1)
           end
-          options[:test_attributes][:form_attributes].merge!({:raw_html => raw_html,:_type =>"CustomTaskForm"})
+        else
+          @errors = ["Badge form path is not valid."]
         end
-        options[:test_attributes][:form_attributes].merge!({:_type =>"TaskForm"}) if form[:type] == "TaskForm"
       end
+
+      #known_answers of the badge get customize because to if unique identifier doesn't present then array of hashs returns the last hash for Httparty and get all key value merge into one in rest client/ rack
+      options[:known_answers] = self.class.customize_known_answers(options[:known_answers], options[:name]) if options[:known_answers].present?
+
       @settings = options
-      @station = options.delete(:station)
-      @line = options.delete(:line)
-      if @line.present? && @station.present?
-        request =
+      @name = options[:name]
+      @description = options[:description]
+      @allow_retake_after = options[:allow_retake_after]
+
+      request =
+      {
+        :body =>
         {
-          :body =>
-          {
-            :api_key => CF.api_key,
-            :badge => options
-          }
+          :api_key => CF.api_key,
+          :badge => options
         }
+      }
 
-        resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/lines/#{CF.account_name}/#{@line.title.downcase}/stations/#{@station.index}/badges.json",request)
-        @station.badges = self
-        self.errors = resp.parsed_response['error']['message'] if resp.code != 200
+      resp = HTTParty.post("#{CF.api_url}#{CF.api_version}/accounts/#{CF.account_name}/badges.json",request)
+      begin
+      self.errors = resp["error"]["message"] if resp.code != 200
+      return resp
+      rescue
+        self.errors = ["Unexpected error found. Confirm that you are in correct path and form for the badge is provided."]
       end
     end
 
     def self.create(*args)
       Badge.new(args.first)
     end
+
+    def self.update(badge_name, update_params)
+      badge_name = badge_name.parameterize
+      update_params.symbolize_keys!
+      if update_params[:form] && update_params[:form].class != Hash && File.exist?(update_params[:form])
+        file_type = IO.popen(["file", "--brief", "--mime-type", update_params[:form]], in: :close, err: :close).read.chomp
+        if file_type == "text/html"
+          update_params[:form] = {:title => "#{update_params[:name]}_form",:_type => "CustomTaskForm", :raw_html => File.read(update_params[:form])}
+        else
+          return
+        end
+      end
+
+      update_params[:known_answers] = customize_known_answers(update_params[:known_answers], update_params[:name]) if update_params[:known_answers].present?
+
+      request =
+      {
+        :body =>
+        {
+          :api_key => CF.api_key,
+          :badge => update_params
+        }
+      }
+      resp = HTTParty.put("#{CF.api_url}#{CF.api_version}/accounts/#{CF.account_name}/badges/#{badge_name}.json",request)
+      return resp
+    end
+
+    def self.destroy(*args)
+      name = args[0].parameterize
+      options = args[1].nil? ? {} : args[1]
+      decendents = check_for_decendents(name)
+      if decendents
+        response = delete("/accounts/#{CF.account_name}/badges/#{name}.json") if options.force
+      else
+        response = delete("/accounts/#{CF.account_name}/badges/#{name}.json")
+      end
+      @errors = response['error']['message'] if response['code'] != 200
+      return response
+    end
+
+    #list all badges with in the account if name is not provided else it will return list all values of the given badge
+    def self.list(name = nil)
+      response =  get("/accounts/#{CF.account_name}/badges.json", :name => name)
+      @errors = response['error']['message'] if response['code'] != 200
+      return response
+    end
+
+    def self.show(name)
+      response =  get("/accounts/#{CF.account_name}/badges/#{name.parameterize}.json")
+      @errors = response['error']['message'] if response['code'] != 200
+      return response
+    end
+
+    protected
+
+    #insert name to the goldstandard/known_answer if name is not provided
+    def self.customize_known_answers(known_answers, badge_name)
+      index = 1
+      known_answers.each do |known_answer|
+        unless known_answer["name"].present?
+          known_answer.merge!("name" => "#{badge_name}_answer_#{index}")
+          index +=1
+        end
+      end
+    end
+
+
+    #list the decendents for the badges like worker_associated, line_associated, number of tasks associated with the badge
+    def self.check_for_decendents(name)
+      show_response =  get("/accounts/#{CF.account_name}/badges/#{name.parameterize}.json")
+      @errors = show_response["error"]["message"] unless show_response["code"] == 200
+      unless @errors
+        response =  get("/accounts/#{CF.account_name}/badges.json", :name => name)
+        errors = response["error"]["message"] unless response["code"] == 200
+        return false if errors
+
+        lines = response["badges"].first["lines_associated"]
+        workers = response["badges"].first["workers"]
+        tasks = response["badges"].first["num_of_tasks"]
+        #if the lines of worker count is greater then 0 then return true else return lines and worker count
+        if lines > 0 || workers > 0
+          {:lines_count => lines, :workers_count => workers, :tasks => tasks }
+        else
+          false
+        end
+      end
+    end
   end
 end

data/lib/cf/cli.rb

@@ -17,12 +17,15 @@ require 'active_support/core_ext/object/blank'
 
 cli_directory = File.expand_path("../cf/cli", File.dirname(__FILE__))
 require "#{cli_directory}/config"
+require "#{cli_directory}/badge_yaml_validator"
+require "#{cli_directory}/badge"
 require "#{cli_directory}/line_yaml_validator"
 require "#{cli_directory}/line"
 require "#{cli_directory}/form"
 require "#{cli_directory}/production"
 
 
+
 if ENV['TEST']
   require 'pry'
 end
@@ -33,9 +36,9 @@ module Cf # :nodoc: all
     include Cf::Config
 
     def help(*args)
-        File.open(File.expand_path(File.dirname(__FILE__)+"/help.txt")).each_line{ |s|
-          say  s
-        }
+      File.open(File.expand_path(File.dirname(__FILE__)+"/help.txt")).each_line{ |s|
+        say  s
+      }
     end
 
     map "-v" => :version
@@ -59,7 +62,7 @@ module Cf # :nodoc: all
 
     no_tasks do
       def ask_password(message)
-        ::HighLine.new.ask(message) do |q| 
+        ::HighLine.new.ask(message) do |q|
           q.echo = '*'
         end
       end
@@ -103,6 +106,9 @@ module Cf # :nodoc: all
     # later it can be replaced with hacked millisami-thor version of the thor library with run-time dependency via Bundler
     subcommand "production", Cf::Production
 
+    desc "badge", "Commands to manage Badges. For more info cf badge help"
+    subcommand "badge", Cf::Badge
+
     desc "output <run-title>", "Get the output of run. For more info, cf output help"
     method_option :run_title, :type => :string, :required => true, :aliases => "-t", :desc => "the index of the station"
     method_option :station_index, :type => :numeric, :aliases => "-s", :desc => "the index of the station"
@@ -128,7 +134,7 @@ module Cf # :nodoc: all
             output = CF::Run.final_output(run_title)
           end
           if !output.empty?
-            output.each 
+            output.each
             csv_str = CSVHash(output,output.first.keys)
             csv_str = csv_str.gsub("\"\"", '"')
             FileUtils.mkdir("#{line_source}/output") unless Dir.exist?("#{line_source}/output") if RUBY_VERSION > "1.9"
@@ -153,5 +159,36 @@ module Cf # :nodoc: all
     def version
       say("Version: #{CF::VERSION}")
     end
+
+    desc "generate <project_name>", "Generate directory hierarchy for a new project"
+    method_option :force, :type => :boolean, :default => false, :aliases => "-f", :desc => "force to overwrite the files if already exists"
+    def generate(project_name)
+      source = Dir.pwd
+
+      parent_dir = "#{source}/#{project_name}"
+      lines_dir = "#{parent_dir}/lines"
+      badges_dir = "#{parent_dir}/badges"
+
+      if options.force?
+        FileUtils.rm_rf( parent_dir, :verbose => true)
+      end
+
+      if File.exist?(parent_dir)
+        say "Skipping #{project_name} because it already exists.", :red
+        exit(1)
+      end
+
+      say "Generating #{project_name} project hierarchy"
+      FileUtils.mkdir(parent_dir)
+      say_status "create", "#{project_name}"
+      FileUtils.mkdir(badges_dir)
+      say_status "create", "#{project_name}/badges"
+      FileUtils.mkdir(lines_dir)
+      say_status "create", "#{project_name}/lines"
+
+      say "#{project_name.humanize} project hierarchy generated successfully.", :green
+      say "Go to the directory #{lines_dir} and run command 'cf line generate <line_name>' to create line.", :yellow
+      say "Go to the directory #{badges_dir} and run command 'cf badge generate <badge_name>' to create badge.", :yellow
+    end
   end
 end

data/lib/cf/cli/badge.rb

@@ -0,0 +1,248 @@
+require 'thor/group'
+module Cf # :nodoc: all
+  class NewBadge < Thor::Group # :nodoc: all
+    include Thor::Actions
+    include Cf::Config
+    source_root File.expand_path('../templates', __FILE__)
+    argument :name, :type => :string, :desc => "The badge name."
+    argument :source_destination, :type => :string, :required => true
+
+    def generate
+      parent_dir = "#{source_destination}/#{name}"
+      FileUtils.mkdir(parent_dir)
+      template("sample-line/badge.yml.erb", "#{parent_dir}/badge.yml")
+      copy_file("sample-line/form.html", "#{parent_dir}/form.html")
+    end
+  end
+end
+
+module Cf # :nodoc: all
+  class Badge < Thor
+    include Cf::Config
+    include Cf::BadgeYamlValidator
+
+
+    desc "badge generate <badge_name>", "Generate a new badge template."
+    method_option :force, :type => :boolean, :default => false, :aliases => "-f", :desc => "force to overwrite the files if already exists, default is false"
+    def generate(badge_name = nil)
+      badge_name = badge_name.nil? ? "web_research" : badge_name.chomp(File.extname(badge_name))
+      source_destination = "#{Dir.pwd}"
+
+      if options.force?
+        FileUtils.rm_rf(badge_name, :verbose => true)
+      end
+
+      if File.exist?(badge_name)
+        say "Skipping #{badge_name} because it already exists.", :red
+      else
+        say "Generating a new badge template #{badge_name}", :green
+        Cf::NewBadge.start([badge_name, source_destination])
+        say "Badge template generated successfully.", :green
+        say "Modify files inside #{badge_name} directory and create badge with: cf badge create", :yellow
+      end
+    end
+
+
+
+    desc "badge create <badge_name>", "takes the badge.yml from badge_name directory and create a badge"
+    def create(badge_name)
+      yaml_source = "#{Dir.pwd}/#{badge_name}/badge.yml"
+
+      unless File.exist?(yaml_source)
+        say "A file with name badge.yml inside #{badge_name} directory does not exists.", :red
+        return
+      end
+
+      errors = validate(yaml_source)
+      unless errors.present?
+        set_target_uri(false)
+        set_api_key(yaml_source)
+        CF.account_name = CF::Account.info['name']
+
+        badge_hash = YAML::load(File.read(yaml_source).strip)
+
+        name = badge_hash["name"]
+
+        #check whether the badge form exist or not. If the badge form path looks invalid then it tries to recover and then again check and then also its      does not exit then it raise errors.
+        if badge_hash["form"].class == String
+          unless File.exist?(badge_hash["form"])
+            badge_hash["form"] = "#{badge_name}/#{badge_hash["form"]}"
+            unless File.exist?(badge_hash["form"])
+              say "Invalid path for badge form.", :red
+              exit(1)
+            end
+          end
+        end
+
+        do_exist = CF::Badge.show(name.parameterize)
+        if do_exist && do_exist["code"]==200
+          say "A badge named #{name} already exists.", :yellow
+          override = agree("Do you want to override ? [y/n] ")
+          override == true ? badge_hash.merge!(:confirmed => true) : ((say "Badge creation aborted!", :red) and exit(1))
+        end
+        say "Creating badge '#{name}'"
+        badge = CF::Badge.new(badge_hash)
+        if badge.errors.present?
+          say "Errors: \n", :red
+          badge.errors.each do |error|
+            say(error, :red)
+          end
+          exit(1)
+        else
+          say "A new badge named '#{name}' created sucessfully!"
+        end
+      else
+        say "Following errors has been encountered in your badge.yml file: #{errors.join(",")}" , :red
+      end
+    end
+
+
+
+    desc "badge update <badge_name>", "takes the badge.yml from badge_name directory and update the badge"
+    def update(badge_name)
+      yaml_source = "#{Dir.pwd}/#{badge_name}/badge.yml"
+
+      unless File.exist?(yaml_source)
+        say "A file with name badge.yml inside #{badge_name} directory does not exists.", :red
+        return
+      end
+      errors = validate(yaml_source)
+
+      unless errors.present?
+        set_target_uri(false)
+        set_api_key(yaml_source)
+        CF.account_name = CF::Account.info['name']
+
+        badge_hash = YAML::load(File.read(yaml_source).strip)
+
+        #check whether the badge form exist or not. If the badge form path looks invalid then it tries to recover and then again check and then also its      does not exit then it raise errors.
+        if badge_hash["form"].class == String
+          unless File.exist?(badge_hash["form"])
+            badge_hash["form"] = "#{badge_name}/#{badge_hash["form"]}"
+            unless File.exist?(badge_hash["form"])
+              say "Invalid path for badge form.", :red
+              exit(1)
+            end
+          end
+        end
+
+        do_exist = CF::Badge.list(badge_name.parameterize)
+        #check whetether the badge do exist and has its decendents if do then retain_current_worker_badge = true so that worker and lines associated get retain if the badge get updated other wise the badge act as a new badge
+        if do_exist && do_exist["code"]==200
+          descendents = CF::Badge.check_for_decendents(badge_name.parameterize)
+          if descendents
+            say("\n!!! Warning !!!\n The badge '#{badge_name}' has the following number of tasks, lines and workers asscociated with it.\n", :yellow)
+            badge_table = table do |t|
+              t.headings = [ 'Tasks', 'Lines', 'Workers']
+              t << [ descendents[:tasks], descendents[:lines_count], descendents[:workers_count]]
+            end
+            say(badge_table)
+            say("\n!!! Warning !!!\n Retaining the workers will keep the workers associated with the badge.\n", :yellow)
+            update_forcefully = agree("Do you want to retain the workers? [y/n] ")
+            badge_hash.merge!(:retain_workers => false) if update_forcefully == false
+          end
+
+          #now update the badge
+          say "Updating badge named '#{badge_name}'"
+          badge = CF::Badge.update(badge_name,badge_hash)
+          if badge && badge.code == 200
+            say "A badge named '#{badge_name}' updated sucessfully!"
+          else
+            if badge.code == 404
+              say "Badge does not exist."
+            elsif badge.code == 422
+              say badge["error"]["message"], :red
+            else
+              say "A badge named '#{badge_name}' can not be updated", :red
+            end
+            exit(1)
+          end
+        else
+          say "A badge named '#{badge_name}' does not exist!", :red
+          exit(1)
+        end
+      else
+        say "Following errors has been encountered in your badge.yml file: #{errors.join(",")}" , :red
+      end
+    end
+
+
+
+    desc "badge delete <badge name>", "Delete the given badge within your account."
+    method_option :force, :type => :boolean, :aliases => "-f", :default => false, :desc => "force delete the badge"
+    def delete(badge_name)
+      #set badge basic credentials
+      line_source = Dir.pwd
+      yaml_source = "#{line_source}/line.yml"
+      set_target_uri(false)
+      set_api_key(yaml_source)
+      set_target_uri(false)
+      CF.account_name = CF::Account.info['name']
+
+      #list all badges if name is not present else list the specific badge
+      if badge_name
+        badge_decendents = CF::Badge.check_for_decendents(badge_name)
+        if badge_decendents
+          say("\n!!! Warning !!!\n The badge #{badge_name} has following number of tasks, lines and workers asscociated with it.\n", :yellow)
+          badge_table = table do |t|
+            t.headings = [ 'Tasks', 'Lines', 'Workers']
+            t << [ badge_decendents[:tasks], badge_decendents[:lines_count], badge_decendents[:workers_count]]
+          end
+          say(badge_table)
+
+          delete_forcefully = agree("Do you still want to delete this badge? [y/n] ")
+          if delete_forcefully
+            badge_resp = CF::Badge.destroy(badge_name,options.merge(:force => true))
+          else
+            say "Badge deletion aborted!", :yellow
+            exit(1)
+          end
+        else
+          say "Deleting badge named '#{badge_name}'"
+          badge_resp = CF::Badge.destroy(badge_name)
+        end
+        badge_resp["code"] == 200 ? (say "The badge named #{badge_name} deleted sucessfully!", :green)  :  (say badge_resp["error"]["message"], :red)
+      else
+        say "Name of the badge for deletion is missing.", :red
+      end
+    end
+
+
+
+    desc "badge list ", "List all badges asscociated within your account. Use 'cf badge list <badge_name>' for single ."
+    def list(name = nil)
+      #set badge basic credentials
+      line_source = Dir.pwd
+      yaml_source = "#{line_source}/line.yml"
+      set_target_uri(false)
+      set_api_key(yaml_source)
+      set_target_uri(false)
+      CF.account_name = CF::Account.info['name']
+
+      #list all badges if name is not present else list the specific badge
+      if name
+        badge_resp = CF::Badge.list(name)
+      else
+        badge_resp = CF::Badge.list
+      end
+
+      #show list of badges in the tabular view
+      if badges = badge_resp["badges"]
+        say "Listing badges within your account" , :green
+        badges.sort! { |a, b| a['name'] <=> b['name'] }
+        badge_table = table do |t|
+          t.headings = ["Name", 'Number Of Tasks', 'Lines Associated', 'Workers', 'Description']
+          badges.each do |badge|
+            badge = Hashie::Mash.new(badge)
+            t << [badge.name, badge.num_of_tasks, badge.lines_associated, badge.workers, badge.description]
+          end
+        end
+        say(badge_table)
+      else
+        say badge_resp["error"]["message"], :red
+      end
+    end
+
+
+  end
+end