denouncer 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd7818d5f9f193ace4fca1390ba000808403fefe
-  data.tar.gz: 33a1d7791e3d04a59f62115e11eb1ff94e98f65b
+  metadata.gz: 435f952054638a12c1528c1a3efd126b3e37d932
+  data.tar.gz: 69e8ea1f3e5fde186106dee702b8d5d798f717d1
 SHA512:
-  metadata.gz: f764ae4755bc8985a99cee4a19d2e0242c456b78be51b84d9ebbe74bab2b48e21eaf071dcb720a359bf295c728f556718062e6912f5cb02ac0c822100fddcab2
-  data.tar.gz: c601d4730d465d00eb6b4b76fd6d2e8d07b133062a7a43d7e56ea674e6bc404534c4ef124a0d3b0d1cc9812847cc48522d4217b837c3915290dbda5ff228ea87
+  metadata.gz: 34984f10a1b5f47d759cc9e5d1d2d112319738967bf08a4b8fbd3bd19bad55c285ee48d31154a0e004beb1fa7f285f7a08a178bfc9ed7957dc61495a1dfdb5e4
+  data.tar.gz: 1115a5fa4739c36e6b6da776ef9b8d5042cde82a0613821f3906a6709bc7f3e4decf51ab98257969142eb346dddcb361d6315950b648fd3ba99adae72957b896

data/README.md

@@ -121,6 +121,37 @@ Configuration variables are:
       message_queue: "my_app.errors"
     )
 
+#### Multiple notifier configuration
+
+Since version 0.4.0 denouncer supports parallel usage of multiple notifiers.
+All exception notifications will be send to all configured notifiers.
+The example below configures the amqp and smtp notifiers in parallel.
+
+    require 'denouncer'
+
+    Denouncer.configure(
+      {
+        application_name: "my_app",
+        notifiers: [:smtp, :amqp],
+        configurations: {
+          smtp: {
+            port: 1025,
+            server: "localhost",
+            sender: "noreply@example.com",
+            recipients: ['usera@example.com', 'userb@example.com']
+          },
+          amqp: {
+            port: 5672,
+            server: "localhost",
+            vhost: "/",
+            username: "guest",
+            password: "guest",
+            message_queue: "my_app.errors"
+          }
+        }
+      }
+    )
+
 ## Usage
 
 The example below shows a basic usage pattern for denouncer notifications.

data/lib/denouncer.rb

@@ -5,34 +5,49 @@ module Denouncer
 
   DEFAULT_NOTIFIER = :smtp
 
-  @@notifier = nil
+  @@notifiers = nil
 
   # Configures denouncer using the specified configuration hash.
   #
   # @param options [Hash] a configuration hash
   def self.configure(options)
     check_base_configuration! options
-    if options[:notifier].nil?
+    if options[:notifier].nil? && options[:notifiers].nil?
       options[:notifier] = DEFAULT_NOTIFIER
-    else
-      options[:notifier] = options[:notifier].to_sym
     end
-    initialize_notifier options
+
+    unless options[:notifiers].nil?
+      options[:notifiers] = options[:notifiers].map { |n| n.to_sym }
+    end
+
+    initialize_notifiers options
     options
   end
 
   def self.reset_configuration
-    @@notifier = nil
+    @@notifiers = nil
   end
 
   def self.is_configured?
-    !notifier.nil?
+    !notifiers.nil?
   end
 
   # Returns the current notifier's config or nil if not configured.
   def self.config
     return nil unless is_configured?
-    notifier.config
+    if notifiers.count == 1
+      notifiers.first.config
+    else
+      conf = {}
+      conf[:application_name] = notifiers.first.config[:application_name]
+      conf[:notifiers] = Array.new
+      conf[:configurations] = {}
+      notifiers.each do |notif|
+        conf[:notifiers] << notif.name.to_sym
+        conf[:configurations][notif.name.to_sym] = notif.config
+      end
+      conf
+    end
   end
 
   # Sends a notification using the configured notifier.
@@ -44,41 +59,97 @@ module Denouncer
       # ATTENTION: this ensures that no exceptions are lost when denouncer is not working as expected!!!
       # This is worth the downside of denouncer debugging thougths.
       begin
-        notifier.notify error, metadata
+        notifiers.each do |notif|
+          notif.notify error, metadata
+        end
         return true
       rescue => err
-        puts "An error occured while sending an exception notification via denouncer!"
-        raise error
+        puts "An error occured while sending an exception notification via denouncer! Error: #{err.message}, Backtrace: #{err.backtrace}"
       end
     else
       return false
     end
   end
 
+  # Sends a notification and raises the given error on return
+  #
+  # @param error [StandardError]
+  # @param metadata [Hash]
+  # @raise [StandardError] the given error
   def self.notify!(error, metadata = nil)
     if is_configured?
-      notifier.notify! error, metadata
+      notifiers.each do |notif|
+        notif.notify error, metadata
+      end
     end
+  rescue => err
+    puts "An error occured while sending an exception notification via denouncer! Error: #{err.message}, Backtrace: #{err.backtrace}"
+  ensure
+    raise error
   end
 
   private
 
-  def self.notifier
-    return @@notifier
+  def self.notifiers
+    return @@notifiers
   end
 
   def self.check_base_configuration!(options)
     raise "Invalid configuration hash: nil" if options.nil?
-    raise "Invalid configuration hash: no hash or subclass of hash given" unless options.is_a? Hash
+    raise "Invalid configuration hash: No hash or subclass of hash given" unless options.is_a? Hash
+    raise "Invalid configuration hash: No :application_name setting given" if options[:application_name].nil?
+
+    if !options[:notifier].nil? && !options[:notifiers].nil?
+      raise "Invalid configuration hash: Can't use :notifiers and :notifier setting in conjunction"
+    end
   end
 
-  def self.initialize_notifier(options)
-    case options[:notifier]
-    when :smtp then @@notifier = ::Denouncer::Notifiers::SmtpNotifier.new options
-    when :console then @@notifier = ::Denouncer::Notifiers::ConsoleNotifier.new options
-    when :amqp then @@notifier = ::Denouncer::Notifiers::AmqpNotifier.new options
+  def self.initialize_notifiers(options)
+    @@notifiers = Array.new
+    unless options[:notifiers].nil?
+      intialize_multiple_notifiers options
+    else
+      initialize_single_notifier options[:notifier], options
+    end
+  rescue => err
+    @@notifiers = nil
+    raise err
+  end
+
+  def self.intialize_multiple_notifiers(options)
+    raise "No :configurations hash given" if options[:configurations].nil?
+    options[:notifiers].each do |notif_symbol|
+      notif_symbol = notif_symbol.to_sym
+      notifier_class = get_notifier_class notif_symbol
+
+      notifier_opts = {
+        application_name: options[:application_name],
+      }
+
+      notifier_opts.merge!(options[:configurations][notif_symbol])
+      @@notifiers << notifier_class.new(notifier_opts)
+    end
+  end
+
+  def self.initialize_single_notifier(notifier_symbol, options)
+    notifier_class = get_notifier_class notifier_symbol
+    @@notifiers << notifier_class.new(options)
+  end
+
+  def self.get_notifier_class(notifier_symbol)
+    notifier_class = nil
+
+    case notifier_symbol
+    when :smtp then
+      notifier_class = ::Denouncer::Notifiers::SmtpNotifier
+    when :console then
+      notifier_class = ::Denouncer::Notifiers::ConsoleNotifier
+    when :amqp then
+      notifier_class = ::Denouncer::Notifiers::AmqpNotifier
     else
       raise "Invalid notifier configuration: #{options} is not a valid :notifier setting!"
     end
+
+    return notifier_class
   end
 end

data/lib/denouncer/notifiers/amqp_notifier.rb

@@ -10,11 +10,15 @@ module Denouncer
       DEFAULT_USERNAME = 'guest'
       DEFAULT_PASSWORD = 'guest'
 
-      # @raise [StandardError] if the configuration is invalid
+      # @return [String]
+      def name
+        'amqp'
+      end
+
       def set_configuration!(options)
-        require 'bunny'
         raise "Configuration error: :application_name is not set!" if options[:application_name].nil?
