mojo_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc5077befcd1a3215bfc2bc080e94e1ab3810479
+  data.tar.gz: f63f06a080617ba976d3b8270b3809d6ed58bf9f
+SHA512:
+  metadata.gz: 14b21d9122cebc7b95d94a577c4dc761ade4abfc6ab78b54b357a51f854ede05afb05ee31fa71872aa92ef81e471673b8fae61e81035bf0d43bf66e492019087
+  data.tar.gz: e84d470a60e7d395b2e9b938957ca80a6cffbe4b56392075f141de37a21b399d150b50204e99c8c41e83d139e4ef290bb58a34183298528ee7665fbb28c4267d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mojo_logger.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Autodesk, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# MojoLogger
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mojo_logger`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mojo_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mojo_logger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mojo_logger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mojo_logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/conf/log4j.properties

@@ -0,0 +1,11 @@
+log4j.rootLogger = INFO, CONSOLE
+
+######################## Add CONSOLE APPENDER ##############################
+######## Comment this section out to suppress local console logging ########
+log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
+log4j.appender.CONSOLE.Threshold=DEBUG
+log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
+log4j.appender.CONSOLE.layout.ConversionPattern={ "time": "%d{MM-dd-yyyy HH:mm:ss.SSS XX}", "log": %m } %n
+##############################################################################
+
+

data/lib/mojo_logger/appender.rb

@@ -0,0 +1,82 @@
+module MojoLogger
+  class Appender
+
+    ACCEPTABLE_LOG_LEVELS = [
+      "DEBUG",
+      "INFO",
+      "WARN",
+      "ERROR",
+      "FATAL"
+    ]
+
+    attr_reader :name, :level, :file
+    attr_accessor :pattern, :max_file_size, :max_backup_index
+
+    def initialize(name, opts={})
+      @name = name
+      set_defaults(opts)
+    end
+
+    def level=(lvl)
+      l = lvl.to_s.upcase
+      raise "InvalidLogLevel" unless valid_log_level?(l)
+      @level = l
+    end
+
+    def file=(file)
+      #raise "FileNotFound" unless File.exist?(file)
+      @type = :file
+      @file = file #File.expand_path(file)
+    end
+
+    def generate_properties_string
+      properties = generate_generic_properties
+      properties += generate_file_properties if @file
+      properties
+    end
+
+    private
+
+    def valid_log_level?(lvl)
+      ACCEPTABLE_LOG_LEVELS.include?(lvl)
+    end
+
+    def set_defaults(opts={})
+      @type = :console
+      @max_file_size    = opts[:max_file_size]    || '10MB'
+      @max_backup_index = opts[:max_backup_index] || '10'
+      @pattern          = opts[:pattern]          || '%n %m %n'
+
+      self.level=(opts[:level]) if opts[:level]
+      self.file=(opts[:file]) if opts[:file]
+    end
+
+    def property_header
+      "log4j.appender.#{@name}"
+    end
+
+    def generate_generic_properties
+      properties = "#{property_header}=#{log4j_type}\n"
+      properties += "#{property_header}.layout=org.apache.log4j.PatternLayout\n"
+      properties += "#{property_header}.layout.ConversionPattern=#{@pattern}\n"
+      properties += "#{property_header}.Threshold=#{@level}\n" if @level
+      properties
+    end
+
+    def generate_file_properties
+      properties = "#{property_header}.file=#{@file}\n"
+      properties += "#{property_header}.MaxFileSize=#{@max_file_size}\n"
+      properties += "#{property_header}.MaxBackupIndex=#{@max_backup_index}\n"
+      properties
+    end
+
+    def log4j_type
+      if @type == :file
+        "org.apache.log4j.RollingFileAppender"
+      else
+        "org.apache.log4j.ConsoleAppender"
+      end
+    end
+
+  end
+end

data/lib/mojo_logger/configurator.rb

@@ -0,0 +1,80 @@
+
+
+module MojoLogger
+  class Configurator
+    # stringio = StringIO.new(s)
+    # jstrinio = org.jruby.util.IOInputStream.new(stringio)
+    # logger = Java::org.apache.log4j.PropertyConfigurator.configure(jstringio)
+    # logger = Java::org.apache.log4j.Logger.getLogger('Mojo')
+    #
+
+    attr_reader :properties_file
+
+    def initialize()
+      @default_appender = MojoLogger::Appender.new("MojoLogger")
+      @default_appender.level = "DEBUG"
+      @use_default_appender = true
+      @appenders = []
+    end
+
+    def default_log_level
+      @default_appender.level
+    end
+
+    def default_log_level=(lvl)
+      @default_appender.level = lvl
+    end
+
+    def log_file=(file)
+      @default_appender.file = file
+    end
+
+    def properties_file=(file)
+      raise "FileNotFound" unless File.exist?(file)
+      @type = :file
+      @properties_file = File.expand_path(file)
+    end
+
+    def custom_line(line)
+      @custom_lines ||= []
+      @custom_lines << line
+    end
+
+    def add_appender(appender)
+      raise "InvalidAppender" unless appender.is_a?(MojoLogger::Appender)
+      @appenders << appender
+    end
+
+    def generate_properties_string
+      properties = "#{generate_root_logger_line}\n"
+      properties += "#{generate_custom_lines}\n"
+      properties += "#{generate_appender_lines}\n"
+      properties
+    end
+
+    private
+
+    def generate_root_logger_line
+      "log4j.rootLogger=#{default_log_level}#{list_appenders}"
+    end
+
+    def list_appenders
+      names = @appenders.map { |a| a.name }
+      names.unshift(@default_appender.name) if @use_default_appender
+      ", #{names.join(',')}"
+    end
+
+    def generate_custom_lines
+      "#{@custom_lines.join("\n") if @custom_lines}"
+    end
+
+    def generate_appender_lines
+      lines = ''
+      lines += @default_appender.generate_properties_string if @use_default_appender
+      lines += "#{@appenders.map { |a| a.generate_properties_string }.join("\n") }"
+
+      lines
+    end
+
+  end
+end

data/lib/mojo_logger/mojo_logger.rb

@@ -0,0 +1,90 @@
+require 'java'
+require 'time'
+require 'json'
+require_relative '../../jars/log4j-1.2.17.jar'
+
+module MojoLogger
+
+  def mojo_debug(*args)
+    MojoLogger.mojo_debug(*args)
+  end
+
+  def mojo_info(*args)
+    MojoLogger.mojo_info(*args)
+  end
+
+  def mojo_warn(*args)
+    MojoLogger.mojo_warn(*args)
+  end
+
+  def mojo_error(*args)
+    MojoLogger.mojo_error(*args)
+  end
+
+  def logger
+    MojoLogger.logger
+  end
+
+  class << self
+
+    def logger
+      @@logger ||= configure_logger
+    end
+
+    def mojo_msg(api_request, category, message, options=nil)
+      msg = {
+        'time' => Time.now.utc.strftime("%m-%d-%Y %H:%M:%S.%L %z"),
+        'app' => "Mojo",
+        'session_id' => api_request[:session_id],
+        'reference_id' => api_request[:reference_id],
+        'api' => api_request[:api],
+        'category' => category,
+        'message' => message
+      }
+
+      msg.merge!(options) if options
+      msg.to_json
+    end
+
+    def mojo_debug(*args)
+      logger.debug(mojo_msg(*args))
+    end
+
+    def mojo_info(*args)
+      logger.info(mojo_msg(*args))
+    end
+
+    def mojo_warn(*args)
+      logger.warn(mojo_msg(*args))
+    end
+
+    def mojo_error(*args)
+      logger.error(mojo_msg(*args))
+    end
+
+
+    def config
+      @@config = MojoLogger::Configurator.new
+
+      yield(@@config) if block_given?
+
+      @@logger = configure_logger
+      @@config
+    end
+
+
+  private
+
+    def configure_logger
+      @@config ||= MojoLogger::Configurator.new
+
+      stringio = StringIO.new(@@config.generate_properties_string)
+      java_stringio = org.jruby.util.IOInputStream.new(stringio)
+
+      Java::org.apache.log4j.PropertyConfigurator.configure(java_stringio)
+      Java::org.apache.log4j.Logger.getLogger('MojoLogger')
+    end
+
+  end # End 'class' methods
+
+end

data/lib/mojo_logger/version.rb

@@ -0,0 +1,3 @@
+module MojoLogger
+  VERSION = "0.1.0"
+end

data/lib/mojo_logger.rb

@@ -0,0 +1,7 @@
+require_relative 'mojo_logger/version'
+require_relative 'mojo_logger/mojo_logger'
+require_relative 'mojo_logger/configurator'
+require_relative 'mojo_logger/appender'
+
+module MojoLogger
+end

data/mojo_logger.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mojo_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mojo_logger"
+  spec.version       = MojoLogger::VERSION
+  spec.authors       = ["John Thomas"]
+  spec.email         = ["john.thomas@autodesk.com"]
+
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  #end
+
+  spec.summary       = "log4j wrapper that handles logging in the Mojo framework."
+  spec.description   = %q{ This gem is a wrapper around log4j that allow you to
+  construct a log4j.properties file from a config block, rather than actually
+  having a log4j.properties file. Useful for setting the log levels dynamically.
+}
+  spec.homepage      = "https://github.com/thomas07vt/mojo_logger/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: mojo_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Thomas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2015-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: |2
+   This gem is a wrapper around log4j that allow you to
+    construct a log4j.properties file from a config block, rather than actually
+    having a log4j.properties file. Useful for setting the log levels dynamically.
+email:
+- john.thomas@autodesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- conf/log4j.properties
+- jars/log4j-1.2.17.jar
+- lib/mojo_logger.rb
+- lib/mojo_logger/appender.rb
+- lib/mojo_logger/configurator.rb
+- lib/mojo_logger/mojo_logger.rb
+- lib/mojo_logger/version.rb
+- mojo_logger.gemspec
+homepage: https://github.com/thomas07vt/mojo_logger/
+licenses:
+- MIT
+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.4.6
+signing_key:
+specification_version: 4
+summary: log4j wrapper that handles logging in the Mojo framework.
+test_files: []