lorj 0.1.0 → 0.2.0

data/lib/prc-logging.rb

@@ -26,13 +26,67 @@ require 'ansi/logger'
 #
 # PrcLib module
 #
+# PrcLib Implements a Logging class based on logger.
+#
+# For details about this class capabilities, see PrcLib::Logging
+#
+#    # To use the Prc::Logging system, do the following:
+#    require 'PrcLib'
+#
+#    # To configure logging system:
+#    PrcLib.app_name = 'config/app'    # Define application data path as ~/.<app_name>. Ex: 'config/app' will use ~/.config/app
+#    PrcLib.log_file = 'app.log'       # Relative path to the log file name stored in the Application data path. Here, ~/.config/app/app.log
+#    PrcLib.level = Logger::FATAL      # Define printout debug level. Can be any Logger predefined value.
+#
+#    # To log some information:
+#    PrcLib.debug('My debug message')
+#    PrcLib.info('My info message')
+#    PrcLib.warning('my warning')
+#    PrcLib.error('my error')
+#    PrcLib.fatal(2, "Fatal error, with return code = 2)
+#    PrcLib.message('Only printout message')
+#
+#    # You can printout some instant message to the terminal, not logged.
+#    # This is useful before any action that will take time to be executed.
+#    # It is inform the end user that something is still running, which means
+#    # the application is not frozen
+#    PrcLib.state("Running a long task")
+#    # The next message will replace the previous state message.
+#    sleep(10)
+#    PrcLib.info("The long task has been executed successfully.")
+#
+#    # You can change the logger level with PrcLib.level
+#    PrcLib.level = Logger::DEBUG
+#
+#    # You can just print high level message (print without \n) if PrcLib.level is not DEBUG or INFO.
+#    PrcLib.high_level_msg("Print a message, not logged, if level is not DEBUG or INFO")
+#
+# Enjoy!
 module PrcLib
 
+   # Class used to create 2 logger object, in order to keep track of error in a log file and change log output to OUTPUT on needs (option flags).
+   # The idea is that everytime, if you did not set the debug level mode, you can refer to the log file which is
+   # already configured with Logger::DEBUG level.
+   #
+   # As well, sometimes, you do not want to keep track on messages that are just to keep informed the end user about activity.
+   # So, this object implement 2 Logger objects.
+   # * One for log file
+   # * One for print out.
+   #
+   # Everytime you log a message with Logging, it is printed out if the level permits and stored everytime in the log file, never mind about Logger level set.
+   # In several cases, messages are printed out, but not stored in the log file.
+   #
+   # See Logging functions for details.
+   #
    class Logging
-     # Class used to create 2 log object, in order to keep track of error in a log file and change log output to OUTPUT on needs (option flags).
 
      attr_reader :level
 
+      # Initialize Logging instance
+      # The log file name is defined by PrcLib.log_file
+      # The log path is defined by PrcLib.app_name and will be kept as ~/.<PrcLib.app_name>
+      # The log level is defined by PrcLib.level. It will update only log print out.
+      # Depending on levels, messages are prefixed by colored 'ERROR!!!', 'FATAL!!!', 'WARNING' or <LEVEL NAME>
       def initialize()
 
          if not PrcLib.app_name
@@ -71,53 +125,66 @@ module PrcLib
          PrcLib.log_file = sLogFile
       end
 
+      # Is Logging print out level is info?
       def info?
          return(@oOutLogger.info?)
       end
 
+      # Is Logging print out level is debug?
       def debug?
          return(@oOutLogger.debug?)
       end
 
+      # Is Logging print out level is error?
       def error?
          return(@oOutLogger.error?)
       end
 
+      # Is Logging print out level is fatal?
       def fatal?
          return(@oOutLogger.fatal?)
       end
 
+      # Log to STDOUT and Log file and INFO class message
       def info(message)
          @oOutLogger.info(message + ANSI.clear_line)
          @oFileLogger.info(message)
       end
 
+      # Log to STDOUT and Log file and DEBUG class message
       def debug(message)
          @oOutLogger.debug(message + ANSI.clear_line)
          @oFileLogger.debug(message)
       end
 
+      # Log to STDOUT and Log file and ERROR class message
       def error(message)
          @oOutLogger.error(message + ANSI.clear_line)
          @oFileLogger.error(message)
       end
 
+      # Log to STDOUT and Log file and FATAL class message
+      # fatal retrieve the caller list of functions and save it to the log file if the exception class is given.
+      # The exception class should provide message and backtrace.
       def fatal(message, e)
          @oOutLogger.fatal(message + ANSI.clear_line)
          @oFileLogger.fatal("%s\n%s\n%s" % [message, e.message, e.backtrace.join("\n")]) if e
          @oFileLogger.fatal(message)
       end
 
+      # Log to STDOUT and Log file and WARNING class message
       def warn(message)
          @oOutLogger.warn(message + ANSI.clear_line)
          @oFileLogger.warn(message)
       end
 
+      # set STDOUT logger level
       def set_level(level)
          @level = level
          @oOutLogger.level = level
       end
 
+      # Print out a message, not logged in the log file. This message is printed out systematically as not taking care of logger level.
       def unknown(message)
          @oOutLogger.unknown(message + ANSI.clear_line)
       end
@@ -126,6 +193,8 @@ module PrcLib
 
    module_function
 
+   # Create a Logging object if missing and return it.
+   # Used internally by other functions
    def log_object()
       if PrcLib.log.nil?
          PrcLib.log = PrcLib::Logging.new
@@ -134,30 +203,38 @@ module PrcLib
       end
    end
 
+   # Print out a message, not logged in the log file. This message is printed out systematically as not taking care of logger level.
    def message(message)
       log_object.unknown(message)
    end
 
+   # Log to STDOUT and Log file and INFO class message
    def info(message)
       log_object.info(message)
       nil
    end
 
+   # Log to STDOUT and Log file and DEBUG class message
    def debug(message)
       log_object.debug(message)
       nil
    end
 
+   # Log to STDOUT and Log file and WARNING class message
    def warning(message)
       log_object.warn(message)
       nil
    end
 
+   # Log to STDOUT and Log file and ERROR class message
    def error(message)
       log_object.error(message)
       nil
    end
 
+   # Log to STDOUT and Log file and FATAL class message then exit the application with a return code.
+   # fatal retrieve the caller list of functions and save it to the log file if the exception class is given.
+   # The exception class should provide message and backtrace.
    def fatal(rc, message, e = nil)
       log_object.fatal(message, e)
       puts 'Issues found. Please fix it and retry. Process aborted.'
@@ -174,8 +251,9 @@ module PrcLib
       nil
    end
 
+   # Not DEBUG and not INFO. Just printed to the output.
    def high_level_msg(message)
-      # Not DEBUG and not INFO. Just printed to the output.
+
       print ("%s" % [message]) if log_object.level > 1
       nil
    end

data/lib/prc.rb

@@ -105,4 +105,27 @@ module PrcLib
       @level
    end
 
+   def lib_path=(v)
+      @lib_path = v if @lib_path.nil?
+   end
+
+   def lib_path()
+      @lib_path
+   end
+
+   def controller_path()
+      File.expand_path(File.join(@lib_path,  "providers"))
+   end
+
+   def process_path()
+      File.join(@lib_path, "core_process")
+   end
+end
+
+
+class Object
+  # Simplify boolean test on objects
+  def boolean?
+    self.is_a?(TrueClass) || self.is_a?(FalseClass)
+  end
 end

data/lib/providers/hpcloud/Hpcloud.rb

@@ -27,7 +27,7 @@ require File.join($HPCLOUD_PATH, "network.rb")
 require File.join($HPCLOUD_PATH, "security_groups.rb")
 
 # Defines Meta HPCloud object
-class Hpcloud < BaseDefinition
+class Hpcloud
 
    define_obj :services
    obj_needs   :data, :account_id,      :mapping => :hp_access_key
@@ -176,7 +176,7 @@ end
 
 # Following class describe how FORJ should handle HP Cloud objects.
 # Except Cloud connection, all HPCloud objects management are described/called in HP* modules.
-class HpcloudController < BaseController
+class HpcloudController
 
    def connect(sObjectType, hParams)
       case sObjectType
@@ -187,7 +187,7 @@ class HpcloudController < BaseController
          when :network_connection
             Fog::HP::Network.new(hParams[:hdata])
          else
-            forjError "'%s' is not a valid object for 'connect'" % sObjectType
+            Error "'%s' is not a valid object for 'connect'" % sObjectType
       end
    end
 
@@ -252,7 +252,7 @@ class HpcloudController < BaseController
             required?(hParams, :subnetwork)
             HPNetwork.add_interface(hParams[:router], hParams[:subnetwork])
          else
-            forjError "'%s' is not a valid object for 'create'" % sObjectType
+            Error "'%s' is not a valid object for 'create'" % sObjectType
       end
    end
 
@@ -296,7 +296,7 @@ class HpcloudController < BaseController
             required?(hParams, :compute_connection)
             HPCompute.query_flavor(hParams[:compute_connection], sQuery)
          else
-            forjError "'%s' is not a valid object for 'query'" % sObjectType
+            Error "'%s' is not a valid object for 'query'" % sObjectType
       end
    end
 
@@ -307,26 +307,33 @@ class HpcloudController < BaseController
          when :rule
             HPSecurityGroups.delete_rule(hParams[:network_connection], hParams[:id])
             hParams[:network_connection].security_group_rules.get(hParams[:id]).destroy
-         else
+          when :server
+            required?(hParams, :compute_connection)
+            required?(hParams, :server)
+            HPCompute.delete_server(hParams[:compute_connection], hParams[:server] )
+        else
             nil
       end
    end
 
    def get(sObjectType, sUniqId, hParams)
       case sObjectType
-        when :server_log
+         when :server_log
             required?(hParams, :server)
-
+            
             hParams[:server].console_output(sUniqId)
-        when :server
+         when :server
             required?(hParams, :compute_connection)
             HPCompute.get_server(hParams[:compute_connection], sUniqId)
-        when :image
+         when :image
             required?(hParams, :compute_connection)
             HPCompute.get_image(hParams[:compute_connection], sUniqId)
          when :network
             required?(hParams, :network_connection)
             HPNetwork.get_network(hParams[:network_connection], sUniqId)
+         when :keypairs
+            required?(hParams, :compute_connection)
+            HPKeyPairs.get_keypair(hParams[:compute_connection], sUniqId)
          else
             forjError "'%s' is not a valid object for 'get'" % sObjectType
       end
@@ -339,21 +346,21 @@ class HpcloudController < BaseController
                yield(value)
             }
          else
-            forjError "'%s' is not a valid list for 'each'" % oFogObject.class
+            Error "'%s' is not a valid list for 'each'" % oFogObject.class
       end
    end
 
    def get_attr(oControlerObject, key)
       begin
          if oControlerObject.is_a?(Excon::Response)
-            rhGet(oControlerObject.data, :body, key)
+            Lorj::rhGet(oControlerObject.data, :body, key)
          else
             attributes = oControlerObject.attributes
             raise "attribute '%s' is unknown in '%s'. Valid one are : '%s'" % [key[0], oControlerObject.class, oControlerObject.class.attributes ] unless oControlerObject.class.attributes.include?(key[0])
-            rhGet(attributes, key)
+            Lorj::rhGet(attributes, key)
          end
       rescue => e
-         forjError "Unable to map '%s'. %s" % [key, e.message]
+         Error "Unable to map '%s'. %s" % [key, e.message]
       end
    end
 
@@ -364,7 +371,7 @@ class HpcloudController < BaseController
          raise "attribute '%s' is unknown in '%s'. Valid one are : '%s'" % [key[0], oControlerObject.class, oControlerObject.class.attributes ] unless oControlerObject.class.attributes.include?(key[0])
          Lorj::rhSet(attributes, value, key)
       rescue => e
-         forjError "Unable to map '%s' on '%s'" % [key, sObjectType]
+         Error "Unable to map '%s' on '%s'" % [key, sObjectType]
       end
    end
 
@@ -372,11 +379,11 @@ class HpcloudController < BaseController
    def update(sObjectType, oObject, hParams)
       case sObjectType
          when :router
-            forjError "Object to update is nil" if oObject.nil?
+            Error "Object to update is nil" if oObject.nil?
 
             HPNetwork.update_router(oObject[:object])
          else
-            forjError "'%s' is not a valid list for 'update'" % oFogObject.class
+            Error "'%s' is not a valid list for 'update'" % oFogObject.class
       end
    end
 
@@ -396,7 +403,7 @@ class HpcloudController < BaseController
                hServiceToFind = oParams[:list_services]
             end
             # Search for service. Ex: Can be :Networking or network. I currently do not know why...
-            hSearchServices= rhGet(hServices, :service_catalog)
+            hSearchServices= Lorj::rhGet(hServices, :service_catalog)
             sService = nil
             hServiceToFind.each { | sServiceElem |
                if hSearchServices.key?(sServiceElem)
@@ -405,15 +412,15 @@ class HpcloudController < BaseController
                end
             }
 