-
+        require 'bunny'
+        
         options[:server] = DEFAULT_SERVER if options[:server].nil?
         options[:port] = DEFAULT_PORT if options[:port].nil?
         options[:vhost] = DEFAULT_VHOST if options[:vhost].nil?

data/lib/denouncer/notifiers/base_notifier.rb

@@ -27,6 +27,11 @@ module Denouncer
         end
       end
 
+      # @return [String] the name for the notifier
+      def name
+        raise NotImplementedException("This method needs to be implemented in a sub-class!")
+      end
+
       def set_configuration!(options)
         raise NotImplementedException("This method needs to be implemented in a sub-class!")
       end
@@ -38,17 +43,6 @@ 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/notifiers/console_notifier.rb

@@ -1,6 +1,11 @@
 module Denouncer
   module Notifiers
     class ConsoleNotifier < BaseNotifier
+      
+      # @return [String]
+      def name
+        'console'
+      end
 
       def set_configuration!(options)
         return options

data/lib/denouncer/notifiers/smtp_notifier.rb

@@ -9,6 +9,11 @@ module Denouncer
       DEFAULT_SERVER = 'localhost'
       DEFAULT_DOMAIN = 'localhost'
 
+      # @return [String]
+      def name
+        'smtp'
+      end
+
       # @raise [StandardError] if the configuration is invalid
       def set_configuration!(options)
         raise "Configuration error: :application_name is not set!" if options[:application_name].nil?

data/lib/denouncer/version.rb

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

data/spec/lib/denouncer/denouncer_spec.rb

@@ -1,9 +1,22 @@
 require 'spec_helper'
 
 describe Denouncer do
+  let(:app_name) { "MyApplication" }
   let(:notifier_configuration) do
-    { application_name: "MyApplication", notifier: :console }
+    { application_name: app_name, notifier: :console }
   end
+
+  let(:multiple_notifier_configuration) do
+    {
+      application_name: app_name,
+      notifiers: [:console, :console],
+      configurations: {
+        console: {
+        }
+      }
+    }
+  end
+
   let(:error) do
     StandardError.new("Test")
   end
@@ -30,9 +43,10 @@ describe Denouncer do
         expect(Denouncer.config).to eq new_configuration
       end
 
-      it "should initialize a notifier" do
+      it "should initialize notifiers" do
         Denouncer.configure new_configuration
-        expect(Denouncer.send(:notifier)).not_to be_nil
+        expect(Denouncer.send(:notifiers)).not_to be_nil
+        expect(Denouncer.send(:notifiers)).to be_instance_of Array
       end
     end
 
@@ -42,9 +56,10 @@ describe Denouncer do
         expect(Denouncer.config).to eq new_configuration
       end
 
-      it "should initialize a notifier" do
+      it "should initialize notifiers" do
         Denouncer.configure new_configuration
-        expect(Denouncer.send(:notifier)).not_to be_nil
+        expect(Denouncer.send(:notifiers)).not_to be_nil
+        expect(Denouncer.send(:notifiers)).to be_instance_of Array
       end
     end
 
@@ -85,6 +100,51 @@ describe Denouncer do
         end
       end
     end
+
+    context 'multiple notifiers' do
+      context 'unconfigured' do
+        it 'should initialize the configuration' do
+          Denouncer.configure multiple_notifier_configuration
+          expect(Denouncer.config).not_to be_nil
+        end
+
+        it "should initialize notifiers" do
+          Denouncer.configure multiple_notifier_configuration
+          expect(Denouncer.send(:notifiers)).to be_instance_of Array
+          expect(Denouncer.send(:notifiers).count).to eq multiple_notifier_configuration[:notifiers].count
+        end
+      end
+
+      context 'invalid settings hash' do
+        context ':notifier and :notifiers setting provided' do
+          let(:invalid) do
+            {
+              application_name: "TestAppThing",
+              notifier: :amqp,
+              notifiers: [:amqp,:smtp]
+            }
+          end
+
+          it 'should raise an error' do
+            expect { Denouncer.configure invalid }.to raise_error
+          end
+        end
+
+        context 'without :configurations sub-hash' do
+          let(:invalid) do
+            {
+              application_name: "TestAppThing",
+              notifiers: [:amqp,:smtp]
+            }
+          end
+
+          it 'should raise an error' do
+            expect { Denouncer.configure invalid }.to raise_error
+          end
+        end
+
+      end
+    end
   end
 
   describe ".is_configured?" do
@@ -110,7 +170,7 @@ describe Denouncer do
       Denouncer.configure notifier_configuration
     end
 
-    it "should set the notifier to nil" do
+    it "should set the configuration to nil" do
       Denouncer.reset_configuration
       expect(Denouncer.config).to be_nil
       expect(Denouncer.is_configured?).to be_falsey
@@ -119,13 +179,34 @@ describe Denouncer do
 
   describe ".config" do
     context "configured" do
-      before do
-        Denouncer.configure notifier_configuration
+      context "single notifier" do
+        before do
+          Denouncer.configure notifier_configuration
+        end
+
+        it "should return the notifier's configuration" do
+          notifier = Denouncer.send(:notifiers).first
+          expect(Denouncer.config).to eq notifier.config
+        end
       end
 
-      it "should return the notifier's configuration" do
-        notifier = Denouncer.send(:notifier)
-        expect(Denouncer.config).to eq notifier.config
+      context 'multiple notifiers' do
+        before do
+          Denouncer.configure multiple_notifier_configuration
+        end
+
+        it "should return a hash of configurations" do
+          notifiers = Denouncer.send(:notifiers)
+          notifier_symbols = notifiers.map { |n| n.name.to_sym }
+          expected_config = {
+            application_name: app_name,
+            notifiers: notifier_symbols,
+            configurations: {
+              console: notifiers.first.config
+            }
+          }
+          expect(Denouncer.config).to eq expected_config
+        end
       end
     end
 
@@ -136,26 +217,78 @@ describe Denouncer do
     end
   end
 
-  describe ".notify" do
-    context "configured" do
+  describe ".notify!" do
+    context "single notifier" do
       before do
         Denouncer.configure notifier_configuration
       end
 
-      it "should call it's notifiers notify method" do
-        notifier = Denouncer.send(:notifier)
-        expect(notifier).to receive(:notify).with(error, metadata)
-        Denouncer.notify error, metadata
+      it "should call it's notifier's notify method and raise the given error" do
+        notifiers = Denouncer.send(:notifiers)
+        notifiers.each do |notif|
+          expect(notif).to receive(:notify).with(error, metadata)
+        end
+        expect { Denouncer.notify! error, metadata }.to raise_error error
+      end
+    end
+
+    context "multiple notifiers" do
+      before do
+        Denouncer.configure multiple_notifier_configuration
       end
 
-      it "should return true" do
-        expect(Denouncer.notify error).to be_truthy
+      it "should call it's notifier's notify method and raise the given error" do
+        notifiers = Denouncer.send(:notifiers)
+        notifiers.each do |notif|
+          expect(notif).to receive(:notify).with(error, metadata)
+        end
+        expect { Denouncer.notify! error, metadata }.to raise_error error
       end
     end
+  end
 
-    context "unconfigured" do
-      it "should return false" do
-        expect(Denouncer.notify error).to be_falsey
+  describe ".notify" do
+    context "single notifier configured" do
+      context "configured" do
+        before do
+          Denouncer.configure notifier_configuration
+        end
+
+        it "should call it's notifier's notify method" do
+          notifiers = Denouncer.send(:notifiers)
+          notifiers.each do |notif|
+            expect(notif).to receive(:notify).with(error, metadata)
+          end
+          Denouncer.notify error, metadata
+        end
+
+        it "should return true" do
+          expect(Denouncer.notify error).to be_truthy
+        end
+      end
+
+      context "unconfigured" do
+        it "should return false" do
+          expect(Denouncer.notify error).to be_falsey
+        end
+      end
+    end
+
+    context "multiple notifiers configured" do
+      before do
+        Denouncer.configure multiple_notifier_configuration
+      end
+
+      it "should call all configured notifiers' notify method" do
+        notifiers = Denouncer.send(:notifiers)
+        notifiers.each do |notif|
+          expect(notif).to receive(:notify).with(error, metadata)
+        end
+        Denouncer.notify error, metadata
+      end
+
+      it "should return true" do
+        expect(Denouncer.notify error).to be_truthy
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: denouncer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Julian Weber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler