denouncer 0.2.13 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f7c1f9cc8a7072f8f71b80eb1f6fea02e74d20c
-  data.tar.gz: 465051f928dd370df5fffa886b677fe1e686205c
+  metadata.gz: dd7818d5f9f193ace4fca1390ba000808403fefe
+  data.tar.gz: 33a1d7791e3d04a59f62115e11eb1ff94e98f65b
 SHA512:
-  metadata.gz: 15664ad3f6338b88a7209c81bfdaa837e5993e9c28243c32caf8b8021818b1c5f45770d2f10c928fda8d64968648d864f537be3f579e2d4d1165a7b0e4f1efd6
-  data.tar.gz: 241110fb60a733e221d5d49d7191530b64dd214c5b8a635b94c26676f4f5d90227c90597fadc01704fa107dd32cfcf01f0fc37e852b4803180dc8fe7a1c3e357
+  metadata.gz: f764ae4755bc8985a99cee4a19d2e0242c456b78be51b84d9ebbe74bab2b48e21eaf071dcb720a359bf295c728f556718062e6912f5cb02ac0c822100fddcab2
+  data.tar.gz: c601d4730d465d00eb6b4b76fd6d2e8d07b133062a7a43d7e56ea674e6bc404534c4ef124a0d3b0d1cc9812847cc48522d4217b837c3915290dbda5ff228ea87

data/README.md

@@ -124,7 +124,7 @@ Configuration variables are:
 ## Usage
 
 The example below shows a basic usage pattern for denouncer notifications.
-Catch exceptions, then use denouncer's notify function and the re-raise the error again.
+Catch exceptions, then use denouncer's notify function and then re-raise the error again.
 
     begin
       1/0
@@ -133,12 +133,24 @@ Catch exceptions, then use denouncer's notify function and the re-raise the erro
       raise err
     end
 
+or
+
+    begin
+      1/0
+    rescue => err
+      Denouncer.notify! err, { test: "my metadata 1", test2: "my metadata 2" }
+    end
+
 The metadata is optional and defaults to nil.
 
 ## Test Suite
 
     bundle exec rspec
 
+## Architecture overview
+
+[This](https://docs.google.com/drawings/d/16DaQhsAwcr-5zlguhKGwigpdNpOgO4-IXssLst7zlUM/edit?usp=sharing) illustration shows the basic architecture of the denouncer gem.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/denouncer/fork )

data/lib/denouncer.rb

@@ -55,6 +55,12 @@ module Denouncer
     end
   end
 
+  def self.notify!(error, metadata = nil)
+    if is_configured?
+      notifier.notify! error, metadata
+    end
+  end
+
   private
 
   def self.notifier

data/lib/denouncer/notifiers/base_notifier.rb

@@ -38,6 +38,17 @@ module Denouncer
       def notify(error, metadata = nil)
         raise NotImplementedException("This method needs to be implemented in a sub-class!")
       end
+
+      # Sends a notification
+      # raises the given error after notifying using the configured adapter
+      #
+      # @param error [StandardError]
+      # @param metadata [Hash]
+      # @raise [StandardError]
+      def notify!(error, metadata = nil)
+        notify error, metadata
+        raise error
+      end
     end
   end
 end

data/lib/denouncer/version.rb

@@ -1,3 +1,3 @@
 module Denouncer
-  VERSION = "0.2.13"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: denouncer
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.3.0
 platform: ruby
 authors:
 - Julian Weber