logger_json 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bf667f25b2c54910ab3e5699df13fa6fb73ae0aa5938971c55accf84534bb37
-  data.tar.gz: 6f40a187db5aea92b1ad3b05ec0f7e43db7adf4aced004e544da7edb05adf095
+  metadata.gz: e65dc39558895b55dc0680b2ce613730a9e6e95cfb19fc84dc62e680c1c637d4
+  data.tar.gz: eecf814bb917975a3508ff9df08a34946a8309e1a76f09a000f2b48684291394
 SHA512:
-  metadata.gz: 01a57b5dac44cac2c73a3a7c6aa80fa15433b8e80c41ae8add3e748cb37128d19908e54dc6030bf3349dd4f84d962d1f7fde3120d907d2e1573b11a7f15b159b
-  data.tar.gz: 98dfbbd52f7cd6f5f267f1bd88d55ea602baddbc3de31a98533bda21bc539086d6f3fed563673ffbfec34ea56ddbbdf76e62801bee5f80e0eda61e2de825d24e
+  metadata.gz: e8fe54cbac887f552fc4e364e1fa343677a664fad7ef8da9298a74550873c3987cb4f16a8ca1bb959562f6bca4f0236dbc6554471d4b2cdbca51ddf085bd19cc
+  data.tar.gz: 89776b2814cb9756097de973f6e22470b63d0e339d1b3bd4e72dc39cc8a03292339b1252ce30fd9e7d6e583a8384605a74ae58717a7e7ebc18f5d989093dbe74

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### 1.0.4 - 2020-02-06
+
+- bug fixes
+  - Fixed the host attribute in model json
+  - Fixed the system not found log folder error 
+
+### 1.1.0 - 2020-02-07
+
+- enhancements
+  - Support Syslog/logger
+  - changed the display of a json parameter in hash format

data/README.md

@@ -1,4 +1,4 @@
-**LoggerJson** is a gem written in Ruby that adds new functionality, without changing the function of the [Logger](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html) class methods, which creates the logs in the json format.
+**LoggerJson** is a gem written in Ruby that adds new functionality, without changing the function of the [Logger](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html) or [Syslog::Logger](https://docs.ruby-lang.org/en/2.1.0/Syslog/Logger.html) classes methods, which creates the logs in the json format.
 
 **Getting started**
 
@@ -11,13 +11,7 @@ gem install logger_json
 Or add the following line to your  `Gemfile`:
 
 ```ruby
-gem 'logger_json', '~> 1.0', '>= 1.0.4'
-```
-
-Before `version 1.0.4` you have to create a logs folder, if you don't have one:
-
-```ruby
-mkdir logs
+gem 'logger_json'
 ```
 
 Then run `bundle install`
@@ -28,9 +22,10 @@ Just initialize the gem and watch the magic happen
 require 'logger_json'
 ```
 
-If you don't create a Logger with specified file, don't be discouraged, you can set a default output for json logs
+If you don't create a Logger with specified file, don't be discouraged, you can set a environment var or ruby path var
 
 ```ruby
+ENV['LOG_PATH'] #or
 LoggerJson::Text::PATH = 'path_you_desire'
 ```
 
@@ -39,9 +34,9 @@ LoggerJson::Text::PATH = 'path_you_desire'
 ```ruby
       {
         date: "2020-02-05T13:46:11.026134758+00:00", #iso8601
-        host: "https://www.r7.com/",
+        host: "172.0.0.10",
         thread: 'current_thread',
-        methods: ['create_json'],
+        methods: ['create_json', 'run', ... , ''],
         level: 'info',
         message: 'LoggerJson is a gem written in Ruby that ...'
       }
@@ -49,17 +44,30 @@ LoggerJson::Text::PATH = 'path_you_desire'
 
 **To add parameters in the json logger**
 
+1. Logger class
+
 ```ruby
 more_params = {key1: data, key2: data ... keyN: data}
 Logger.new('output').warn(message, more_params)
 ```
 
+2. Syslog::Logger class
+
+```ruby
+LoggerJson::Text::PATH = './logs/logs-json.log'
+logger = Syslog::Logger.new 'logger_json'
+more_params = {key1: data, key2: data ... keyN: data}
+logger.info(message, more_params)
+```
+
 **Compatibility**
 
 - Ruby 1.9+
 
 **Running tests**
 
+Download the source code
+
 LoggerJson uses [Mini Test](https://github.com/seattlerb/minitest) as test framework.
 
 * Ruby version > 2.0

data/lib/core/logger_json_core.rb

@@ -0,0 +1,30 @@
+module LoggerJsonCore
+  def self.included(klass)
+    %w{debug info warn error fatal}.each do |level|
+      klass.send(:alias_method, "old_#{level}", level)
+
+      block = Proc.new do |*args, &block|
+        create_file args, level
+        return send("old_#{level}", args[0]) { block.call } unless block.nil?
+        send "old_#{level}", args[0]
+      end
+
+      klass.send(:define_method, level, block)
+    end
+  end
+
+  private
+
+  def create_file(message, type=:info)
+    path = filename || ENV['LOG_PATH'] || LoggerJson::Text::PATH
+    json = LoggerJson::Model.new(message, type).json
+    LoggerJson::Writter.logger_json(path, json)
+  end
+
+  def filename
+    return unless defined?(Syslog::Logger).nil?
+    path = instance_variable_get('@logdev').filename
+    return if path.nil?
+    path.gsub('.log','-json.log')
+  end
+end

data/lib/logger_json.rb

@@ -1,30 +1,34 @@
 # frozen_string_literal: true
 
-if defined?(JSON).nil?
+unless defined?(JSON)
   require 'json'
 end
 
-if defined?(DateTime).nil?
+unless defined?(DateTime)
   require 'date'
 end
 
+unless defined?(Socket)
+  require 'socket'
+end
+
+require 'logger_json/text'
+require 'logger_json/writter'
+require 'logger_json/model'
+
 def load_logger_json
-  if defined?(Logger).nil?
+  unless defined?(Logger)
     require 'logger'
   end
-
-  require 'logger_json/text'
+  require 'core/logger_json_core'
   Logger.new(STDOUT).info(LoggerJson::Text::LOGGER_JSON)
-
   require 'logger_json/logger'
-  require 'logger_json/writter'
-  require 'logger_json/json/model'
-  require 'logger_json/json/logger'
 end
 
 def load_syslog_json
-  require 'syslog_json/text'
-  Logger.new(STDOUT).info(Syslog::Text::LOGGER_JSON)
+  require 'core/logger_json_core'
+  Logger.new(STDOUT).info(LoggerJson::Text::SYSLOG_JSON)
+  require 'syslog_json/logger'
 end
 
 defined?(Syslog::Logger).nil? ? load_logger_json : load_syslog_json

data/lib/logger_json/logger.rb

@@ -1,21 +1,3 @@
-class Logger
-  class << self
-    def json_path
-      LoggerJson::Text::PATH
-    end
-  end
-
-  private
-
-  def create_file(message, type=:info)
-    path = filename || Logger.json_path
-    json = LoggerJson::Model.new(message, type).json
-    LoggerJson::Writter.logger_json(path, json)
-  end
-
-  def filename
-    path = instance_variable_get("@logdev").filename
-    return if path.nil?
-    path.gsub(".log","-json.log")
-  end
+Logger.class_eval do
+  include LoggerJsonCore 
 end

data/lib/logger_json/{json/model.rb → model.rb}

@@ -12,14 +12,13 @@ module LoggerJson
     def convert_to_json(msg)
       return log(msg[0]).to_json if msg[1].nil?
       return (log(msg[0]).merge(msg[1])).to_json if msg[1].is_a? Hash
-      return add_array_in_log msg if msg[1].is_a? Array
-      add_string_in_log msg
+      add_in_log msg
     end
 
     def log(message)
       {
         date: DateTime.now.iso8601(9),
-        host: IO.popen('hostname').readlines[0].strip,
+        host: host.nil? ? "*" : host.ip_address,
         thread: Thread.current,
         methods: methods,
         level: @type,
@@ -41,10 +40,14 @@ module LoggerJson
       array.drop(5)
     end
 
-    def add_string_in_log(msg)
+    def add_in_log(msg)
       logs = log msg[0]
       logs[:log] = msg[1]
       logs.to_json
     end
+
+    def host
+      Socket.ip_address_list.detect{|intf| intf.ipv4_private?}
+    end
   end
-end
+end

data/lib/logger_json/text.rb

@@ -1,6 +1,7 @@
 module LoggerJson
   module Text
     LOGGER_JSON = 'From now on every log will generate a json'.freeze
+    SYSLOG_JSON = 'From now on every syslog will generate a json'.freeze
     PATH = nil
   end
 end

data/lib/logger_json/version.rb

@@ -1,3 +1,3 @@
 module LoggerJson
-  VERSION = "1.0.5".freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/syslog_json/logger.rb

@@ -0,0 +1,5 @@
+module Syslog
+  Logger.class_eval do
+    include LoggerJsonCore 
+  end
+end

data/logger_json.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["vfoliveira@rederecord.com.br"]
 
   spec.summary       = "Flexible Json Logger solution for Ruby"
-  spec.description   = "LoggerJson is a gem written in Ruby that adds new functionality, without changing the function of the Logger class methods, which creates the logs in json format."
+  spec.description   = "LoggerJson is a gem written in Ruby that adds new functionality, without changing the function of the Logger and Syslog::Logger class methods, which creates the logs in json format."
   spec.homepage      = "https://gitlab.ir7.com.br/r7/logger-json"
   spec.license       = "MIT"
   spec.required_ruby_version = '>= 1.9.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logger_json
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Vinicius Freire
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,8 +53,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: LoggerJson is a gem written in Ruby that adds new functionality, without
-  changing the function of the Logger class methods, which creates the logs in json
-  format.
+  changing the function of the Logger and Syslog::Logger class methods, which creates
+  the logs in json format.
 email:
 - vfoliveira@rederecord.com.br
 executables: []
@@ -69,14 +69,14 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- lib/core/logger_json_core.rb
 - lib/logger_json.rb
-- lib/logger_json/json/logger.rb
-- lib/logger_json/json/model.rb
 - lib/logger_json/logger.rb
+- lib/logger_json/model.rb
 - lib/logger_json/text.rb
 - lib/logger_json/version.rb
 - lib/logger_json/writter.rb
-- lib/syslog_json/text.rb
+- lib/syslog_json/logger.rb
 - logger_json.gemspec
 homepage: https://gitlab.ir7.com.br/r7/logger-json
 licenses:

data/lib/logger_json/json/logger.rb

@@ -1,11 +0,0 @@
-class Logger
-  %w{debug info warn error fatal}.each do |level|
-    alias_method "old_#{level}", level
-
-    define_method level do |*args, &block|
-      create_file args, level
-      return send("old_#{level}", args[0]) { block.call } unless block.nil?
-      send "old_#{level}", args[0]
-    end
-  end
-end

data/lib/syslog_json/text.rb

@@ -1,6 +0,0 @@
-module Syslog
-  module Text
-    SYSLOG_JSON = 'From now on every syslog will generate a json'.freeze
-    PATH = nil
-  end
-end