epc 1.0.4 → 1.0.6

data/lib/epc.rb

@@ -144,6 +144,9 @@ module EPC
     autoload(:UpdateProjecttypeCommand, "#{ROOT}/epc/command/projecttype/update_projecttype_command")
     autoload(:ShowProjectSnapshotCommand, "#{ROOT}/epc/command/project/show_project_snapshot_command")
     autoload(:ListUserpropertiesCommand, "#{ROOT}/epc/command/userproperty/list_user_properties_command")
+    autoload(:SetUserPropertyCommand, "#{ROOT}/epc/command/userproperty/set_user_property_command")
+    autoload(:GetUserPropertyCommand, "#{ROOT}/epc/command/userproperty/get_user_property_command")
+    autoload(:DeleteUserpropertyCommand, "#{ROOT}/epc/command/userproperty/delete_user_property_command")
 
 
     autoload(:CreateCommand, "#{ROOT}/epc/command/create_command")

data/lib/epc/client/base_client.rb

@@ -9,7 +9,7 @@ module EPC
       class BadResponse < RuntimeError; end
       class HTTPException <  RuntimeError; end
     
-      def initialize(target_url=EPC::Config::DEFAULT_TARGET, caller_id = nil, auth_token = nil)
+      def initialize(target_url=EPC::Config::DEFAULT_TARGET, caller_id = nil, auth_token = nil, debug = false)
         target_url = "http://#{target_url}" unless target_url =~ /^https?/
         target_url = target_url.gsub(/\/+$/, '')
         @target =  target_url
@@ -17,6 +17,7 @@ module EPC
         @caller_id = caller_id || EPC::Config.caller_id
         @auth_token = auth_token || EPC::Config.auth_token
         @digest = OpenSSL::Digest::Digest.new('sha256')
+        @debug = debug
       end
     
       # returns an array of status, body, response_headers

data/lib/epc/client/json_client.rb

@@ -4,8 +4,10 @@ require 'json'
 module EPC::Client
   class JsonClient < HttpClient
     def get(url, skip_signature = false)
+      debug_request(:get, url) if @debug
       begin
         status, body, headers = super(url, 'application/json', skip_signature)
+        debug_response(status, json_parse(body), headers) if @debug
         [status, json_parse(body), headers]
       rescue JSON::ParserError
         raise BadResponse, "Invalid response received. Response status: #{status}", body
@@ -13,8 +15,10 @@ module EPC::Client
     end
 
     def post(url, payload = {}, skip_signature = false)
+      debug_request(:post, url, payload) if @debug
       begin
         status, body, headers = super(url, payload.to_json, 'application/json', {}, skip_signature)
+        debug_response(status, json_parse(body), headers) if @debug
         [status, json_parse(body), headers]
       rescue JSON::ParserError
         raise BadResponse, "Invalid response received. Response status: #{status}", body
@@ -22,8 +26,10 @@ module EPC::Client
     end
 
     def put(url, payload = {})
+      debug_request(:put, url, payload) if @debug
       begin
         status, body, headers = super(url, payload.to_json, 'application/json')
+        debug_response(status, json_parse(body), headers) if @debug
         [status, json_parse(body), headers]
       rescue JSON::ParserError
         raise BadResponse, "Invalid response received. Response status: #{status}", body
@@ -31,8 +37,10 @@ module EPC::Client
     end
     
     def delete(url, payload = {})
+      debug_request(:delete, url, payload) if @debug
       begin
         status, body, headers = super(url, payload.to_json, 'application/json')
+        debug_response(status, json_parse(body), headers) if @debug
         [status, json_parse(body), headers]
       rescue JSON::ParserError
         raise BadResponse, "Invalid response received. Response status: #{status}", body
@@ -41,6 +49,20 @@ module EPC::Client
     
     private
 
+    def debug_request(action, url, payload = nil)
+      say("\n## Request data")
+      say("\t" + action.to_s.capitalize + ": #{url}")
+      say("\t" + payload.to_s) if payload.present?
+    end
+
+    def debug_response(status, body, headers)
+      say("\n## Response data")
+      say("\tStatus: " + status.to_s)
+      say("\tResponse: " + body.to_s)
+      say("\tHeaders: " + headers.to_s)
+      say("\n\n")
+    end
+
     def json_parse(body)
       JSON.parse(body, :symbolize_names => true) if body
     end

data/lib/epc/command/archive_command.rb

@@ -2,7 +2,7 @@ module EPC::Command
   class ArchiveCommand < BaseCommand
 
     def execute(*args)
