pier_logging 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a2b1c76716abf96ce6ed1d392d3ac945a3565b05abb16f5400fd1f41a27e509
+  data.tar.gz: 22ab7775f0c76d51075d566b7d8561c8ceed631693661ef6995669f03c51a809
+SHA512:
+  metadata.gz: 54864d9541a7aecb5e470d00b8938d3f1198ffb031ecb7057e2b4bcbe00bf5e3f5f7f953fa39f927071f4d26cf0f8a7c1c1d07f68c0bcee66edaf6700b7597e1
+  data.tar.gz: 5a2230fcf76ac2e0563b9100f90f6841b0c97a1cf907b8e6e017fc65934f92201a1ef8cc64becbf309caf5efcf03a83fd3d5444263c74fe10c244c3e73b5d629

data/.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish gem
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2.1.0
+    - name: Check if version changed
+      uses: tony84727/changed-file-filter@0.0.2
+      id: filter
+      with:
+        filters: |
+          version:
+            - 'lib/pier_logging/version.rb'
+    - name: Setup Ruby
+      # 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'
+      id: new_version
+      run: echo "##[set-output name=version;]$(ruby ./bin/get_current_version.rb)"
+    - name: Create tag
+      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'
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ steps.new_version.outputs.version }}
+        release_name: Release ${{ steps.new_version.outputs.version }}
+        tag_prefix: v
+        draft: false
+        prerelease: false
+    - name: Publish Gem
+      # 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

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pier_logging.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,152 @@
+PATH
+  remote: .
+  specs:
+    pier_logging (0.1.2)
+      awesome_print
+      ougai
+      rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    awesome_print (1.8.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    oj (3.10.6)
+    ougai (1.8.5)
+      oj (~> 3.10)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.2)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 2.1.4)
+  byebug (>= 11.1.3)
+  minitest (>= 5.8.4)
+  pier_logging!
+  rake (>= 12.3.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mauricio Banduk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pier_logging'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pier_logging
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pier_logging.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pier_logging"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/get_current_version.rb

@@ -0,0 +1 @@
+print Gem::Specification::load('pier_logging.gemspec').version.to_s

data/bin/notify_slack_github.sh

@@ -0,0 +1,93 @@
+#!/usr/bin/env bash
+
+# ==================================================================================================
+# Required preset env vars
+# ==================================================================================================
+# SLACK_WEBHOOK: 
+#   The Slack webhook url
+#   Reference: https://slack.com/apps/A0F7XDUAZ-incoming-webhooks
+#   Please use github secrets to store it
+# SLACK_CHANNEL: 
+#   The slack channel to send message to
+#   How to get: https://stackoverflow.com/a/44883343/536807
+#   Please use github secrets to store it
+# STATUS: 
+#   The github action job status
+#   You can get this with `${{ job.status }}`
+# GH_REPO: 
+#   The github repository
+#   You can get this with `${{ github.repository }}`
+# GH_MESSAGE: 
+#   The commit message of the commit to show as code block in the slack message
+#   You can get this with `${{ github.event.commits[0].message }}`
+# GH_ACTOR: 
+#   The person to show as the responsible for the commit
+#   You can get this with `${{ github.actor }}`
+# GH_SHA: 
+#   The sha of the commit
+#   You can get this with `${{ github.sha }}``
+# APP_ENVIRONMENT:
+#   The application environment, usually `production` or `staging`
+# DEPLOY_TARGET:
+#   Where it was deployed to, usually a heroku app name
+# LANGUAGE: 
+#   The main programming language of the project. This is used to show the language
+#   icon on the slack message. We use a bitbucket CDN to get the images. Please test
+#   the image exists before setting it
+#   Known working values: `ruby`, `python`, `nodejs` 
+
+REPO_NAME=`cut -d "/" -f2 <<< "$GH_REPO"`
+NOW=`date +'%s'`
+FOOTER_ICON="https://d301sr5gafysq2.cloudfront.net/e0aa900cf99a/img/repo-avatars/$LANGUAGE.png"
+USERNAME="Github"
+TEXT="\`\`\`$GH_MESSAGE\`\`\`"
+TITLE_LINK="https://github.com/$GH_REPO/commit/$GH_SHA/checks"
+AUTHOR_NAME="$GH_ACTOR"
+AUTHOR_ICON="http://github.com/$GH_ACTOR.png?size=32"
+AUTHOR_LINK="http://github.com/$GH_ACTOR"
+STATUS=`echo $STATUS | tr '[A-Z]' '[a-z]'`
+
+if [ "$STATUS" = "success" ]
+then
+  ICON_EMOJI=":ivete-happy:"
+  NOTIFICATION_COLOR="#5DB182"
+elif [ "$STATUS" = "failure" ]
+then
+  ICON_EMOJI=":ivete-sad:"
+  NOTIFICATION_COLOR="#EC6240"
+else
+  ICON_EMOJI=":ivete:"
+  NOTIFICATION_COLOR="#CCCCCC"
+fi
+
+read -r -d '' body << EOF
+{
+  "channel": "$SLACK_CHANNEL",
+  "username": "$USERNAME",
+  "icon_emoji": "$ICON_EMOJI",
+  "attachments": [
+    {
+      "color": "$NOTIFICATION_COLOR",
+      "title": "[$REPO_NAME] Deploy to $APP_ENVIRONMENT",
+      "text": "$TEXT",
+      "title_link": "$TITLE_LINK",
+      "fallback": "[$REPO_NAME] Successfully deployed to $APP_ENVIRONMENT",
+      "author_name": "$AUTHOR_NAME",
+      "author_icon": "$AUTHOR_ICON",
+      "author_link": "$AUTHOR_LINK",
+      "ts": $NOW,
+      "footer_icon": "$FOOTER_ICON",
+      "footer": "$REPO_NAME",
+      "fields": [ 
+        { "title": "Status", "value": "$STATUS", "short": true },
+        { "title": "Deployed to", "value": "$DEPLOY_TARGET", "short": true }
+      ]
+    }
+  ]
+}
+EOF
+
+curl "$SLACK_WEBHOOK" \
+  -X POST \
+  -H "Content-type: application/json; charset=utf-8" \
+  -d "$body"

data/bin/publish_gem.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fileutils'
+
+def safe_system(*cmd)
+  exit 1 unless system(*cmd)
+end
+
+api_key = ENV['RUBYGEMS_API_KEY'] || 'dummy'
+gemspec_files = Dir.glob('*.gemspec')
+credentials_dir_path = "#{Dir.home}/.gem"
+credentials_file_path = "#{credentials_dir_path}/credentials"
+credentials = <<~END_OF_CREDENTIALS
+  ---
+  :rubygems_api_key: #{api_key}
+END_OF_CREDENTIALS
+
+FileUtils.mkdir_p(credentials_dir_path)
+File.open(credentials_file_path, 'w') { |f| f.write(credentials) }
+FileUtils.chmod(0o600, credentials_file_path)
+
+gemspec_files.each do |gemspec_file|
+  gemspec = Gem::Specification.load(gemspec_file)
+  gem_file = gemspec.full_name + '.gem'
+  safe_system('gem', 'build', gemspec_file)
+  safe_system('gem', 'push', gem_file)
+end

data/bin/rb_lint.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+echo "Checking changed files"
+files=$(git diff --name-only origin/master -- | xargs ls -d 2>/dev/null | egrep "\.(rb|spec|rake|rhtml|rjs|rxml|erb)$")
+echo "Changed files:"
+echo "***"
+echo "$files"
+echo "***"
+if [ -z "$files" ]; then echo "No ruby files were changed"; else echo "$files" | xargs rubocop -l ; fi

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pier_logging.rb

@@ -0,0 +1,69 @@
+require "rails"
+require "ougai"
+require "pier_logging/version"
+require "pier_logging/logger"
+require "pier_logging/request_logger"
+require "pier_logging/formatter/base"
+require "pier_logging/formatter/json"
+require "pier_logging/formatter/readable"
+
+module PierLogging
+  def self.logger_configuration
+    @logger_configuration ||= LoggerConfiguration.new
+  end
+
+  def self.configure_logger
+    yield(logger_configuration)
+  end
+
+  def self.request_logger_configuration
+    @request_logger_configuration ||= RequestLoggerConfiguration.new
+  end
+
+  def self.configure_request_logger
+    yield(request_logger_configuration)
+  end
+
+  class LoggerConfiguration
+    attr_reader :app_name, :env, :formatter
+
+    def initialize
+      @app_name = nil
+      @env = nil
+      @formatter = Formatter::Json.new
+    end
+
+    def app_name=(app_name)
+      raise ArgumentError, "Config 'app_name' must be a String" unless app_name.is_a?(String)
+      @app_name = app_name
+    end
+    
+    def env=(env)
+      raise ArgumentError, "Config 'env' must be a String" unless env.is_a?(String)
+      @env = env
+    end
+
+    def formatter=(formatter)
+      raise ArgumentError, "Config 'formatter' must be a 'Ougai::Formatters::Base'" unless formatter.is_a?(Ougai::Formatters::Base)
+      @formatter = formatter
+    end
+  end
+
+  class RequestLoggerConfiguration
+    attr_reader :enabled, :user_info_getter
+
+    def initialize
+      @user_info_getter = nil
+      @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
+    end
+    
+    def enabled=(enabled = false)
+      @enabled = enabled
+    end
+  end
+end

data/lib/pier_logging/formatter/base.rb

@@ -0,0 +1,48 @@
+
+# The base formatter
+module PierLogging
+  module Formatter
+    class Base < Ougai::Formatters::Base
+      include Ougai::Formatters::ForJson
+      
+      def initialize(app_name = nil, hostname = nil, opts = {})
+        aname, hname, opts = Ougai::Formatters::Base.parse_new_params([app_name, hostname, opts])
+        super(aname, hname, opts)
+      end
+
+      def get_message(data)
+        # Use `message` (besides `msg` - ougai default) as the message field
+        if data.is_a?(Hash)
+          msg = data.delete(:msg)
+          data[:message] = msg if !data[:message]
+        end
+        data.delete(:message)
+      end
+
+      def get_message_type(data)
+        data.delete(:type) || 'default'
+      end
+
+      def get_log_content(severity, time, message, message_type, data)
+        dump({
+          env: PierLogging.logger_configuration.env,
+          app: PierLogging.logger_configuration.app_name,
+          level: severity.downcase,
+          timestamp: time,
+          message: message,
+          type: message_type,
+        }.merge({ fields: data }))
+      end
+
+      def _call(severity, time, progname, data)
+        message = get_message(data)
+        message_type = get_message_type(data)
+        get_log_content(severity, time, message, message_type, data)
+      end
+
+      def convert_time(data)
+        data[:timestamp] = data[:timestamp].utc.iso8601(3)
+      end
+    end
+  end
+end

data/lib/pier_logging/formatter/json.rb

@@ -0,0 +1,13 @@
+
+# A JSON formatter
+module PierLogging
+  module Formatter
+    class Json < Base
+      def initialize(app_name = nil, hostname = nil, opts = {})
+        aname, hname, opts = Ougai::Formatters::Base.parse_new_params([app_name, hostname, opts])
+        super(aname, hname, opts)
+        init_opts_for_json(opts)
+      end
+    end
+  end
+end

data/lib/pier_logging/formatter/readable.rb

@@ -0,0 +1,10 @@
+# A Readable formatter
+module PierLogging
+  module Formatter
+    class Readable < Base
+      def get_log_content(severity, time, message, message_type, data)
+        super.ai
+      end
+    end
+  end
+end

data/lib/pier_logging/logger.rb

@@ -0,0 +1,11 @@
+
+module PierLogging
+  class Logger < Ougai::Logger
+    include ActiveSupport::LoggerThreadSafeLevel
+    include ActiveSupport::LoggerSilence
+
+    def create_formatter
+      PierLogging.logger_configuration.formatter
+    end
+  end
+end

data/lib/pier_logging/request_logger.rb

@@ -0,0 +1,144 @@
+# Requiring only the part that we need
+require 'facets/hash/traverse'
+module PierLogging
+  class RequestLogger
+    REDACT_REPLACE_KEYS = [
+      /passw(or)?d/i,
+      /^pw$/,
+      /^pass$/i,
+      /secret/i,
+      /token/i,
+      /api[-._]?key/i,
+      /session[-._]?id/i,
+      /^connect\.sid$/
+    ].freeze
+    REDACT_REPLACE_BY = '*'.freeze
+    
+    attr_reader :logger
+
+    def initialize(app, logger = PierLogging::Logger.new(STDOUT))
+      @app = app
+      @logger = logger
+    end
+
+    def call(env)
+      starts_at = Time.now.utc
+      begin
+        status, type, body = response = @app.call(env)
+        log([env, status, type, body, starts_at, Time.now.utc, nil])
+      rescue Exception => exception
+        status = determine_status_code_from_exception(exception)
+        type = determine_type_from_exception(exception)
+        body = determine_body_from_exception(exception)
+        log([env, status, type, body, starts_at, Time.now.utc, exception])
+        raise exception
+      end
+
+      response
+    end
+
+    # Optimization https://github.com/JuanitoFatas/fast-ruby#function-with-single-array-argument-vs-splat-arguments-code
+    def log(args)
+      return unless PierLogging.request_logger_configuration.enabled
+
+      env, status, type, body, starts_at, ends_at, _ = args
+      request = Rack::Request.new(env)
+      request_headers = get_request_headers_from_env(env)
+      logger.info redact_hash({
+        message: build_message_from_request(request),
+        type: 'http',
+        duration: ((ends_at - starts_at)*1000).to_i,
+        context: {
+          user: get_user_info_from_headers(request_headers),
+          correlation_id: env['action_dispatch.request_id'],
+        },
+        request: {
+          headers: request_headers,
+          href: request.url,
+          body: parse_body(request.POST)
+        },
+        response: {
+          status: status,
+          body: parse_body(body),
+          type: type['Content-Type'],
+        }
+      })
+    rescue StandardError => error
+      # 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
+
+    private
+    def get_request_headers_from_env(env)
+      env.select { |k,v| k.start_with? 'HTTP_'}.
+        transform_keys { |k| k.delete_prefix('HTTP_').split('_').join('-').upcase }
+    end
+
+    def build_message_from_request(request)
+      [
+        request.request_method.upcase, 
+        [request.base_url,request.path].join(''),
+      ].join(' ')
+    end
+
+    def get_user_info_from_headers(headers)
+      PierLogging.request_logger_configuration.user_info_getter.call(headers)
+    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
+    rescue
+      body
+    end
+
+    def redact_hash(hash)
+      hash.traverse do |k,v| 
+        should_redact = REDACT_REPLACE_KEYS.any?{ |regex| k =~regex }
+        if (should_redact)
+          [k, REDACT_REPLACE_BY]
+        else
+          [k, v]
+        end
+      end
+    end
+
+    def determine_body_from_exception(exception)
+      { message: exception.message }
+    end
+
+    def determine_type_from_exception(exception)
+      'application/json'
+    end
+
+    def determine_status_code_from_exception(exception)
+      exception_wrapper = ActionDispatch::ExceptionWrapper.new(nil, exception)
+      exception_wrapper.status_code
+    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

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

data/pier_logging.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pier_logging/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pier_logging"
+  spec.version       = PierLogging::VERSION
+  spec.authors       = ["Mauricio Banduk"]
+  spec.email         = ["mauricio.banduk@pier.digital"]
+
+  spec.summary       = %q{Structured log used on Pier Applications}
+  spec.description   = %q{Defines a basic structure for general and request logging}
+  spec.homepage      = "https://github.com/pier-digital"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ougai"
+  spec.add_dependency "awesome_print"
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", ">= 2.1.4"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "minitest", ">= 5.8.4"
+  spec.add_development_dependency "byebug", ">= 11.1.3"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: pier_logging
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Mauricio Banduk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ougai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.4
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+description: Defines a basic structure for general and request logging
+email:
+- mauricio.banduk@pier.digital
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/publish.yml"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/get_current_version.rb
+- bin/notify_slack_github.sh
+- bin/publish_gem.rb
+- bin/rb_lint.sh
+- bin/setup
+- lib/pier_logging.rb
+- lib/pier_logging/formatter/base.rb
+- lib/pier_logging/formatter/json.rb
+- lib/pier_logging/formatter/readable.rb
+- lib/pier_logging/logger.rb
+- lib/pier_logging/request_logger.rb
+- lib/pier_logging/version.rb
+- pier_logging.gemspec
+homepage: https://github.com/pier-digital
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Structured log used on Pier Applications
+test_files: []