beekeeper 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec711a53303d9fb0e5f4ee680e81e058ffc46e1652a91ca4bee3dcb05f7b81cc
-  data.tar.gz: 4efc54f12c5499769992c5d3e05f644d0b9fe8ff09369d31f2e9f82d8d1bf98b
+  metadata.gz: d2e59a97870e4ff992512cfd825ea70d3ee508c1b22299484d0e7bcb5650dec3
+  data.tar.gz: f329c4677c876ad554bf446f5b3bab061cf037ee86ab4881ad07ea5ddec34c6d
 SHA512:
-  metadata.gz: ad035c428b70925a0d27bd6aa4ed1373133009c1f806df0a1b93021e4f541146460d2deeace4cbdde664ab904e46844352f61a5976545dc0b34a0827715f390f
-  data.tar.gz: b62a386d0d7acb6270e247cb7c885211d00ca1fdf34c3498b8674e584b8b14097dc9a9e6d843118d62eb54adc15807b0926259ea8d702e81d28f3018d66a4725
+  metadata.gz: 81110a70e01c7ab375c59621b79af6ea78dbcb15bf70770d5eb082e5f05e924f87a66b7a982aa39f595f847e0c43a9e333e9e42ec7aa133bb2d078c08a2d4463
+  data.tar.gz: 78316c16c36cf72850603d223a68b7fd5756e586f58d1d99d22df2c840616a02f7da5ef357113b6ecae268defeda86e7764eed11cf9f81c4d71c6bd0e76ca59c

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beekeeper
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Omkar Joshi
@@ -55,7 +55,7 @@ dependencies:
 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,7 +72,7 @@ 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/josho1/beekeeper
 licenses:
 - MIT
 metadata: