beekeeper 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec711a53303d9fb0e5f4ee680e81e058ffc46e1652a91ca4bee3dcb05f7b81cc
+  data.tar.gz: 4efc54f12c5499769992c5d3e05f644d0b9fe8ff09369d31f2e9f82d8d1bf98b
+SHA512:
+  metadata.gz: ad035c428b70925a0d27bd6aa4ed1373133009c1f806df0a1b93021e4f541146460d2deeace4cbdde664ab904e46844352f61a5976545dc0b34a0827715f390f
+  data.tar.gz: b62a386d0d7acb6270e247cb7c885211d00ca1fdf34c3498b8674e584b8b14097dc9a9e6d843118d62eb54adc15807b0926259ea8d702e81d28f3018d66a4725

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 
+
+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,48 @@
+# Beekeeper
+This is a library for error processing, logging and rendering.
+
+## Description
+
+* This gem prints an error and a trimmed down version of the backtrace in case of ANY non-200 response in any application.
+* This gem enables the application code(models, controllers and libs) code to be clean and concise. Since, now, we are handling the exceptions in a middleware, there is no need for ANY `re-raising exception` code in our models, controllers and other files. 
+    * Application code should just contain the happy path and raise `known errors` if required. Other than that, no exception related code is required in the application code.
+* This gem renders a standard JSON error response in case there is any error when calling an API route (`/api`). Currently, if there is any error, an HTML response is returned even if a JSON API route is called.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'beekeeper'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install beekeeper
+```
+
+## Usage
+
+* Include `Beekeeper::Rescuer` in your application controller so that known errors are logged and response is returned in a standard JSON format.
+    * These are the `known errors` it rescues:
+        * `CustomErrors`
+        * `BaseError`
+        * `ActiveRecord::RecordInvalid` (Validation errors)
+        * `ActiveRecord::RecordNotFound`
+        
+* This library also inserts a `TrapApiExceptions` middleware in your Rails application stack which traps errors from an API route (`/api`) and returns a standard JSON error response by default. (Without this middleware, an HTML response is returned)
+
+## Usage
+
+* Define `CustomErrors` in this gem and let other Rails apps inherit or use this in their apps.
+
+## Contributing
+Contribution directions go here.
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Beekeeper'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/beekeeper.rb

@@ -0,0 +1,5 @@
+require "beekeeper/railtie"
+require "beekeeper/rescuer"
+require "beekeeper/trap_api_exceptions"
+require "beekeeper/error"
+require "beekeeper/logger"

data/lib/beekeeper/error.rb

@@ -0,0 +1,32 @@
+module Beekeeper
+  class Error < StandardError
+
+    attr_reader :status_code, :errors, :data, :status
+
+    def initialize(status_code, msg, options = {})
+      super(msg)
+      @status_code = status_code
+      @errors = get_errors(options)
+      @data = options[:data] || {}
+      @status = @status_code
+    end
+
+    def get_errors(options)
+      return [options.delete(:error)] if options[:error].present?
+      return options[:errors].errors().messages() if options[:errors].class < ActiveRecord::Base
+      return options[:error_map] if options[:error_map]
+      return options[:errors] || [{
+        code: class_name(options),
+        message: self.message
+      }]
+    end
+
+    private
+
+    def class_name options
+      return options[:exception].class.to_s if options[:exception].present?
+      self.class.to_s
+    end
+  end
+end
+

data/lib/beekeeper/exception_blueprinter.rb

@@ -0,0 +1,51 @@
+require 'blueprinter'
+module Beekeeper
+  class ExceptionBlueprinter < Blueprinter::Base
+
+    view :basic do
+      field :status do |exception, options|
+        exception.try(:status) || get_status(exception, options)
+      end
+      field :message
+      field :error do |exception, options|
+        exception.try(:error) || get_error(exception, options)
+      end
+      field :errors do |exception, options|
+        exception.try(:errors) || get_errors(exception)
+      end
+      field :data do |exception, options|
+        exception.try(:data) || {}
+      end
+    end
+
+    def self.get_status exception, options
+      exception.try(:status) || get_status_from_backtrace(exception, options)
+    end
+
+    def self.get_error exception, options
+      status = get_status exception, options
+      Rack::Utils::HTTP_STATUS_CODES.fetch(status, Rack::Utils::HTTP_STATUS_CODES[500])
+    end
+
+    def self.get_status_from_backtrace exception, options
+      request = options[:request]
+      backtrace_cleaner = request.env['action_dispatch.backtrace_cleaner']
+      wrapper = ::ActionDispatch::ExceptionWrapper.new(backtrace_cleaner, exception)
+      return wrapper.status_code
+    end
+
+    def self.get_errors exception
+      return [
+        {
+          code: exception.class.name,
+          message: exception.message
+        }
+      ]
+    end
+
+    private
+
+
+  end
+end
+

data/lib/beekeeper/logger.rb

@@ -0,0 +1,37 @@
+module Beekeeper
+  class Logger
+    def self.fatal(error)
+      message = if error.respond_to? :backtrace
+                  message_with_backtrace(error)
+                else
+                  error
+                end
+      Rails.logger.fatal message
+    end
+
+    def self.error(error)
+      message = if error.respond_to? :backtrace
+                  message_with_backtrace(error)
+                else
+                  error
+                end
+      Rails.logger.error message
+    end
+
+    private
+
+    def self.message_with_backtrace(error)
+      trace = clean(error.backtrace)
+      "\n#{error.class.name} (#{error.message}):\n#{trace.join}"
+    end
+
+    def self.clean(backtrace)
+      bc = ActiveSupport::BacktraceCleaner.new
+      bc.add_filter   { |line| line.gsub(Rails.root.to_s, '') } # strip the Rails.root prefix
+      bc.add_silencer { |line| line =~ /puma|rubygems|vendor|bin/ } # skip any lines from puma or rubygems
+      bc.clean(backtrace).map! { |t| "  #{t}\n" }
+    end
+
+  end
+end
+

data/lib/beekeeper/railtie.rb

@@ -0,0 +1,4 @@
+module Beekeeper
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/beekeeper/rescuer.rb

@@ -0,0 +1,26 @@
+require 'beekeeper/exception_blueprinter'
+module Beekeeper
+  module Rescuer
+    extend ActiveSupport::Concern
+
+    included do
+      RESCUABLE_ERRORS = [
+        ::Beekeeper::Error,
+        ::Apipie::Error,
+        ::ActiveRecord::RecordInvalid
+      ]
+
+      rescue_from(*RESCUABLE_ERRORS, with: :handle_error)
+
+      def handle_error(error)
+        Logger.error(error)
+        response = ExceptionBlueprinter.render_as_hash error, view: :basic, request: request
+        render json: response, status: response[:status]
+      end
+
+    end
+
+  end
+end
+
+

data/lib/beekeeper/trap_api_exceptions.rb

@@ -0,0 +1,60 @@
+require 'beekeeper/exception_blueprinter'
+class Beekeeper::Railtie
+  initializer 'beekeeper.trap_api_exceptions' do |app|
+    # Global exception handler. No need of any exception handling in the application code.
+    app.middleware.insert_after(ActionDispatch::ShowExceptions, Beekeeper::TrapApiExceptions)
+  end
+end
+
+module Beekeeper
+  class TrapApiExceptions
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = ActionDispatch::Request.new env
+      @app.call(env)
+    rescue StandardError => e
+      if request.path_info.include? '/api'
+        render_json_error(request, e)
+      else
+        raise e
+      end
+    end
+
+    private
+
+    def render_json_error(request, exception)
+      response = ExceptionBlueprinter.render_as_hash(exception, view: :basic, request: request)
+      body = response.to_json
+      return [
+        response[:status],
+        {
+          'Content-Type' => "json; charset=#{::ActionDispatch::Response.default_charset}",
+          'Content-Length' => body.bytesize.to_s
+        },
+        [body]
+      ]
+    end
+
+    def get_status(request, exception)
+      backtrace_cleaner = request.get_header 'action_dispatch.backtrace_cleaner'
+      wrapper = ::ActionDispatch::ExceptionWrapper.new(backtrace_cleaner, exception)
+      return wrapper.status_code
+    end
+
+    def get_error(status)
+      Rack::Utils::HTTP_STATUS_CODES.fetch(status, Rack::Utils::HTTP_STATUS_CODES[500])
+    end
+
+    def get_errors(exception)
+      return [
+        {
+          code: exception.class.name,
+          message: exception.message
+        }
+      ]
+    end
+  end
+end

data/lib/beekeeper/version.rb

@@ -0,0 +1,3 @@
+module Beekeeper
+  VERSION = '0.1.7'
+end

data/lib/tasks/beekeeper_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :beekeeper do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: beekeeper
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Omkar Joshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: blueprinter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.4
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+description: 'Beekeepeer: This gem is responsible for error logging, processing and
+  rendering of errors in a standard JSON format..'
+email:
+- omkar.joshi@anarock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/beekeeper.rb
+- lib/beekeeper/error.rb
+- lib/beekeeper/exception_blueprinter.rb
+- lib/beekeeper/logger.rb
+- lib/beekeeper/railtie.rb
+- lib/beekeeper/rescuer.rb
+- lib/beekeeper/trap_api_exceptions.rb
+- lib/beekeeper/version.rb
+- lib/tasks/beekeeper_tasks.rake
+homepage: https://github.com/saas-bn/beekeeper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.0.3
+signing_key: 
+specification_version: 4
+summary: 'Beekeeper: Error logging, processing and rendering.'
+test_files: []