log_toolbox 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab0c74326566d3f63c41afe1b88201488141290e
-  data.tar.gz: e0808c1c4b47e113380cf9e2625d074e6ed10012
+SHA256:
+  metadata.gz: e7a0a82ef30745dbef3c5bc479a0be875fd881b015254b5650ce15c61611595c
+  data.tar.gz: 797f45b294bdabeaf068df140e3d278dfd20a5b2f23ff684f40d865703bec041
 SHA512:
-  metadata.gz: a27847e65bc3f4a509c83d9f53bfbbe9c7dc68009f9ac0b9b9cf415d5cadb2e6ea08fb2ef965c8ac11d5d56c7ed327cb1f486376485c1ddbf778d58e383b3119
-  data.tar.gz: ea248ffec06a96789ace5d7918b4be20d3b103b210bb09ccc0659cd4fa7a0ecacc5d724b98986277da99c363ce5b95735ff3de9092b3f1ee44985638da3060de
+  metadata.gz: 897098929dea4f4105c1eba591d3a133c33c8faada961f09d1e4dc959fd2f6b86801f69d4f863030bce531a5e9ab99706a84944f4f366604b9a1d55d149e5707
+  data.tar.gz: 9a2a119b9dcd418e86684678f24c2b0f49a87799a41d52b4593b907ac143b2b652c9984d2106e0d181c9f83f75848bee29f87c6666e5e9ab292ceb1d1933f572

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+spec/dummy/log/*
+spec/dummy/db/*.sqlite3
+spec/dummy/tmp/*

data/CHANGELOG.md

@@ -6,3 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Released] - 2019-05-21
 
+## [1.2.0] - 2019-07-24
+### Added
+- Add feature to change log level of your application at running time
+
+## [1.1.0] - 2019-05-30
+### Changed
+- Changed header correlation_id to activityID as requested by architecture team

data/Gemfile

@@ -2,3 +2,4 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in log_toolbox.gemspec
 gemspec
+gem 'sqlite3'

data/Gemfile.lock

@@ -1,15 +1,24 @@
 PATH
   remote: .
   specs:
-    log_toolbox (1.0.0)
-      actionpack (>= 4.0.0)
-      activesupport (>= 4.0.0)
+    log_toolbox (1.2.0)
       lograge (>= 0.11.1)
       logstash-event (>= 1.2.02)
+      rails (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
     actionpack (5.2.3)
       actionview (= 5.2.3)
       activesupport (= 5.2.3)
@@ -23,11 +32,25 @@ GEM
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
     activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    arel (9.0.0)
     ast (2.4.0)
     builder (3.2.3)
     byebug (11.0.1)
@@ -36,10 +59,12 @@ GEM
     crass (1.0.4)
     diff-lcs (1.3)
     erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
-    lograge (0.11.1)
+    lograge (0.11.2)
       actionpack (>= 4)
       activesupport (>= 4)
       railties (>= 4)
@@ -48,9 +73,16 @@ GEM
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
     method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
+    nio4r (2.4.0)
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
@@ -65,6 +97,19 @@ GEM
     rack (2.0.7)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
@@ -77,50 +122,66 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (12.3.2)
     request_store (1.4.1)
       rack (>= 1.4)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.68.1)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.71.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.0)
-    shoulda-matchers (3.1.2)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    shoulda-matchers (3.1.3)
       activesupport (>= 4.0.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
     thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.5.0)
+    unicode-display_width (1.6.0)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  bundler
   log_toolbox!
   pry
   pry-byebug
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake
+  rspec-rails
   rubocop
   shoulda-matchers (~> 3.1)
+  sqlite3
 
 BUNDLED WITH
    2.0.1

data/README.md

@@ -4,10 +4,6 @@ Ruby gem for logging
 =======
 # LogToolbox
 
-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/log_toolbox`. 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:
@@ -64,8 +60,29 @@ end
 LogToolbox::LogSimple.log_info('system was here') # => {"event_at":"2019-05-21 17:41:59 -0300","level":"INFO","service_name":"logging","version":"1.0.1","message":"system was here"}
 ```
 
-Also you can log with same methods log_info, log_warn, log_error and log_critical
+Also you can log with same methods log_debug, log_info, log_warn, log_error and log_critical
+
+### Log routes
+
+## Add routes config to manage your log level
+
+At your 'routes.rb' add log routes
+
+```ruby
+Rails.application.routes.draw do
+  log_routes
+end
+```
+
+You can change your application log doing a POST at /log/change_level
+
+```json
+{
+  "level": "FATAL"
+}
+```
 
+You can test your application log doing a GET at /log/test
 
 ## Development
 

data/bitbucket-pipelines.yml

@@ -1,10 +1,11 @@
-image: ruby:2.4.1
+image: ruby:2.6.3
 
 pipelines:
   default:
     - step:
         script:
           - git archive --remote=git@bitbucket.org:guideinvestimentos/rails_defaults.git HEAD .rubocop.yml | tar -x
+          - gem update bundler
           - bundle install
           - gem install rubocop
           - rspec -fdoc
@@ -14,6 +15,7 @@ pipelines:
     master:
       - step:
           script:
+            - mkdir -p ~/.gem
             - gem build log_toolbox.gemspec
             - curl -u $RUBYGEMS_USERNAME:$RUBYGEMS_PASSWORD https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials
             - chmod 0600 ~/.gem/credentials

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  log_routes
+end

data/lib/log_toolbox/log_controller.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'log_toolbox/log_payload'
+require 'action_controller'
+
+module LogToolbox
+  class LogController < ActionController::Base
+    include LogToolbox::LogPayload
+
+    def change_level
+      log_info("Log level was changed to #{level_param}")
+      Rails.logger.level = Logger.const_get(level_param.upcase)
+
+      render json: {
+        message: "Your application log level was changed to #{rails_logger}",
+        log_options: options,
+        log_levels: levels
+      }
+    end
+
+    def test
+      log_debug('Log level DEBUG')
+      log_info('Log level INFO')
+      log_warn('Log level WARN')
+      log_error('Log level ERR')
+      log_critical('Log level CRIT')
+
+      render json: {
+        message: "Your application log level is #{rails_logger}",
+        log_options: options,
+        log_levels: levels
+      }
+    end
+
+    private
+
+    def options
+      %w[DEBUG INFO WARN ERROR FATAL]
+    end
+
+    def levels
+      { DEBUG: 0, INFO: 1, WARN: 2, ERROR: 3, FATAL: 4 }
+    end
+
+    def rails_logger
+      Rails.logger.level
+    end
+
+    def level_param
+      params.require(:level)
+    end
+  end
+end

data/lib/log_toolbox/log_helper.rb

@@ -25,13 +25,17 @@ module LogToolbox
       log_pattern('info', additional.merge(message: message))
     end
 
+    def log_debug(message, additional = {})
+      log_pattern('debug', additional.merge(message: message))
+    end
+
     private
 
     # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
     def default_log(level)
       level = 'CRITICAL' if level == 'FATAL'
       {
-        id: request.headers['correlation_id'],
+        activityID: request.headers['activityID'],
         event_at: I18n.l(Time.now, format: :timestamp),
         level: level,
         service_name: LogUtil.system_service_name,

data/lib/log_toolbox/log_payload.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support'
+require 'log_toolbox/log_helper'
 
 module LogToolbox
   module LogPayload
@@ -10,7 +11,7 @@ module LogToolbox
     # rubocop:disable Metrics/AbcSize
     def append_info_to_payload(payload)
       super
-      payload[:id] = request.headers['correlation_id']
+      payload[:activityID] = request.headers['activityID']
       payload[:event_at] = I18n.l(Time.now, format: :timestamp)
       payload[:service_name] = LogUtil.system_service_name
       payload[:version] = LogUtil.system_version

data/lib/log_toolbox/log_routes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    class Mapper
+      def log_routes
+        match 'log/change_level(/:checks)(.:format)', to:
+          'log_toolbox/log#change_level', via: :post
+
+        match 'log/test(/:checks)(.:format)', to:
+          'log_toolbox/log#test', via: :get
+      end
+    end
+  end
+end

data/lib/log_toolbox/log_simple.rb

@@ -27,7 +27,7 @@ module LogToolbox
           event_at: I18n.l(Time.now, format: :timestamp),
           level: level,
           service_name: LogUtil.system_service_name,
-          version: LogUtil.system_version,
+          version: LogUtil.system_version
         }
       end
 

data/lib/log_toolbox/lograge_config.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'lograge'
+
 module LogToolbox
   class LogrageConfig
     # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
@@ -11,7 +13,7 @@ module LogToolbox
 
         config.lograge.custom_options = lambda do |event|
           {
-            id: event.payload[:id],
+            activityID: event.payload[:activityID],
             event_at: event.payload[:event_at],
             level: 'INFO',
             service_name: event.payload[:service_name],

data/lib/log_toolbox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LogToolbox
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/lib/log_toolbox.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'log_toolbox/version'
+require 'log_toolbox/log_routes'
+require 'log_toolbox/log_controller'
 require 'log_toolbox/lograge_config'
 require 'log_toolbox/log_util'
 require 'log_toolbox/log_helper'

data/log_toolbox.gemspec

@@ -21,16 +21,15 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'actionpack', '>= 4.0.0'
-  spec.add_dependency 'activesupport', '>= 4.0.0'
   spec.add_dependency 'lograge', '>= 0.11.1'
   spec.add_dependency 'logstash-event', '>= 1.2.02'
+  spec.add_dependency('rails', ['>= 4.0'])
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
 end

metadata

@@ -1,85 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: log_toolbox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Caio Almeida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: lograge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 0.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 0.11.1
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: logstash-event
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 1.2.02
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 1.2.02
 - !ruby/object:Gem::Dependency
-  name: lograge
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.1
-- !ruby/object:Gem::Dependency
-  name: logstash-event
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.02
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.02
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -112,30 +98,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -183,9 +169,12 @@ files:
 - bin/console
 - bin/setup
 - bitbucket-pipelines.yml
+- config/routes.rb
 - lib/log_toolbox.rb
+- lib/log_toolbox/log_controller.rb
 - lib/log_toolbox/log_helper.rb
 - lib/log_toolbox/log_payload.rb
+- lib/log_toolbox/log_routes.rb
 - lib/log_toolbox/log_simple.rb
 - lib/log_toolbox/log_util.rb
 - lib/log_toolbox/lograge_config.rb
@@ -210,8 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Guide default gem for ruby application logging