hubrise_initializer 0.2.9 → 1.0.2

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0"
+gem "rspec"
+gem "rspec-rails", "~> 5.0"
+gem "hubrise_initializer", path: "."
+
+gem "rubocop", "0.81.0"
+gem "webmock"

data/Gemfile.lock

@@ -0,0 +1,219 @@
+PATH
+  remote: .
+  specs:
+    hubrise_initializer (1.0.1)
+      act-fluent-logger-rails (~> 0.6)
+      lograge (~> 0.11)
+      lograge-sql
+      logstash-event (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    act-fluent-logger-rails (0.6.4)
+      activesupport (>= 4)
+      fluent-logger
+      railties (>= 4)
+    actioncable (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activejob (= 6.1.6.1)
+      activerecord (= 6.1.6.1)
+      activestorage (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      actionview (= 6.1.6.1)
+      activejob (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.6.1)
+      actionview (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activerecord (= 6.1.6.1)
+      activestorage (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.6.1)
+      activesupport (= 6.1.6.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.6.1)
+      activesupport (= 6.1.6.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activerecord (6.1.6.1)
+      activemodel (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activestorage (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activejob (= 6.1.6.1)
+      activerecord (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.6.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    fluent-logger (0.9.0)
+      msgpack (>= 1.0.0, < 2)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    lograge (0.12.0)
+      actionpack (>= 4)
+      activesupport (>= 4)
+      railties (>= 4)
+      request_store (~> 1.0)
+    lograge-sql (2.0.0)
+      activerecord (>= 5, < 7.1)
+      lograge (~> 0.11)
+    logstash-event (1.2.02)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.2)
+    msgpack (1.5.3)
+    nio4r (2.5.8)
+    nokogiri (1.13.7)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (6.1.6.1)
+      actioncable (= 6.1.6.1)
+      actionmailbox (= 6.1.6.1)
+      actionmailer (= 6.1.6.1)
+      actionpack (= 6.1.6.1)
+      actiontext (= 6.1.6.1)
+      actionview (= 6.1.6.1)
+      activejob (= 6.1.6.1)
+      activemodel (= 6.1.6.1)
+      activerecord (= 6.1.6.1)
+      activestorage (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.6.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (6.1.6.1)
+      actionpack (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    request_store (1.5.1)
+      rack (>= 1.4)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.1.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.11.0)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.11.0)
+    sprockets (4.1.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.8.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hubrise_initializer!
+  rails (~> 6.0)
+  rspec
+  rspec-rails (~> 5.0)
+  rubocop (= 0.81.0)
+  webmock
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -40,9 +40,21 @@ The following environment variables can be used only when`ENV['RAILS_LOGGER'] ==
 
 To upload the latest version to RubyGems.org:
 
+0. Make sure all local changes are committed.
+
 1. Increase version in `lib/hubrise_initializer/version.rb`
 
-2. Build & publish - `cd` to the repository main folder then: 
+2. Tag the repository:
+```bash
+VERSION=1.0.2
+git add lib/hubrise_initializer/version.rb
+git commit -m "Version $VERSION"
+git tag v$VERSION
+git push --tags
+git push
+```
+
+3. Build & publish - `cd` to the repository main folder then: 
 
 ```bash
 rm -f hubrise_initializer-*.gem

data/hubrise_initializer.gemspec

@@ -1,14 +1,15 @@
-$LOAD_PATH.push File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+$LOAD_PATH.push(File.expand_path("lib", __dir__))
 
 require "hubrise_initializer/version"
 
 Gem::Specification.new do |spec|
-  spec.name = 'hubrise_initializer'
+  spec.name = "hubrise_initializer"
   spec.version = HubriseInitializer::VERSION
 
-  spec.require_paths = ['lib']
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
   spec.authors = ["Antoine Monnier"]
@@ -16,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/hubrise/rails-initializer.git"
   spec.license = "MIT"
 
-  spec.add_runtime_dependency 'lograge', '~> 0.11'
-  spec.add_runtime_dependency 'lograge-sql', '~>1.1'
-  spec.add_runtime_dependency 'act-fluent-logger-rails', '~> 0.6'
-  spec.add_runtime_dependency 'logstash-event', '~> 1.2'
+  spec.add_runtime_dependency("lograge", "~> 0.11")
+  spec.add_runtime_dependency("lograge-sql")
+  spec.add_runtime_dependency("act-fluent-logger-rails", "~> 0.6")
+  spec.add_runtime_dependency("logstash-event", "~> 1.2")
 end

data/lib/hubrise_initializer/lograge.rb

@@ -1,30 +1,35 @@
+# frozen_string_literal: true
 class HubriseInitializer
   class Lograge
     class << self
-      def custom_options(event)
+      def custom_options(_event)
         {}
       end
 
       def custom_payload(controller)
-        request, response = controller.request, controller.response
+        request = controller.request
+        request_headers = process_request_headers(request)
+        response = controller.response
+
         {
-            release: ENV['RELEASE'],
-            host: request.host,
-            ip: request.ip,
-            user_agent: request.user_agent,
-            params: request.query_string.presence
-        }.merge(
-            if ENV['RAILS_LOGRAGE_QUERY'] == 'true'
+          release: ENV["RELEASE"],
+          host: request.host,
+          ip: request.ip,
+          access_token: request_headers["X-Access-Token"], # For the API
+          params: request.query_string.presence,
+        }.compact
+          .merge(
+            if ENV["RAILS_LOGRAGE_QUERY"] == "true"
               {
-                  request_headers: process_request_headers(request).to_s,
-                  request_body: truncate_body(switch_to_utf8(request.raw_post)),
-                  response_headers: response.headers.to_h.to_s,
-                  response_body: truncate_body(switch_to_utf8(response.body))
+                request_headers: request_headers.to_s,
+                request_body: truncate_body(switch_to_utf8(request.raw_post)),
+                response_headers: response.headers.to_h.to_s,
+                response_body: truncate_body(switch_to_utf8(response.body)),
               }
             else
               {}
             end
-        )
+          )
       end
 
       private
@@ -33,7 +38,7 @@ class HubriseInitializer
 
       # Attempt to switch string encoding to utf-8. Return fallback if not a valid utf-8 sequence.
       def switch_to_utf8(s)
-        return if !s
+        return unless s
 
         return s if s.encoding == Encoding::UTF_8
 
@@ -41,23 +46,22 @@ class HubriseInitializer
         return s_utf_8 if s_utf_8.valid_encoding?
 
         # Fallback for binary data
-        return "Binary (#{s.size} bytes)"
+        "Binary (#{s.size} bytes)"
       end
 
       def truncate_body(s)
-        s.present? ? s.squish.truncate(TRUNCATED_BODY_MAX_LENGTH, omission: '...') : nil
+        s.present? ? s.squish.truncate(TRUNCATED_BODY_MAX_LENGTH, omission: "...") : nil
       end
 
       def process_request_headers(request)
-        http_prefix = 'HTTP_'
-        request.headers.inject({}) do |hash, (key, value)|
-          next hash if !key.start_with?(http_prefix)
+        http_prefix = "HTTP_"
+        request.headers.each_with_object({}) do |(key, value), hash|
+          next hash unless key.start_with?(http_prefix)
 
-          header_name = key.gsub(http_prefix, '').split('_').map(&:capitalize).join('-')
+          header_name = key.gsub(http_prefix, "").split("_").map(&:capitalize).join("-")
           hash[header_name] = value
-          hash
         end
       end
     end
   end
-end
+end

data/lib/hubrise_initializer/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class HubriseInitializer
-  VERSION = '0.2.9'.freeze
+  VERSION = "1.0.2"
 end

data/lib/hubrise_initializer.rb

@@ -1,8 +1,9 @@
-require 'lograge'
-require 'act-fluent-logger-rails'
+# frozen_string_literal: true
+require "lograge"
+require "act-fluent-logger-rails"
 
-require 'hubrise_initializer/version'
-require 'hubrise_initializer/lograge'
+require "hubrise_initializer/version"
+require "hubrise_initializer/lograge"
 
 class HubriseInitializer
   class << self
@@ -25,16 +26,16 @@ class HubriseInitializer
       Rails.application.configure do
         config.lograge.base_controller_class = %w[ActionController::API ActionController::Base]
 
-        if log_level = ENV['RAILS_LOG_LEVEL']
+        if (log_level = ENV["RAILS_LOG_LEVEL"])
           config.log_level = log_level
         end
 
-        case ENV['RAILS_LOGGER']
-        when 'stdout'
+        case ENV["RAILS_LOGGER"]
+        when "stdout"
           # Log to STDOUT (docker-compose)
           config.logger = ActiveSupport::Logger.new(STDOUT)
 
-        when 'fluentd'
+        when "fluentd"
           # Log to fluentd (kubernetes)
           # ENV['FLUENTD_URL'] is used internally by this logger
           config.logger = ActFluentLoggerRails::Logger.new
@@ -46,12 +47,12 @@ class HubriseInitializer
           config.lograge.custom_options = lambda { |event| HubriseInitializer::Lograge.custom_options(event) }
           config.lograge.custom_payload { |controller| HubriseInitializer::Lograge.custom_payload(controller) }
 
-          if ENV['RAILS_LOGRAGE_SQL'] == 'true'
-            require 'lograge/sql'
-            require 'lograge/sql/extension'
+          if ENV["RAILS_LOGRAGE_SQL"] == "true"
+            require "lograge/sql"
+            require "lograge/sql/extension"
           end
 
-        else
+        else # rubocop:disable Style/EmptyElse
           # Log to a file (Rails default)
         end
       end
@@ -59,19 +60,19 @@ class HubriseInitializer
 
     def configure_delayed_job_logger
       Rails.application.configure do
-        case ENV['RAILS_LOGGER']
-        when 'stdout'
+        Delayed::Worker.logger = case ENV["RAILS_LOGGER"]
+        when "stdout"
           # Log to STDOUT (docker-compose)
-          Delayed::Worker.logger = ActiveSupport::Logger.new(STDOUT)
+          ActiveSupport::Logger.new(STDOUT)
 
-        when 'fluentd'
+        when "fluentd"
           # Log to fluentd (kubernetes)
           # ENV['FLUENTD_URL'] is used internally by this logger
-          Delayed::Worker.logger = ActFluentLoggerRails::Logger.new
+          ActFluentLoggerRails::Logger.new
 
         else
           # Log to a file
-          Delayed::Worker.logger = ActiveSupport::Logger.new(File.join(Rails.root, 'log', 'delayed_job.log'))
+          ActiveSupport::Logger.new(File.join(Rails.root, "log", "delayed_job.log"))
         end
       end
     end
@@ -79,13 +80,13 @@ class HubriseInitializer
     def configure_web_console
       Rails.application.configure do
         # web_console is generally enabled on dev only
-        return if !config.respond_to?(:web_console)
+        return unless config.respond_to?(:web_console)
 
         # - 172.0.0.0/8: host in docker-compose
         # - 192.168.0.0/16: inter containers network in docker-compose
         # - 10.244.0.0/16: pod networks in Kubernetes
-        config.web_console.whitelisted_ips = ['172.0.0.0/8', '192.168.0.0/16', '10.0.0.0/8']
+        config.web_console.whitelisted_ips = ["172.0.0.0/8", "192.168.0.0/16", "10.0.0.0/8"]
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubrise_initializer
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 1.0.2
 platform: ruby
 authors:
 - Antoine Monnier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -28,16 +28,16 @@ dependencies:
   name: lograge-sql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: act-fluent-logger-rails
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +72,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/spec.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
 - README.md
 - hubrise_initializer.gemspec
 - lib/hubrise_initializer.rb