ree_lib 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6993bc1d11274673b58043eb21b76ac10a725ee12f1718858573c946eb8c209
-  data.tar.gz: dd9829fb7303a8faf0794bd429413e45be81a9cc603436c4286ef5b707751944
+  metadata.gz: 9481a0ea7f7bebebf1386a48fb558859ff18c761ebece7f56b0e43e279fd1945
+  data.tar.gz: 98aa337a94ab47d178e45f54f94b15027c0d6a71c164df5d0450874fe8e876d1
 SHA512:
-  metadata.gz: 134160befab48d3efebc41320ecdcba87abbd898110a9b5f11218ac3dbc6f7c010193db04c66d4e25b22f858d353c895187f9bce67e2de47984736c28cb4add3
-  data.tar.gz: 929156910d1168bd58d78a00da630bcea2eec737914ce4adbbe037da161169a8865d33c4e207753d5bf631d51a24a30eba5d034640ee91246c2283d7f4083489
+  metadata.gz: 7b5b129cb9045109d08a53a938d446eb6210ea23f63f9656abd77d0c1344fb2c7297c51a5983e1ebb61d9829977f40facc83ae6e4f8c8e7f9845e869292c25be
+  data.tar.gz: b1e945345d629c4fe23283660d0328a186308559f2b3c4c6fd2e2ed2cadcf6d300f8c9946e947b51010902a732547dbe408e2248075030466d0a9387871d3f08

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ree_lib (1.0.4)
+    ree_lib (1.0.5)
       binding_of_caller (~> 1.0.0)
       i18n (~> 1.12.0)
       loofah (~> 2.18.0)
@@ -49,6 +49,7 @@ GEM
     ree (1.0.2)
       commander (~> 4.6.0)
     rexml (3.2.5)
+    rollbar (3.3.1)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -82,6 +83,7 @@ DEPENDENCIES
   pg (~> 1.4.1)
   rake (~> 13.0)
   ree_lib!
+  rollbar (~> 3.3.1)
   rspec
   sqlite3 (~> 1.4.4)
   timecop (~> 0.9.5)

data/lib/ree_lib/packages/ree_logger/Package.schema.json

@@ -16,6 +16,9 @@
     {
       "name": "ree_object"
     },
+    {
+      "name": "ree_swagger"
+    },
     {
       "name": "ree_validator"
     }

data/lib/ree_lib/packages/ree_logger/package/ree_logger/appenders/rollbar_appender.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'appender'
+require 'rollbar'
+require 'digest'
+
+class ReeLogger::RollbarAppender < ReeLogger::Appender
+  include Ree::LinkDSL
+
+  link 'ree_logger/log_event', -> { LogEvent }
+
+  contract(
+    Symbol,
+    Kwargs[
+      access_token: String,
+      environment: String,
+    ],
+    Ksplat[
+      branch?: Nilor[String],
+      host?: Nilor[String],
+    ] =>  Any
+  )
+  def initialize(level, access_token:, environment:, **opts)
+    super(level, nil)
+
+    Rollbar.configure do |config|
+      config.enabled = true
+      config.access_token = access_token
+      config.environment = environment
+      config.branch = opts[:branch] if opts[:branch]
+      config.host = opts[:host] if opts[:host]
+    end
+  end
+
+  contract(LogEvent, Nilor[String] => nil)
+  def append(event, progname = nil)
+    rollbar_level =
+      case event.level
+      when :fatal
+        'critical'
+      when :unknown
+        'critical'
+      else
+        event.level.to_s
+      end
+
+    fingerprint = event.message.to_s
+
+    if event.exception
+      fingerprint += event.exception.class.to_s
+    end
+
+    scope = {}
+    parameters = event.parameters.dup
+
+    if parameters.key?(:rollbar_scope) && parameters[:rollbar_scope].is_a?(Hash)
+      scope = scope.merge(
+        parameters.delete(:rollbar_scope)
+      )
+    end
+
+    if !scope[:fingerprint]
+      fingerprint = event.message.to_s
+
+      if event.exception
+        fingerprint += event.exception.class.to_s
+      end
+
+      scope[:fingerprint] = Digest::MD5.new.update(fingerprint).to_s
+    end
+
+    Rollbar.scoped(scope) do
+      Rollbar.log(rollbar_level, event.message, event.exception, parameters)
+    end
+
+    nil
+  end
+end

data/lib/ree_lib/packages/ree_logger/package/ree_logger/beans/logger.rb

@@ -14,6 +14,7 @@ class ReeLogger::Logger
     link 'ree_logger/rate_limiter', -> { RateLimiter }
     link 'ree_logger/appenders/file_appender', -> { FileAppender }
     link 'ree_logger/appenders/stdout_appender', -> { StdoutAppender }
+    link 'ree_logger/appenders/rollbar_appender', -> { RollbarAppender }
   end
 
   def build
@@ -35,6 +36,19 @@ class ReeLogger::Logger
       )
     end
 
+    if config.rollbar.enabled
+      opts = {}
+      opts[:branch] = config.rollbar.branch if config.rollbar.branch
+      opts[:host] = config.rollbar.host if config.rollbar.host
+
+      appenders << RollbarAppender.new(
+        config.levels.rollbar,
+        access_token: config.rollbar.access_token,
+        environment: config.rollbar.environment,
+        **opts
+      )
+    end
+
     build_logger(
       appenders,
       ENV['APP_NAME'],

data/lib/ree_lib/packages/ree_logger/package/ree_logger/config.rb

@@ -17,12 +17,22 @@ class ReeLogger::Config
   RATE_LIMIT_MAX_COUNT = 600
 
   def build
+    is_rollbar_enabled = parse_bool_string(ENV['LOG_ROLLBAR_ENABLED'])
+
     to_obj({
       file_path: ENV['LOG_FILE_PATH'],
       file_auto_flush: parse_bool_string(ENV['LOG_FILE_AUTO_FLUSH']),
       levels: {
         file: parse_level(ENV['LOG_LEVEL_FILE']),
         stdout: parse_level(ENV['LOG_LEVEL_STDOUT']),
+        rollbar: is_rollbar_enabled ? parse_level(ENV['LOG_LEVEL_ROLLBAR']) : nil,
+      },
+      rollbar: {
+        enabled: is_rollbar_enabled,
+        access_token: is_rollbar_enabled ? ENV.fetch('LOG_ROLLBAR_ACCESS_TOKEN') : nil,
+        environment: is_rollbar_enabled ? ENV.fetch('LOG_ROLLBAR_ENVIRONMENT') : nil,
+        branch: ENV['LOG_ROLLBAR_BRANCH'],
+        host: ENV['LOG_ROLLBAR_HOST']
       },
       rate_limit: {
         interval: get_int_value('LOG_RATE_LIMIT_INTERVAL', RATE_LIMIT_INTERVAL),

data/lib/ree_lib/packages/ree_logger/package/ree_logger/multi_logger.rb

@@ -134,6 +134,14 @@ class ReeLogger::MultiLogger < Logger
       end
     end
 
+    parameters = transform_values(parameters) do |k, v|
+      if @filter_words.any? { k.to_s.include?(_1) }
+        'FILTERED'
+      else
+        v
+      end
+    end
+
     event = LogEvent.new(level, message, exception, parameters)
 
     appenders.each do |appender|

data/lib/ree_lib/packages/ree_logger/package/ree_logger.rb

@@ -11,6 +11,7 @@ module ReeLogger
     depends_on :ree_datetime
     depends_on :ree_validator
     depends_on :ree_hash
+    depends_on :ree_swagger
 
     env_var 'LOG_FILE_PATH'
     env_var 'LOG_LEVEL_FILE'

data/lib/ree_lib/packages/ree_logger/spec/ree_logger/appenders/rollbar_appender_spec.rb

@@ -0,0 +1,33 @@
+#frozen_string_literal = true
+
+package_require('ree_logger/appenders/rollbar_appender')
+
+RSpec.describe ReeLogger::RollbarAppender do
+  let(:rollbar_appender) { described_class }
+
+  let(:log_event) {
+    ReeLogger::LogEvent.new(
+      :info,
+      "Some message",
+      nil,
+      {}
+    )
+  }
+
+  # comment "before" block to test sending to api
+  before do
+    allow(Rollbar).to receive(:log)
+  end
+
+  it "sends log event to Rollbar" do
+    appender = rollbar_appender.new(
+      :info,
+      access_token: ENV['LOG_ROLLBAR_ACCESS_TOKEN'],
+      environment: ENV['LOG_ROLLBAR_ENVIRONMENT']
+    )
+
+    expect(appender).to respond_to(:append)
+    expect { appender.append(log_event) }.not_to raise_error
+    expect(Rollbar).to have_received(:log)
+  end
+end

data/lib/ree_lib/packages/ree_logger/spec/ree_logger/beans/logger_spec.rb

@@ -8,12 +8,16 @@ RSpec.describe :logger do
 
   before(:all) do
     tmp_file_log = ENV['LOG_FILE_PATH']
-    
+
     if !is_blank(tmp_file_log)
       File.open(tmp_file_log, 'w') {|file| file.truncate(0) }
     end
   end
 
+  before(:each) do
+    allow(Rollbar).to receive(:log)
+  end
+
   let(:log_file_path) { ENV['LOG_FILE_PATH'] }
 
   let(:exception) {
@@ -22,21 +26,25 @@ RSpec.describe :logger do
 
   it {
     expect { logger.info('hello world') }.to output(/hello world/).to_stdout
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("hello world")
   }
 
   it {
-    expect { logger.info('hello world', { param: 1, another_param: { name: 'John'} }) }.to output(/John/).to_stdout
+    expect { logger.info('hello world', { rollbar_scope: {fingerprint: 'test', test: 'test'}, param: 1, another_param: { name: 'John'} }) }.to output(/John/).to_stdout
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("John")
   }
-  
+
   it {
     expect { logger.debug('debug message') }.to_not output(/debug message/).to_stdout
+    expect(Rollbar).not_to have_received(:log)
     expect(File.read(log_file_path)).to_not match("debug")
   }
 
   it {
     expect { logger.warn('warning message') }.to output(/warning message/).to_stdout
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("warning message")
   }
 
@@ -46,17 +54,20 @@ RSpec.describe :logger do
     }
     expect(output).to match(/some error message/)
     expect(output).to_not match(/method|args/)
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("some error message")
     expect(File.read(log_file_path)).to_not match("PARAMETERS: {:method=>{:name=>:call, :args=>{:block=>{}}}}")
   }
 
   it {
     expect { logger.fatal('some fatal message', {}, exception) }.to output(/some fatal message/).to_stdout
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("some fatal message")
   }
 
   it {
     expect { logger.unknown('unknown message') }.to output(/unknown message/).to_stdout
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("unknown message")
   }
 end

data/lib/ree_lib/packages/ree_logger/spec/ree_logger/multi_logger_spec.rb

@@ -1,15 +1,17 @@
 #frozen_string_literal = true
 
+require 'rollbar'
 package_require('ree_logger/multi_logger')
 package_require('ree_logger/appenders/stdout_appender')
 package_require('ree_logger/appenders/file_appender')
+package_require('ree_logger/appenders/rollbar_appender')
 
 RSpec.describe ReeLogger::MultiLogger do
   link :is_blank, from: :ree_object
 
   before(:all) do
     tmp_file_log = ENV['LOG_FILE_PATH']
-    
+
     if !is_blank(tmp_file_log)
       File.open(tmp_file_log, 'w') {|file| file.truncate(0) }
     end
@@ -37,6 +39,14 @@ RSpec.describe ReeLogger::MultiLogger do
     )
   }
 
+  let(:rollbar_appender) {
+    ReeLogger::RollbarAppender.new(
+      :info,
+      access_token: ENV['LOG_ROLLBAR_ACCESS_TOKEN'],
+      environment: ENV['LOG_ROLLBAR_ENVIRONMENT']
+    )
+  }
+
   let(:logger) {
     multi_logger.new(
       'SomeCoolApp',
@@ -46,37 +56,47 @@ RSpec.describe ReeLogger::MultiLogger do
   }
 
   let(:logger_with_appenders) {
-    [file_appender, stdout_appender].map { logger.add_appender(_1) }
+    [file_appender, stdout_appender, rollbar_appender].map { logger.add_appender(_1) }
 
     logger
   }
 
+  before(:each) do
+    allow(Rollbar).to receive(:log)
+  end
+
   it {
     expect { logger.add_appender(stdout_appender) }.to change { logger.appenders }
   }
 
   it {
     expect { logger.info('any message') }.to_not output(/any message/).to_stdout
-    expect(File.read(log_file_path)).to_not match('any message') 
+    expect(Rollbar).not_to have_received(:log)
+    expect(File.read(log_file_path)).to_not match('any message')
   }
 
   it {
     expect { logger_with_appenders.info('hello world') }.to output(/hello world/).to_stdout
-    expect(File.read(log_file_path)).to match("hello world") 
+    expect(Rollbar).to have_received(:log)
+    expect(File.read(log_file_path)).to match("hello world")
   }
 
   it {
-    expect { logger_with_appenders.info('hello world', { param: 1, another_param: { name: 'John'} }) }.to output(/John/).to_stdout
+    expect { logger_with_appenders.info('hello world', { param: 1, another_param: { name: 'John'}, password: 'password01' }) }.to output(/John/).to_stdout
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("John")
+    expect(File.read(log_file_path)).to match(":password=>\"FILTERED\"")
   }
-  
+
   it {
     expect { logger_with_appenders.debug('debug message') }.to_not output(/debug message/).to_stdout
+    expect(Rollbar).not_to have_received(:log)
     expect(File.read(log_file_path)).to_not match("debug")
   }
 
   it {
     expect { logger_with_appenders.warn('warning message') }.to output(/warning message/).to_stdout
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("warning message")
   }
 
@@ -87,16 +107,20 @@ RSpec.describe ReeLogger::MultiLogger do
     expect(output).to match(/some error message/)
     expect(output).to_not match(/method|args/)
     expect(File.read(log_file_path)).to match("some error message")
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to_not match("PARAMETERS: {:method=>{:name=>:call, :args=>{:block=>{}}}}")
   }
 
   it {
-    expect { logger_with_appenders.fatal('some fatal message', {}, exception) }.to output(/some fatal message/).to_stdout
+    expect { logger_with_appenders.fatal('some fatal message', { email: 'some@mail.com', password: 'password01' }, exception) }.to output(/some fatal message/).to_stdout
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("some fatal message")
+    expect(File.read(log_file_path)).to match(":password=>\"FILTERED\"")
   }
 
   it {
     expect { logger_with_appenders.unknown('unknown message') }.to output(/unknown message/).to_stdout
+    expect(Rollbar).to have_received(:log)
     expect(File.read(log_file_path)).to match("unknown message")
   }
 
@@ -113,5 +137,5 @@ RSpec.describe ReeLogger::MultiLogger do
     }.to_not output.to_stdout
   }
 
-  
+
 end

data/lib/ree_lib/packages/ree_logger/spec/spec_helper.rb

@@ -15,5 +15,9 @@ ENV['LOG_FILE_PATH'] = '/tmp/ree_logger.log'
 ENV['LOG_FILE_AUTO_FLUSH'] = 'true'
 ENV['LOG_LEVEL_FILE'] = 'info'
 ENV['LOG_LEVEL_STDOUT'] = 'info'
+ENV['LOG_LEVEL_ROLLBAR'] = 'info'
 ENV['LOG_RATE_LIMIT_INTERVAL'] = '60'
-ENV['LOG_RATE_LIMIT_COUNT'] = '600'
+ENV['LOG_RATE_LIMIT_COUNT'] = '600'
+ENV['LOG_ROLLBAR_ACCESS_TOKEN'] = 'SET_YOUR_TOKEN'
+ENV['LOG_ROLLBAR_ENABLED'] = 'true'
+ENV['LOG_ROLLBAR_ENVIRONMENT'] = 'test'

data/lib/ree_lib/packages/ree_migrator/spec/spec_helper.rb

@@ -6,4 +6,5 @@ ENV['LOG_FILE_PATH'] =
 ENV['LOG_LEVEL_FILE'] = ''
 ENV['LOG_LEVEL_STDOUT'] = ''
 ENV['LOG_RATE_LIMIT_INTERVAL'] = ''
-ENV['LOG_RATE_LIMIT_COUNT'] = ''
+ENV['LOG_RATE_LIMIT_COUNT'] = ''
+ENV['LOG_ROLLBAR_ENABLED'] = 'false'

data/lib/ree_lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReeLib
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ree_lib
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Ruslan Gatiyatov
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: rollbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.1
 description: Ree Lib provides set of packages to extend Ruby Standard Library
 email:
 - ruslan.gatiyatov@gmail.com
@@ -869,6 +883,7 @@ files:
 - lib/ree_lib/packages/ree_logger/package/ree_logger.rb
 - lib/ree_lib/packages/ree_logger/package/ree_logger/appenders/appender.rb
 - lib/ree_lib/packages/ree_logger/package/ree_logger/appenders/file_appender.rb
+- lib/ree_lib/packages/ree_logger/package/ree_logger/appenders/rollbar_appender.rb
 - lib/ree_lib/packages/ree_logger/package/ree_logger/appenders/stdout_appender.rb
 - lib/ree_lib/packages/ree_logger/package/ree_logger/beans/logger.rb
 - lib/ree_lib/packages/ree_logger/package/ree_logger/config.rb
@@ -887,6 +902,7 @@ files:
 - lib/ree_lib/packages/ree_logger/spec/package_schema_spec.rb
 - lib/ree_lib/packages/ree_logger/spec/ree_logger/appenders/appender_spec.rb
 - lib/ree_lib/packages/ree_logger/spec/ree_logger/appenders/file_appender_spec.rb
+- lib/ree_lib/packages/ree_logger/spec/ree_logger/appenders/rollbar_appender_spec.rb
 - lib/ree_lib/packages/ree_logger/spec/ree_logger/appenders/stdout_appender_spec.rb
 - lib/ree_lib/packages/ree_logger/spec/ree_logger/beans/logger_spec.rb
 - lib/ree_lib/packages/ree_logger/spec/ree_logger/formatters/colorized_formatter_spec.rb