hickory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06f7b612145ede0127857dac94e78b6e90538f6a
+  data.tar.gz: ee7f5b25696032a1281ea16cb788e4e7e2b9235c
+SHA512:
+  metadata.gz: b5fde2b0952019adcb2deb38bcf7fda83741258f0eeed946dd955c939c33508afbf6b46535c3812370b3a2bc94bb2c26bf257f780aa98a3d8bd99a710a6a81ac
+  data.tar.gz: d3f6e63eb0d1e57ceec88ffe447f0b11dbc42a81a4d7af3520df4cb85da7670172b6689a8eae675680b9308840e710dafdd4ba8c90fec6c8c41633853184ba5f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

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 hickory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 blahed
+
+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 @@
+# Hickory
+
+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/hickory`. 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 'hickory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hickory
+
+## 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]/hickory.
+
+## 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 "hickory"
+
+# 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/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/hickory.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hickory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hickory'
+  spec.version       = Hickory::VERSION
+  spec.authors       = ['blahed']
+  spec.email         = ['trvsdnn@gmail.com']
+
+  spec.summary       = 'An opinionated logger for rails and ruby.'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/hickory/ext/rails/rack/logger.rb

@@ -0,0 +1,21 @@
+require 'active_support/concern'
+require 'rails/rack/logger'
+
+module Rails
+  module Rack
+    # Overwrites defaults of Rails::Rack::Logger that cause
+    # unnecessary logging.
+    # This effectively removes the log lines from the log
+    # that say:
+    # Started GET / for 192.168.2.1...
+    class Logger
+      # Overwrites Rails 3.2 code that logs new requests
+      def call_app(*args)
+        env = args.last
+        @app.call(env)
+      ensure
+        ActiveSupport::LogSubscriber.flush_all!
+      end
+    end
+  end
+end

data/lib/hickory/formatters/json.rb

@@ -0,0 +1,26 @@
+module Hickory
+  module Formatters
+    class JSON < ::Logger::Formatter
+      def initialize(options = {})
+        @key_mappings = Hash.new.tap { |mapping|
+          mapping[:message]   = options.fetch(:message_key, :message)
+          mapping[:severity]  = options.fetch(:severity_key, :level)
+          mapping[:timestamp] = options.fetch(:timestamp_key, :timestamp)
+          mapping[:env]       = options.fetch(:env_key, :env)
+        }
+      end
+
+      def call(severity, time, progname, msg)
+        line = msg.tap { |message|
+          message[@key_mappings[:message]]      = msg.delete(:message) unless @key_mappings[:message] == :message
+          message[@key_mappings[:timestamp]]    = time
+          message[@key_mappings[:severity]]     = severity
+          message[@key_mappings[:env]]          = Rails.env
+          message[:progname]                    = progname if progname.present?
+        }
+
+        line.to_json
+      end
+    end
+  end
+end

data/lib/hickory/formatters/simple.rb

@@ -0,0 +1,12 @@
+module Hickory
+  module Formatters
+    class Simple < ::Logger::Formatter
+      def call(severity, time, progname, msg)
+        message  = msg.delete(:message)
+        metadata = msg.map {|k,v| "#{k}=#{v}" }.join(' ')
+
+        "#{message} #{metadata}\n"
+      end
+    end
+  end
+end

data/lib/hickory/log_subscribers/action_controller.rb

@@ -0,0 +1,62 @@
+module Hickory
+  module LogSubscribers
+    class ActionController < ActiveSupport::LogSubscriber
+      def process_action(event)
+        return if Hickory.ignore_if.present? && Hickory.ignore_if.call(event)
+
+        payload = event.payload
+        default_keys = %i[method format controller action user_id request_id]
+
+        metadata = payload.slice(default_keys).tap { |data|
+          data.merge!(uri(payload))
+          data.merge!(runtimes(event, payload))
+          data.merge!(status(payload))
+          data.merge!(params(payload))
+        }
+
+        logger.info('canoncial-request', metadata)
+      end
+
+      private
+
+      def uri(payload)
+        return {} unless payload.key?(:path)
+
+        _uri = URI.parse(payload[:path])
+
+        { path: _uri.path }.tap { |data|
+          data[:query] = _uri.query unless _uri.query.nil?
+        }
+      end
+
+      def runtimes(event, payload)
+        { duration: event.duration.to_f.round(2) }.tap { |data|
+          data[:view] = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
+          data[:db]  = payload[:db_runtime].to_f.round(2) if payload.key?(:db_runtime)
+        }
+      end
+
+      def status(payload)
+        if status = payload[:status]
+          { status: status.to_i }
+        elsif error = payload[:exception]
+          exception, message = error
+          { status: get_error_status_code(exception), error: "#{exception}: #{message}" }
+        else
+          { status: 0 }
+        end
+      end
+
+      def params(payload)
+        {
+          params: payload[:params].except(:controller, :action, :format)
+        }
+      end
+
+      def get_error_status_code(exception)
+        status = ActionDispatch::ExceptionWrapper.rescue_responses[exception]
+        Rack::Utils.status_code(status)
+      end
+    end
+  end
+end

data/lib/hickory/log_subscribers/action_mailer.rb

@@ -0,0 +1,35 @@
+module Hickory
+  module LogSubscribers
+    class ActionMailer < ActiveSupport::LogSubscriber
+      def process(event)
+        metadata = {
+          mailer: event.payload[:mailer],
+          action: event.payload[:action]
+        }
+
+        logger.info('mailer-process', metadata)
+      end
+
+      def deliver(event)
+        payload = event.payload
+        metadata = {
+          mailer:     payload[:mailer],
+          message_id: payload[:message_id],
+          subject:    payload[:subject],
+          to:         obfuscate_emails(payload[:to]),
+          from:       obfuscate_emails(payload[:from])
+        }
+
+        logger.info('mailer-deliver', metadata)
+      end
+
+      private
+
+      def obfuscate_emails(emails)
+        emails.map do |email|
+          email.sub(/([^\s]+)@([^\s]+)/) { |_| "#{$1[0...4]}****@#{$2[0...3]}***" }
+        end.join(', ')
+      end
+    end
+  end
+end

data/lib/hickory/log_subscribers/active_job.rb

@@ -0,0 +1,59 @@
+module Hickory
+  module LogSubscribers
+    class ActiveJob < ActiveSupport::LogSubscriber
+      def enqueue(event)
+        logger.info('job-enqueued', job_metadata(event))
+      end
+
+      def enqueue_retry(event)
+        metadata = job_metadata(event)
+        metadata.merge!({
+          error: event.payload[:error],
+          wait: event.payload[:wait]
+        })
+
+        logger.info('job-retry-enqueued', metadata)
+      end
+
+      def perform_start(event)
+        logger.info('job-perform-start', job_metadata(event))
+      end
+
+      def perform(event)
+        logger.info('job-perform', job_metadata(event))
+      end
+
+      def retry_stopped(event)
+        metadata = job_metadata(event)
+        metadata.merge!({
+          error: event.payload[:error]
+        })
+
+        logger.info('job-retry-stopped', metadata)
+      end
+
+      def retry_discard(event)
+        metadata = job_metadata(event)
+        metadata.merge!({
+          error: event.payload[:error]
+        })
+
+        logger.info('job-discard', metadata)
+      end
+
+      private
+
+      def job_metadata(event)
+        job = event.payload[:job]
+
+        {
+          job_id: job.job_id,
+          queue: job.queue_name,
+          priority: job.priority,
+          executions: job.executions
+        }
+      end
+
+    end
+  end
+end

data/lib/hickory/log_subscribers/base.rb

@@ -0,0 +1,68 @@
+require 'json'
+require 'action_pack'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/log_subscriber'
+# require 'action_view/log_subscriber'
+# require 'action_controller/log_subscriber'
+# require 'request_store'
+
+module Hickory
+  module LogSubscribers
+    class Base < ActiveSupport::LogSubscriber
+      # def logger
+      #   Lograge.logger.presence || super
+      # end
+
+      private
+
+      # def process_main_event(event)
+      #   # return if Lograge.ignore?(event)
+      #
+      #   payload = event.payload
+      #   data = extract_request(event, payload)
+      #   data = before_format(data, payload)
+      #   formatted_message = Lograge.formatter.call(data)
+      #   logger.send(Lograge.log_level, formatted_message)
+      # end
+      #
+      # def extract_request(event, payload)
+      #   data = initial_data(payload)
+      #   data.merge!(extract_status(payload))
+      #   data.merge!(extract_runtimes(event, payload))
+      #   data.merge!(extract_location)
+      #   data.merge!(extract_unpermitted_params)
+      #   data.merge!(custom_options(event))
+      # end
+      #
+      # %i(initial_data extract_status extract_runtimes
+      #    extract_location extract_unpermitted_params).each do |method_name|
+      #   define_method(method_name) { |*_arg| {} }
+      # end
+      #
+      # def extract_status(payload)
+      #   if (status = payload[:status])
+      #     { status: status.to_i }
+      #   elsif (error = payload[:exception])
+      #     exception, message = error
+      #     { status: get_error_status_code(exception), error: "#{exception}: #{message}" }
+      #   else
+      #     { status: 0 }
+      #   end
+      # end
+      #
+      # def get_error_status_code(exception)
+      #   status = ActionDispatch::ExceptionWrapper.rescue_responses[exception]
+      #   Rack::Utils.status_code(status)
+      # end
+      #
+      # def custom_options(event)
+      #   options = Lograge.custom_options(event) || {}
+      #   options.merge event.payload[:custom_payload] || {}
+      # end
+      #
+      # def before_format(data, payload)
+      #   Lograge.before_format(data, payload)
+      # end
+    end
+  end
+end

data/lib/hickory/logger.rb

@@ -0,0 +1,35 @@
+require 'logger'
+
+require 'active_support/logger_silence'
+require 'active_support/logger_thread_safe_level'
+
+require 'hickory/formatters/json'
+require 'hickory/formatters/simple'
+
+module Hickory
+  class Logger < ::Logger
+    include ActiveSupport::LoggerThreadSafeLevel
+    include ActiveSupport::LoggerSilence
+
+    SEVERITIY_LABELS = %w(TRACE DEBUG INFO WARN ERROR FATAL UNKNOWN)
+
+    %i[trace debug info warn error fatal unknown].each do |level|
+
+      define_method(level) do |msg = nil, meta={}, &block|
+        message = { message: msg }
+
+        message.merge!(meta) if meta.is_a?(Hash) && !meta.empty?
+
+        severity = SEVERITIY_LABELS.index(level.to_s.upcase) - 1
+
+        if block
+          send(level, block.call)
+        else
+          log(severity, message)
+        end
+      end
+    end
+  end
+end
+
+require 'hickory/railtie' if defined?(Rails)

data/lib/hickory/railtie.rb

@@ -0,0 +1,18 @@
+require 'rails/railtie'
+require 'active_support/ordered_options'
+
+# require 'hickory/log_subscribers/base'
+require 'hickory/log_subscribers/action_controller'
+require 'hickory/log_subscribers/action_mailer'
+require 'hickory/log_subscribers/active_job'
+
+module Hickory
+  class Railtie < Rails::Railtie
+    config.hickory = ActiveSupport::OrderedOptions.new
+    config.hickory.canonical_request_lines = false
+
+    config.after_initialize do |app|
+      Hickory.initialize_canonical_logs(app) if app.config.hickory.canonical_request_lines
+    end
+  end
+end

data/lib/hickory/version.rb

@@ -0,0 +1,3 @@
+module Hickory
+  VERSION = '0.1.0'
+end

data/lib/hickory.rb

@@ -0,0 +1,64 @@
+require 'hickory/logger'
+require 'hickory/version'
+
+module Hickory
+  module_function
+
+  def initialize_canonical_logs(app)
+    require 'hickory/ext/rails/rack/logger'
+
+    self.application = app
+    Hickory.ignore_if  = config.ignore_if
+
+    Hickory.remove_existing_log_subscriptions
+    Hickory::LogSubscribers::ActionController.attach_to :action_controller
+    Hickory::LogSubscribers::ActionMailer.attach_to :action_mailer
+    Hickory::LogSubscribers::ActiveJob.attach_to :active_job
+  end
+
+  def application
+    @@application
+  end
+
+  def application=(app)
+    @@application = app
+  end
+
+  def ignore_if
+    @@ignore_if
+  end
+
+  def ignore_if=(check)
+    @@ignore_if = check
+  end
+
+  def config
+    application.config.hickory
+  end
+
+  def remove_existing_log_subscriptions
+    ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+      case subscriber
+      when ActionView::LogSubscriber
+        unsubscribe(:action_view, subscriber)
+      when ActionController::LogSubscriber
+        unsubscribe(:action_controller, subscriber)
+      when ActionMailer::LogSubscriber
+        unsubscribe(:action_mailer, subscriber)
+      when ActiveJob::Logging::LogSubscriber
+        unsubscribe(:active_job, subscriber)
+      end
+    end
+  end
+
+  def unsubscribe(component, subscriber)
+    events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+    events.each do |event|
+      ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+        if listener.instance_variable_get('@delegate') == subscriber
+          ActiveSupport::Notifications.unsubscribe listener
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: hickory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- blahed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- trvsdnn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hickory.gemspec
+- lib/hickory.rb
+- lib/hickory/ext/rails/rack/logger.rb
+- lib/hickory/formatters/json.rb
+- lib/hickory/formatters/simple.rb
+- lib/hickory/log_subscribers/action_controller.rb
+- lib/hickory/log_subscribers/action_mailer.rb
+- lib/hickory/log_subscribers/active_job.rb
+- lib/hickory/log_subscribers/base.rb
+- lib/hickory/logger.rb
+- lib/hickory/railtie.rb
+- lib/hickory/version.rb
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: An opinionated logger for rails and ruby.
+test_files: []