-      raise FatalError, "You need to specify the object for the command" if args.blank?
+      raise InputError, "You need to specify the object for the command" if args.blank?
       params = resolve_context(args)
       @klass_name = "EPC::Command::Archive#{@object_type.to_s.gsub("-","").capitalize}Command" 
       command = eval(@klass_name).new(client, @options)

data/lib/epc/command/attachto_command.rb

@@ -2,7 +2,7 @@ module EPC::Command
   class AttachtoCommand < BaseCommand
 
     def execute(*args)
-      raise FatalError, "You need to specify the object for the command" if args.blank?
+      raise InputError, "You need to specify the object for the command" if args.blank?
       params = resolve_context(args)
       @klass_name = "EPC::Command::Attachto#{@object_type.to_s.gsub("-","").capitalize}Command" 
       command = eval(@klass_name).new(client, @options)

data/lib/epc/command/base_command.rb

@@ -15,22 +15,7 @@ module EPC
       attr_accessor :object_id
       attr_accessor :target_type 
       attr_accessor :target_id
-      attr_accessor :klass_name
-
-      @@retrieval_rules = {
-        :Role => {
-          :required_type => :numeric, 
-        },
-        :User => {
-          :required_type => :numeric,
-        },
-        :UserGroup => {
-          :required_type => :numeric,
-        },
-        :LibrarySet => {
-          :required_type => :numeric,
-        }
-      }
+      attr_writer :klass_name
 
       @@required_options = []
 
@@ -78,6 +63,11 @@ module EPC
         end
       end
 
+      def say_err(statement)
+        EPC::Config.say_err(statement)
+      end
+
+
       def check_options
         @@required_options.each do |req_opt|
           raise FatalError, req_opt[:message] unless req_opt[:name].map{|opt| @options[opt].present?}.send(req_opt[:mode])
@@ -93,6 +83,11 @@ module EPC
         @object_type, @object_id, @target_type, @target_id = params
       end
 
+      def klass_name
+        return self.class.name if @klass_name.blank?
+        @klass_name
+      end
+
       private
 
       def translate_status_to_exit_code(status)
@@ -148,21 +143,35 @@ module EPC
         return target_type.present? && target_id.present?
       end
 
-      def require_object
-        raise InputError, "#{object_type.capitalize} not found" if object_type.blank? || object_id.blank?
+
+      def has_object?
+        return object_type.present? && object_id.present?
       end
 
-      def require_target
-        raise InputError, "Target incorrectly specified" if target_type.blank? || target_id.blank?
+      def require_object(msg = "You need to specify the object")
+        if object_type.blank?
+          raise FatalError, msg
+        elsif object_id.blank?
+          raise InputError, "#{object_type.capitalize} not found" if object_type.blank? || object_id.blank?
+        end
+      end
+
+      def require_target(msg = "You need to specify the target")
+        if target_type.blank?
+          raise FatalError, msg
+        elsif target_id.blank?
+          raise InputError, "#{target_type.capitalize} not found"
+        end
       end
 
       def resolve_context(args, opts = {})
         defaults = {
           :skip_object_resolution => Proc.new{|type, id| false},
-          :skip_target_resolution => Proc.new{|type, id| false}
+          :skip_target_resolution => Proc.new{|type, id| false},
+          :accept_no_object => false
         }.merge!(opts)
         @object_id, @object_type, args = parse_context_param(args, defaults[:skip_object_resolution])
-        raise InputError, "Invalid command" if @object_type.blank?
+        raise NameError if @object_type.blank? && !defaults[:accept_no_object]
         @target_id, @target_type, args = parse_context_param(args, defaults[:skip_target_resolution])
         return args
       end
@@ -170,7 +179,7 @@ module EPC
       def parse_context_param(params, skip_proc)
         return [nil, nil, params] unless is_context_param?((params.first rescue nil))
         param = params.shift
-        param_parts = param.split(":") 
+        param_parts = param.split(":")
         type = param_parts[0]
         id = param_parts[1..-1].join(":")
         if skip_proc.call(type, id)
@@ -298,7 +307,8 @@ module EPC
                     solution
                     user
                     metrics
-                    user-properties
+                    userproperty
+                    userproperties
         )
 
       end
@@ -307,7 +317,7 @@ module EPC
         entity = entity.to_sym
         match_value = args.join(":")
         return nil if match_value.blank?
-        rule = @@retrieval_rules[entity.to_sym] || {:required_type => :numeric}
+        rule = {:required_type => :numeric}
         if rule[:required_type] == :numeric
           if numeric?(match_value)
             return match_value.to_i

data/lib/epc/command/build_command.rb

@@ -58,7 +58,7 @@ module EPC::Command
           return poll_for_build_status(id)
         end
       else
-        say("Failed to find the project ID in the EPC configuration. Aborting")
+        say_err("Failed to find the project ID in the EPC configuration. Aborting")
       end
       return 1
     end
@@ -75,7 +75,7 @@ module EPC::Command
         say("Successfully kicked off a build with [#{target_url}]")
         return true, response[:id]
       else
-        say("Build kickoff failed [#{response[:message]}]. Aborting.")
+        say_err("Build kickoff failed [#{response[:message]}]. Aborting.")
         return false
       end
     end

data/lib/epc/command/config/create_config_command.rb

@@ -43,7 +43,7 @@ module EPC::Command
       if status.successful?
         say("Configuration values saved.")
       else
-        say("Request failed with message [#{response[:message]}]")
+        say_err("Request failed with message [#{response[:message]}]")
       end
       return status
     end

data/lib/epc/command/config/delete_config_command.rb

@@ -27,7 +27,7 @@ module EPC::Command
 
       key_id = existing_keys.detect{|k| k[:name] == key }[:id] rescue nil
       if key_id.nil?
-        say("#{key} is not defined.")
+        say_err("#{key} is not defined.")
         return 1
       end
 
@@ -44,10 +44,10 @@ module EPC::Command
       end
 
       status, response, headers = client.delete(EPC::Config::CONFIGURATIONS_PATH + "/#{key_id}")
-      if status.failure?
-        say("Request failed: [#{response[:message]}]")
-      else
+      if status.successful?
         say("#{key} succesfully removed.")
+      else
+        say_err("Request failed: [#{response[:message]}]")
       end
       return status
 

data/lib/epc/command/config/list_configs_command.rb

@@ -43,7 +43,7 @@ module EPC::Command
       status, response, headers = client.get(path)
       @status = status
       if status.failure? 
-        say("Configuration retrieval failed with [#{response[:message]}]")
+        say_err("Configuration retrieval failed with [#{response[:message]}]")
         return false
       end
 

data/lib/epc/command/config/update_config_command.rb

@@ -22,7 +22,7 @@ module EPC::Command
       status, response, headers = client.get(request_path)
 
       if status.failure? 
-        say("Configuration retrieval failed with [#{response[:message]}]")
+        say_err("Configuration retrieval failed with [#{response[:message]}]")
         return status
       end
 
@@ -31,7 +31,7 @@ module EPC::Command
       key_id = keys.detect{|k| k[:name] == object_id}[:id] rescue nil
       
       if key_id.nil?
-        say("Key does not exist.") 
+        say_err("Key does not exist.") 
         return 1
       end
 
@@ -49,7 +49,7 @@ module EPC::Command
           say("#{object_id} saved.")
         end
       else
-        say("Request failed with message [#{response[:message]}]")
+        say_err("Request failed with message [#{response[:message]}]")
       end
       return status
     end

data/lib/epc/command/copy_command.rb

@@ -2,7 +2,7 @@ module EPC::Command
   class CopyCommand < BaseCommand
 
     def execute(*args)
-      raise FatalError, "You need to specify the object for the command" if args.blank?
+      raise InputError, "You need to specify the object for the command" if args.blank?
       params = resolve_context(args)
       raise FatalError, "Could not determine ObjectType" if @object_type.blank?
       @klass_name = "EPC::Command::Copy#{@object_type.to_s.gsub("-","").capitalize}Command" 

data/lib/epc/command/create_command.rb

@@ -2,7 +2,7 @@ module EPC::Command
   class CreateCommand < BaseCommand
 
     def execute(*args)
-      raise FatalError, "You need to specify the object for the command" if args.blank?
+      raise InputError, "You need to specify the object for the command" if args.blank?
       params = resolve_context(args)
       @klass_name = "EPC::Command::Create#{@object_type.to_s.gsub("-","").capitalize}Command" 
       command = eval(@klass_name)

data/lib/epc/command/delete_command.rb

@@ -2,8 +2,8 @@ module EPC::Command
   class DeleteCommand < BaseCommand
     
     def execute(*args)
-      raise FatalError, "You need to specify the object for the command" if args.blank?
-      params = resolve_context(args, {:skip_object_resolution => Proc.new{|type, id| type.downcase == "config" || type.downcase == "objectrole"}})
+      raise InputError, "You need to specify the object for the command" if args.blank?
+      params = resolve_context(args, {:skip_object_resolution => Proc.new{|type, id| type.downcase == "config" || type.downcase == "objectrole" || type.downcase == "userproperty"}})
       @klass_name = "EPC::Command::Delete#{@object_type.to_s.gsub("-","").capitalize}Command" 
       command = eval(@klass_name)
       command.include_module(object_type)

data/lib/epc/command/deploy_command.rb

@@ -11,7 +11,7 @@ module EPC::Command
       path = File.expand_path(path)
 
       if  !( EPC::Config.is_solution_dir?(path) || EPC::Config.is_project_dir?(path)) && @options[:deployment_id].nil?
-        say("This is not a solution directory.")
+        say_err("This is not a solution directory.")
         return 1
       end
 
@@ -59,7 +59,7 @@ module EPC::Command
           display_statuses(deployment_status, response[:deployed_projects])
         end
       rescue Exception => ex
-        say("Deploy failed [#{ex.to_s}].")
+        say_err("Deploy failed [#{ex.to_s}].")
         return 1
       end
       return status
@@ -131,7 +131,8 @@ module EPC::Command
     def display_statuses(deployment_status, deployed_projects)
       say("\nStatus = #{deployment_status}\n")
       deployed_projects.each do |project|
-        say("#{project[:project_name]} -> #{project[:uris].join(",")}\n")
+        uris = project[:uris].join(",") rescue "N/A"
+        say("#{project[:project_name]} -> #{uris}\n") rescue ""
       end
       
     end

data/lib/epc/command/deployment/copy_deployment_command.rb

@@ -10,7 +10,7 @@ module EPC::Command
       status, response, headers = client.post(EPC::Config::DEPLOYMENTS_PATH + "/#{object_id}/copy", {:stage_name => stage})
 
       if status.failure?
-        say("Request failed: [#{response[:message]}]")
+        say_err("Request failed: [#{response[:message]}]")
       else
         say("Copied new deployment to the #{stage} stage. ID: #{response[:id]}")
       end

data/lib/epc/command/deployment/create_deployment_command.rb

@@ -24,7 +24,7 @@ module EPC::Command
         status, @id = create_deployment(solution_name, stage_name, versions, instances, memory)
         return status
       rescue Exception => ex
-        say("Create deployment failed [Exception Caught (#{ex.class.name}): #{ex.to_s}].")
+        say_err("Create deployment failed [Exception Caught (#{ex.class.name}): #{ex.to_s}].")
         return 1
       end 
 
@@ -32,7 +32,7 @@ module EPC::Command
       if @options[:replaces].present?
         status, response, headers = client.put(EPC::Config::DEPLOYMENTS_PATH + "/#{@id}", {:stage_name => "no_change", :replaces_id => @options[:replaces], :versions => "no_change"})
         if status.failure?
-          say("Replacement request failed: [#{response[:message]}]")
+          say_err("Replacement request failed: [#{response[:message]}]")
         else
           say("Replacement request successful")
         end
@@ -58,7 +58,7 @@ module EPC::Command
         say("Successfully created deployment [#{response[:id]}] with [#{target_url}]")
         return status, response[:id]
       else
-        say("Deployment creation failed [#{response[:message]}]. Aborting.")
+        say_err("Deployment creation failed [#{response[:message]}]. Aborting.")
         return status, nil
       end
     end

data/lib/epc/command/deployment/list_deployments_command.rb

@@ -26,7 +26,7 @@ module EPC::Command
       status, response, headers = client.get(url)
 
       if status.failure?
-        say("Deployments retrieval failed with [#{response[:message]}]")
+        say_err("Deployments retrieval failed with [#{response[:message]}]")
       elsif response.empty?
         say("You have no deployments created. You can create them with epc create deployment.")
       else

data/lib/epc/command/deployment/show_deployment_command.rb

@@ -6,7 +6,7 @@ module EPC::Command
       
       status, response, headers = client.get(EPC::Config::DEPLOYMENTS_PATH + "/#{object_id}?include=solution,deployment_stage,approvals,deployer,submitter")
       if status.failure?
-        say("Request failed: [#{response[:message]}]")
+        say_err("Request failed: [#{response[:message]}]")
         return status
       end
 

data/lib/epc/command/deployment/submit_deployment_command.rb

@@ -7,7 +7,7 @@ module EPC::Command
       if status.successful?
         say("Deployment submitted for approval")
       else
-        say("Request failed: [#{response[:message]}]")
+        say_err("Request failed: [#{response[:message]}]")
       end
       return status
     end

data/lib/epc/command/deployment/update_deployment_command.rb

@@ -21,7 +21,7 @@ module EPC::Command
       if status.successful?
         say("Deployment updated")
       else
-        say("Request failed with: [#{response[:message]}]")
+        say_err("Request failed with: [#{response[:message]}]")
       end
       return status
     end