exceptions 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be972ecb6d34a925191b4337f17c8542296937e9
+  data.tar.gz: fec33cc75f361d78e1db22cb27a73638db79fcb5
+SHA512:
+  metadata.gz: 53626569e8487494a85b87544fcbac4b4ecf6437f08514e8552eb9a8bdefc828b8fd673748dcc0207d54124b0aea2b64ae8bc7e73c7d1369a40718f5d5e7f1eb
+  data.tar.gz: 23b957be7f746255410972b339453209c3caba0bf1f9db807443597c6034696421941a6bca834c2615819e140dc3242b7c2eb03c9943281ffbc70c206c6e3165

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exceptions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric J. Holmes
+
+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,40 @@
+# Exceptions
+
+Exceptions is a Ruby gem that provides the right amount of abstraction for doing exception
+tracking in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exceptions'
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install exceptions
+```
+
+## Usage
+
+**Track an exception**
+
+```ruby
+Exceptions.notify(StandardError.new("Boom"))
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/exceptions.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exceptions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exceptions"
+  spec.version       = Exceptions::VERSION
+  spec.authors       = ["Eric J. Holmes"]
+  spec.email         = ["eric@ejholmes.net"]
+  spec.description   = %q{Exceptions is a Ruby gem for exception tracking.}
+  spec.summary       = %q{Exceptions is a Ruby gem for exception tracking.}
+  spec.homepage      = "https://github.com/remind101/exceptions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "honeybadger"
+end

data/lib/exceptions.rb

@@ -0,0 +1,53 @@
+require 'exceptions/version'
+require 'exceptions/configuration'
+require 'exceptions/result'
+require 'exceptions/backend'
+require 'exceptions/backends'
+
+module Exceptions
+  class << self
+    # Public: Forwards the exception to the configured backend.
+    #
+    # exception - An Exception object.
+    # options   - A Hash of options to pass to the backend.
+    #
+    # Returns a Result object.
+    def notify(exception, options = {})
+      backend.notify exception, options
+    end
+
+    # Public: Set the context.
+    #
+    # Returns nothing.
+    def context(ctx)
+      backend.context ctx
+    end
+
+    # Public: Clear the context.
+    #
+    # Returns nothing.
+    def clear_context
+      backend.clear_context
+    end
+
+    # Public: The configuration object.
+    #
+    # Returns a Configuration instance.
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Public: Configure the configuration.
+    #
+    # Yields the Configuration object.
+    def configure
+      yield configuration
+    end
+
+    private
+
+    def backend
+      configuration.backend
+    end
+  end
+end

data/lib/exceptions/backend.rb

@@ -0,0 +1,34 @@
+module Exceptions
+  # Public: Backend is an abstract class that documents the interface
+  # for an exception tracking backend.
+  class Backend
+    # Public: Notify should be implemented by classes that inherit from Backend to
+    # do something with the exception. Implementers of this interface can optionally
+    # return a Result object which can include things like an exception id from
+    # an external service.
+    #
+    # exception - An Exception object.
+    # options   - A Hash of options.
+    #
+    # Returns nil or a Result object.
+    def notify(exception)
+      raise NotImplementedError
+    end
+
+    # Public: Context can be used to set global context.
+    #
+    # ctx - A Hash of contextual information.
+    #
+    # Returns nothing.
+    def context(ctx)
+      raise NotImplementedError
+    end
+
+    # Public: Clear should clear the context.
+    #
+    # Returns nothing.
+    def clear_context
+      raise NotImplementedError
+    end
+  end
+end

data/lib/exceptions/backends.rb

@@ -0,0 +1,9 @@
+module Exceptions
+  module Backends
+    autoload :Null,        'exceptions/backends/null'
+    autoload :Raiser,      'exceptions/backends/raiser'
+    autoload :Multi,       'exceptions/backends/multi'
+    autoload :Logger,      'exceptions/backends/logger'
+    autoload :Honeybadger, 'exceptions/backends/honeybadger'
+  end
+end

data/lib/exceptions/backends/honeybadger.rb

@@ -0,0 +1,31 @@
+require 'honeybadger'
+
+module Exceptions
+  module Backends
+    # Public: The Honeybadger backend is a Backend implementation that sends the 
+    # exception to Honeybadger.
+    class Honeybadger < Backend
+      def notify(exception, options = {})
+        if id = ::Honeybadger.notify_or_ignore(exception, options)
+          Result.new id
+        else
+          BadResult.new
+        end
+      end
+
+      def context(ctx)
+        ::Honeybadger.context ctx
+      end
+
+      def clear_context
+        ::Honeybadger.clear!
+      end
+
+      class Result < ::Exceptions::Result
+        def url
+          "https://www.honeybadger.io/notice/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/exceptions/backends/logger.rb

@@ -0,0 +1,17 @@
+module Exceptions
+  module Backends
+    # Public: Logger is an implementation of the Backend interface that logs exceptions
+    # to STDOUT.
+    class Logger < Backend
+      attr_accessor :logger
+
+      def initialize(logger = ::Logger.new(STDOUT))
+        @logger = logger
+      end
+
+      def notify(exception, options = {})
+        logger.info exception
+      end
+    end
+  end
+end

data/lib/exceptions/backends/multi.rb

@@ -0,0 +1,19 @@
+module Exceptions
+  module Backends
+    # Public: Multi is an implementation of the Backend interface for wrapping multiple
+    # backends as a single Backend.
+    class Multi < Backend
+      attr_reader :backends
+
+      def initialize(*backends)
+        @backends = backends
+      end
+
+      def notify(exception, options = {})
+        backends.each do |backend|
+          backend.notify exception, options
+        end
+      end
+    end
+  end
+end

data/lib/exceptions/backends/null.rb

@@ -0,0 +1,8 @@
+module Exceptions
+  module Backends
+    # Public: Null is an implementation of the Backend interface that does nothing.
+    class Null < Backend
+      def notify(exception, options = {}); end
+    end
+  end
+end

data/lib/exceptions/backends/raiser.rb

@@ -0,0 +1,10 @@
+module Exceptions
+  module Backends
+    # Public: Raiser is an implementation of the Backend interface that raises the exception.
+    class Raiser < Backend
+      def notify(exception, options = {})
+        raise exception
+      end
+    end
+  end
+end

data/lib/exceptions/configuration.rb

@@ -0,0 +1,10 @@
+module Exceptions
+  class Configuration
+    # The exception tracking backend to use.
+    attr_accessor :backend
+
+    def backend
+      @backend ||= Backends::Honeybadger.new
+    end
+  end
+end

data/lib/exceptions/result.rb

@@ -0,0 +1,26 @@
+module Exceptions
+  # Public: Result represents a result of an Exception notification. It can be used
+  # to return information about the exception.
+  class Result
+    attr_reader :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    def url
+      raise NotImplementedError
+    end
+
+    def ok?
+      true
+    end
+  end
+
+  # Public: BadResult can be returned when there's a failure.
+  class BadResult
+    def ok?
+      false
+    end
+  end
+end

data/lib/exceptions/version.rb

@@ -0,0 +1,3 @@
+module Exceptions
+  VERSION = "0.0.1"
+end

data/spec/exceptions/backends/honeybadger/integration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Exceptions::Backends::Honeybadger, backend: :honeybadger do
+  before do
+    Exceptions.clear_context
+  end
+
+  describe '#notify' do
+    it 'sends the exception to honeybadger' do
+      Exceptions.context(request_id: '1234')
+      result = Exceptions.notify(boom)
+      expect(result.id).to_not be_empty
+      expect(result.url).to_not be_empty
+    end
+  end
+
+  describe '#context' do
+    it 'sets the honeybadger context' do
+      expect {
+        Exceptions.context(request_id: '1234')
+      }.to change { Thread.current[:honeybadger_context] }.from(nil).to(request_id: '1234')
+    end
+  end
+end

data/spec/exceptions/backends/logger/integration_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Exceptions::Backends::Logger, backend: :logger do
+  describe '.notify' do
+    it 'logs the exception to stdout' do
+      Exceptions.notify(boom)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+require 'bundler/setup'
+Bundler.require :default, :test
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.around(:each) do |example|
+    if backend = example.metadata[:backend]
+      with_backend(BACKENDS[backend]) do
+        example.run
+      end
+    end
+  end
+end
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}
+
+BACKENDS = {
+  honeybadger: Exceptions::Backends::Honeybadger.new,
+  multi:       Exceptions::Backends::Multi.new(Exceptions::Backends::Null.new),
+  logger:      Exceptions::Backends::Logger.new
+}
+
+Exceptions.configure do |config|
+  config.backend = BACKENDS[:multi]
+end
+
+def with_backend(backend)
+  old = Exceptions.configuration.backend
+  Exceptions.configuration.backend = backend
+  yield
+ensure
+  Exceptions.configuration.backend = old
+end
+
+def backend
+  Exceptions.configuration.backend
+end
+
+def boom
+  StandardError.new("Boom")
+end

data/spec/support/honeybadger.rb

@@ -0,0 +1,6 @@
+require 'honeybadger'
+
+Honeybadger.configure do |config|
+  config.api_key = ENV.fetch('HONEYBADGER_API_KEY')
+  config.environment_name = 'testing'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: exceptions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric J. Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: honeybadger
+  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: Exceptions is a Ruby gem for exception tracking.
+email:
+- eric@ejholmes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exceptions.gemspec
+- lib/exceptions.rb
+- lib/exceptions/backend.rb
+- lib/exceptions/backends.rb
+- lib/exceptions/backends/honeybadger.rb
+- lib/exceptions/backends/logger.rb
+- lib/exceptions/backends/multi.rb
+- lib/exceptions/backends/null.rb
+- lib/exceptions/backends/raiser.rb
+- lib/exceptions/configuration.rb
+- lib/exceptions/result.rb
+- lib/exceptions/version.rb
+- spec/exceptions/backends/honeybadger/integration_spec.rb
+- spec/exceptions/backends/logger/integration_spec.rb
+- spec/spec_helper.rb
+- spec/support/honeybadger.rb
+homepage: https://github.com/remind101/exceptions
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Exceptions is a Ruby gem for exception tracking.
+test_files:
+- spec/exceptions/backends/honeybadger/integration_spec.rb
+- spec/exceptions/backends/logger/integration_spec.rb
+- spec/spec_helper.rb
+- spec/support/honeybadger.rb