-            forjError "Unable to find services %s" % hServiceToFind if sService.nil?
-            result = rhGet(hServices, :service_catalog, sService).keys
+            Error "Unable to find services %s" % hServiceToFind if sService.nil?
+            result = Lorj::rhGet(hServices, :service_catalog, sService).keys
             result.delete("name")
             result.each_index { | iIndex |
                result[iIndex] = result[iIndex].to_s if result[iIndex].is_a?(Symbol)
             }
             return result
          else
-            forjError "'%s' is not a valid object for 'get_services'" % sObjectType
+            Error "'%s' is not a valid object for 'get_services'" % sObjectType
       end
    end
 end

data/lib/providers/hpcloud/compute.rb

@@ -105,4 +105,9 @@ module HPCompute
       # This list must support the each function.
       oAddress
    end
+
+   def HPCompute.delete_server(oComputeConnect, oServer)
+     oComputeConnect.servers.get(oServer.id).destroy
+   end
+
 end

data/lorj.gemspec

@@ -4,36 +4,39 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lorj/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "lorj"
+  spec.name          = 'lorj'
   spec.version       = Lorj::VERSION
-  spec.authors       = ["forj team"]
-  spec.email         = ["forj@forj.io"]
-  spec.summary       = %q{Process Controllers framework system}
-  spec.description   = %q{Framework to create/maintain uniform process, against any kind of controller.}
-  spec.homepage      = "https://github.com/forj-oss/lorj"
-  spec.license       = "Apache License, Version 2.0."
+  spec.authors       = ['forj team']
+  spec.email         = ['forj@forj.io']
+  spec.summary       = 'Process Controllers framework system'
+  spec.description   = <<-END
+  Framework to create/maintain uniform process, against any kind of controller.
+  This library is used by forj to become cloud agnostic.
+  END
+  spec.homepage      = 'https://github.com/forj-oss/lorj'
+  spec.license       = 'Apache License, Version 2.0.'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.1.0"
-  spec.rdoc_options << '--title' << 'Lorj - The Process Controllers framework system' <<
-  '--main' << 'README.md'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.rdoc_options << \
+    '--title Lorj - The Process Controllers framework system' << \
+    '--main README.md'
 
-#  spec.add_runtime_dependency 'thor', '~>0.16.0'
-#  spec.add_runtime_dependency 'nokogiri', '~>1.5.11'
-#  spec.add_runtime_dependency 'fog', '~>1.19.0'
-#  spec.add_runtime_dependency 'hpcloud', '~>2.0.9'
-#  spec.add_runtime_dependency 'git', '>=1.2.7'
-#  spec.add_runtime_dependency 'rbx-require-relative', '~>0.0.7'
-#  spec.add_runtime_dependency 'highline', '~> 1.6.21'
+  #  spec.add_runtime_dependency 'thor', '~>0.16.0'
+  #  spec.add_runtime_dependency 'nokogiri', '~>1.5.11'
+  #  spec.add_runtime_dependency 'fog', '~>1.19.0'
+  #  spec.add_runtime_dependency 'hpcloud', '~>2.0.9'
+  #  spec.add_runtime_dependency 'git', '>=1.2.7'
+  #  spec.add_runtime_dependency 'rbx-require-relative', '~>0.0.7'
+  spec.add_runtime_dependency 'highline', '~> 1.6.21'
   spec.add_runtime_dependency 'ansi', '>= 1.4.3'
-#  spec.add_runtime_dependency 'bundler'
-#  spec.add_runtime_dependency 'encryptor', '1.3.0'
-#  spec.add_runtime_dependency 'json', '1.7.5'
-
+  #  spec.add_runtime_dependency 'bundler'
+  spec.add_runtime_dependency 'encryptor', '1.3.0'
+  #  spec.add_runtime_dependency 'json', '1.7.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorj
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - forj team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.21
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.21
 - !ruby/object:Gem::Dependency
   name: ansi
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,23 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.3
-description: Framework to create/maintain uniform process, against any kind of controller.
+- !ruby/object:Gem::Dependency
+  name: encryptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: |2
+    Framework to create/maintain uniform process, against any kind of controller.
+    This library is used by forj to become cloud agnostic.
 email:
 - forj@forj.io
 executables:
@@ -137,10 +167,8 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --title
-- Lorj - The Process Controllers framework system
-- --main
-- README.md
+- --title Lorj - The Process Controllers framework system
+- --main README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -162,3 +190,4 @@ summary: Process Controllers framework system
 test_files:
 - spec/forj-account_spec.rb
 - spec/forj-config_spec.rb
+has_rdoc: