denouncer 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a617e06d207d307b00aef250f2761426e399bf3
-  data.tar.gz: 042772019efda8ebba7cb648a8f9bbcb7a4f5e9a
+  metadata.gz: 9ebc092428d54475eaad29ef95ee9fdf9693c7a6
+  data.tar.gz: c99262d3fb6d92b93170ac1c0002a3989462f39e
 SHA512:
-  metadata.gz: a98e7decc781c4e20672386e356dbcaea28549330adca3b0ea99498f067f11942a11641c97cf3820d2bd0d7216ac52091356bae2c593ec24f0dc4550923f383c
-  data.tar.gz: 5f8a801e34736502d7e282744aa72110ce0e9cf97addd445831fbcd6e3094d515516ed7ecba706eb04c6b312c28ecc8dd84ab4a5a42dd157be4bd95d09ce663c
+  metadata.gz: d5d058c86ad2e9f8a8145deec9607538a88d081eb178ce1a87339d4f233c7c8511bce942aba2c487b21676dd07973e23270250d3891c0687e97af2eae2f39f6a
+  data.tar.gz: 1bff9e47c7b2efd3363d747f167589ae6cdf2c93c9c8e9736a8e1beb4d1e5353c8f4ccb96a5cfb1491cbba220645eae348f628ecb203d06ed840a53c34da10fa

data/README.md

@@ -141,6 +141,26 @@ Honeybadger is automatically configured using environment variables (e.g. HONEYB
       notifier: :honeybadger
     )
 
+#### AirbrakeNotifier
+
+For more information on airbrake please refer to their [github repo](https://github.com/airbrake/airbrake).
+
+#### !!!ATTENTION
+
+The airbrake gem is required for the AirbrakeNotifier. Please add the gem to your Gemfile as follows:
+
+    gem 'airbrake'
+
+
+##### Airbrake Usage
+
+    require 'denouncer'
+
+    Denouncer.configure(
+      application_name: "my_app",
+      notifier: :airbrake,
+      api_key: 'my_key'
+    )
 
 #### Multiple notifier configuration
 
@@ -210,3 +230,20 @@ The metadata is optional and defaults to nil.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## How to add a new notfier?
+
+    # Copy the console notifier as base
+    cp lib/denouncer/notifiers/console_notifier.rb lib/denouncer/notifiers/<name>_notifier.rb
+
+    # add your notifier to the module
+    vim lib/denouncer/notifiers.rb
+
+    # adjust the notifier as needed
+    # implement name, set_configuration! and notify methods
+    vim lib/denouncer/notifiers/<name>_notifier.rb
+
+    # add a section for the notifier to the documentation
+    vim README.md
+
+    # follow the instructions above (Contributing)

data/denouncer.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bunny"
   spec.add_development_dependency "honeybadger"
   spec.add_development_dependency "rack"
+  spec.add_development_dependency "airbrake"
 end

data/lib/denouncer/notifiers.rb

@@ -5,5 +5,6 @@ module Denouncer
     autoload :SmtpNotifier, File.expand_path('../notifiers/smtp_notifier', __FILE__)
     autoload :AmqpNotifier, File.expand_path('../notifiers/amqp_notifier', __FILE__)
     autoload :HoneybadgerNotifier, File.expand_path('../notifiers/honeybadger_notifier', __FILE__)
+    autoload :AirbrakeNotifier, File.expand_path('../notifiers/airbrake_notifier', __FILE__)
   end
 end

data/lib/denouncer/notifiers/airbrake_notifier.rb

@@ -0,0 +1,35 @@
+require 'socket'
+require 'json'
+
+module Denouncer
+  module Notifiers
+    class AirbrakeNotifier < BaseNotifier
+
+      # @return [String]
+      def name
+        'airbrake'
+      end
+
+      def set_configuration!(options)
+        raise "Airbrake configuration error: :api_key is nil!" if options[:api_key].nil?
+        require 'airbrake'
+        Airbrake.configure do |config|
+          config.api_key = options[:api_key]
+        end
+        return options
+      end
+
+      # Sends an error notification via amqp.
+      #
+      # @param error [StandardError]
+      # @param metadata [Hash]
+      def notify(error, metadata = nil)
+        Airbrake.notify(error,
+          api_key: config[:api_key],
+          error_message: error.message,
+          backtrace: error.backtrace
+        )
+      end
+    end
+  end
+end

data/lib/denouncer/version.rb

@@ -1,3 +1,3 @@
 module Denouncer
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: denouncer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Julian Weber
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Denouncer allows you to send notifications with error/exception details
   using a simple interface. New methods of sending error messages can be implemented
   using a pre-defined class interface. SMTP and AMQP  notification are the first implemented
@@ -142,6 +156,7 @@ files:
 - denouncer.gemspec
 - lib/denouncer.rb
 - lib/denouncer/notifiers.rb
+- lib/denouncer/notifiers/airbrake_notifier.rb
 - lib/denouncer/notifiers/amqp_notifier.rb
 - lib/denouncer/notifiers/base_notifier.rb
 - lib/denouncer/notifiers/console_notifier.rb