denouncer 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a77f3e86d725082c9c340e887f054db7af630aa
-  data.tar.gz: b3dfaa416e6d0285cb8fff1a038da98501993876
+  metadata.gz: ed284b585007fb67403b53f2a89977c8275765e1
+  data.tar.gz: d893fbd56d104bda09efdf692a0eeac088522267
 SHA512:
-  metadata.gz: 9a2f523840d14d12b7d43e264d140b66ce4a0f29905ea71e424839dbedf6b83fcff44c3a5e2adf9dc9844897247b010f4b9bda222dd8d17a7dd6842c919b8df6
-  data.tar.gz: ad47ec37b564d0c0d30b0c5cbd5144f34ed6df82e8b1b518264cfd8e4a244cdb87abbab04f7e6d99df992b7e4e5416e328b8d4c209cd8db038c17a5a481eaa5f
+  metadata.gz: 233ec02b14c08f01db39a204cb4699d1488fd2d037dff0caf1f46c2a985447411afcf777aec337f15a2c4022515253a6d28c75838e48bbd40da92c6601350b30
+  data.tar.gz: e8920a8f456feff216979ed0dbc8f19e38b7b9b48ab341a813a86119fff8658f1db602acf9a359181fa9c1fca602e9ea5f05d8205d707b1f394e8ff117b084bd

data/README.md

@@ -195,6 +195,8 @@ The example below configures the amqp and smtp notifiers in parallel.
 
 ## Usage
 
+### Error notification
+
 The example below shows a basic usage pattern for denouncer notifications.
 Catch exceptions, then use denouncer's notify function and then re-raise the error again.
 
@@ -215,6 +217,10 @@ or
 
 The metadata is optional and defaults to nil.
 
+### Information notification
+
+    Denouncer.info 'This contains lots of valuable information :)', { t1: "metadata 1", t2: "metadata 2" }
+
 ## Test Suite
 
     bundle exec rspec
@@ -223,6 +229,10 @@ The metadata is optional and defaults to nil.
 
 [This](https://docs.google.com/drawings/d/16DaQhsAwcr-5zlguhKGwigpdNpOgO4-IXssLst7zlUM/edit?usp=sharing) illustration shows the basic architecture of the denouncer gem.
 
+## TODOs
+
+* Implement better test coverage
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/denouncer/fork )

data/lib/denouncer.rb

@@ -2,6 +2,7 @@ require "denouncer/version"
 
 module Denouncer
   autoload :Notifiers, File.expand_path('../denouncer/notifiers', __FILE__)
+  autoload :InfoError, File.expand_path('../denouncer/info_error', __FILE__)
 
   DEFAULT_NOTIFIER = :smtp
 
@@ -50,7 +51,7 @@ module Denouncer
     end
   end
 
-  # Sends a notification using the configured notifier.
+  # Sends a notification using the configured notifiers.
   #
   # @param error [StandardError]
   # @param metadata [Hash]
@@ -71,6 +72,25 @@ module Denouncer
     end
   end
 
+  # Sends a info notification using the configured notifiers.
+  #
+  # @param error [StandardError]
+  # @param metadata [Hash]
+  def self.info(info_message, metadata = nil)
+    if is_configured?
+      begin
+        notifiers.each do |notif|
+          notif.info info_message, metadata
+        end
+        return true
+      rescue => err
+        puts "An error occured while sending an info 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]

data/lib/denouncer/info_error.rb

@@ -0,0 +1,4 @@
+module Denouncer
+  class InfoError < StandardError
+  end
+end

data/lib/denouncer/notifiers/airbrake_notifier.rb

@@ -30,6 +30,17 @@ module Denouncer
           backtrace: error.backtrace
         )
       end
+
+      # Sends a info notification.
+      #
+      # @param info_message [String]
+      # @param metadata [Hash]
+      def info(info_message, metadata = nil)
+        Airbrake.notify(Denouncer::InfoError.new(info_message),
+          api_key: config[:api_key],
+          error_message: info_message
+        )
+      end
     end
   end
 end

data/lib/denouncer/notifiers/amqp_notifier.rb

@@ -33,13 +33,22 @@ module Denouncer
       # @param error [StandardError]
       # @param metadata [Hash]
       def notify(error, metadata = nil)
-        msg = generate_json_message error, metadata
+        msg = generate_error_hash(error, metadata).to_json
+        send_message_via_amqp msg
+      end
+
+      # Sends a info notification.
+      #
+      # @param info_message [String]
+      # @param metadata [Hash]
+      def info(info_message, metadata = nil)
+        msg = generate_info_hash(info_message, metadata).to_json
         send_message_via_amqp msg
       end
 
       private
 
-      def generate_message_hash(error, metadata = nil)
+      def generate_error_hash(error, metadata = nil)
         hostname = Socket.gethostname
         time_now = get_current_timestamp
         {
@@ -54,8 +63,16 @@ module Denouncer
         }
       end
 
-      def generate_json_message(error, metadata = nil)
-        generate_message_hash(error, metadata).to_json
+      def generate_info_hash(message, metadata = nil)
+        hostname = Socket.gethostname
+        time_now = get_current_timestamp
+        {
+          notification_time: time_now,
+          application_name: config[:application_name],
+          hostname: hostname,
+          message: message,
+          metadata: metadata
+        }
       end
 
       def send_message_via_amqp(message)

data/lib/denouncer/notifiers/base_notifier.rb

@@ -36,13 +36,21 @@ module Denouncer
         raise NotImplementedException("This method needs to be implemented in a sub-class!")
       end
 
-      # Sends a notification.
+      # Sends an error 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
+
+      # Sends a info notification.
+      #
+      # @param info_message [String]
+      # @param metadata [Hash]
+      def info(info_message, 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

@@ -1,7 +1,7 @@
 module Denouncer
   module Notifiers
     class ConsoleNotifier < BaseNotifier
-      
+
       # @return [String]
       def name
         'console'
@@ -17,6 +17,16 @@ module Denouncer
         puts "Error Message: #{error.message}"
         puts "Metadata: #{metadata.to_s}"
       end
+
+      # Sends a info notification.
+      #
+      # @param info_message [String]
+      # @param metadata [Hash]
+      def info(info_message, metadata = nil)
+        puts "Timestamp: #{get_current_timestamp.to_s}"
+        puts "INFO: #{info_message.to_s}"
+        puts "Metadata: #{metadata.to_s}"
+      end
     end
   end
 end

data/lib/denouncer/notifiers/honeybadger_notifier.rb

@@ -28,6 +28,18 @@ module Denouncer
           parameters: metadata
         )
       end
+
+      # Sends a info notification.
+      #
+      # @param info_message [String]
+      # @param metadata [Hash]
+      def info(info_message, metadata = nil)
+        Honeybadger.notify(
+          error_message: info_message,
+          parameters: metadata
+        )
+      end
+
     end
   end
 end

data/lib/denouncer/notifiers/smtp_notifier.rb

@@ -33,20 +33,30 @@ module Denouncer
       # @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, metadata), config[:sender], config[:recipients]
+          smtp.send_message generate_error_text_message(error, metadata), config[:sender], config[:recipients]
+        end
+      end
+
+      # Sends a info notification.
+      #
+      # @param info_message [String]
+      # @param metadata [Hash]
+      def info(info_message, metadata = nil)
+        Net::SMTP.start(config[:server], config[:port], config[:domain], config[:username], config[:password], config[:authtype]) do |smtp|
+          smtp.send_message generate_info_text_message(info_message, metadata), config[:sender], config[:recipients]
         end
       end
 
       private
 
-      def generate_text_message(error, metadata = nil)
+      def generate_error_text_message(error, metadata = nil)
         hostname = Socket.gethostname
         time_now = get_current_timestamp
         recipients_list = formatted_recipients
         msgstr = <<END_OF_MESSAGE
 From: #{config[:application_name]} <#{config[:sender]}>
 To: #{recipients_list}
-Subject: #{generate_subject(error)}
+Subject: #{generate_error_subject(error)}
 Date: #{formatted_time(time_now)}
 
 Application name:
@@ -73,6 +83,38 @@ Error cause:
 Metadata:
 #{metadata.to_s}
 
+-- -- -- -- -- -- -- -- -- -- --
+This message was generated using the denouncer exception notifier gem.
+( http://github.com/julweber/denouncer )
+END_OF_MESSAGE
+        return msgstr
+      end
+
+      def generate_info_text_message(message, metadata = nil)
+        hostname = Socket.gethostname
+        time_now = get_current_timestamp
+        recipients_list = formatted_recipients
+        msgstr = <<END_OF_MESSAGE
+From: #{config[:application_name]} <#{config[:sender]}>
+To: #{recipients_list}
+Subject: #{generate_info_subject}
+Date: #{formatted_time(time_now)}
+
+Application name:
+#{config[:application_name]}
+
+Hostname:
+#{hostname}
+
+Notification time:
+#{time_now}
+
+Info message:
+#{message}
+
+Metadata:
+#{metadata.to_s}
+
 -- -- -- -- -- -- -- -- -- -- --
 This message was generated using the denouncer exception notifier gem.
 ( http://github.com/julweber/denouncer )
@@ -106,8 +148,12 @@ END_OF_MESSAGE
         return str
       end
 
-      def generate_subject(error)
-        "[Denouncer] - [Error] - #{config[:application_name]} - #{error.class.name} - #{get_current_timestamp.to_s}"
+      def generate_error_subject(error)
+        "[Denouncer] - [ERROR] - #{config[:application_name]} - #{error.class.name} - #{get_current_timestamp.to_s}"
+      end
+
+      def generate_info_subject
+        "[Denouncer] - [INFO] - #{config[:application_name]} - #{get_current_timestamp.to_s}"
       end
     end
   end

data/lib/denouncer/version.rb

@@ -1,3 +1,3 @@
 module Denouncer
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

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

@@ -66,52 +66,45 @@ describe Denouncer::Notifiers::AmqpNotifier do
     end
   end
 
-  describe "#generate_json_message" do
+  describe "#generate_error_hash" 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
+    it "should generate a hash" do
+      msg = notifier.send(:generate_error_hash, error, metadata)
+      expect(msg).to be_kind_of Hash
     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)
+      h = notifier.send(:generate_error_hash, error, metadata)
+      expect(h[: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)
+      h = notifier.send(:generate_error_hash, error, metadata)
+      expect(h[: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
+      h = notifier.send(:generate_error_hash, error, metadata)
+      expect(h[: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
+      h = notifier.send(:generate_error_hash, error, metadata)
+      expect(h[:metadata]).to be_kind_of Hash
+      expect(h[: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
+      h = notifier.send(:generate_error_hash, error, metadata)
+      expect(h[: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
+      h = notifier.send(:generate_error_hash, error, metadata)
+      expect(h[:notification_time]).not_to be_nil
     end
   end
 end

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

@@ -99,33 +99,33 @@ describe Denouncer::Notifiers::SmtpNotifier do
     end
   end
 
-  describe "#generate_text_message" do
+  describe "#generate_error_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)
+      msg = notifier.send(:generate_error_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)
+      msg = notifier.send(:generate_error_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)
+      msg = notifier.send(:generate_error_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)
+      msg = notifier.send(:generate_error_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)
+      msg = notifier.send(:generate_error_text_message, error, metadata)
       expect(msg).to match metadata_var
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: denouncer
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Julian Weber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,6 +155,7 @@ files:
 - Rakefile
 - denouncer.gemspec
 - lib/denouncer.rb
+- lib/denouncer/info_error.rb
 - lib/denouncer/notifiers.rb
 - lib/denouncer/notifiers/airbrake_notifier.rb
 - lib/denouncer/notifiers/amqp_notifier.rb