omf_common 6.1.3.pre.1 → 6.1.3.pre.2

data/Gemfile

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

data/lib/omf_common/comm/amqp/amqp_communicator.rb

@@ -127,17 +127,14 @@ module OmfCommon
           begin
             last_reported_timestamp = nil
             @session = ::AMQP.connect(@url, @opts) do |connection|
-              connection.on_connection_interruption do |conn|
-                warn "Conn detected connection interruption"
+              connection.on_tcp_connection_loss do |conn, settings|
+                now = Time.now
+                if last_reported_timestamp == nil || (now - last_reported_timestamp) > 60
+                  warn "Lost connectivity. Trying to reconnect..."
+                  last_reported_timestamp = now
+                end
+                _reconnect(conn)
               end
-              #connection.on_tcp_connection_loss do |conn, settings|
-              #  now = Time.now
-              #  if last_reported_timestamp == nil || (now - last_reported_timestamp) > 60
-              #    warn "Lost connectivity. Trying to reconnect..."
-              #    last_reported_timestamp = now
-              #  end
-              #  _reconnect(conn)
-              #end
               @channel  = ::AMQP::Channel.new(connection)
               @channel.auto_recovery = true
 

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" }})
+  #
+  #
+  # @example Use AMQP for communication in :development mode
+  #
+  #   OmfCommon.init(:development, { communication: { url: "amqp://localhost" }})
+  #
+  # @example Change Logging configuration
   #
-  # Initialize the OMF runtime.
-  # Options are:
-  #    :communication
-  #      :type
-  #      ... specific opts
-  #    :eventloop
-  #      :type {:em|:local...}
+  #   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,8 +286,49 @@ 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
 
@@ -275,7 +357,11 @@ module OmfCommon
           date_method: topts.delete(:date_method)
         }
 
-        appender_opts = topts.merge(layout: Logging.layouts.pattern(pattern_opts))
+        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
@@ -286,6 +372,8 @@ module OmfCommon
           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

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omf_common
 version: !ruby/object:Gem::Version
-  version: 6.1.3.pre.1
+  version: 6.1.3.pre.2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -107,22 +107,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: blather
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement