safely 0.1.0pre → 0.1.0

data/CHANGES

@@ -0,0 +1,4 @@
+0.1 (WIP)
+
+* Initial hoptoad support
+* Initial email support

data/Gemfile

@@ -8,6 +8,7 @@ source "http://rubygems.org"
 
 group :development do
   gem "toadhopper"
+  gem "mail"
 
   gem "rspec", "~> 2.5.0"
   gem "yard", "~> 0.6.0"

data/Gemfile.lock

@@ -1,13 +1,22 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.0.6)
     diff-lcs (1.1.2)
     git (1.2.5)
+    i18n (0.5.0)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
     mocha (0.9.12)
+    polyglot (0.3.1)
     rake (0.8.7)
     rcov (0.9.9)
     rspec (2.5.0)
@@ -19,6 +28,8 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.5.0)
     toadhopper (1.1)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
     yard (0.6.7)
 
 PLATFORMS
@@ -27,6 +38,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
+  mail
   mocha
   rcov
   rspec (~> 2.5.0)

data/README.rdoc

@@ -1,46 +1,17 @@
 = safely
 
-Safely is a simple exception handling and alerting mechanism extract from the daemon-kit[http://github.com/kennethkalmer/daemon-kit] project.
+Safely is a simple exception handling and alerting mechanism extract from the daemon-kit[https://github.com/kennethkalmer/daemon-kit] project.
 
-Safely currently supports error reporting to Hoptoad via the Toadhopper[http://github.com/toolmantim/toadhopper] gem. Future support will
-include reporting errors to log files and via email.
+Safely currently supports error reporting to Hoptoad, or via email.
 
-== Installation
+== Installation and Usage
 
-In your Gemfile
-
-    gem "toadhopper", "~> 1.1"
-    gem "safely", "~> 0.1"
-
-Or directly
-
-    gem install toadhopper -v "~> 1.1"
-    gem install safely -v "~> 0.1"
-
-Although Safely currently only supports Toadhopper, it doesn't specify it as a dependency. This allows for
-future strategies to be added and giving users the choice on which strategy to use without bloating their
-projects.
-
-== Usage
-
-    require 'toadhopper'
-    require 'safely'
-    
-    # Configure
-    Safely.configure do |c|
-      c.hoptoad_key = 'XXXXXXXX'
-    end
-    
-    # Run your code
-    safely do
-      do_something_dangerous!
-    end
+Please refer to the wiki[https://github.com/kennethkalmer/safely/wiki] for installation and usage information.
 
 == TODO
 
-* Support for mail exceptions
 * Support for logging exceptions
-* Fine-tine strategies
+* Fine-tune strategies
 * Support for trapping exceptions on exit
 
 == Contributing to safely

data/lib/safely/config.rb

@@ -1,6 +1,24 @@
 module Safely
   class Config
-    # Hoptoad API key
-    attr_accessor :hoptoad_key
+
+    # List of strategies to use
+    attr_reader :strategies
+
+    def initialize
+      @strategies = [
+        Safely::Strategy::Hoptoad,
+        Safely::Strategy::Mail
+      ]
+    end
+
+    def hoptoad_key
+      $stderr.write "DEPRECATED: Call Safely::Strategy::Hoptoad.hoptoad_key"
+      Safely::Strategy::Hoptoad.hoptoad_key
+    end
+
+    def hoptoad_key=( key )
+      $stderr.write "DEPRECATED: Call Safely::Strategy::Hoptoad.hoptoad_key="
+      Safely::Strategy::Hoptoad.hoptoad_key=( key )
+    end
   end
 end

data/lib/safely/strategy/hoptoad.rb

@@ -0,0 +1,28 @@
+module Safely
+  module Strategy
+    class Hoptoad
+
+      class << self
+
+        # Hoptoad API key to use for reporting errors
+        attr_accessor :hoptoad_key
+        
+        def load!
+          begin
+            require 'toadhopper'
+          rescue LoadError
+            $stderr.write( "'toadhopper' not available, safely cannot use the Hoptoad stategy" )
+          end
+        end
+
+        def report!( exception )
+          if defined?( Toadhopper ) && !self.hoptoad_key.nil?
+            Toadhopper( self.hoptoad_key ).post!( exception )
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/safely/strategy/mail.rb

@@ -0,0 +1,55 @@
+module Safely
+  module Strategy
+    class Mail
+
+      class << self
+
+        # Recipient of the exception mails
+        attr_accessor :recipient
+
+        # The sender
+        attr_accessor :sender
+
+        # Subject prefix
+        attr_accessor :subject_prefix
+
+        def load!
+          begin
+            require 'mail'
+          rescue LoadError
+            $stderr.write( "'mail' not available, safely cannot use the email stategy" )
+          end
+
+          if self.sender.nil?
+            require 'socket'
+            self.sender = "safely@#{Socket.gethostname}"
+          end
+
+          self.subject_prefix ||= "[SAFELY]"
+        end
+
+        def report!( exception )
+          return if self.sender.nil? || self.recipient.nil?
+
+          mail = ::Mail.new
+          mail.from = self.sender
+          mail.to   = self.recipient
+          mail.subject = "#{subject_prefix} - #{exception.message}"
+
+          mail.body = <<-EOF
+            Safely caught an unhandled exception in your application, details below:
+
+            Type: #{exception.class.name}
+            Message: #{exception.message}
+
+            Backtrace:
+            #{exception.backtrace.join("\n  ")}
+            EOF
+
+          mail.deliver
+        end
+
+      end
+    end
+  end
+end

data/lib/safely/strategy.rb

@@ -0,0 +1,6 @@
+module Safely
+  module Strategy
+    autoload :Hoptoad, 'safely/strategy/hoptoad'
+    autoload :Mail,    'safely/strategy/mail'
+  end
+end

data/lib/safely.rb

@@ -2,10 +2,11 @@ $:.unshift File.expand_path('../', __FILE__)
 
 module Safely
 
-  VERSION = "0.1.0pre"
+  VERSION = "0.1.0"
 
-  autoload :Config, 'safely/config'
-  autoload :Mixin,  'safely/mixin'
+  autoload :Config,   'safely/config'
+  autoload :Mixin,    'safely/mixin'
+  autoload :Strategy, 'safely/strategy'
 
   class << self
 
@@ -22,19 +23,13 @@ module Safely
     end
 
     def load_strategies!
-      begin
-        require 'toadhopper'
-      rescue LoadError
-        # Print warning
-      end
+      @config.strategies.each { |s| s.load! }
     end
 
     def report!( exception )
-      if defined?( Toadhopper ) && !config.hoptoad_key.nil?
-        Toadhopper( config.hoptoad_key ).post!( exception )
-      else
-        STDERR.puts "Toadhopper not available or not configured!"
-      end
+      load_strategies! if @config.nil?
+
+      @config.strategies.each { |s| s.report! exception }
     end
 
     private

data/spec/config_spec.rb

@@ -2,7 +2,6 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Safely::Config do
   describe "Hoptoad" do
-    it { should respond_to(:hoptoad_key) }
-    it { should respond_to(:hoptoad_key=) }
+    it { should respond_to(:strategies) }
   end
 end

data/spec/safely_spec.rb

@@ -27,15 +27,18 @@ describe Safely do
 
       defined?( Toadhopper ).should be_true
     end
+
+    it "should load Mail if present" do
+      Safely.load_strategies!
+
+      defined?( Mail ).should be_true
+    end
   end
 
   describe "usage" do
     it "should report exceptions to hoptoad" do
-      Safely.configure do |c|
-        c.hoptoad_key = "foo"
-      end
-
-      Toadhopper.any_instance.expects(:post!)
+      Safely::Strategy::Hoptoad.expects(:report!)
+      Safely::Strategy::Mail.expects(:report!)
 
       safely do
         raise "Hello"

data/spec/spec_helper.rb

@@ -7,6 +7,16 @@ require 'safely'
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
+require 'mail'
+Mail.defaults do
+  delivery_method :test
+end
+
+
 RSpec.configure do |config|
   config.mock_with(:mocha)
+
+  config.before(:each) do
+    Mail::TestMailer.deliveries.clear
+  end
 end

data/spec/strategies/hoptoad_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Safely::Strategy::Hoptoad do
+  it "should be configurable" do
+    Safely::Strategy::Hoptoad.should respond_to(:hoptoad_key)
+    Safely::Strategy::Hoptoad.should respond_to(:hoptoad_key=)
+  end
+
+  it "should report when configured" do
+    Safely::Strategy::Hoptoad.hoptoad_key = "foo"
+
+    Toadhopper.any_instance.expects(:post!)
+
+    safely do
+      raise "Argh"
+    end
+  end
+
+  it "should not bother when not configured" do
+    Safely::Strategy::Hoptoad.hoptoad_key = nil
+
+    Toadhopper.any_instance.expects(:post!).never
+
+    safely do
+      raise "Argh"
+    end
+  end
+end

data/spec/strategies/mail_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Safely::Strategy::Mail do
+  describe "configuration" do
+    %w( recipient sender subject_prefix ).each do |attr|
+      it "should support configuring #{attr}" do
+        Safely::Strategy::Mail.should respond_to( attr )
+        Safely::Strategy::Mail.should respond_to( "#{attr}=" )
+      end
+    end
+  end
+
+  describe "reporting" do
+    it "should be enabled when configured" do
+      Safely::Strategy::Mail.recipient = "kenneth.kalmer@gmail.com"
+
+      safely do
+        raise "Argh"
+      end
+
+      Mail::TestMailer.deliveries.should_not be_empty
+
+      mail = Mail::TestMailer.deliveries.last
+
+      mail.to_addrs.should include("kenneth.kalmer@gmail.com")
+      mail.body.should match(/Backtrace/)
+    end
+
+    it "should not bother if not configured" do
+      Safely::Strategy::Mail.recipient = nil
+
+      expect {
+        safely do
+          raise "Argh"
+        end
+      }.to_not change( Mail::TestMailer.deliveries, :length )
+    end
+  end
+end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: safely
 version: !ruby/object:Gem::Version 
-  prerelease: 5
-  version: 0.1.0pre
+  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kenneth Kalmer
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-14 00:00:00 Z
+date: 2011-05-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: toadhopper
@@ -24,8 +24,19 @@ dependencies:
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: mail
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,10 +44,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: yard
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -44,10 +55,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -55,10 +66,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -66,10 +77,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,10 +88,10 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: mocha
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -88,7 +99,7 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id007
+  version_requirements: *id008
 description: Safely run your code in a loving error reporting embrace
 email: kenneth.kalmer@gmail.com
 executables: []
@@ -101,6 +112,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .rspec
+- CHANGES
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -110,10 +122,15 @@ files:
 - lib/safely.rb
 - lib/safely/config.rb
 - lib/safely/mixin.rb
+- lib/safely/strategy.rb
+- lib/safely/strategy/hoptoad.rb
+- lib/safely/strategy/mail.rb
 - safely.gemspec
 - spec/config_spec.rb
 - spec/safely_spec.rb
 - spec/spec_helper.rb
+- spec/strategies/hoptoad_spec.rb
+- spec/strategies/mail_spec.rb
 homepage: http://github.com/kennethkalmer/safely
 licenses: 
 - MIT
@@ -127,16 +144,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1229273114892724216
+      hash: -2395968726711885681
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.1
+      version: "0"
 requirements: []
 
 rubyforge_project: 
@@ -148,3 +165,5 @@ test_files:
 - spec/config_spec.rb
 - spec/safely_spec.rb
 - spec/spec_helper.rb
+- spec/strategies/hoptoad_spec.rb
+- spec/strategies/mail_spec.rb