exception_file_notifier 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6253e8fb63683fc043da38e4a201c0c7b20d50d9
+  data.tar.gz: cb722eefe2b781fe6f2792a422bb8a6f967ad1c0
+SHA512:
+  metadata.gz: e91366f1931ce5fd49e6592da8881cd3fba762d33c55847b8ca45eafbfdd34ebd3309b7550dc9c9982c045b6dc858c06e485abe8110f8da6060ca07e62a97227
+  data.tar.gz: f4da9a5eb2381e6ca1ed74e8f1c69a8e2b4aa2f69812fa76820cb94b9597a522936bdbd329748736a80b30e419329f1981b8cfce6558b6037103e26841798f97

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+rvm:
+- 2.1
+- 2.2
+- 2.3.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Koji Onishi
+
+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,40 @@
+# ExceptionFileNotifier
+
+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/exception_file_notifier`. 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 'exception_file_notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception_file_notifier
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/fursich/exception_file_notifier.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exception_notifier/exception_file_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exception_file_notifier"
+  spec.version       = ::ExceptionNotifier::ExceptionFileNotifier::VERSION
+  spec.authors       = ["Koji Onishi"]
+  spec.email         = ["fursich0@gmail.com"]
+
+  spec.summary       = %q{ A custom notifier for ExceptionNotification that generates exception log files in JSON format. }
+  spec.description   = %q{ Exception File Notifier records exception logs in JSON format, helping you track errors in the production environment. }
+  spec.homepage      = "https://github.com/fursich/exception_file_notifier"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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.required_ruby_version     = '>= 2.1'
+  spec.required_rubygems_version = '>= 1.8.11'
+  # spec.add_dependency("activesupport", ">= 4.0", "< 6")
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rails", ">= 4.0", "< 6"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "exception_notification", ">= 4.0"
+end

data/lib/exception_file_notifier.rb

@@ -0,0 +1,2 @@
+require "exception_notifier/exception_file_notifier/version"
+require "exception_notifier/file_notifier"

data/lib/exception_notifier/exception_file_notifier/version.rb

@@ -0,0 +1,5 @@
+module ExceptionNotifier
+  module ExceptionFileNotifier
+    VERSION = "0.0.6"
+  end
+end

data/lib/exception_notifier/file_notifier.rb

@@ -0,0 +1,155 @@
+require "exception_notification"
+require "action_dispatch"
+require "active_support/core_ext/hash"
+require "socket"
+require 'logger'
+require 'json'
+
+module ExceptionNotifier
+  class FileNotifier < BaseNotifier
+    include ExceptionNotifier::BacktraceCleaner
+
+    def initialize(options={})
+      filename     = options[:filename]   || "log/error.log"
+      shift_age    = options[:shift_age]  || 0
+      shift_size   = options[:shift_size] || nil
+
+      @logger_options     = [filename, shift_age, shift_size]
+      @formatter          = -> (_, _, _, message) { message + "\n" }
+    end
+
+    def call(exception=nil, options={})
+      append_log exception_message(options[:env], exception, options)
+    end
+
+    def append_log(message)
+      log = ::Logger.new(*@logger_options)
+      log.formatter = @formatter
+      error_log = generate_json(message)
+      log.error(error_log)
+      log.close
+    end
+
+    def generate_json(message)
+      ::JSON.generate(deep_encode(message))
+    end
+
+    def exception_message(env, exception, options={})
+      return error_message(exception) unless exception.is_a?(Exception)
+
+      if env.present?
+        exception_notification(options[:env], exception, options)
+      else
+        background_exception_notification(exception, options)
+      end
+    end
+
+    def exception_notification(env, exception, options)
+      @env        = env
+      @exception  = exception
+      @options    = options.reverse_merge(@env['exception_notifier.options'] || {}).symbolize_keys
+      @kontroller = @env['action_controller.instance'] || MissingController.new
+      @request    = ::ActionDispatch::Request.new(@env)
+      @backtrace  = exception.backtrace ? clean_backtrace(exception) : []
+      @timestamp  = ::Time.current
+      @data       = (@env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+
+      render_notice
+    end
+
+    def background_exception_notification(exception, options)
+      @exception = exception
+      @options   = options.symbolize_keys
+      @backtrace = exception.backtrace || []
+      @timestamp = ::Time.current
+      @data      = options[:data] || {}
+      @env = @kontroller = nil
+
+      render_notice
+    end
+
+    def error_message(exception)
+      {
+        message:           '[FATAL] NO EXCEPTION GIVEN: Please provide Exception as argument',
+        exception:         exception.try(:to_s),
+        timestamp:         ::Time.current,
+      }
+    end
+
+    def render_notice
+      set_data_variables
+
+      exception_details = {
+        exception:         @exception.class,
+        controller:        @kontroller.present? ? @kontroller.controller_name : '[BACKGROUND]',
+        action:            @kontroller.present? ? @kontroller.action_name : '[BACKGROUND]',
+        exception_message: @exception.message,
+
+        timestamp:         @timestamp,
+        server:            ::Socket.gethostname,
+        rails_root:        (defined?(::Rails) && ::Rails.respond_to?(:root) ) ? ::Rails.root : nil,
+        process:           $$,
+        backtrace:         @backtrace,
+      }
+
+      if @env.present?
+        exception_details.merge!({
+          url:               @request.url,
+          http_method:       @request.request_method,
+          ip_address:        @request.remote_ip,
+          parameters:        (@request.filtered_parameters.inspect rescue "[NOT ENCODABLE]"),
+          session_id:        (@request.ssl? ? "[FILTERED]" : @request.session['session_id'] || (@request.env["rack.session.options"] and @request.env["rack.session.options"][:id])),
+          session_data:      @request.session.to_hash,
+        })
+        filtered_env = @request.filtered_env
+        filtered_env.sort_by { |key, _| key.to_s }.each do |key, value|
+          exception_details[key] = value
+        end
+      end
+
+      exception_details.merge!({
+        data:              @data,
+      })
+
+      exception_details
+    end
+
+    class MissingController
+      def controller_name
+        '[NO CONTROLLER]'
+      end
+      def action_name
+        '[NO CONTROLLER]'
+      end
+      def method_missing(*args, &block)
+      end
+    end
+
+    def set_data_variables
+      @data.each do |name, value|
+        instance_variable_set("@#{name}", value)
+      end
+    end
+
+    def deep_encode(obj)
+      case obj
+      when Array
+        obj.map { |o| deep_encode(o) }
+      when Hash
+        deep_encode(obj.to_a).to_h
+      when String
+        encode_to_utf8(obj)
+      else
+        obj.respond_to?(:to_s) ? encode_to_utf8(obj.to_s) : '[NOT ENCODABLE]'
+      end
+    end
+
+    def encode_to_utf8(str)
+      quick_sanitization(str).encode(::Encoding.find('UTF-8'), {invalid: :replace, undef: :replace, replace: '?'})
+    end
+
+    def quick_sanitization(str) # stringify any random objects in a safe (and convenient) manner
+      str.inspect.gsub(/\A\"(.*)\"\z/,'\1')
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: exception_file_notifier
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Koji Onishi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: " Exception File Notifier records exception logs in JSON format, helping
+  you track errors in the production environment. "
+email:
+- fursich0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exception_file_notifier.gemspec
+- lib/exception_file_notifier.rb
+- lib/exception_notifier/exception_file_notifier/version.rb
+- lib/exception_notifier/file_notifier.rb
+homepage: https://github.com/fursich/exception_file_notifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A custom notifier for ExceptionNotification that generates exception log
+  files in JSON format.
+test_files: []