pier_logging 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a2b1c76716abf96ce6ed1d392d3ac945a3565b05abb16f5400fd1f41a27e509
-  data.tar.gz: 22ab7775f0c76d51075d566b7d8561c8ceed631693661ef6995669f03c51a809
+  metadata.gz: 1edbf6a4c1e0e1bcce41d72a274024cc03c3cbe1f1b7d024895ff9e22233c3de
+  data.tar.gz: f8e35c6786a7f91ad63390ba2e967c585515347e2f5a572e0207d85b701ab3f3
 SHA512:
-  metadata.gz: 54864d9541a7aecb5e470d00b8938d3f1198ffb031ecb7057e2b4bcbe00bf5e3f5f7f953fa39f927071f4d26cf0f8a7c1c1d07f68c0bcee66edaf6700b7597e1
-  data.tar.gz: 5a2230fcf76ac2e0563b9100f90f6841b0c97a1cf907b8e6e017fc65934f92201a1ef8cc64becbf309caf5efcf03a83fd3d5444263c74fe10c244c3e73b5d629
+  metadata.gz: 59cd614cbff2b29fa81ee854550774e9257eef41606683be53b80f436fbcf111cb6487d81fb4190e1b06a054d83b77225da1700120c456ca90808270ba7cbcb4
+  data.tar.gz: 7119018bce9343ac5a9542a0ab11b28656b8853e22d33b5cf14eb00f50e827606a4c0731209255c6e698d0d0a5dff1d4b4ebf5066bf279fff24c2d99d5c20663

data/.github/CODEOWNERS

