omf_common 6.1.3 → 6.1.4.pre.1

data/Gemfile

@@ -6,3 +6,7 @@ gemspec
 group :test do
   gem 'rake'
 end
+
+group :xmpp do
+  gem 'blather'
+end

data/lib/omf_common/comm/xmpp/communicator.rb

@@ -3,8 +3,21 @@
 # You should find a copy of the License in LICENSE.TXT or at http://opensource.org/licenses/MIT.
 # By downloading or using this software you accept the terms and the liability disclaimer in the License.
 
-require 'blather'
-require 'blather/client/dsl'
+begin
+  require 'blather'
+  require 'blather/client/dsl'
+rescue LoadError => e
+  error <<-ERR
+#{e.message}
+
+# Looks like you are trying to use XMPP as your communication protocol but you have not installed XMPP library 'blather'
+#
+# To correct this, install blather. E.g.
+#
+#   gem install blather
+  ERR
+  exit(1)
+end
 
 require 'omf_common/comm/xmpp/xmpp_mp'
 require 'omf_common/comm/xmpp/topic'

data/lib/omf_common.rb

@@ -17,6 +17,8 @@ require 'omf_common/auth'
 require 'omf_common/core_ext/string'
 require 'omf_common/eventloop'
 
+require 'oml4r/logging/oml4r_appender'
+
 include OmfCommon::DefaultLogging
 
 # Set the default encoding to UTF8
@@ -132,15 +134,54 @@ module OmfCommon
     }
   }
 
+  # Initialise the OMF runtime.
+  #
+  # The options here can be customised via EC or RC's configuration files.
+  #
+  # Given the following example EC configuration file (YAML format):
+  #
+  #   environment: development
+  #   communication:
+  #     url: amqp://localhost
+  #
+  # OMF runtime will be configured as:
+  #
+  #   OmfCommon.init(:development, { communication: { url: "amqp://localhost" }})
+  #
   #
-  # Initialize the OMF runtime.
-  # Options are:
-  #    :communication
-  #      :type
-  #      ... specific opts
-  #    :eventloop
-  #      :type {:em|:local...}
+  # @example Use AMQP for communication in :development mode
   #
+  #   OmfCommon.init(:development, { communication: { url: "amqp://localhost" }})
+  #
+  # @example Change Logging configuration
+  #
+  #   options = {
+  #     communication: { url: "amqp://localhost" },
+  #     logging: {
+  #       level: { default: 'debug' },
+  #         appenders: {
+  #           stdout: {
+  #             level: :info,
+  #             date_pattern: '%H:%M:%S',
+  #             pattern: '%d %5l %c{2}: %m\n'
+  #           },
+  #           rolling_file: {
+  #             level: :debug,
+  #             log_dir: '/var/tmp',
+  #             size: 1024*1024*50, # max 50mb of each log file
+  #             keep: 5, # keep a 5 logs in total
+  #             date_pattern: '%F %T %z',
+  #             pattern: '[%d] %-5l %c: %m\n'
+  #           },
+  #         }
+  #      }
+  #   }
+  #
+  #   OmfCommon.init(:development, options)
+  #
+  # @see _init_logging
+  #
+  # @param [Symbol] op_mode
   # @param [Hash] opts
   #
   def self.init(op_mode, opts = {}, &block)
@@ -245,34 +286,52 @@ module OmfCommon
     yh
   end
 
-  # DO NOT CALL DIRECTLY
+  # DO NOT CALL THIS METHOD DIRECTLY
+  #
+  # By providing logging section via init method, you could custom how logging messages could be written.
   #
+  # @example Change default logging level to :default, but :info under OmfEc namespace
+  #
+  #   {
+  #     logging: {
+  #       level: { default: 'debug', 'OmfEc' => 'info' }
+  #     }
+  #   }
+  #
+  # @example Write logging message to STDOUT, OML, and ROLLING_FILE
+  #   {
+  #     logging: {
+  #       level: { default: 'debug' }, # root logger set to level :debug
+  #       appenders: {
+  #         stdout: {
+  #           level: :info,
+  #           date_pattern: '%H:%M:%S', # show hours, mintues, seconds
+  #           pattern: '%d %5l %c{2}: %m\n' # show date time, logging level, namespace/class
+  #         },
+  #         rolling_file: {
+  #           level: :debug,
+  #           log_dir: '/var/tmp', # files go to /var/tmp
+  #           log_file: 'bob', # name of file
+  #           size: 1024*1024*50, # max 50mb of each log file
+  #           keep: 5, # keep a 5 logs in total
+  #           date_pattern: '%F %T %z', # shows date, time, timezone
+  #           pattern: '[%d] %-5l %c: %m\n'
+  #         },
+  #         oml4r: {
+  #           appName: 'bob', # OML appName
+  #           domain: 'bob_2345', # OML domain (database name)
+  #           collect: 'tcp:localhost:3003' # OML server
+  #         }
+  #       }
+  #     }
+  #   }
+  #
+  # @note OmfCommon now ONLY provides support for STDOUT, OML, FILE, and ROLLING_FILE.
+  #
+  # @param [Hash] opts
   def self._init_logging(opts = {})
     logger = Logging.logger.root
-    if appenders = opts[:appenders]
-      logger.clear_appenders
-      appenders.each do |type, topts|
-        case type.to_sym
-        when :stdout
-          $stdout.sync = true
-          logger.add_appenders(
-            Logging.appenders.stdout('custom',
-              :layout => Logging.layouts.pattern(topts)
-          ))
 
-        when :file
-          dir_name = topts.delete(:log_dir) || DEF_LOG_DIR
-          file_name = topts.delete(:log_file) || "#{File.basename($0, File.extname($0))}.log"
-          path = File.join(dir_name, file_name)
-          logger.add_appenders(
-            Logging.appenders.file(path,
-              :layout => Logging.layouts.pattern(topts)
-          ))
-        else
-          raise "Unknown logging appender type '#{type}'"
-        end
-      end
-    end
     if level = opts[:level]
       if level.is_a? Hash
         # package level settings
@@ -287,6 +346,39 @@ module OmfCommon
         logger.level = level.to_sym
       end
     end
+
+    if appenders = opts[:appenders]
+      logger.clear_appenders
+      appenders.each do |type, topts|
+        pattern_opts = {
+          pattern:  topts.delete(:pattern),
+          date_pattern: topts.delete(:date_pattern),
+          color_scheme: topts.delete(:color_scheme),
+          date_method: topts.delete(:date_method)
+        }
+
+        if pattern_opts[:pattern]
+          appender_opts = topts.merge(layout: Logging.layouts.pattern(pattern_opts))
+        else
+          appender_opts = topts
+        end
+
+        case type.to_sym
+        when :stdout
+          $stdout.sync = true
+          logger.add_appenders(Logging.appenders.stdout('custom_stdout', appender_opts))
+        when :file, :rolling_file
+          dir_name = topts.delete(:log_dir) || DEF_LOG_DIR
+          file_name = topts.delete(:log_file) || "#{File.basename($0, File.extname($0))}.log"
+          path = File.join(dir_name, file_name)
+          logger.add_appenders(Logging.appenders.send(type, path, appender_opts))
+        when :oml4r
+          logger.add_appenders(Logging.appenders.oml4r('oml4r', appender_opts))
+        else
+          raise "Unknown logging appender type '#{type}'"
+        end
+      end
+    end
   end
 
   def self._rec_merge(this_hash, other_hash)

data/omf_common.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "mocha"
 
   s.add_runtime_dependency "eventmachine"
-  s.add_runtime_dependency "blather"
   s.add_runtime_dependency "logging"
   s.add_runtime_dependency "hashie"
   s.add_runtime_dependency "oml4r", "~> 2.10.1"

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: omf_common
 version: !ruby/object:Gem::Version
-  version: 6.1.3
+  version: 6.1.4.pre.1
+  prerelease: 6
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: evented-spec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -83,6 +94,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -90,20 +102,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: blather
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -111,6 +110,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,6 +118,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -125,6 +126,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -132,6 +134,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -139,6 +142,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: oml4r
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -146,6 +150,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -153,6 +158,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -160,6 +166,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -167,6 +174,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json-jwt
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -174,6 +182,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -181,6 +190,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: amqp
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -188,6 +198,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -195,6 +206,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -202,6 +214,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -304,49 +317,26 @@ files:
 homepage: http://omf.mytestbed.net
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: omf_common
-rubygems_version: 2.1.10
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Common library of OMF
-test_files:
-- test/fixture/1st_level.pem
-- test/fixture/2nd_level.pem
-- test/fixture/alice-cert.pem
-- test/fixture/alice-key.pem
-- test/fixture/omf_test.cert.pem
-- test/fixture/omf_test.pem
-- test/fixture/omf_test.pub
-- test/fixture/omf_test.pub.pem
-- test/fixture/pubsub.rb
-- test/fixture/rc.pem
-- test/fixture/root.pem
-- test/omf_common/auth/certificate_spec.rb
-- test/omf_common/auth/certificate_store_spec.rb
-- test/omf_common/auth/ssh_pub_key_convert_spec.rb
-- test/omf_common/comm/amqp/communicator_spec.rb
-- test/omf_common/comm/topic_spec.rb
-- test/omf_common/comm/xmpp/communicator_spec.rb
-- test/omf_common/comm/xmpp/topic_spec.rb
-- test/omf_common/comm_spec.rb
-- test/omf_common/command_spec.rb
-- test/omf_common/core_ext/string_spec.rb
-- test/omf_common/message/xml/message_spec.rb
-- test/omf_common/message_spec.rb
-- test/test_helper.rb
+test_files: []

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDUxYzc4NjE0ZTNlMzQwZDI2YWY3YWZlZmJmMDg0YjljMWY2ZmE2Mg==
-  data.tar.gz: !binary |-
-    NWU2MTQ0NmZkM2RhOTllOTJiYTAxODg3MTdlNTEzY2JmM2E1YTg3ZA==
-SHA512:
-  metadata.gz: !binary |-
-    ZDMzNDVlODI4OWRmYTA3YWFkMzc0MTgzYzdiMzQxZDI3ZTliMTEwODZhMWI4
-    YWNiNDMyMzAwOWEyYjY5NjczYmI5OWYzNjY2Mzg0MWNjYzcwYTg5OGFlODYx
-    MDNmNmFmYzllMTMxODk4YzcyZjZmNGIxNjdmNjg5ZDIyMjAwY2M=
-  data.tar.gz: !binary |-
-    ODQ5ZGEzOWY5ODBlYTczMDAxMzI4ZjRiODZiNTk3MzUzZjEyMmI2OWY3Njdl
-    ZTU4ZDMwZTliZTI3MTVjZmQ0YmY4NmFiNzA5MTc5YTE5MmRkZDc4ZWI4ZTVi
-    ZGY2M2VlZGZhOTFlNjgyNjQyMTBlZDg1YmJhNzhmMTMyNjRkYTU=