multi_bug 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9ef955ed75c64de91ff4de130c3f6c0e77c23f897c562a6beffb2b2a0288ec1
+  data.tar.gz: 6184c9f3de679ada1df12fd45d4cbbd9557f19c8c111ac2a911bb8550e7825a4
+SHA512:
+  metadata.gz: c0fb3eeaa9063c066cdf3b19bacb6061a27402c1fb4419e7745bccaf1ce016548409f1f0553272e952fcadf82d32575f2ca820b252f4237756ed048bbea7f6bc
+  data.tar.gz: d4881edb9122206b2bbea372b171274ae0ab846a767d485ef5e2c62fa5c27e44cb534176b6acf35e73f6102b440e10a67c11d51c9e0932e5fd8111e0ef5452b1

data/README.md

@@ -0,0 +1,92 @@
+# MultiBug
+
+[![Gem Version](https://badge.fury.io/rb/multi_bug.svg)](http://badge.fury.io/rb/multi_bug)
+
+MultiBug is a simple error monitoring gem that abstracts multiple reporting tools in one.
+
+## 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
+  - Aditional adapters for [Sentry](https://github.com/getsentry/raven-ruby) and [Rollbar](https://github.com/rollbar/rollbar-gem)
+  - Advanced configuration
+  - Support for common advanced features
+
+## Getting started
+
+To install, run:
+
+    gem install multi_bug
+
+Add the following to your Gemfile:
+
+    gem "multi_bug", '~> 0.2.1'
+
+After you've added the `multi_bug` 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:
+
+ - [Airbrake](https://github.com/airbrake/airbrake-ruby#installation)
+ - [Bugsnag](https://docs.bugsnag.com/platforms/ruby/rails/#installation)
+
+## Usage
+
+### Reporting exceptions
+
+After installing one of the supported gems, reporting of unhandled exceptions should happen automatically and be visible in their respective monitoring dashboard.
+
+Reporting of handled exceptions can be done with:
+
+```ruby
+begin
+  raise 'Robots are taking over!'
+rescue => exception
+  MultiBug.notify(exception)
+end
+```
+
+#### Custom payload
+If you need to add custom payload to the error report you can do this by providing an options hash.
+
+```ruby
+begin
+  raise 'Robots are taking over!'
+rescue => exception
+  MultiBug.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 rspec
+
+## Versioning
+
+Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
+
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+## Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## License
+
+Copyright 2018 []().
+Read [LICENSE](LICENSE.md) for details.
+
+## History
+
+Read [CHANGES](CHANGES.md) for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default do
+  system('bundle exec rspec')
+  system('bundle exec rubocop')
+end

data/lib/multi_bug/adapter.rb

@@ -0,0 +1,12 @@
+require 'singleton'
+
+module MultiBug
+  class Adapter
+    include Singleton
+    class << self
+      def notify(exception, options = {})
+        instance.notify(exception, options)
+      end
+    end
+  end
+end

data/lib/multi_bug/adapters/airbrake.rb

@@ -0,0 +1,14 @@
+require 'airbrake-ruby'
+require 'multi_bug/adapter'
+
+module MultiBug
+  module Adapters
+    class Airbrake < Adapter
+      def notify(exception, options = {})
+        ::Airbrake.notify(exception) do |report|
+          report[:params].merge!(options)
+        end
+      end
+    end
+  end
+end

data/lib/multi_bug/adapters/bugsnag.rb

@@ -0,0 +1,14 @@
+require 'bugsnag'
+require 'multi_bug/adapter'
+
+module MultiBug
+  module Adapters
+    class Bugsnag < Adapter
+      def notify(exception, options = {})
+        ::Bugsnag.notify(exception) do |report|
+          report.meta_data = options
+        end
+      end
+    end
+  end
+end

data/lib/multi_bug/identity.rb

@@ -0,0 +1,22 @@
+module MultiBug
+  # Gem identity information.
+  module Identity
+    module_function
+
+    def name
+      'multi_bug'
+    end
+
+    def label
+      'MultiBug'
+    end
+
+    def version
+      '0.2.1'
+    end
+
+    def version_label
+      "#{label} #{version}"
+    end
+  end
+end

data/lib/multi_bug.rb

@@ -0,0 +1,51 @@
+require 'multi_bug/identity'
+
+module MultiBug
+  extend self
+
+  SUPPORTED_ADAPTERS = { airbrake: 'airbrake-ruby', bugsnag: 'bugsnag' }.freeze
+
+  def use_adapter(adapter)
+    @adapter = case adapter
+               when String, Symbol
+                 load_adapter(adapter.to_s)
+               when Class, Module
+                 adapter
+               else
+                 load_adapter(default_adapter)
+               end
+  end
+
+  def adapter
+    return @adapter if defined?(@adapter)
+
+    # TODO: Add adapter from config here
+    load_adapter(default_adapter)
+  end
+
+  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)
+
+    SUPPORTED_ADAPTERS.each do |adapter, gem_name|
+      require gem_name
+      return adapter
+    end
+
+    # TODO: Return default adapter here
+  end
+
+  private
+
+  def load_adapter(name)
+    require "multi_bug/adapters/#{name.downcase}"
+
+    MultiBug::Adapters.const_get(name.capitalize)
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: multi_bug
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Amir Mujkic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description: 
+email:
+- amirmujk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/multi_bug.rb
+- lib/multi_bug/adapter.rb
+- lib/multi_bug/adapters/airbrake.rb
+- lib/multi_bug/adapters/bugsnag.rb
+- lib/multi_bug/identity.rb
+homepage: https://github.com/amirmujkic/multi_bug
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/amirmujkic/multi_bug/blob/master/CHANGELOG.md
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A simple gem that abstracts error monitoring
+test_files: []