@@ -0,0 +1,40 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+*               @pier-digital/backend
+.github/*       @pier-digital/backend @pier-digital/devops
+bin/*           @pier-digital/backend @pier-digital/devops
+
+# # Order is important; the last matching pattern takes the most
+# # precedence. When someone opens a pull request that only
+# # modifies JS files, only @js-owner and not the global
+# # owner(s) will be requested for a review.
+# *.js    @js-owner
+
+# # You can also use email addresses if you prefer. They'll be
+# # used to look up users just like we do for commit author
+# # emails.
+# *.go docs@example.com
+
+# # In this example, @doctocat owns any files in the build/logs
+# # directory at the root of the repository and any of its
+# # subdirectories.
+# /build/logs/ @doctocat
+
+# # The `docs/*` pattern will match files like
+# # `docs/getting-started.md` but not further nested files like
+# # `docs/build-app/troubleshooting.md`.
+# docs/*  docs@example.com
+
+# # In this example, @octocat owns any file in an apps directory
+# # anywhere in your repository.
+# apps/ @octocat
+
+# # In this example, @doctocat owns any file in the `/docs`
+# # directory in the root of your repository.
+# /docs/ @doctocat
+

data/.github/workflows/publish.yml

@@ -18,21 +18,22 @@ jobs:
           version:
             - 'lib/pier_logging/version.rb'
     - name: Setup Ruby
-      # if: steps.filter.outputs.version == 'true'
+      if: steps.filter.outputs.version == 'true'
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.7.1
     - name: Get version
-      # if: steps.filter.outputs.version == 'true'
+      if: steps.filter.outputs.version == 'true'
       id: new_version
       run: echo "##[set-output name=version;]$(ruby ./bin/get_current_version.rb)"
     - name: Create tag
+      if: steps.filter.outputs.version == 'true'
       uses: tvdias/github-tagger@v0.0.1
       with:
         repo-token: "${{ secrets.GITHUB_TOKEN }}"
         tag: "${{ steps.new_version.outputs.version }}"
     - name: Create Release
-      # if: steps.filter.outputs.version == 'true'
+      if: steps.filter.outputs.version == 'true'
       id: create_release
       uses: actions/create-release@v1
       env:
@@ -44,8 +45,22 @@ jobs:
         draft: false
         prerelease: false
     - name: Publish Gem
-      # if: steps.filter.outputs.version == 'true'
+      if: steps.filter.outputs.version == 'true'
       env:
         VERSION: ${{ steps.new_version.outputs.version }}
         RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
       run: ruby ./bin/publish_gem.rb
+    - name: Notify deploy status to Slack
+      if: steps.filter.outputs.version == 'true'
+      env:
+        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+        STATUS: ${{ job.status }}
+        GH_MESSAGE: ${{ github.event.commits[0].message }}
+        GH_ACTOR: ${{ github.actor }}
+        GH_SHA: ${{ github.sha }}
+        GH_REPO: ${{ github.repository }}
+        APP_ENVIRONMENT: rubygems
+        SLACK_CHANNEL: CEBAD7R0F
+        LANGUAGE: "ruby" # "python", "nodejs" 
+        DEPLOY_TARGET: ${{ github.event.repository.name }}
+      run: /bin/bash ./bin/notify_slack_github.sh

data/README.md

@@ -1,8 +1,6 @@
 # PierLogging
 
-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/pier_logging`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A gem developed by [PIER](https://www.pier.digital/) to standardize our logs (request and general-purpose)
 
 ## Installation
 
@@ -22,17 +20,75 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+- Create an initializer at `config/initializers/pier_logging.rb` to configure the gem.
+- Configure General-purpose logging, Request logging and register the request logger rails middleware.
+- Configure your logger on `config/application.rb` to use `PierLogging::Logger`
+
+### General-purpose logging
+
+Use `PierLogging.configure_logger` block to configure general-purpose logs. Accepted configs are:
+
+| config    | Required | Type                      | Default                            |
+| --------- | --------:| -------------------------:| ----------------------------------:|
+| app_name  | true     | string                    | nil                                |
+| env       | true     | string                    | nil                                |
+| formatter | false    | `Ougai::Formatters::Base` | `PierLogging::Formatter::Json.new` |
+
+### Request logging
+
+Use `PierLogging.configure_request_logger` block to configure request logs. Accepted configs are:
+
+| config           | Required | Type            | Default    |
+| ---------------- | --------:| ---------------:| ----------:|
+| enabled          | false    | boolean         | false      |
+| user_info_getter | true     | block (headers) | nil        |
+
+The block passed to `user_info_getter` receives the headers of the request so you can use your headers to define the username or role. 
 
-## Development
+You have at your disposal the following helper methods:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- has_basic_credentials(headers): checks if there are basic auth credentials in the header
+- get_basic_credentials_user(headers): get the user from the basic auth credential
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Example
+
+```ruby
+# config/initializers/pier_logging.rb
+
+PierLogging.configure_logger do |config|
+  config.app_name = Rails.application.class.module_parent_name.underscore.dasherize
+  config.env = Rails.env
+  config.formatter = Rails.env.production? ? PierLogging::Formatter::Json.new : 
+    PierLogging::Formatter::Readable.new
+end 
+
+PierLogging.configure_request_logger do |config|
+  config.user_info_getter do |headers|
+    if headers['MY-USER-HEADER'].present?
+      { username: headers['MY-USER-HEADER']  }
+    elsif has_basic_credentials?(headers)
+      { username: get_basic_credentials_user(headers) }
+    else
+      { username: 'anonymous' }
+    end
+  end
+  config.enabled = ENV.fetch('REQUEST_LOG_ENABLED', 'true') == 'true'
+end
+
+Rails.application.config.middleware.use PierLogging::RequestLogger, PierLogging::Logger.new(STDOUT)
+```
+
+```ruby
+# config/application.rb
+
+# ...
+config.logger = PierLogging::Logger.new(STDOUT)
+# ...
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pier_logging.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pier-digital/pier_logging.
 
 ## License
 

data/lib/pier_logging.rb

@@ -6,6 +6,7 @@ require "pier_logging/request_logger"
 require "pier_logging/formatter/base"
 require "pier_logging/formatter/json"
 require "pier_logging/formatter/readable"
+require "pier_logging/helpers/headers"
 
 module PierLogging
   def self.logger_configuration
@@ -57,12 +58,13 @@ module PierLogging
       @enabled = false
     end
 
-    def user_info_getter(&block)
-      raise ArgumentError, "Config 'user_info_getter' must be a 'Proc'" unless block_given?
-      @user_info_getter = block
+    def user_info_getter=(proc)
+      raise ArgumentError, "Config 'user_info_getter' must be a 'Proc'" unless proc.is_a? Proc
+      @user_info_getter = proc
     end
     
     def enabled=(enabled = false)
+      raise ArgumentError, "Config 'enabled' must be a 'boolean'" unless !!enabled == enabled
       @enabled = enabled
     end
   end

data/lib/pier_logging/helpers/headers.rb

@@ -0,0 +1,20 @@
+module PierLogging
+  module Helpers
+    class Headers
+      def self.has_basic_credentials?(headers)
+        auth_header = headers['AUTHENTICATION'].to_s
+        return false if auth_header.blank?
+        # Optimization: https://github.com/JuanitoFatas/fast-ruby#stringcasecmp-vs-stringdowncase---code
+        return false if auth_header.split(' ', 2)[0].casecmp('basic') == 0
+        return false if auth_header.split(' ', 2)[1].blank?
+        return true
+      end
+
+      def self.get_basic_credentials_user(headers)
+        auth_headers = headers['AUTHENTICATION'].to_s
+        credentials = auth_headers.split(' ', 2)[1]
+        ::Base64.decode64(credentials).split(':', 2)[0]
+      end
+    end
+  end
+end

data/lib/pier_logging/request_logger.rb

@@ -67,7 +67,7 @@ module PierLogging
       # We should never fall in this part as the only errors that could result in this are errors
       # in our logger (inside this same method)
       @logger.error(error.message)
-    end
+    end 
 
     private
     def get_request_headers_from_env(env)
@@ -87,16 +87,15 @@ module PierLogging
     end
 
     def parse_body(body)
-      if body.is_a? String # when string
-        JSON.parse(body, nil, allow_blank: true)
-      elsif body.is_a? Array # Grape body
-        JSON.parse(body.last, nil, allow_blank: true)
-      elsif body.is_a? ActionDispatch::Response::RackBody # Rails body
-        JSON.parse(body.body, nil, allow_blank: true)
-      else
-        body
-      end
+      body_object = get_body_object(body)
+      Oj.load(body_object, allow_blank: true)
     rescue
+      body_object || body
+    end
+
+    def get_body_object(body)
+      return body.last if body.is_a? Array # Grape body
+      return body.body if body.is_a? ActionDispatch::Response::RackBody # Rails body
       body
     end
 
@@ -125,20 +124,5 @@ module PierLogging
     rescue
       500
     end
-
-    def has_basic_credentials?(headers)
-      auth_header = headers['AUTHENTICATION'].to_s
-      return false if auth_header.blank?
-      # Optimization: https://github.com/JuanitoFatas/fast-ruby#stringcasecmp-vs-stringdowncase---code
-      return false if auth_header.split(' ', 2)[0].casecmp('basic') == 0
-      return false if auth_header.split(' ', 2)[1].blank?
-      return true
-    end
-
-    def get_basic_credentials_user(headers)
-      auth_headers = headers['AUTHENTICATION'].to_s
-      credentials = auth_headers.split(' ', 2)[1]
-      ::Base64.decode64(credentials).split(':', 2)[0]
-    end 
   end
 end

data/lib/pier_logging/version.rb

@@ -1,3 +1,3 @@
 module PierLogging
-  VERSION = "0.1.2"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pier_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Mauricio Banduk
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
 - ".github/workflows/publish.yml"
 - ".gitignore"
 - ".ruby-version"
@@ -134,6 +135,7 @@ files:
 - lib/pier_logging/formatter/base.rb
 - lib/pier_logging/formatter/json.rb
 - lib/pier_logging/formatter/readable.rb
+- lib/pier_logging/helpers/headers.rb
 - lib/pier_logging/logger.rb
 - lib/pier_logging/request_logger.rb
 - lib/pier_logging/version.rb