err 0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62dbf0caf18619f5a9f80231f4d0c48a8fb6964b
-  data.tar.gz: cc174ecb465d805cd2deacb21fbeeaa855fc15cd
+  metadata.gz: 07affa7e7938f1ac3388a2bf05a7aa62de6ccc78
+  data.tar.gz: c3197404a39f79fcb7a3bf617bc7336f41074193
 SHA512:
-  metadata.gz: 6d85540f9a0a34c400f5a8c50a458481df5cad6535bb11256c14f9268b5c98ffcc0ad61c8e5df19a317c8b564c5910c7188e8bfd2bc9e815af8c108e152b90f0
-  data.tar.gz: 730a2866846457427d0878608a2c056639cf47aa3c5c47f50b784e402788ffed60f72a45d8a40ca79e4bde57e069d943590f08c4b425fff6ccb62b5db4a824d7
+  metadata.gz: d562d4917ee2b3d23feb9c395bff1143a33acc25308be38979f3e043ff8d124dcaf029700dca1cf7e06aa18459eb0870189ce11ce0ea9c153eeb01d38230a12f
+  data.tar.gz: 1666098f7ac9ae2dd0cfe9ede947fc3e18fc60e2b4141a5bf60c03a6e68b239c31de5e2ccd0b70020a00e4ae2d1e36706c4fc2f24b48c9b3c0ca1219ea2b850c

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Version 0.0.1
+
+* Initial release

data/README.md

@@ -1,6 +1,12 @@
 # Err
 
-TODO: Write a gem description
+Err helps you try out and use different error notification gems without the hassle of individual setup.
+It adds a simple API that you can use to set up all your notification gems in one place.
+
+Err works with or without Rails.
+
+**Supported services:** [Airbrake](https://github.com/airbrake/airbrake), [Honeybadger](https://github.com/honeybadger-io/honeybadger-ruby) and [Opbeat](https://github.com/opbeat/opbeat_ruby).
+If you use a service that isn't listed here, please [add it](#contributing) so others can use it too. Thanks :heart:
 
 ## Installation
 
@@ -12,18 +18,91 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
+
+To use a service, just add its Ruby gem to your *Gemfile* and set it up as shown below.
 
-    $ gem install err
+Example configuration, in an initializer, e.g. *config/initializers/err.rb*:
 
-## Usage
+```ruby
+Err.configure do |config|
+  # Set up shared configuration
+  config.environments = %w{ staging production }
+  config.ignore << "Some::Exception"
+
+  # Set up Airbrake
+  config.airbrake do |config|
+    config.api_key = 'some key'
+  end
+
+  # Set up Honeybadger
+  config.honeybadger do |config|
+    config.api_key = 'some key'
+  end
+
+  # Set up Opbeat
+  config.opbeat do |config|
+    config.organization_id = 'some organization id'
+    config.app_id = 'some app id'
+    config.secret_token = 'some secret token'
+  end
+end
+```
+
+If you prefer to have the individual services set up in different initializers, you can do the following:
+
+```ruby
+Err.configure :airbrake do |config|
+  config.api_key = 'some key'
+end
+```
+
+If you don't use Rails, you can do this anywhere in your application setup, as long as the service gems are loaded in advance.
+
+To remove a service, just remove its Ruby gem from the *Gemfile*. You can leave the config if you wish, so you can use it at a later time. It won't get called if the service's Ruby gem isn't available.
 
-TODO: Write usage instructions here
+## Defaults
+
+Err sets up some defaults that makes it easy to try out new services without the common setup.
+
+#### Ignored exceptions by default
+
+#### Default notification environments
+
+## Manually tracking exceptions
+
+The various error notification gems will track errors automatically. In addition, Err adds a simple API for tracking exceptions and messages manually.
+
+#### Sending an exception
+
+The following will send an exception to all available services:
+
+```ruby
+begin
+  # Some failing code
+rescue => e
+  Err.notify e, some_param: "Some value"
+end
+```
+
+#### Sending a message
+
+You can send a message manually that isn't an actual exception to all services:
+
+```ruby
+Err.message "Something went wrong", this_is: "A param"
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/err/fork )
+You are very welcome to add new error notification services so others can use them too.
+See the [existing services](https://github.com/lassebunk/err/tree/master/lib/err/services) to see how this is done.
+
+1. Fork the project
 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 a new Pull Request
+3. Make your changes
+4. Add tests so others don't break it unintentionally
+5. Run tests (`rake`)
+6. Commit your changes (`git commit -am 'Add feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create a new pull request

data/Rakefile

@@ -1,2 +1,17 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task :console do
+  require "irb"
+  require "err"
+  ARGV.clear
+  IRB.start
+end
+
+task :default => :test

data/err.gemspec

@@ -20,8 +20,11 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "bundler", "~> 1.6"
   s.add_development_dependency "rake"
+  s.add_development_dependency "mocha", "~> 1.1"
+  s.add_development_dependency "minitest"
 
   # Services
   s.add_development_dependency "airbrake"
+  s.add_development_dependency "honeybadger"
   s.add_development_dependency "opbeat"
 end

data/lib/err/configuration.rb

@@ -0,0 +1,38 @@
+module Err
+  module Configuration
+    DEFAULT_DEVELOPMENT_ENVIRONMENTS = %w{ development test cucumber }
+    DEFAULT_IGNORE = %w{
+      ActiveRecord::RecordNotFound,
+      ActionController::RoutingError,
+      ActionController::InvalidAuthenticityToken,
+      CGI::Session::CookieStore::TamperedWithCookie,
+      ActionController::UnknownHttpMethod,
+      ActionController::UnknownAction,
+      AbstractController::ActionNotFound,
+      Mongoid::Errors::DocumentNotFound,
+      ActionController::UnknownFormat
+    }
+
+    class << self
+      def development_environments
+        @development_environments ||= DEFAULT_DEVELOPMENT_ENVIRONMENTS.dup
+      end
+
+      attr_writer :development_environments
+
+      def ignore
+        @ignore ||= DEFAULT_IGNORE.dup
+      end
+
+      attr_writer :ignore
+
+      def method_missing(method, *args, &block)
+        if service = Err.find_service_by_key(method)
+          service.configure(&block) if service.enabled?
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/err/services/airbrake.rb

@@ -1,24 +1,40 @@
 module Err
   class Airbrake < Service
     class << self
-      def enabled?
+      def available?
         defined?(::Airbrake)
       end
 
-      def environments=(envs)
-        Airbrake.development_environments -= envs.map(&:to_s)
+      def configure(&block)
+        return unless enabled?
+        airbrake.configure(&block)
       end
 
-      def ignored=(exception_names)
-        Airbrake.ignore << *exception_names
+      def development_environments=(envs)
+        config.development_environments = envs.map(&:to_s)
       end
 
-      def notify(exception)
-        Airbrake.notify(exception)
+      def ignore=(exception_names)
+        config.ignore.clear
+        config.ignore.concat exception_names
       end
 
-      def message(msg)
-        Airbrake.notify(message)
+      def notify(exception, params = {})
+        airbrake.notify_or_ignore(exception, parameters: params)
+      end
+
+      def message(msg, params = {})
+        airbrake.notify(msg, parameters: params)
+      end
+
+      private
+
+      def airbrake
+        ::Airbrake
+      end
+
+      def config
+        airbrake.configuration
       end
     end
   end

data/lib/err/services/honeybadger.rb

@@ -0,0 +1,41 @@
+module Err
+  class Honeybadger < Service
+    class << self
+      def available?
+        defined?(::Honeybadger)
+      end
+
+      def configure(&block)
+        return unless enabled?
+        honeybadger.configure(&block)
+      end
+
+      def development_environments=(envs)
+        config.development_environments = envs.map(&:to_s)
+      end
+
+      def ignore=(exception_names)
+        config.ignore.clear
+        config.ignore.concat exception_names
+      end
+
+      def notify(exception, params = {})
+        honeybadger.notify_or_ignore(exception, parameters: params)
+      end
+
+      def message(msg, params = {})
+        honeybadger.notify(msg, parameters: params)
+      end
+
+      private
+
+      def honeybadger
+        ::Honeybadger
+      end
+
+      def config
+        honeybadger.configuration
+      end
+    end
+  end
+end

data/lib/err/services/opbeat.rb

@@ -0,0 +1,46 @@
+module Err
+  class Opbeat < Service
+    class << self
+      def available?
+        defined?(::Opbeat)
+      end
+
+      def configure(&block)
+        return unless enabled?
+        opbeat.configure(&block)
+      end
+
+      def development_environments=(envs)
+        config.environments = [config.current_environment] - envs.map(&:to_s)
+      end
+
+      def ignore=(exception_names)
+        config.excluded_exceptions = exception_names
+      end
+
+      def notify(exception, params = {})
+        opbeat.captureException(exception)
+      end
+
+      def message(msg, params = {})
+        msg = msg.dup
+        msg << " (#{params_string(params)})" if params.any?
+        opbeat.captureMessage(msg)
+      end
+
+      private
+
+      def params_string(params)
+        params.map { |k, v| "#{k}: #{v}" }.join(", ")
+      end
+
+      def opbeat
+        ::Opbeat
+      end
+
+      def config
+        opbeat.configuration
+      end
+    end
+  end
+end

data/lib/err/services/service.rb

@@ -0,0 +1,37 @@
+module Err
+  class Service
+    class << self
+      def key
+        @key ||= name.split("::").last.gsub(/^./, &:downcase).gsub(/[A-Z]/) { |s| "_#{s.downcase}" }
+      end
+
+      def available?
+        raise NotImplementedError
+      end
+
+      def enabled?
+        available?
+      end
+
+      def configure(&block)
+        raise NotImplementedError
+      end
+
+      def development_environments=(envs)
+        raise NotImplementedError
+      end
+
+      def ignore=(exception_names)
+        raise NotImplementedError
+      end
+
+      def notify(exception, params = {})
+        raise NotImplementedError
+      end
+
+      def message(msg, params = {})
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/err/services.rb

@@ -0,0 +1,3 @@
+require "err/services/service"
+
+Dir["#{File.dirname(__FILE__)}/services/*.rb"].each { |f| require f }

data/lib/err/version.rb

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

data/lib/err.rb

@@ -1,16 +1,58 @@
 %w{
   version
-  service
+  configuration
+  services
 }.each { |f| require "err/#{f}" }
 
 module Err
   class << self
+    def configure(service_key = nil, &block)
+      if service_key
+        service = find_service_by_key(service_key)
+        raise "Service #{service_key.inspect} not found" unless service
+        service.configure(&block) if service.enabled?
+      else
+        yield config
+      end
+      setup!
+    end
+
+    def notify(exception, params = {})
+      call_each_service :notify, exception, params
+    end
+
+    def message(msg, params = {})
+      call_each_service :message, msg, params
+    end
+
     def setup!
-      return if @set_up
-      @set_up = true
+      [:development_environments, :ignore].each do |method|
+        call_each_service "#{method}=", config.send(method)
+      end
     end
 
     def services
+      @services ||= ObjectSpace.each_object(Class).select { |klass| klass < Err::Service }
+    end
+
+    def enabled_services
+      services.select(&:enabled?)
+    end
+
+    def find_service_by_key(key)
+      services.find { |s| s.key == key.to_s }
+    end
+
+    private
+
+    def config
+      Configuration
+    end
+
+    def call_each_service(method, *args)
+      enabled_services.each do |s|
+        s.send method, *args
+      end
     end
   end
 end

data/test/err_test.rb

@@ -0,0 +1,4 @@
+require "test_helper"
+
+class ErrTest < Minitest::Test
+end

data/test/services/airbrake_test.rb

@@ -0,0 +1,56 @@
+require "test_helper"
+
+class AirbrakeTest < Minitest::Test
+  def test_key
+    assert_equal "airbrake", Err::Airbrake.key
+  end
+
+  def test_enabled
+    assert Err::Airbrake.enabled?
+  end
+
+  def test_configure
+    Err.configure do |config|
+      config.airbrake do |config|
+        config.api_key = "123"
+      end
+    end
+    assert_equal "123", Airbrake.configuration.api_key
+  end
+
+  def test_configure_separate
+    Err.configure :airbrake do |config|
+      config.api_key = "456"
+    end
+    assert_equal "456", Airbrake.configuration.api_key
+  end
+
+  def test_configure_development_environments
+    Err.configure do |config|
+      config.development_environments = %w{development staging}
+    end
+    assert Airbrake.configuration.development_environments.include?("staging")
+  end
+
+  def test_configure_ignore
+    Err.configure do |config|
+      config.ignore = %w{
+        ActiveRecord::RecordNotFound
+        ActionController::RoutingError
+      }
+    end
+
+    assert_equal %w{ ActiveRecord::RecordNotFound ActionController::RoutingError },
+                 Airbrake.configuration.ignore
+  end
+
+  def test_notify
+    Airbrake.expects(:notify_or_ignore).once
+    Err::Airbrake.notify RuntimeError.new
+  end
+
+  def test_message
+    Airbrake.expects(:notify).once
+    Err::Airbrake.message "This is a test", one: "First", two: "Second"
+  end
+end

data/test/services/honeybadger_test.rb

@@ -0,0 +1,56 @@
+require "test_helper"
+
+class HoneybadgerTest < Minitest::Test
+  def test_key
+    assert_equal "honeybadger", Err::Honeybadger.key
+  end
+
+  def test_enabled
+    assert Err::Honeybadger.enabled?
+  end
+
+  def test_configure
+    Err.configure do |config|
+      config.honeybadger do |config|
+        config.api_key = "123"
+      end
+    end
+    assert_equal "123", Honeybadger.configuration.api_key
+  end
+
+  def test_configure_separate
+    Err.configure :honeybadger do |config|
+      config.api_key = "456"
+    end
+    assert_equal "456", Honeybadger.configuration.api_key
+  end
+
+  def test_configure_development_environments
+    Err.configure do |config|
+      config.development_environments = %w{development staging}
+    end
+    assert Honeybadger.configuration.development_environments.include?("staging")
+  end
+
+  def test_configure_ignore
+    Err.configure do |config|
+      config.ignore = %w{
+        ActiveRecord::RecordNotFound
+        ActionController::RoutingError
+      }
+    end
+
+    assert_equal %w{ ActiveRecord::RecordNotFound ActionController::RoutingError },
+                 Honeybadger.configuration.ignore
+  end
+
+  def test_notify
+    Honeybadger.expects(:notify_or_ignore).once
+    Err::Honeybadger.notify RuntimeError.new
+  end
+
+  def test_message
+    Honeybadger.expects(:notify).once
+    Err::Honeybadger.message "This is a test", one: "First", two: "Second"
+  end
+end

data/test/services/opbeat_test.rb

@@ -0,0 +1,56 @@
+require "test_helper"
+
+class OpbeatTest < Minitest::Test
+  def test_key
+    assert_equal "opbeat", Err::Opbeat.key
+  end
+
+  def test_enabled
+    assert Err::Opbeat.enabled?
+  end
+
+  def test_configure
+    Err.configure do |config|
+      config.opbeat do |config|
+        config.organization_id = "123"
+      end
+    end
+    assert_equal "123", Opbeat.configuration.organization_id
+  end
+
+  def test_configure_separate
+    Err.configure :opbeat do |config|
+      config.organization_id = "456"
+    end
+    assert_equal "456", Opbeat.configuration.organization_id
+  end
+
+  def test_configure_development_environments
+    Err.configure do |config|
+      config.development_environments = %w{development production}
+    end
+    assert !Opbeat.configuration.environments.include?("production")
+  end
+
+  def test_configure_ignore
+    Err.configure do |config|
+      config.ignore = %w{
+        ActiveRecord::RecordNotFound
+        ActionController::RoutingError
+      }
+    end
+
+    assert_equal %w{ ActiveRecord::RecordNotFound ActionController::RoutingError },
+                 Opbeat.configuration.excluded_exceptions
+  end
+
+  def test_notify
+    Opbeat.expects(:captureException).once
+    Err::Opbeat.notify RuntimeError.new
+  end
+
+  def test_message
+    Opbeat.expects(:captureMessage).once
+    Err::Opbeat.message "This is a test", one: "First", two: "Second"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require "minitest/autorun"
+require "mocha/test_unit"
+
+require "err"
+
+%w{
+  airbrake
+  honeybadger
+  opbeat
+}.each do |service|
+  require service
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: err
 version: !ruby/object:Gem::Version
-  version: '0'
+  version: 0.0.1
 platform: ruby
 authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-02 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: airbrake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - ">="
       - !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'
 - !ruby/object:Gem::Dependency
   name: opbeat
   requirement: !ruby/object:Gem::Requirement
@@ -75,15 +117,26 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - err.gemspec
 - lib/err.rb
-- lib/err/service.rb
+- lib/err/configuration.rb
+- lib/err/services.rb
 - lib/err/services/airbrake.rb
+- lib/err/services/honeybadger.rb
+- lib/err/services/opbeat.rb
+- lib/err/services/service.rb
 - lib/err/version.rb
+- test/err_test.rb
+- test/services/airbrake_test.rb
+- test/services/honeybadger_test.rb
+- test/services/opbeat_test.rb
+- test/test_helper.rb
 homepage: https://github.com/lassebunk/err
 licenses:
 - MIT
@@ -108,4 +161,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Switch out error notification apps like MultiJSON.
-test_files: []
+test_files:
+- test/err_test.rb
+- test/services/airbrake_test.rb
+- test/services/honeybadger_test.rb
+- test/services/opbeat_test.rb
+- test/test_helper.rb

data/lib/err/service.rb

@@ -1,25 +0,0 @@
-module Err
-  class Service
-    class << self
-      def enabled?
-        raise NotImplementedError
-      end
-
-      def environments=(envs)
-        raise NotImplementedError
-      end
-
-      def ignored=(exception_names)
-        raise NotImplementedError
-      end
-
-      def notify(exception)
-        raise NotImplementedError
-      end
-
-      def message(msg)
-        raise NotImplementedError
-      end
-    end
-  end
-end