exologger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0ea86ab7c2ee081011c5e0cd113bb90c205039b
+  data.tar.gz: 545aae4d51274a5ea754e58b9f475f21578ed0c9
+SHA512:
+  metadata.gz: 2303cdce8dfdb6b08618d7d4d7d60dfed0a0ad62668541fa320fc032684284540d7d77cb30fb4839da8f4457af67eb4d54f23878109edf33293d60c29bd7b7ce
+  data.tar.gz: f0fbd97df08008963f2eff370471c3e4800476ca4381ce2d2a65fe5cfa0cfab051b04a10c00dc80098a43598b748ee98c541d57b5604b724bf6391f4557ae05e

data/lib/exologger.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'log4r'
+
+$pattern_formatter_params = {:pattern => "%l, %d, %c, %M", :date_pattern => "%Y-%m-%d %H:%M:%S"}
+$pattern_formatter = Log4r::PatternFormatter.new $pattern_formatter_params
+$stdout_outputter = Log4r::Outputter.stdout
+$stdout_outputter.formatter = $pattern_formatter
+
+module Exologger
+
+  # The method returns a log4r logger which outputs to stdout in a
+  # standard format followed across all services at Exotel
+  # log4r ref: http://log4r.rubyforge.org/manual.html
+  def self.get_logger(name)
+    raise ArgumentError, "Logger must have a name", caller if name.nil?
+    exologger = Log4r::Logger.new name
+    exologger.outputters = $stdout_outputter
+    return exologger
+  end
+
+  # standard formatter to be used across all services. If you are using a a custom
+  # outputter, you should configure the outputter with the formatter returned
+  # by this method
+  def self.get_formatter
+    return $pattern_formatter
+  end
+end

data/test/exologger_test.rb

@@ -0,0 +1,40 @@
+require 'test/unit'
+require_relative "../lib/exologger.rb"
+
+class ExologgerTest < Test::Unit::TestCase
+
+  def testLoggerInstantiation
+    logger = Exologger.get_logger "logger1"
+    assert_instance_of(Log4r::Logger, logger, 'logger is not an instance of log4r')
+    assert_equal(1, logger.outputters.size, "Expected only one outputter. But, found more than one")
+    assert_instance_of(Log4r::StdoutOutputter, logger.outputters.first, 'outputter is not an instance of StdoutOutputter')
+    assert_instance_of(Log4r::PatternFormatter, logger.outputters.first.formatter, 'formatter is not an instance of PatternFormatter')
+    assert_equal("logger1", logger.name)
+  end
+
+  def testLogMessageFormat
+    logger = Exologger.get_logger "logger2"
+    stringIO = StringIO.new
+    stringIOOutputter = Log4r::IOOutputter.new("stringio", stringIO)
+    stringIOOutputter.formatter = Exologger.get_formatter
+    logger.outputters = [stringIOOutputter]
+    logger.debug "test message1"
+    if !(stringIO.string =~ /DEBUG, [0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2} [0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}, logger2, test message1/)
+      logs = stringIO.string
+      assert(false, "wrong log message format: #{logs}")
+    end
+  end
+
+  def testMultiLineLogMessage
+    logger = Exologger.get_logger "logger3"
+    stringIO = StringIO.new
+    stringIOOutputter = Log4r::IOOutputter.new("stringio", stringIO)
+    stringIOOutputter.formatter = Exologger.get_formatter
+    logger.outputters = [stringIOOutputter]
+    logger.info "test multiline message \n line1 \n line2 \t\n line3 \t\n\n"
+    if !(stringIO.string =~ /INFO, [0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2} [0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}, logger3, test multiline message \n line1 \n line2 \t\n line3 \t\n\n/)
+      logs = stringIO.string
+      assert(false, "wrong log message format: #{logs}")
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: exologger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vishnu Gajendran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  A simple wrapper around Log4r logger to ensure
+    that all service logs follow a standard format
+email: vishnu.gajendran@exotel.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/exologger.rb
+- test/exologger_test.rb
+homepage: http://rubygems.org/gems/exologger
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Logger used across services at Exotel
+test_files: []