tablexi-logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24f5baa0ee4ada9002d1ede440013adf9700244e
+  data.tar.gz: 2ea1197b9a786f1a5f0b92cf75dea74493ff6b00
+SHA512:
+  metadata.gz: 2828d849cb6f2b4c1822fe0c8bd5341ae7d90ef5c166d17bacd4713eec25aa2fbb2d2f37aea50f5af4b0271945d2bccea065d0ff8c56393f612a0389d0d8490e
+  data.tar.gz: 6a0d581fc5270ad173d52cf55b248a24415beebbc2bfdc433802ccb314aa740c91c624a6d723ee11275b87f0f33c881c869634e3c4ef6ad15ba173f3897b683f

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  Exclude:
+    - ".bundle/**/*" # Auto-generated
+    - "bin/**/*"     # Auto-generated
+    - "vendor/**/*"  # We cannot solve the world's problems
+    - "tablexi-logger.gemspec" # just not worth it
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+Style/TrivialAccessors:
+  ExactNameMatch: true

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tablexi-logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bradley Schaefer
+
+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,58 @@
+# Tablexi::Logger
+
+Standardized logging for Table XI applications.
+
+The default behavior will log to `Rails.logger` or fallback to `::Logger.new($stdout)` if
+Rails is not available. If [Rollbar](https://rollbar.com/) or [NewRelic](http://newrelic.com/)
+are available, logging will also send events to the available service for log levels `error`
+or higher.
+
+## Usage
+
+Basic usage looks like this:
+
+```ruby
+Tablexi.logger.warn "Missing configuration, using default"
+Tablexi.logger.error "Bad Things Happened"
+Tablexi.logger.error "Bad Request", request: request
+Tablexi.logger.error "Request Timeout", metric: :timeout_error
+```
+
+You may also assign the logger, for example configuring a null logger would look like this:
+
+```ruby
+Tablexi.logger = ::Logger.new(File.open(File::NULL, "w"))
+```
+
+## Extending Functionality
+
+### Options Filtering
+
+Applications may wish to modify the options passed to error handlers - for example
+a `Tablexi::Logger::OptionFilter::HumanizeRequest` is provided by default, which
+takes any `options[:request]` value and splits out the interesting parts such as
+request method and body, and excludes the spammy parts such as headers.
+
+Option filters may be configured via the `Tablexi::Logger#option_filters` array
+with a callable:
+
+```ruby
+Tablexi.logger.option_filters << ->(options) { options.delete(:password) }  
+```
+
+### Registering logging handlers
+
+Custom logging handlers implement callable and may be registered by log level (e.g. `:debug`):
+
+```ruby
+Tablexi.logger.handlers[:debug] << ->(error, options) { puts [error, options].join("\n") }
+
+# Or to register multiple severities at once
+Tablexi.logger.handle [:debug, :warn, :info] do |*args|
+  puts args.join("\n")
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  require "irb"
+  require "irb/completion"
+  require "tablexi/logger"
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tablexi/logger"
+
+# 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

data/bin/setup

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

data/circle.yml

@@ -0,0 +1,10 @@
+machine:
+  ruby:
+    version: 2.1.4
+dependencies:
+  pre:
+    - gem install bundler --pre
+test:
+  override:
+    - bundle exec rspec --order rand -fd --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec.xml:
+        parallel: true

data/lib/tablexi/logger.rb

@@ -0,0 +1,82 @@
+require "logger"
+
+require "tablexi/logger/version"
+require "tablexi/logger/severities"
+require "tablexi/logger/new_relic"
+require "tablexi/logger/rollbar"
+require "tablexi/logger/standard"
+require "tablexi/logger/option_filter/humanize_request"
+
+module Tablexi
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= default_logger
+    end
+
+    def default_logger(base_logger = bare_logger)
+      Logger.new.tap do |logger|
+        logger.option_filters << Tablexi::Logger::OptionFilter::HumanizeRequest
+        Tablexi::Logger::SEVERITIES.each do |severity|
+          logger.handlers[severity] << Tablexi::Logger::Standard.new(base_logger, severity: severity)
+        end
+        trackable_severities = %i(error fatal unknown)
+        logger.handle trackable_severities, &Tablexi::Logger::Rollbar if defined?(::Rollbar)
+        logger.handle trackable_severities, &Tablexi::Logger::NewRelic if defined?(::NewRelic)
+      end
+    end
+
+    private def bare_logger
+      Rails.logger
+    rescue NameError
+      ::Logger.new($stdout).tap do |config|
+        config.level = ::Logger::DEBUG
+      end
+    end
+  end
+
+  class Logger
+    include Severities
+
+    attr_reader :option_filters
+    attr_reader :handlers
+
+    def initialize
+      @option_filters = []
+      @handlers = Hash.new { |h, k| h[k] = [] }
+    end
+
+    def handle(severities, &block)
+      raise ArgumentError, "Missing block argument" unless block_given?
+
+      Array(severities).each { |severity| handlers[severity] << block }
+    end
+
+    SEVERITIES.each do |severity|
+      define_method(severity) do |exception_or_message, options = {}|
+        log(severity, exception_or_message, Hash(options))
+      end
+    end
+
+    private
+
+    def log(severity, exception_or_message, options)
+      process_option_filters(options)
+      handlers[severity].each do |handler|
+        handler.call(exception_or_message, options)
+      end
+      nil
+    rescue StandardError => e
+      if options.key? :tablexi_logger_error
+        raise # recursion prevention
+      else
+        error(e, tablexi_logger_error: true)
+      end
+    end
+
+    def process_option_filters(options)
+      option_filters.each_with_object(options) { |filter, opts| filter.call(opts) }
+    end
+  end
+end

data/lib/tablexi/logger/new_relic.rb

@@ -0,0 +1,7 @@
+module Tablexi
+  class Logger
+    NewRelic = lambda do |error, options|
+      ::NewRelic::Agent.notice_error(error, options)
+    end
+  end
+end

data/lib/tablexi/logger/option_filter/humanize_request.rb

@@ -0,0 +1,18 @@
+module Tablexi
+  class Logger
+    module OptionFilter
+      HumanizeRequest = lambda do |options|
+        return options unless options.key? :request
+
+        request = options.delete :request
+        body = request.body.read
+        request.body.rewind
+
+        options[:http_method] = request.headers["REQUEST_METHOD"]
+        options[:uri] = request.original_url
+        options[:body] = body
+        options
+      end
+    end
+  end
+end

data/lib/tablexi/logger/rollbar.rb

@@ -0,0 +1,7 @@
+module Tablexi
+  class Logger
+    Rollbar = lambda do |error, options|
+      ::Rollbar.error(error, options)
+    end
+  end
+end

data/lib/tablexi/logger/severities.rb

@@ -0,0 +1,14 @@
+module Tablexi
+  class Logger
+    module Severities
+      SEVERITIES = %i(
+        debug
+        info
+        warn
+        error
+        fatal
+        unknown
+      ).freeze
+    end
+  end
+end

data/lib/tablexi/logger/standard.rb

@@ -0,0 +1,35 @@
+require "tablexi/logger/severities"
+
+module Tablexi
+  class Logger
+    class Standard
+      include Tablexi::Logger::Severities
+
+      attr_reader :logger
+      attr_reader :severity
+
+      def initialize(logger, severity: :unknown)
+        raise ArgumentError, "Severity `#{severity}` must be one of #{SEVERITIES}" unless SEVERITIES.include?(severity)
+
+        @logger = logger
+        @severity = severity
+      end
+
+      def call(exception_or_message, options)
+        logger.public_send severity, generate_log(exception_or_message, options)
+      end
+
+      private
+
+      def generate_log(exception_or_message, options)
+        options = Hash(options)
+
+        message = []
+        message << (exception_or_message.respond_to?(:message) ? exception_or_message.message : exception_or_message)
+        message << options.map { |k, v| "#{k}: #{v}" } if options.size > 0
+        message << exception_or_message.backtrace if exception_or_message.respond_to?(:backtrace)
+        message.flatten.join("\n")
+      end
+    end
+  end
+end

data/lib/tablexi/logger/version.rb

@@ -0,0 +1,5 @@
+module Tablexi
+  class Logger
+    VERSION = "1.0.0"
+  end
+end

data/tablexi-logger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tablexi/logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tablexi-logger"
+  spec.version       = Tablexi::Logger::VERSION
+  spec.authors       = ["Table XI Partners LLC", "Bradley Schaefer"]
+  spec.email         = ["bradley.schaefer@gmail.com"]
+
+  spec.summary       = "A simple logging wrapper to use in Table XI applications."
+  spec.description   = "Provides a single interface for logging so that applications do not need to be aware of NewRelic, Rollbar, or whatever else."
+  spec.homepage      = "https://github.com/tablexi/tablexi-logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: tablexi-logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Table XI Partners LLC
+- Bradley Schaefer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a single interface for logging so that applications do not need
+  to be aware of NewRelic, Rollbar, or whatever else.
+email:
+- bradley.schaefer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/tablexi/logger.rb
+- lib/tablexi/logger/new_relic.rb
+- lib/tablexi/logger/option_filter/humanize_request.rb
+- lib/tablexi/logger/rollbar.rb
+- lib/tablexi/logger/severities.rb
+- lib/tablexi/logger/standard.rb
+- lib/tablexi/logger/version.rb
+- tablexi-logger.gemspec
+homepage: https://github.com/tablexi/tablexi-logger
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A simple logging wrapper to use in Table XI applications.
+test_files: []