tocsin 0.1.0 → 0.1.1

data/lib/tocsin/config.rb

@@ -1,6 +1,17 @@
 module Tocsin
   class Config
-    attr_accessor :logger, :queue, :recipient_groups, :from_address
+    attr_accessor :exception_level, :from_address, :logger, :queue, :recipient_groups
+
+    def initialize
+      @exception_level  = StandardError
+      @logger           = select_logger
+      @queue            = :high
+    end
+
+    def select_logger
+      rails = defined?(Rails) && Rails.respond_to?(:logger)
+      rails ? Rails.logger : Logger.new($stderr)
+    end
 
     # notify [r1, r2], :of => filters, :by => notifier 
     def notify(recipients, parameters)
@@ -14,19 +25,5 @@ module Tocsin
                        :notifier    => notifier}.merge(filters)
       self.recipient_groups.push(group_config)
     end
-
-    def queue
-      @queue ||= :high
-    end
-
-    def logger
-      @logger ||= Rails.logger
-    rescue NameError, NoMethodError => e
-      ok =  [ /^uninitialized constant .*Rails$/,
-              /^undefined method `logger'/
-            ].any?{|regex| e.message =~ regex }
-      raise unless ok
-      @logger ||= Logger.new($stderr)
-    end
   end
 end

data/lib/tocsin/version.rb

@@ -1,3 +1,3 @@
 module Tocsin
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/tocsin.rb

@@ -42,7 +42,7 @@ module Tocsin
   def self.watch(options={})
     begin
       yield
-    rescue => e
+    rescue exception_level => e
       raise_alert(e, options)
     end
   end
@@ -51,7 +51,7 @@ module Tocsin
   def self.watch!(options={})
     begin
       yield
-    rescue => e
+    rescue exception_level => e
       raise_alert(e, options)
       raise e
     end
@@ -112,6 +112,10 @@ module Tocsin
 
   private
 
+  def self.exception_level
+    config.exception_level
+  end
+
   def self.sound(alert)
     alert = Tocsin::Alert.find(alert) unless alert.is_a?(Tocsin::Alert)
     recipients = Tocsin.recipients(alert)
@@ -120,12 +124,16 @@ module Tocsin
       notifier = Tocsin::Notifiers[notifier_key]
 
       if notifier && recipient_list.any?
-        notifier.notify(recipient_list, alert)
-        Tocsin.logger.info { "Notification sent to #{recipient_list.inspect} via #{notifier_key} for alert #{alert.id}." }
+        logger.info { "Sending notification to #{recipient_list.inspect} via #{notifier_key} for alert #{alert.id}." }
+        begin
+          notifier.notify(recipient_list, alert)
+        rescue Timeout::Error, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Errno::ENETUNREACH, Errno::ETIMEDOUT => e
+          logger.error { "Notification failed. #{e.to_s}:\n#{e.backtrace.join('\n')}" }
+        end
       elsif recipient_list.empty?
-        Tocsin.logger.error { "No recipients associated with alert: \n #{alert.inspect}" }
+        logger.error { "No recipients associated with alert: \n #{alert.inspect}" }
       elsif notifier.nil?
-        Tocsin.logger.error { "Raised alert with ID=#{alert.id} for unregistered notifier '#{notifier_key}'." }
+        logger.error { "Raised alert with ID=#{alert.id} for unregistered notifier '#{notifier_key}'." }
       end
     end
   end

data/spec/spec_helper.rb

@@ -9,26 +9,23 @@ Mail.defaults do
 end
 
 class Tocsin::Alert
-  def id
-    1
-  end
-
-  def category
-  end
-
-  def severity
+  attr_accessor :id, :exception, :backtrace, :category, :severity, :message
+
+  def initialize(args = {})
+    @id = 1
+    @backtrace = args[:backtrace]
+    @exception = args[:exception]
+    @category  = args[:category]
+    @severity  = args[:severity]
+    @message   = args[:message]
   end
 
   def self.create(*args)
-    self.new
+    self.new(*args)
   end
 
   def self.find(*args)
-    self.new
-  end
-
-  def self.logger
-    @logger ||= Logger.new($stdout)
+    self.new(*args)
   end
 end
 

data/spec/tocsin_spec.rb

@@ -22,13 +22,13 @@ describe Tocsin do
   end
 
   context "when an exception has already been rescued" do
-    it "raises an alert" do
-      Tocsin::Alert.expects(:create).returns(stub("alert", :id => 1))
+    it "raises (and returns) an alert" do
+      Tocsin::Alert.expects(:create).returns(Tocsin::Alert.new)
 
       begin
         raise "Testing"
       rescue => e
-        Tocsin.raise_alert(e, alert_options)
+        Tocsin.raise_alert(e, alert_options).should be_a_kind_of(Tocsin::Alert)
       end
     end
   end
@@ -44,6 +44,25 @@ describe Tocsin do
       }.should_not raise_error
     end
 
+    it "normally does not rescue low-level Exceptions" do
+      expect { Tocsin.watch(alert_options) do raise Exception.new end }.to raise_error
+    end
+
+    context "when configured to catch all Exceptions" do
+      before {
+        Tocsin.config.exception_level = Exception
+      }
+
+      it "can rescue low-level Exceptions too" do
+        expect { Tocsin.watch(alert_options) do raise Exception.new end }.to_not raise_error
+      end
+
+      it "still creates an alert when watch!-ing a block which raises an Exception" do
+        Tocsin.expects(:raise_alert).once
+        expect { Tocsin.watch!(alert_options) do raise Exception.new end }.to raise_error
+      end
+    end
+
     it "provides a watch! method which both send an alert and re-raises the exception" do
       Tocsin.expects(:raise_alert).with(is_a(Exception), has_entries(alert_options))
 
@@ -163,15 +182,18 @@ describe Tocsin do
       Tocsin.raise_alert(exception, alert_options)
     end
 
+    let(:attributes) do
+      { :exception  =>  exception.to_s,
+        :backtrace  =>  exception.backtrace.join("\n"),
+        :severity   =>  alert_options[:severity].to_s,
+        :message    =>  alert_options[:message].to_s,
+        :category   =>  alert_options[:category].to_s
+      }
+    end
+
     describe "the created Tocsin::Alert object" do
       it "is created with appropriate fields" do
-        Tocsin::Alert.expects(:create).with(has_entries(
-          :exception  =>  exception.to_s,
-          :backtrace  =>  exception.backtrace.join("\n"),
-          :severity   =>  alert_options[:severity].to_s,
-          :message    =>  alert_options[:message].to_s,
-          :category   =>  alert_options[:category].to_s
-        )).returns(stub("alert", :id => 1))
+        Tocsin::Alert.expects(:create).with(has_entries(attributes)).returns(Tocsin::Alert.new)
         alert
       end
     end
@@ -198,6 +220,30 @@ describe Tocsin do
       expect { alert }.to_not raise_error
     end
 
+    context "common communication errors" do
+      before do
+        Tocsin.configure do |c|
+          c.notify ["a@b.com"], :of => { :severity => /.*/ }
+          c.logger = Logger.new('/dev/null')
+        end
+      end
+
+      errors =  [ Timeout::Error,
+                  Errno::EHOSTUNREACH,
+                  Errno::ECONNREFUSED,
+                  Errno::ENETUNREACH,
+                  Errno::ETIMEDOUT ]
+
+      errors.each do |err|
+        it "logs #{err.to_s} without exploding" do
+          alert_options.merge!(now: true)
+          Mail.expects(:deliver).raises(err)
+          Tocsin.logger.expects(:error)
+          expect { alert }.to_not raise_error
+        end
+      end
+    end
+
   end
 
   describe Tocsin::NotificationJob do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tocsin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec