trouble 0.0.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 Bukowskis
+
+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,24 @@
+# Trouble
+
+A unified wrapper to report errors and Exceptions.
+
+This gem achieves independence of things like Bugsnag, Airbrake, etc.. If any of those is defined, Trouble will pass on the exception to them. Additionaly, everything is written to a custom logger you specify (defaults to `Rails.logger`).
+
+Currently only Bugsnag is defined as a working backend.
+
+# Usage
+
+#### Syntax
+
+```ruby
+Trouble.notify EXCEPTION, [METADATA-HASH]
+````
+
+#### Examples 
+
+```ruby
+exception = RuntimeError.new
+
+Trouble.notify exception
+Trouble.notify exception, some_idea_why_it_happened: "I don't know, but try this and that."
+```

data/lib/trouble/configuration.rb

@@ -0,0 +1,43 @@
+require 'logger'
+
+module Trouble
+  class Configuration
+    attr_accessor :logger
+
+    def initialize(options={})
+      @logger = options[:logger] || default_logger
+    end
+
+    private
+
+    def default_logger
+      if defined?(Rails)
+        Rails.logger
+      else
+        Logger.new(STDOUT)
+      end
+    end
+
+  end
+end
+
+module Trouble
+
+  # Public: Returns the the configuration instance.
+  #
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  # Public: Yields the configuration instance.
+  #
+  def self.configure(&block)
+    yield config
+  end
+
+  # Public: Reset the configuration (useful for testing)
+  #
+  def self.reset!
+    @config = nil
+  end
+end

data/lib/trouble/version.rb

@@ -0,0 +1,9 @@
+module Trouble
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 6
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
+end

data/lib/trouble.rb

@@ -0,0 +1,43 @@
+require 'trouble/configuration'
+
+# A generic wrapper to report errors and Exceptions.
+#
+module Trouble
+
+  # Public: Notify the developers about an Exception
+  #
+  # exception - An instance of an Exception
+  # metadata - An Hash with arbitrary additional information (optional)
+  #
+  # Examples
+  #
+  #   Trouble.notify RuntimeError.new
+  #   Trouble.notify RuntimeError.new, some_idea_why_it_happened: "I don't know, but try this and that."
+  #
+  # Returns nothing.
+  #
+  def self.notify(exception, metadata = nil)
+    exception.set_backtrace(caller) unless exception.backtrace
+    notify! exception, metadata
+  end
+
+  private
+
+  # Internal: Dispatch the Exception to the backend(s).
+  #
+  def self.notify!(exception, metadata)
+    log(exception, metadata)            if config.logger
+    Bugsnag.notify(exception, metadata) if defined?(Bugsnag)
+  end
+
+  # Internal: Log to the current Logger.
+  #
+  def self.log(exception, metadata)
+    rows = ['TROUBLE NOTIFICATION']
+    rows << "   | Exception: #{exception.inspect}"
+    rows << "   | Metadata:  #{metadata.inspect}"
+    rows << "   \\ Location:  #{exception.backtrace.first}\n"
+    config.logger.error rows.join("\n")
+  end
+
+end

data/spec/lib/trouble_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+TroubleTestException = Class.new(RuntimeError)
+
+describe Trouble do
+
+  let(:exception) { TroubleTestException.new('big problems') }
+  let(:metadata)  { { details: 'mean bug'} }
+  let(:logger)    { mock(:logger) }
+
+  let(:trouble)   { Trouble }
+
+  describe '.notify' do
+    it 'does not cause any Exceptions if there is no Backend' do
+      trouble.notify(exception, metadata)
+    end
+
+    context 'with a Logger' do
+      before do
+        trouble.config.logger = mock(:logger)
+      end
+
+      it 'logs the output' do
+        trouble.config.logger .should_receive(:error) do |string|
+          string.should include('TROUBLE')
+          string.should include('TroubleTestException')
+          string.should include('big problems')
+          string.should include('mean bug')
+          string.should include('trouble_spec.rb')
+        end
+        trouble.notify exception, metadata
+      end
+    end
+
+    context 'with Bugsnag' do
+      before do
+        ensure_module :Bugsnag
+        Bugsnag.stub!(:notify)
+      end
+
+      describe '.notify' do
+        it 'uses Bugsnag as notification backend' do
+          Bugsnag.should_receive(:notify).with(exception, metadata)
+          trouble.notify exception, metadata
+        end
+      end
+    end
+  end
+
+  describe '.logger' do
+    before do
+      Trouble.reset!
+    end
+
+    it 'is an STDOUT logger' do
+      Logger.should_receive(:new).with(STDOUT).and_return logger
+      trouble.config.logger.should be logger
+    end
+
+    context 'with Rails' do
+      before do
+        ensure_module :Rails
+        Rails.stub!(:logger).and_return(logger)
+      end
+
+      it 'is the Rails logger' do
+        trouble.config.logger.should be Rails.logger
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'logger'
+require 'trouble'
+
+def ensure_class_or_module(full_name, class_or_module)
+  full_name.to_s.split(/::/).inject(Object) do |context, name|
+    begin
+      context.const_get(name)
+    rescue NameError
+      if class_or_module == :class
+        context.const_set(name, Class.new)
+      else
+        context.const_set(name, Module.new)
+      end
+    end
+  end
+end
+
+def ensure_module(name)
+  ensure_class_or_module(name, :module)
+end
+
+def ensure_class(name)
+  ensure_class_or_module(name, :class)
+end
+
+RSpec.configure do |config|
+  config.before do
+    Trouble.config.logger = nil
+  end
+
+  config.after do
+    Trouble.reset!
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: trouble
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- bukowskis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem achieves independence of things like Bugsnag, Airbrake, etc..
+  If any of those is defined, Trouble will pass on the exception to them.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/trouble/configuration.rb
+- lib/trouble/version.rb
+- lib/trouble.rb
+- spec/lib/trouble_spec.rb
+- spec/spec_helper.rb
+- README.md
+- LICENSE
+homepage: https://github.com/bukowskis/trouble
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --encoding
+- UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A generic abstraction layer for reporting errors and Exceptions.
+test_files: []