researchable_loggable 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b483e9b1dcee65ba39a14ee62c76b0f81a92751ca755072bcae1c45c84954bb
-  data.tar.gz: c2de92b359b3d87bda96673eee61d141641a52e5e264f691f453f7800f01bd12
+  metadata.gz: 2a23495beab24247d68a2d16b22b47c63dc62907f5a0cd97a2bf239a697d7bae
+  data.tar.gz: 6da7d0c63b104be64d7ba13006db69cc2ff24610ea6494db4460db4db328620b
 SHA512:
-  metadata.gz: 45d49f54d2b674d2f5e0e23fd659f7b2ae988732e5261a5070c529b4ed959aadc7c47b36a91078bc10d8edaef272a7a73d0abaa610c3b4c41dd01518e4715cc8
-  data.tar.gz: 7468411333b7e4d7014c29dc825e23a54902af8a895629b99ab09817cdedab2fddb668ca54108597bea3e494049356dce38df0d66e4dbdc41ee302d07e81dedc
+  metadata.gz: 5d169fe09836a0aaa5d9a8537590e77ccbfb2a8b8fd5998a71bd9eb1ec3913d20f84deec030274c361e20f18284ec10df825eb8d1635d17f561beb4678471eaa
+  data.tar.gz: 7675af41ca588f916a67dc4ac782bdd21480d0b043ef22f4412cc7dbae063d4be23eaad9bb95bf9d7d7e33abc2c265900e289c987c23787b920c7fd9238e5156

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.1.0](https://gitlab.com/researchable/general/gems/loggable/compare/v1.0.2...v1.1.0) (2023-07-06)
+
+
+### Features
+
+* **config:** Support other current_user_method ([e5797ba](https://gitlab.com/researchable/general/gems/loggable/commit/e5797ba6cc7f2a3e589895cf05ba2f4a109b10e1))
+
+## [1.0.2](https://gitlab.com/researchable/general/gems/loggable/compare/v1.0.1...v1.0.2) (2023-06-27)
+
+
+### Bug Fixes
+
+* gem not being properly loaded ([7e19afd](https://gitlab.com/researchable/general/gems/loggable/commit/7e19afdfc3252303bfb363061c88f7a168ca0779))
+
 ## [1.0.1](https://gitlab.com/researchable/general/gems/loggable/compare/v1.0.0...v1.0.1) (2023-03-08)
 
 

data/Gemfile

@@ -9,8 +9,7 @@ gem 'rake', '~> 13.0'
 
 gem 'rspec', '~> 3.0'
 
-# TODO: remove ref once first implementation has been merged to master
-gem 'ruboguide', git: 'https://gitlab.com/researchable/general/gems/ruboguide'
+gem 'ruboguide', '~> 1.0'
 
 gem 'ecs-logging', '~> 1.0'
 gem 'lograge'

data/Gemfile.lock

@@ -1,18 +1,7 @@
-GIT
-  remote: https://gitlab.com/researchable/general/gems/ruboguide
-  revision: fd7b55c93c3ebfe63aed5cb7e5c9c38bd4a45020
-  specs:
-    ruboguide (0.1.0)
-      rubocop (= 1.23.0)
-      rubocop-performance (= 1.12.0)
-      rubocop-rails (= 2.12.4)
-      rubocop-rake (= 0.6.0)
-      rubocop-rspec (= 2.6.0)
-
 PATH
   remote: .
   specs:
-    researchable_loggable (1.0.0)
+    researchable_loggable (1.0.2)
       ecs-logging (~> 1.0)
       lograge
       logstash-event
@@ -61,7 +50,7 @@ GEM
     nokogiri (1.14.1-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.2.1.0)
+    parser (3.2.1.1)
       ast (~> 2.4.1)
     racc (1.6.2)
     rack (2.2.6.2)
@@ -107,7 +96,7 @@ GEM
       rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.26.0)
+    rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
     rubocop-performance (1.12.0)
       rubocop (>= 1.7.0, < 2.0)
@@ -120,7 +109,13 @@ GEM
       rubocop (~> 1.0)
     rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
+    ruboguide (1.0.0)
+      rubocop (= 1.23.0)
+      rubocop-performance (= 1.12.0)
+      rubocop-rails (= 2.12.4)
+      rubocop-rake (= 0.6.0)
+      rubocop-rspec (= 2.6.0)
+    ruby-progressbar (1.13.0)
     thor (1.2.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -137,7 +132,7 @@ DEPENDENCIES
   rake (~> 13.0)
   researchable_loggable!
   rspec (~> 3.0)
-  ruboguide!
+  ruboguide (~> 1.0)
 
 BUNDLED WITH
    2.4.6

data/README.md

@@ -39,9 +39,9 @@ of lograge as the message, however some of the fields in the lograge output are
 monkey patch on the ECS gem that flattens the lograge output onto the Ecs object.
 
 ## Installation
-Add this to your Gemfile (replace the tag with your intended one):
+Add this to your Gemfile:
 ```ruby
-gem 'loggable', git: 'https://gitlab.com/researchable/general/gems/loggable'
+gem 'researchable_loggable', '~> 1.0'
 ```
 
 Additionally, if you want to be able to correlate logs with Elastic's APM traces, you may also add the elastic apm gem:
@@ -61,7 +61,11 @@ If loggable detects the presence of this gem, it will inject `transaction.id`, `
 For a brand new Rails application, adding this gem to the Gemfile should be all the configuration that is needed. This
 gem will automatically configure the Rails logger and lograge to follow the Researchable standard.
 
-There is only one parameter that is configurable, and that is `production_like`. By default loggable will only 
+
+### Parameters
+This are the parameters that can be configured in the `config.loggable` namespace:
+
+`production_like`. By default loggable will only 
 modify how the logs look on production. This is because the format that this gem enforces is slightly less 
 human readable (in favour of machine readability and compatibility with the Elastic Common Schema) than the default 
 Rails one. For development, the more human readable format is preferred. However, if you want to override this and
@@ -71,6 +75,12 @@ are developing against this gem) then you may add the following to your `config/
 config.loggable.production_like = true
 ```
 
+`current_user_method`. This is the name of the method that will be called on the controller to get the current user. By default this is set to `current_user`. If you want to override this, you may add the following to your `config/application.rb` file:
+```ruby
+config.loggable.current_user_method = :my_current_user_method
+```
+This method is used for ECS logging, if the method is not found, the user.id field will be set to nil.
+
 No other configuration options are provided because this gem seeks to enforce consistency across all applications.
 
 For applications that already had some level of log customization, some cleanup might be needed:

data/lib/loggable/railtie.rb

@@ -9,9 +9,11 @@ module Loggable
     # We add a new loggable namespace to the config object, to keep all the configuration related to this gem organized
     config.loggable = ActiveSupport::OrderedOptions.new
     config.loggable.production_like = false
+    config.loggable.current_user_method = :current_user
 
     # Initializer runs before initialize_logger (found in Bootstrap) so from the very beginning we are logging using
     # the ecs format, even during the initialization process
+    # rubocop:disable Metrics/BlockLength
     initializer :loggable_web, before: :initialize_logger do
       Rails.application.configure do
         production_like = Rails.env.production? || config.loggable.production_like
@@ -25,10 +27,13 @@ module Loggable
         config.lograge.base_controller_class = 'ApplicationController'
         config.lograge.custom_payload do |controller|
           response_code = controller.response.code
+          if controller.respond_to?(config.loggable.current_user_method)
+            user_id = controller.send(config.loggable.current_user_method).try(:id)
+          end
           {
             ecs: {
               'source.ip': controller.request.ip,
-              'user.id': controller.current_user.try(:id),
+              'user.id': user_id,
               'http.code': response_code
             },
             status: response_code
@@ -41,6 +46,7 @@ module Loggable
         config.lograge.formatter = Loggable::Lograge::Formatter.new if production_like
       end
     end
+    # rubocop:enable Metrics/BlockLength
 
     initializer :loggable_worker, before: :initializer_logger do
       Rails.application.configure do

data/lib/loggable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Loggable
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/{loggable.rb → researchable_loggable.rb}

@@ -5,7 +5,7 @@ require_relative 'loggable/railtie' if defined?(Rails::Railtie)
 require_relative 'loggable/ecs_logging/formatter_monkey_patch'
 require_relative 'loggable/lograge/formatter'
 
-module Loggable
+module ResearchableLoggable
   class Error < StandardError
   end
 end

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestGem
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: researchable_loggable
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Researchable
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecs-logging
@@ -72,22 +72,22 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/loggable.rb
 - lib/loggable/ecs_logging/formatter_monkey_patch.rb
 - lib/loggable/lograge/formatter.rb
 - lib/loggable/railtie.rb
 - lib/loggable/version.rb
+- lib/researchable_loggable.rb
 - node_modules/semantic-release-rubygem/src/__tests__/fixtures/invalid-version-file/lib/test-gem/version.rb
 - node_modules/semantic-release-rubygem/src/__tests__/fixtures/prerelease/lib/test-gem/version.rb
 - node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb
 - sig/loggable.rbs
-homepage: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.0.1/README.md
+homepage: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.1.0/README.md
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.0.1/README.md
+  homepage_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.1.0/README.md
   source_code_uri: https://gitlab.com/researchable/general/gems/loggable
-  changelog_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.0.1/CHANGELOG.md
+  changelog_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.1.0/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Researchable's gem to standardize logging on all Rails applications.