bug_bot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0846fe897275c66ee4299d32736a50009d9cf9490b0f43f5302e1ad4f6f4346d'
-  data.tar.gz: a2b10c4387ee9cf721bf98718654c80bbe447ab7e1d048dbbf187d1ecded0b56
+  metadata.gz: 170ae14d120c32b4569474cbcf74203fe552c348c896e0809486b68b08212d0b
+  data.tar.gz: 2dac4f4f4dcc618eded809f4aca2de48f7e5afe739f31f4c6452e917fa677691
 SHA512:
-  metadata.gz: 15fa1ff6d000d85bf7bb0e44c3ec2335b57cbadbfde1b46c53753e541c4298e15f02a215f87a3fe60ee094052b1937c4f12f5ed52261d578f8fa440bb1d8cffe
-  data.tar.gz: 26a003927aa27fd2f60b18c4948466d41736900074b73faad3f54fa4aee4d4fd8e04535ce95ace6355d469a96d7678d68001048d6f255f4ff2cde609978dbfc7
+  metadata.gz: e1dd284537652ada0085a796a0d08ab48977c97335103b0747f42699d98d6dea40c291bc88b70d4167f66237b352121d66498df5a534af30b3ad3b350eb97c65
+  data.tar.gz: 788dfe83cea3ac4c4d1ab745fe5e6224b02a467f441ff9da5c0470ee730b921ee5b74ed736ce3c48cb79d09b0013175edfcf854b5a2b809dc4986f50730c9a52

data/README.md

@@ -2,49 +2,73 @@
 
 [![Gem Version](https://badge.fury.io/rb/bug_bot.svg)](http://badge.fury.io/rb/bug_bot)
 
-<!-- Tocer[start]: Auto-generated, don't remove. -->
+BugBot is a simple error monitoring gem that abstracts multiple reporting tools in one.
 
-## Table of Contents
+## Features
+- Easily switch error monitoring provider by changing config only
+- Supported adapters
+  - [Airbrake](https://github.com/airbrake/airbrake-ruby)
+  - [Bugsnag](https://github.com/bugsnag/bugsnag-ruby)
+- Upcoming features
+  - Support for custom payloads and metadata
+  - Aditional adapters for [Sentry](https://github.com/getsentry/raven-ruby) and [Rollbar](https://github.com/rollbar/rollbar-gem)
+  - Advanced configuration
 
-  - [Features](#features)
-  - [Screencasts](#screencasts)
-  - [Requirements](#requirements)
-  - [Setup](#setup)
-  - [Usage](#usage)
-  - [Tests](#tests)
-  - [Versioning](#versioning)
-  - [Contributions](#contributions)
-  - [License](#license)
-  - [History](#history)
-  - [Credits](#credits)
+## Getting started
 
-<!-- Tocer[finish]: Auto-generated, don't remove. -->
+To install, run:
 
-## Features
+    gem install bug_bot
 
-## Screencasts
+Add the following to your Gemfile:
 
-## Requirements
+    gem "bug_bot", '~> 0.1.0'
 
-1. [Ruby 2.5.0](https://www.ruby-lang.org)
+After you've added the `bug_bot` gem, please install one of the gems for the monitoring platform you want to use.
+To accomplish that, you can use one of the following installation guides:
 
-## Setup
+ - [Airbrake](https://github.com/airbrake/airbrake-ruby#installation)
+ - [Bugsnag](https://docs.bugsnag.com/platforms/ruby/rails/#installation)
 
-To install, run:
+## Usage
 
-    gem install bug_bot
+### Reporting exceptions
 
-Add the following to your Gemfile:
+After installing one of the supported gems, reporting of unhandled exceptions should happen automatically and be visible for you in their respective monitoring dashboard.
 
-    gem "bug_bot"
+Report handled exceptions of errors can be done with:
 
-## Usage
+```ruby
+begin
+  raise 'Robots are taking over!'
+rescue => exception
+  BugBot.notify(exception)
+end
+```
+
+#### Custom payload
+If you need to add custom payload to the error report you can do this by providing a an options hash.
+
+```ruby
+begin
+  raise 'Robots are taking over!'
+rescue => exception
+  BugBot.notify(exception, {
+    foo: {
+      bar: 'baz'
+    }
+  })
+end
+```
+
+### Changing the provider
+Changing of the monitoring provider should be easily achieved just by installing/configuring the other gem.
 
 ## Tests
 
 To test, run:
 
-    bundle exec rake
+    bundle exec rspec
 
 ## Versioning
 
@@ -63,4 +87,6 @@ Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 Copyright 2018 []().
 Read [LICENSE](LICENSE.md) for details.
 
+## History
 
+Read [CHANGES](CHANGES.md) for details.

data/lib/bug_bot.rb

@@ -25,6 +25,10 @@ module BugBot
 
   alias adapter= use_adapter
 
+  def notify(exception, options = {})
+    adapter.notify(exception, options)
+  end
+
   def default_adapter
     return :airbrake if defined?(::Airbrake)
     return :bugsnag if defined?(::Bugsnag)
@@ -37,13 +41,11 @@ module BugBot
     # TODO: Return default adapter here
   end
 
+  private
+
   def load_adapter(name)
     require "bug_bot/adapters/#{name.downcase}"
 
     BugBot::Adapters.const_get(name.capitalize)
   end
-
-  def notify(exception, &block)
-    adapter.notify(exception, &block)
-  end
 end

data/lib/bug_bot/adapter.rb

@@ -4,8 +4,8 @@ module BugBot
   class Adapter
     include Singleton
     class << self
-      def notify(exception, &block)
-        instance.notify(exception, &block)
+      def notify(exception, options = {})
+        instance.notify(exception, options)
       end
     end
   end

data/lib/bug_bot/adapters/airbrake.rb

@@ -4,8 +4,10 @@ require 'bug_bot/adapter'
 module BugBot
   module Adapters
     class Airbrake < Adapter
-      def notify(exception, &block)
-        ::Airbrake.notify(exception, &block)
+      def notify(exception, options = {})
+        ::Airbrake.notify(exception) do |report|
+          report[:params].merge!(options)
+        end
       end
     end
   end

data/lib/bug_bot/adapters/bugsnag.rb

@@ -4,8 +4,10 @@ require 'bug_bot/adapter'
 module BugBot
   module Adapters
     class Bugsnag < Adapter
-      def notify(exception, &block)
-        ::Bugsnag.notify(exception, &block)
+      def notify(exception, options = {})
+        ::Bugsnag.notify(exception) do |report|
+          report.meta_data = options
+        end
       end
     end
   end

data/lib/bug_bot/identity.rb

@@ -12,7 +12,7 @@ module BugBot
     end
 
     def version
-      '0.1.0'
+      '0.2.0'
     end
 
     def version_label

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bug_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Amir Mujkic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-08 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -122,7 +122,7 @@ files:
 - lib/bug_bot/adapters/airbrake.rb
 - lib/bug_bot/adapters/bugsnag.rb
 - lib/bug_bot/identity.rb
-homepage: ''
+homepage: https://github.com/amirmujkic/bug_bot
 licenses:
 - MIT
 metadata:
@@ -146,5 +146,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: ''
+summary: A simple gem that abstracts error monitoring
 test_files: []