beekeeper 0.1.7 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec711a53303d9fb0e5f4ee680e81e058ffc46e1652a91ca4bee3dcb05f7b81cc
-  data.tar.gz: 4efc54f12c5499769992c5d3e05f644d0b9fe8ff09369d31f2e9f82d8d1bf98b
+  metadata.gz: 5600dd4c02baeb97f8d977529b03c3354d8a0b9924bdfe0b60b9693521311e75
+  data.tar.gz: b7179bf9048ca148d096b520c11d41c5518394b8d307ef42d57f1aa99f693a48
 SHA512:
-  metadata.gz: ad035c428b70925a0d27bd6aa4ed1373133009c1f806df0a1b93021e4f541146460d2deeace4cbdde664ab904e46844352f61a5976545dc0b34a0827715f390f
-  data.tar.gz: b62a386d0d7acb6270e247cb7c885211d00ca1fdf34c3498b8674e584b8b14097dc9a9e6d843118d62eb54adc15807b0926259ea8d702e81d28f3018d66a4725
+  metadata.gz: 2f4d7cef134b4beb2377d8bd43e95227145ca99d84515d78d365f63ab568aaaecba2ec753338ec9d375e9c9243a1bd7667357a9046a3a496980ad7999f19eaa4
+  data.tar.gz: 8049b92aaddc3bf3dfb682b548b7b4813e17cc5da7d3c3c5c3afbc06af38cca0b21e8be1b78b4a2b0e4e41b5effcacf4ee8e1c0e386b96048b97d4ca10a88b92

data/README.md

@@ -30,16 +30,54 @@ $ gem install beekeeper
 
 * 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`
+        * `Beekeeper::Error`
         * `ActiveRecord::RecordInvalid` (Validation errors)
         * `ActiveRecord::RecordNotFound`
         
+* In order to define and raise known errors in your application, it is recommended that you subclass Beekeeper::Error
+
+For example:
+```ruby
+class CustomError < Beekeeper::Error
+end
+
+class CustomErrors::BadRequest < CustomError
+  def initialize(message = "Request params are invalid")
+    super(error: :bad_request, status: 400, message: message)
+  end
+end
+
+
+class UsersController
+  def edit
+    raise CustomErrors::BadRequest, message: "User not found" if params[:id].blank?
+  end
+end
+
+
+```
+        
 * 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
+* This gem also provides standard logging for an exception message. For eg. sometimes, you would like to rescue the exception and just log the exception in the application code itself.
+
+```ruby
+
+class BackgroundTaskWorker < Worker
+
+    def perform
+      begin
+        #Code Body
+      rescue e => StandardError
+        Beekeeper::Logger.fatal(e)
+      end
+    end
+
+end
+
+```
 
-* Define `CustomErrors` in this gem and let other Rails apps inherit or use this in their apps.
+Above Beekeeper::Logger will print the error message, error class along with a trimmed version of the backtrace.
 
 ## Contributing
 Contribution directions go here.

data/lib/beekeeper/logger.rb

@@ -1,21 +1,21 @@
 module Beekeeper
   class Logger
-    def self.fatal(error)
+    def self.fatal(error, logger: nil)
       message = if error.respond_to? :backtrace
                   message_with_backtrace(error)
                 else
                   error
                 end
-      Rails.logger.fatal message
+      internal_logger(logger).fatal message
     end
 
-    def self.error(error)
+    def self.error(error, logger: nil)
       message = if error.respond_to? :backtrace
                   message_with_backtrace(error)
                 else
                   error
                 end
-      Rails.logger.error message
+      internal_logger(logger).error message
     end
 
     private
@@ -32,6 +32,10 @@ module Beekeeper
       bc.clean(backtrace).map! { |t| "  #{t}\n" }
     end
 
+    def internal_logger(logger)
+      logger || Rails.logger
+    end
+
   end
 end
 

data/lib/beekeeper/rescuer.rb

@@ -7,7 +7,10 @@ module Beekeeper
       RESCUABLE_ERRORS = [
         ::Beekeeper::Error,
         ::Apipie::Error,
-        ::ActiveRecord::RecordInvalid
+        ::ActiveRecord::RecordInvalid,
+        ::ActiveRecord::RecordNotUnique,
+        ::ActiveRecord::RecordNotFound,
+        ::ActiveRecord::ActiveRecordError,
       ]
 
       rescue_from(*RESCUABLE_ERRORS, with: :handle_error)

data/lib/beekeeper/trap_api_exceptions.rb

@@ -16,11 +16,11 @@ module Beekeeper
       request = ActionDispatch::Request.new env
       @app.call(env)
     rescue StandardError => e
-      if request.path_info.include? '/api'
+      # if request.path_info.include? '/api'
         render_json_error(request, e)
-      else
-        raise e
-      end
+      # else
+      #   raise e
+      # end
     end
 
     private

data/lib/beekeeper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beekeeper
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.12
 platform: ruby
 authors:
 - Omkar Joshi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,34 +28,62 @@ dependencies:
   name: blueprinter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.23.4
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.23.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   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: apipie-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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.6
+        version: '0'
 description: 'Beekeepeer: This gem is responsible for error logging, processing and
   rendering of errors in a standard JSON format..'
 email:
-- omkar.joshi@anarock.com
+- onjoshi@ncsu.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -72,12 +100,12 @@ files:
 - lib/beekeeper/trap_api_exceptions.rb
 - lib/beekeeper/version.rb
 - lib/tasks/beekeeper_tasks.rake
-homepage: https://github.com/saas-bn/beekeeper
+homepage: https://github.com/joshio1/beekeeper
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
-summary: 'Beekeeper: Error logging, processing and rendering.'
+summary: 'Beekeeper: Error logging, processing and rendering via Rack middleware.'
 test_files: []