denouncer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d9585cf186ffdb08fc942cddf41d041f1296206
+  data.tar.gz: de1fab455ae3ae74db81b561b99d06bc32e945cc
+SHA512:
+  metadata.gz: 8498a42f1f5aa436c0f0b567caa64da06a624360fdbe3c6eefefc59c434bf6b0819716d3852c40593fdb27ead6d540e24dfbeeaa39b67d0321bda470553a2af4
+  data.tar.gz: ec63e2488edf124098f3c2e64c59293d0c4dd62b093b4e32db555927033107921cd6b78cd181eadb59413322a1d644afb6d887f06ea027c89ff79e10626d5501

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+test_example.txt

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Julian Weber
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# Denouncer
+
+Denouncer allows you to send notifications for occuring errors within your ruby applications.
+Right now it supports SMTP to send mail notifications with error details.
+The gem is designed to be extendable and provides a simple interface to implement other notification
+methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'denouncer'
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install denouncer
+
+## Configuration
+
+The configuration options depend on the chosen Notifier.
+Basic configuration variables are:
+* application_name - the name of your application (required)
+
+### Console Notifier
+
+The ConsoleNotifier is just for testing and demo purposes. It prints out exception details on the command line.
+
+### SmtpNotifier
+
+The STMP notifier sends email messages using the SMTP protocol.
+Set the notifier configuration setting to :smtp to use the SmtpNotifier.
+
+Configuration variables are:
+* application_name - the name of your application (required)
+* server - the smtp server address to use (default: localhost)
+* port - the port to use for smtp connections (default: 25)
+* domain - the from domain to use (default: localhost)
+* username - the username for the smtp connection (default: nil)
+* password - the password for the smtp connection (default: nil)
+* authtype - the smtp auth type to use (default: :cram_md5) (:plain, :login or :cram_md5)
+* sender - the sender (from) address to use (required)
+* recipients - an array of recipients for the notifications (required)
+
+#### External SMTP server
+
+Denouncer uses the Net::SMTP class to send mail. Additional configuration options are described [here](http://ruby-doc.org/stdlib-2.0/libdoc/net/smtp/rdoc/Net/SMTP.html).
+    require 'denouncer'
+
+    Denouncer.configure(
+      application_name: 'my_app',
+      notifier: :smtp,
+      port: 25,
+      server: 'mail.example.com',
+      sender: 'noreply@example.com',
+      username: 'noreply@example.com',
+      password: 'your_password',
+      recipients: ['usera@example.com', 'userb@example.com'],
+      authtype: :plain,
+      domain: 'mail.example.com'
+    )
+
+#### mailcatcher configuration
+
+For more information in mailcatcher please refer to their [github repo](https://github.com/sj26/mailcatcher).
+
+    require 'denouncer'
+
+    Denouncer.configure(
+      application_name: "my_app",
+      notifier: :smtp,
+      port: 1025,
+      server: "localhost",
+      sender: "noreply@example.com",
+      recipients: ['usera@example.com', 'userb@example.com']
+    )
+
+### AmqpNotifier
+
+Denouncer uses the bunny gem to send mail. Additional configuration options are described [here](http://reference.rubybunny.info/).
+
+#### !!!ATTENTION
+
+The bunny gem is required for the AmqpNotifier. Please add the bunny gem to your Gemfile as follows:
+
+    gem 'bunny'
+
+    Configuration variables are:
+    * application_name - the name of your application (required)
+    * server - the amqp server address to use (default: localhost)
+    * port - the port to use for amqp connections (default: 5672)
+    * username - the username for the amqp connection (default: 'guest')
+    * password - the password for the amqp connection (default: 'guest')
+    * vhost - the virtual host to use for the amqp connection (default: '/')
+    * message_queue - the message queue to use (default: "#{application_name}.errors", e.g. "myapp.errors")
+
+#### AMQP Configuration
+
+require 'denouncer'
+
+Denouncer.configure(
+  application_name: "my_app",
+  notifier: :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.
+Catch exceptions, then use denouncer's notify function and the re-raise the error again.
+
+    begin
+      1/0
+    rescue => err
+      Denouncer.notify err, { test: "my metadata 1", test2: "my metadata 2" }
+      raise err
+    end
+
+The metadata is optional and defaults to nil.
+
+## Test Suite
+
+    bundle exec rspec
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/denouncer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+desc 'Run a pry console session'
+task :console do
+  exec("pry -r ./lib/denouncer.rb")
+end
+task c: :console

data/denouncer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'denouncer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "denouncer"
+  spec.version       = Denouncer::VERSION
+  spec.authors       = ["Julian Weber"]
+  spec.email         = ["jweber@anynines.com"]
+  spec.summary       = %q{Denouncer allows you to send notifications (SMTP, AMQP) with error/exception details using a simple interface.}
+  spec.description   = %q{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 adapters. Use denouncer to get informed on error occurences instantly.}
+  spec.homepage      = "http://github.com/julweber/denouncer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "bunny"
+end

data/lib/denouncer.rb

@@ -0,0 +1,65 @@
+require "denouncer/version"
+
+module Denouncer
+  autoload :Notifiers, File.expand_path('../denouncer/notifiers', __FILE__)
+
+  DEFAULT_NOTIFIER = :smtp
+
+  @@notifier = 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?
+      options[:notifier] = DEFAULT_NOTIFIER
+    end
+    initialize_notifier options
+    options
+  end
+
+  def self.reset_configuration
+    @@notifier = nil
+  end
+
+  def self.is_configured?
+    !notifier.nil?
+  end
+
+  # Returns the current notifier's config or nil if not configured.
+  def self.config
+    return nil unless is_configured?
+    notifier.config
+  end
+
+  # Sends a notification using the configured notifier.
+  #
+  # @param error [StandardError]
+  # @param metadata [Hash]
+  def self.notify(error, metadata = nil)
+    raise "Denouncer is not configured yet. Please run Denouncer.configure(options) to setup denouncer!" if @@notifier.nil?
+    notifier.notify error
+  end
+
+  private
+
+  def self.notifier
+    return @@notifier
+  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
+  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
+    else
+      raise "Invalid notifier configuration: #{options} is not a valid :notifier setting!"
+    end
+  end
+end

data/lib/denouncer/notifiers.rb

@@ -0,0 +1,8 @@
+module Denouncer
+  module Notifiers
+    autoload :BaseNotifier, File.expand_path('../notifiers/base_notifier', __FILE__)
+    autoload :ConsoleNotifier, File.expand_path('../notifiers/console_notifier', __FILE__)
+    autoload :SmtpNotifier, File.expand_path('../notifiers/smtp_notifier', __FILE__)
+    autoload :AmqpNotifier, File.expand_path('../notifiers/amqp_notifier', __FILE__)
+  end
+end

data/lib/denouncer/notifiers/amqp_notifier.rb

@@ -0,0 +1,84 @@
+require 'socket'
+require 'json'
+
+module Denouncer
+  module Notifiers
+    class AmqpNotifier < BaseNotifier
+      DEFAULT_PORT = 5672
+      DEFAULT_SERVER = 'localhost'
+      DEFAULT_VHOST = '/'
+      DEFAULT_USERNAME = 'guest'
+      DEFAULT_PASSWORD = 'guest'
+
+      # @raise [StandardError] if the configuration is invalid
+      def set_configuration!(options)
+        require 'bunny'
+        raise "Configuration error: :application_name is not set!" if options[:application_name].nil?
+
+        options[:server] = DEFAULT_SERVER if options[:server].nil?
+        options[:port] = DEFAULT_PORT if options[:port].nil?
+        options[:vhost] = DEFAULT_VHOST if options[:vhost].nil?
+        options[:username] = DEFAULT_USERNAME if options[:username].nil?
+        options[:password] = DEFAULT_PASSWORD if options[:password].nil?
+        options[:message_queue] = "#{options[:application_name]}.errors" if options[:errors].nil?
+        return options
+      end
+
+      # Sends an error notification via amqp.
+      #
+      # @param error [StandardError]
+      # @param metadata [Hash]
+      def notify(error, metadata = nil)
+        msg = generate_json_message error, metadata
+        send_message_via_amqp msg
+      end
+
+      private
+
+      def generate_message_hash(error, metadata = nil)
+        hostname = Socket.gethostname
+        time_now = get_current_timestamp
+        {
+          notification_time: time_now,
+          application_name: config[:application_name],
+          hostname: hostname,
+          error_class: error.class.name,
+          error_backtrace: error.backtrace,
+          error_message: error.message,
+          error_cause: error.cause,
+          metadata: metadata
+        }
+      end
+
+      def generate_json_message(error, metadata = nil)
+        generate_message_hash(error, metadata).to_json
+      end
+
+      def send_message_via_amqp(message)
+        # Start a communication session with RabbitMQ
+        connection_hash = {
+          host: config[:server],
+          vhost: config[:vhost],
+          port: config[:port],
+          username: config[:username],
+          password: config[:password],
+          threaded: false
+        }
+        conn = Bunny.new connection_hash
+        conn.start
+
+        # open a channel
+        ch = conn.create_channel
+
+        # declare a queue
+        q  = ch.queue(config[:message_queue])
+
+        # publish a message to the default exchange which then gets routed to this queue
+        q.publish(message)
+
+        # close the connection
+        conn.stop
+      end
+    end
+  end
+end

data/lib/denouncer/notifiers/base_notifier.rb

@@ -0,0 +1,34 @@
+require 'time'
+
+module Denouncer
+  module Notifiers
+    class BaseNotifier
+      attr_reader :config
+
+      def initialize(options)
+        if options[:application_name].nil? || !options[:application_name].is_a?(String)
+          raise "Invalid configuration hash: No valid :application_name given"
+        end
+        opts = set_configuration!(options).dup
+        @config = opts
+      end
+
+      # Returns the current timestamp in utc is8601 format
+      def get_current_timestamp
+        Time.now.utc.iso8601
+      end
+
+      def set_configuration!(options)
+        raise NotImplementedException("This method needs to be implemented in a sub-class!")
+      end
+
+      # Sends a notification.
+      #
+      # @param error [StandardError]
+      # @param metadata [Hash]
+      def notify(error, metadata = nil)
+        raise NotImplementedException("This method needs to be implemented in a sub-class!")
+      end
+    end
+  end
+end

data/lib/denouncer/notifiers/console_notifier.rb

@@ -0,0 +1,17 @@
+module Denouncer
+  module Notifiers
+    class ConsoleNotifier < BaseNotifier
+
+      def set_configuration!(options)
+        return options
+      end
+
+      def notify(error, metadata = nil)
+        puts "Timestamp: #{get_current_timestamp}"
+        puts "Error Class: #{error.class.name}"
+        puts "Error Message: #{error.message}"
+        puts "Metadata: #{metadata.to_s}"
+      end
+    end
+  end
+end

data/lib/denouncer/notifiers/smtp_notifier.rb

@@ -0,0 +1,72 @@
+require 'net/smtp'
+require 'time'
+require 'socket'
+
+module Denouncer
+  module Notifiers
+    class SmtpNotifier < BaseNotifier
+      DEFAULT_PORT = 25
+      DEFAULT_SERVER = 'localhost'
+      DEFAULT_DOMAIN = 'localhost'
+
+      # @raise [StandardError] if the configuration is invalid
+      def set_configuration!(options)
+        raise "Configuration error: :application_name is not set!" if options[:application_name].nil?
+        raise "SMTP configuration error: #{options[:sender]} is not a valid :sender setting!" if options[:sender].nil? || !options[:sender].is_a?(String)
+        raise "SMTP configuration error: :recipients is nil!" if options[:recipients].nil?
+
+        options[:server] = DEFAULT_SERVER if options[:server].nil?
+        options[:port] = DEFAULT_PORT if options[:port].nil?
+        options[:domain] = DEFAULT_DOMAIN if options[:domain].nil?
+        return options
+      end
+
+      # Sends an error notification via mail.
+      #
+      # @param error [StandardError]
+      # @param metadata [Hash]
+      def notify(error, metadata = nil)
+        Net::SMTP.start(config[:server], config[:port], config[:domain], config[:username], config[:password], config[:authtype]) do |smtp|
+          smtp.send_message generate_text_message(error), config[:sender], config[:recipients]
+        end
+      end
+
+      private
+
+      def generate_text_message(error, metadata = nil)
+        hostname = Socket.gethostname
+        time_now = get_current_timestamp
+        msgstr = <<END_OF_MESSAGE
+From: #{config[:application_name]} <#{config[:sender]}>
+Subject: [ERROR] - #{config[:application_name]} - An exception occured
+Date: #{time_now}
+
+Application name:
+#{config[:application_name]}
+
+Hostname:
+#{hostname}
+
+Notification time:
+#{time_now} UTC
+
+Error class:
+#{error.class.name}
+
+Error message:
+#{error.message}
+
+Backtrace:
+#{error.backtrace}
+
+Error cause:
+#{error.cause}
+
+Additional metadata:
+#{metadata.to_s}
+END_OF_MESSAGE
+        return msgstr
+      end
+    end
+  end
+end

data/lib/denouncer/version.rb

@@ -0,0 +1,3 @@
+module Denouncer
+  VERSION = "0.2.0"
+end

data/spec/lib/denouncer/denouncer_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe Denouncer do
+  let(:notifier_configuration) do
+    { application_name: "MyApplication", notifier: :console }
+  end
+  let(:error) do
+    StandardError.new("Test")
+  end
+
+  before do
+    Denouncer.reset_configuration
+  end
+
+  describe ".configure" do
+    let(:new_configuration) do
+      { application_name: "TestAppThing", notifier: :console, extra: "abc" }
+    end
+
+    context "configured" do
+      before do
+        Denouncer.configure notifier_configuration
+      end
+
+      it "should override the configuration" do
+        Denouncer.configure new_configuration
+        expect(Denouncer.config).to eq new_configuration
+      end
+
+      it "should initialize a notifier" do
+        Denouncer.configure new_configuration
+        expect(Denouncer.send(:notifier)).not_to be_nil
+      end
+    end
+
+    context "unconfigured" do
+      it "should set the given configuration" do
+        Denouncer.configure new_configuration
+        expect(Denouncer.config).to eq new_configuration
+      end
+
+      it "should initialize a notifier" do
+        Denouncer.configure new_configuration
+        expect(Denouncer.send(:notifier)).not_to be_nil
+      end
+    end
+
+    context "invalid config hash" do
+      context "no :application_name setting given" do
+        let(:invalid) do
+          { notifier: :console, extra: "abc" }
+        end
+
+        it "should raise an error" do
+          expect { Denouncer.configure invalid }.to raise_error
+        end
+      end
+
+      context "no hash given" do
+        let(:invalid) do
+          "Invalid String"
+        end
+
+        it "should raise an error" do
+          expect { Denouncer.configure invalid }.to raise_error
+        end
+      end
+
+      context "nil given" do
+        it "should raise an error" do
+          expect { Denouncer.configure nil }.to raise_error
+        end
+      end
+
+      context "invalid notifier setting given" do
+        let(:invalid) do
+          { application_name: "TestAppThing", notifier: :not_existing }
+        end
+
+        it "should raise an error" do
+          expect { Denouncer.configure invalid }.to raise_error
+        end
+      end
+    end
+  end
+
+  describe ".is_configured?" do
+    context "configured" do
+      before do
+        Denouncer.configure notifier_configuration
+      end
+
+      it "should return true" do
+        expect(Denouncer.is_configured?).to be_truthy
+      end
+    end
+
+    context "unconfigured" do
+      it "should return false" do
+        expect(Denouncer.is_configured?).to be_falsey
+      end
+    end
+  end
+
+  describe ".reset_configuration" do
+    before do
+      Denouncer.configure notifier_configuration
+    end
+
+    it "should set the notifier to nil" do
+      Denouncer.reset_configuration
+      expect(Denouncer.config).to be_nil
+      expect(Denouncer.is_configured?).to be_falsey
+    end
+  end
+
+  describe ".config" do
+    context "configured" do
+      before do
+        Denouncer.configure notifier_configuration
+      end
+
+      it "should return the notifier's configuration" do
+        notifier = Denouncer.send(:notifier)
+        expect(Denouncer.config).to eq notifier.config
+      end
+    end
+
+    context "unconfigured" do
+      it "should return nil" do
+        expect(Denouncer.config).to be_nil
+      end
+    end
+  end
+
+  describe ".notify" do
+    context "configured" 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)
+        Denouncer.notify error
+      end
+    end
+
+    context "unconfigured" do
+      it "should raise an error" do
+        expect { Denouncer.notify error }.to raise_error
+      end
+    end
+  end
+end

data/spec/lib/denouncer/notifiers/amqp_notifier_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Denouncer::Notifiers::AmqpNotifier do
+  let(:error) do
+    error = nil
+    begin
+      1/0
+    rescue => err
+      error = err
+    end
+    error
+  end
+  let(:app_name) { "my_app" }
+  let(:server) { 'localhost' }
+  let(:port) { 5672 }
+  let(:username) { 'guest' }
+  let(:password) { 'guest' }
+  let(:vhost) { '/'}
+  let(:message_queue) { 'my_app.errors' }
+  let(:config) do
+    {
+      application_name: app_name,
+      notifier: :amqp,
+      port: port,
+      server: server,
+      vhost: vhost,
+      username: username,
+      password: password,
+      message_queue: message_queue
+    }
+  end
+
+  describe "initialize" do
+    context "valid configuration" do
+      it "should set the configuration" do
+        notifier = Denouncer::Notifiers::AmqpNotifier.new config
+        expect(notifier.config).to eq config
+      end
+    end
+  end
+
+  describe "set_configuration!" do
+    let(:notifier) { Denouncer::Notifiers::AmqpNotifier.new config }
+
+    context "valid configuration" do
+      it "should not raise an error" do
+        expect { notifier.set_configuration!(config) }.not_to raise_error
+      end
+
+      it "should return the options hash" do
+        expect(notifier.set_configuration!(config)).to eq config
+      end
+    end
+
+    context "invalid configuration" do
+      context "no application_name" do
+        let(:invalid) do
+          config.delete(:application_name)
+          config
+        end
+
+        it "should raise an error" do
+          expect { notifier.set_configuration! invalid }.to raise_error
+        end
+      end
+    end
+  end
+
+  describe "#generate_json_message" do
+    let(:notifier) { Denouncer::Notifiers::AmqpNotifier.new config }
+    let(:metadata_var) { "HASHVAR123" }
+    let(:metadata) { { hash_var: metadata_var } }
+
+    it "should generate a json encoded message" do
+      msg = notifier.send(:generate_json_message, error, metadata)
+      expect(msg).to be_kind_of String
+      expect { JSON.parse(msg) }.not_to raise_error
+    end
+
+    it "should contain the error message" do
+      msg = notifier.send(:generate_json_message, error, metadata)
+      parsed = JSON.parse(msg)
+      expect(parsed["error_message"]).to match (error.message)
+    end
+
+    it "should contain the error class" do
+      msg = notifier.send(:generate_json_message, error, metadata)
+      parsed = JSON.parse(msg)
+      expect(parsed["error_class"]).to eq (error.class.name)
+    end
+
+    it "should contain the application_name" do
+      msg = notifier.send(:generate_json_message, error, metadata)
+      parsed = JSON.parse(msg)
+      expect(parsed["application_name"]).to eq app_name
+    end
+
+    it "should contain the metadata hash" do
+      msg = notifier.send(:generate_json_message, error, metadata)
+      parsed = JSON.parse(msg)
+      expect(parsed["metadata"]).to be_kind_of Hash
+      expect(parsed["metadata"]["hash_var"]).to eq metadata_var
+    end
+
+    it "should contain the backtrace" do
+      msg = notifier.send(:generate_json_message, error, metadata)
+      parsed = JSON.parse(msg)
+      expect(parsed["error_backtrace"]).to be_kind_of Array
+    end
+
+    it "should contain the notification_time" do
+      msg = notifier.send(:generate_json_message, error, metadata)
+      parsed = JSON.parse(msg)
+      expect(parsed["notification_time"]).not_to be_nil
+    end
+  end
+end

data/spec/lib/denouncer/notifiers/console_notifier_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Denouncer::Notifiers::ConsoleNotifier do
+  let(:config) { { application_name: "my_app" } }
+  let(:notifier) { Denouncer::Notifiers::ConsoleNotifier.new config }
+
+  describe "#set_configuration!" do
+    it "should return the options" do
+      conf = notifier.set_configuration! config
+      expect(conf).to eq config
+    end
+  end
+
+  describe "#notify" do
+    it "should call puts" do
+      expect_any_instance_of(Object).to receive(:puts).at_least(:once)
+      notifier.notify(StandardError.new("Test"))
+    end
+  end
+end

data/spec/lib/denouncer/notifiers/smtp_notifier_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Denouncer::Notifiers::SmtpNotifier do
+  let(:error) do
+    error = nil
+    begin
+      1/0
+    rescue => err
+      error = err
+    end
+    error
+  end
+  let(:app_name) { "my_app" }
+  let(:server) { 'localhost' }
+  let(:port) { 1025 }
+  let(:domain) { 'localhost' }
+  let(:username) { nil }
+  let(:password) { nil }
+  let(:authtype) { nil }
+  let(:config) do
+    {
+      application_name: app_name,
+      notifier: :smtp,
+      port: port,
+      server: server,
+      sender: "noreply@example.com",
+      recipients: ['usera@example.com', 'userb@example.com'],
+      domain: domain,
+      username: username,
+      password: password,
+      authtype: authtype
+    }
+  end
+
+  describe "initialize" do
+    context "valid configuration" do
+      it "should set the configuration" do
+        notifier = Denouncer::Notifiers::SmtpNotifier.new config
+        expect(notifier.config).to eq config
+      end
+    end
+  end
+
+  describe "notify" do
+    let(:notifier) { Denouncer::Notifiers::SmtpNotifier.new config }
+
+    it "should start a SMTP connection" do
+      expect(Net::SMTP).to receive(:start).with(server, port, domain, username, password, authtype)
+      notifier.notify(error, { test: "abc" })
+    end
+  end
+
+  describe "set_configuration!" do
+    let(:notifier) { Denouncer::Notifiers::SmtpNotifier.new config }
+
+    context "valid configuration" do
+      it "should not raise an error" do
+        expect { notifier.set_configuration!(config) }.not_to raise_error
+      end
+
+      it "should return the options hash" do
+        expect(notifier.set_configuration!(config)).to eq config
+      end
+    end
+
+    context "invalid configuration" do
+      context "no application_name" do
+        let(:invalid) do
+          config.delete(:application_name)
+          config
+        end
+
+        it "should raise an error" do
+          expect { notifier.set_configuration! invalid }.to raise_error
+        end
+      end
+
+      context "no sender" do
+        let(:invalid) do
+          config.delete(:sender)
+          config
+        end
+
+        it "should raise an error" do
+          expect { notifier.set_configuration! invalid }.to raise_error
+        end
+      end
+
+      context "no recipients array" do
+        let(:invalid) do
+          config.delete(:recipients)
+          config
+        end
+
+        it "should raise an error" do
+          expect { notifier.set_configuration! invalid }.to raise_error
+        end
+      end
+    end
+  end
+
+  describe "#generate_text_message" do
+    let(:notifier) { Denouncer::Notifiers::SmtpNotifier.new config }
+    let(:metadata_var) { "HASHVAR123" }
+    let(:metadata) { { hash_var: metadata_var } }
+
+    it "should generate a text message" do
+      msg = notifier.send(:generate_text_message, error, metadata)
+      expect(msg).to be_kind_of String
+    end
+
+    it "should contain the error message" do
+      msg = notifier.send(:generate_text_message, error, metadata)
+      expect(msg).to match error.message
+    end
+
+    it "should contain the error class" do
+      msg = notifier.send(:generate_text_message, error, metadata)
+      expect(msg).to match error.class.name
+    end
+
+    it "should contain the application_name" do
+      msg = notifier.send(:generate_text_message, error, metadata)
+      expect(msg).to match app_name
+    end
+
+    it "should contain the metadata hash" do
+      msg = notifier.send(:generate_text_message, error, metadata)
+      expect(msg).to match metadata_var
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'simplecov'
+SimpleCov.start
+
+require_relative '../lib/denouncer'
+require 'rspec'
+
+RSpec.configure do |config|
+
+  config.formatter = :documentation
+  config.tty = true
+  config.color = true
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = [:expect, :should]
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: denouncer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Julian Weber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  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
+  adapters. Use denouncer to get informed on error occurences instantly.
+email:
+- jweber@anynines.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- denouncer.gemspec
+- lib/denouncer.rb
+- lib/denouncer/notifiers.rb
+- lib/denouncer/notifiers/amqp_notifier.rb
+- lib/denouncer/notifiers/base_notifier.rb
+- lib/denouncer/notifiers/console_notifier.rb
+- lib/denouncer/notifiers/smtp_notifier.rb
+- lib/denouncer/version.rb
+- spec/lib/denouncer/denouncer_spec.rb
+- spec/lib/denouncer/notifiers/amqp_notifier_spec.rb
+- spec/lib/denouncer/notifiers/console_notifier_spec.rb
+- spec/lib/denouncer/notifiers/smtp_notifier_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/julweber/denouncer
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Denouncer allows you to send notifications (SMTP, AMQP) with error/exception
+  details using a simple interface.
+test_files:
+- spec/lib/denouncer/denouncer_spec.rb
+- spec/lib/denouncer/notifiers/amqp_notifier_spec.rb
+- spec/lib/denouncer/notifiers/console_notifier_spec.rb
+- spec/lib/denouncer/notifiers/smtp_notifier_spec.rb
+- spec/spec_helper.rb