request_headers_logger 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 470b462a8ffc11750785e8efc88d477d2efd61f5
-  data.tar.gz: ff88013a271b1c3f21b9b91219007b3b6016a45a
+SHA256:
+  metadata.gz: e7b41746047401b957cc85417b20f911cde79f6ae69ba703ec582941965c1650
+  data.tar.gz: 613329a86a1352f39f01a5a815d56813ccc7c1bf186c60610f4371f8895b8ce2
 SHA512:
-  metadata.gz: 10084ec99b39e60ff233e5426ba82d6a47f021732dfc09780168cd966fb3940f45672386b92bfc47012212f77c341aa4e6ae74e7c2127d2cb70de6a3caba562d
-  data.tar.gz: 83bdd44b690bccf5714590a14984c292efc2006c2d7c37036cab309b5aaa4ed11d0eecf1066ef09de0e37b8342b89d21005a315271036d3b28be26a1b9c299c8
+  metadata.gz: 512d286d34c872bb01134c8e1b5f55a793c9db473b57c1d3227a110d525ea1ada3c167619ab2445beea4a3945e8e616ab5b8e8090a5a262729b13603e708eaf8
+  data.tar.gz: e72953e00874b9ffa7154dd12bd04064357e43e391784022f57662bc60deb5da60c2830ef9067649ec6f3b4151f8c9f1ebacff15e1f3b0879adea7a8ae517eed

data/.gitignore

@@ -13,3 +13,4 @@ rdoc
 spec/reports
 tmp
 .byebug_history
+Gemfile.lock

data/.travis.yml

@@ -8,12 +8,6 @@ rvm:
 
 before_install: gem install bundler
 
-script: bin/travis
-
-matrix:
-  fast_finish: true
-
-env:
-  matrix:
-    - BUILD_TYPE=rspec
-    - BUILD_TYPE=rubocop
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/README.md

@@ -16,11 +16,11 @@ The gem can be used to share *RequestHeader* store items the asynchronous servic
 
 So how does it work with Rails.
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile after the delayed job and message_queue gems:
 
-``
+```ruby
 gem 'request_headers_logger'
-``
+```
 
 And then execute:
 
@@ -33,11 +33,10 @@ That's it now Delayed job logs should show the *X-Request-Id* from the http requ
 
 ### Configure RequestHeadersLogger
 
-```
- RequestHeadersLogger.configure do |config|
+```ruby
+RequestHeadersLogger.configure do |config|
   config[:logger_format] = 'json'         # Options [text json] default: text
   config[:tag_format] = 'key_val'         # Options: [val key_val] default: val
-  config[:Loggers] << MessageQueue.logger # List of all loggers used.
 end
 ```
 
@@ -45,6 +44,6 @@ end
 
 Per default the delayed job plug in applies a whitelist to only filter *X-Request-Id* header from the store. To white list new flags, you can do the following.
 
-``
+```ruby
  RequestHeadersLogger.whitelist << "customer-id".to_sym
-``
+```

data/lib/request_headers_logger.rb

@@ -6,6 +6,7 @@ require 'request_headers_logger/json_formatter'
 require 'request_headers_logger/text_formatter'
 require 'request_headers_logger/delayed_job/delayed_job'
 require 'request_headers_logger/message_queue/message_queue'
+require 'request_headers_logger/railtie' if defined?(Rails)
 
 module RequestHeadersLogger # :nodoc:
   extend self
@@ -34,19 +35,13 @@ module RequestHeadersLogger # :nodoc:
     @configuration[:loggers]
   end
 
-  def prepare_loggers
-    loggers.each do |logger|
-      logger_formatter logger
-    end
-  end
-
-  private
-
   def logger_formatter(logger)
     logger.formatter ||= Logger::Formatter.new
     logger.formatter.extend formatter_class
   end
 
+  private
+
   def formatter_class
     RequestHeadersLogger.const_get("#{log_format.capitalize}Formatter")
   end

data/lib/request_headers_logger/configuration.rb

@@ -10,7 +10,6 @@ module RequestHeadersLogger
 
     CONFIG_KEYS = [
       :log_format, # [logger_format] default or json
-      :loggers,    # [Loggers]  List of all loggers used.
       :tag_format, # [tag_format]
     ].freeze
 
@@ -20,7 +19,6 @@ module RequestHeadersLogger
     def initialize
       @configs = {
         log_format: LOG_FORMATS.first,
-        loggers: [],
         tag_format: TAG_FORMATS.first
       }
     end

data/lib/request_headers_logger/delayed_job/request_header_delayed_plugin.rb

@@ -13,23 +13,12 @@ module RequestHeadersLogger
 
       lifecycle.before(:perform) do |worker, job|
         RequestHeadersMiddleware.store = job.payload_object.instance_variable_get(:@store)
-        set_dj_loggers
       end
 
       lifecycle.after(:perform) do |worker, job|
         RequestHeadersMiddleware.store = {}
       end
     end
-
-    def self.set_dj_loggers
-      RequestHeadersLogger.configure do |config|
-        loggers = [Delayed::Worker.logger]
-        loggers << ::Rails.logger
-
-        config[:loggers].push(loggers).flatten!.uniq!
-      end
-      RequestHeadersLogger.prepare_loggers
-    end
   end
 end
 

data/lib/request_headers_logger/message_queue/message_queue_plugin.rb

@@ -24,21 +24,12 @@ module RequestHeadersLogger
       lifecycle.before(:consume) do |delivery_info, properties, payload|
         store = symbolize(properties.headers)&.dig(:store) || {}
         RequestHeadersMiddleware.store = store
-
-        set_mq_loggers
       end
 
       lifecycle.after(:consume) do |delivery_info, properties, payload|
         RequestHeadersMiddleware.store = {}
       end
     end
-
-    def self.set_mq_loggers
-      RequestHeadersLogger.configure do |config|
-        config[:loggers] << MessageQueue.logger
-      end
-      RequestHeadersLogger.prepare_loggers
-    end
   end
 end
 

data/lib/request_headers_logger/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RequestHeadersLogger
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      RequestHeadersLogger.logger_formatter(MessageQueue.logger) if defined?(MessageQueue)
+      if defined?(Delayed)
+        RequestHeadersLogger.logger_formatter(Delayed::Worker.logger)
+        RequestHeadersLogger.logger_formatter(Rails.logger)
+      end
+    end
+  end
+end

data/lib/request_headers_logger/text_formatter.rb

@@ -7,11 +7,22 @@ module RequestHeadersLogger
     def call(severity, time, progname, msg)
       format(::Logger::Formatter::Format,
              severity_name(severity)[0],
-             format_datetime(time),
+             format_time(time),
              $PID,
              severity_name(severity),
              progname,
-             msg2str("#{tags_text}#{msg}"))
+             "#{tags_text}#{to_string(msg)}")
+    end
+
+    def format_time(time)
+      return format_datetime(time) if respond_to? :format_datetime
+      time.strftime(@datetime_format || '%Y-%m-%dT%H:%M:%S.%6N ')
+    end
+
+    def to_string(msg)
+      return msg2str(msg) if respond_to? :format_datetime
+      return msg.inspect unless msg.is_a? String
+      msg
     end
 
     def severity_name(severity)

data/lib/request_headers_logger/version.rb

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

data/spec/configuration_spec.rb

@@ -41,21 +41,13 @@ RSpec.describe RequestHeadersLogger::Configuration do
     it 'return text as default for log_format' do
       expect(config[:log_format]).to eq('text')
     end
-
-    it 'return empty array as default for loggers' do
-      expect(config[:loggers]).to eq([])
-    end
   end
 
   describe '[]=' do
     it 'assign valid config keys' do
-      logger = Logger.new(STDOUT)
-
       config[:log_format] = 'json'
-      config[:loggers] << logger
 
       expect(config[:log_format]).to eq('json')
-      expect(config[:loggers].first).to eq(logger)
     end
 
     it 'raise an error for invalid configs ' do

data/spec/text_formatter_spec.rb

@@ -4,42 +4,88 @@ require 'spec_helper'
 
 RSpec.describe RequestHeadersLogger::TextFormatter do
   let(:buffer) { StringIO.new }
-  let(:logger) do
-    logger = Logger.new(buffer)
-    logger.progname = 'dummy'
-    logger.formatter = Logger::Formatter.new
-    logger.formatter.extend RequestHeadersLogger::TextFormatter
-    logger
-  end
 
-  it 'output logs in a text format' do
-    logger.info('text log message')
+  context 'Using a Logger::Formatter' do
+    let(:logger) do
+      logger = Logger.new(buffer)
+      logger.progname = 'dummy'
+      logger.formatter = Logger::Formatter.new
+      logger.formatter.extend RequestHeadersLogger::TextFormatter
+      logger
+    end
 
-    expect(buffer.string).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: text log message$/)
-  end
+    it 'output logs in a text format' do
+      logger.info('text log message')
 
-  context 'store has some tags' do
-    before do
-      RequestHeadersMiddleware.store = { 'X-Request-Id': 'ef382618', 'tag': 'SSS' }
+      expect(buffer.string).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: text log message$/)
     end
 
-    after do
-      RequestHeadersMiddleware.store = {}
-      RequestHeadersLogger.configure { |c| c[:tag_format] = 'val' }
+    context 'store has some tags' do
+      before do
+        RequestHeadersMiddleware.store = { 'X-Request-Id': 'ef382618', 'tag': 'SSS' }
+      end
+
+      after do
+        RequestHeadersMiddleware.store = {}
+        RequestHeadersLogger.configure { |c| c[:tag_format] = 'val' }
+      end
+
+      it 'output tags with key_val formmat' do
+        RequestHeadersLogger.configure { |c| c[:tag_format] = 'key_val' }
+        logger.info('text log message')
+        output = buffer.string
+
+        expect(output).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: \[X-Request-Id: ef382618\] text log message$/)
+      end
+
+      it 'include tags in the log line' do
+        logger.info('text log message')
+
+        expect(buffer.string).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: \[ef382618\] text log message$/)
+      end
+    end
+  end
+
+  context 'Using a Proc' do
+    let(:logger) do
+      logger = Logger.new(buffer)
+      logger.progname = 'dummy'
+      # rubocop:disable Metrics/LineLength
+      logger.formatter = proc { |severity, datetime, progname, msg| "[#{datetime} ##{Process.pid}] #{severity}: #{msg}\n" }
+      # rubocop:enable Metrics/LineLength
+      logger.formatter.extend RequestHeadersLogger::TextFormatter
+      logger
     end
 
-    it 'output tags with key_val formmat' do
-      RequestHeadersLogger.configure { |c| c[:tag_format] = 'key_val' }
+    it 'output logs in a text format' do
       logger.info('text log message')
-      output = buffer.string
 
-      expect(output).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: \[X-Request-Id: ef382618\] text log message$/)
+      expect(buffer.string).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: text log message$/)
     end
 
-    it 'include tags in the log line' do
-      logger.info('text log message')
+    context 'store has some tags' do
+      before do
+        RequestHeadersMiddleware.store = { 'X-Request-Id': 'ef382618', 'tag': 'SSS' }
+      end
+
+      after do
+        RequestHeadersMiddleware.store = {}
+        RequestHeadersLogger.configure { |c| c[:tag_format] = 'val' }
+      end
+
+      it 'output tags with key_val formmat' do
+        RequestHeadersLogger.configure { |c| c[:tag_format] = 'key_val' }
+        logger.info('text log message')
+        output = buffer.string
+
+        expect(output).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: \[X-Request-Id: ef382618\] text log message$/)
+      end
+
+      it 'include tags in the log line' do
+        logger.info('text log message')
 
-      expect(buffer.string).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: \[ef382618\] text log message$/)
+        expect(buffer.string).to match(/I, \[[0-9\-T:\.# ]*\]  INFO -- dummy: \[ef382618\] text log message$/)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request_headers_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Al-waleed Shihadeh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-17 00:00:00.000000000 Z
+date: 2018-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_headers_middleware
@@ -68,42 +68,42 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -135,8 +135,7 @@ dependencies:
 description: RequestHeaderLogger Allows you to tag logs with RequestHeader flags.
 email:
 - wshihadh@gmail.com
-executables:
-- travis
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -145,11 +144,9 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/travis
 - lib/request_headers_logger.rb
 - lib/request_headers_logger/configuration.rb
 - lib/request_headers_logger/delayed_job/delayed_job.rb
@@ -158,6 +155,7 @@ files:
 - lib/request_headers_logger/json_formatter.rb
 - lib/request_headers_logger/message_queue/message_queue.rb
 - lib/request_headers_logger/message_queue/message_queue_plugin.rb
+- lib/request_headers_logger/railtie.rb
 - lib/request_headers_logger/text_formatter.rb
 - lib/request_headers_logger/version.rb
 - request_headers_logger.gemspec
@@ -188,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: RequestHeaderLogger Allows you to tag logs with RequestHeader flags.

data/Gemfile.lock

@@ -1,80 +0,0 @@
-PATH
-  remote: .
-  specs:
-    request_headers_logger (0.0.4)
-      request_headers_middleware (~> 0.0.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.1.5)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    ast (2.4.0)
-    concurrent-ruby (1.0.5)
-    delayed_job (4.1.4)
-      activesupport (>= 3.0, < 5.2)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    json (2.1.0)
-    minitest (5.11.3)
-    parallel (1.12.1)
-    parser (2.5.0.2)
-      ast (~> 2.4.0)
-    powerpack (0.1.1)
-    rack (1.6.5)
-    rainbow (3.0.0)
-    rake (12.0.0)
-    request_headers_middleware (0.0.4)
-      request_store
-    request_store (1.4.0)
-      rack (>= 1.4)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    rubocop (0.53.0)
-      parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    simplecov (0.12.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  delayed_job (~> 4.1, >= 4.1.4)
-  rack (~> 1.6, >= 1.6.5)
-  rake (~> 12.0, >= 12.0.0)
-  request_headers_logger!
-  rspec (~> 3.5, >= 3.5.0)
-  rubocop (~> 0.53.0)
-  simplecov (~> 0.12.0)
-
-BUNDLED WITH
-   1.16.1

data/bin/travis

@@ -1,12 +0,0 @@
-#!/bin/sh
-
-set -e
-
-case "$BUILD_TYPE" in
-  "rubocop")
-    bundle exec rubocop
-    ;;
-   "rspec")
-    bundle exec rspec
-    ;;
-esac