logging-appenders-airbrake 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e929ba30042809af24030e50fced5b64859fc26b
+  data.tar.gz: 94880fe8ac8fed00c0cffd06b9a46a7c111afe35
+SHA512:
+  metadata.gz: eb14162f105a6cfaaa72388662bf2050b95773c0cd66ae1f4ac4545b37d5cd3272269e7655f401566edca5212f9246a3da07855d128fffb617b289d53f5cfcc6
+  data.tar.gz: 81da15b60be0f1909fbf6e745d9b8070ae672c54be98c74e89a4baa81373caeb4e3d42183cce95c6c66ff85a5be3c4c6facc5df5d765ac92e164ceb3b19379b7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,59 @@
+# Logging::Appenders::Airbrake
+
+Airbrake appender for [the logging gem](https://github.com/TwP/logging).
+
+## Overview
+
+    require "logging"
+    require "logging/appenders/airbrake"
+
+	log = Logging.logger[self]
+	log.add_appenders(
+	  Logging.appenders.airbrake(:api_key => "123XYZ", :ignore => %w[SomeThang AnotherThang])
+    )
+
+    # Or
+
+    Airbrake.configure do |cfg|
+      # ...
+    end
+
+	log.add_appenders(Logging.appenders.airbrake)
+	
+	log.info  "Not sent to airbrake"
+	log.error "Airbrake here I come!"
+	log.error SomeError.new("See you @ airbrake.io!")	
+
+## Description
+
+Only events with the `:error` log level are sent to Airbrake. Errors are not sent asynchronously,
+though this can be changed via `Airbrake.configure`.
+
+By default the appender  will be named `"airbrake"`. This can be changed by passing a name
+to the `airbrake` method:
+
+    Logging.appenders.airbrake("another_name", options)
+
+Airbrake configuration can be done via `Airbrake.configure` or via `Logging.appenders.airbrake`. 
+All Airbrake options can be passed to the latter.
+
+## Using With `logging-rails`
+
+If you're already using Airbrake then your current Airbrake initializer will be used.
+If not you can either create one or specify your options in `config/logging.rb`.
+
+In `config/logging.rb`:
+
+	Logging.appenders.airbrake if config.log_to.include?("airbrake")
+
+In `config/environments/xxx.rb`, where `xxx` corresponds to the desired `Rails.env`:
+
+	config.log_to = %w[airbrake]  # or %w[airbrake file email] # etc...
+
+## Author
+
+Skye Shaw [sshaw AT gmail.com]
+
+## License
+
+Released under the MIT License: www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => "test"
+Rake::TestTask.new
+

data/lib/logging/appenders/airbrake.rb

@@ -0,0 +1,63 @@
+require "airbrake"
+require "logging/appender"
+
+module Logging::Appenders
+  def self.airbrake(*args)
+    if args.empty?
+      return self["airbrake"] || Logging::Appenders::Airbrake.new
+    end
+
+    Logging::Appenders::Airbrake.new(*args)
+  end
+
+  class Airbrake < Logging::Appender
+    FILTER = lambda do |line|
+      line =~ %r{/logging-[^/]+/lib/logging/} ? nil : line
+    end
+
+    attr :options
+
+    def initialize(*args)
+      args.compact!
+
+      name = args.first.is_a?(String) ? args.shift : "airbrake"
+      super(name, :level => :error)
+
+      cfg = ::Airbrake.configuration
+      cfg.framework = "Logging #{Logging.version}"
+
+      @options = args.shift || {}
+      @options[:backtrace_filters] ||= []
+      @options[:backtrace_filters] << FILTER
+
+      @options.each do |k,v|
+        unless ::Airbrake::Configuration::OPTIONS.include?(k)
+          raise ArgumentError, "unknown Airbrake configuration option #{k}"
+        end
+
+        # Airbrake array attributes have no setter
+        if cfg[k].is_a?(Array)
+          cfg[k].concat(Array(v))
+        else
+          cfg.method("#{k}=")[v]
+        end
+      end
+    end
+
+    private
+
+    def write(event)
+      if ::Airbrake.configuration.configured?
+        # Docs say event can be a String too, not sure when/how but we'll check anyways
+        error = event.is_a?(Logging::LogEvent) ? event.data : event
+        error = { :error_message => error } if error.is_a?(String)
+
+        ::Airbrake.notify_or_ignore(error)
+      else
+        # TODO: better to just set Airbrake's logger to something so it can log this?
+        Logging.log_internal { 'Not logging #{event.inspect}: Airbrake is not configured' }
+      end
+      self
+    end
+  end
+end

data/logging-appenders-airbrake.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "logging-appenders-airbrake"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+  spec.summary       = %q{Airbrake appender for the logging gem}
+  spec.description   = %q{An appender for the logging gem that will send all messages logged at the :error level to Airbrake}
+  spec.homepage      = "https://github.com/sshaw/logging-appenders-airbrake"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "airbrake"
+  spec.add_dependency "logging"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/test/test_airbrake.rb

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+require "minitest/autorun"
+require "minitest/mock"
+
+require "logging"
+require "logging/appenders/airbrake"
+
+class TestAirbrake < MiniTest::Unit::TestCase
+  def test_configuration_without_appender_name
+    app = appender(config)
+
+    refute_nil Logging.logger["airbrake"]
+    assert_same app, Logging.appenders.airbrake
+
+    assert_equal config[:api_key], Airbrake.configuration.api_key
+    assert_equal config[:host], Airbrake.configuration.host
+    config[:ignore].each do |name|
+      assert_includes Airbrake.configuration.ignore, name
+    end
+  end
+
+  def test_configuration_with_appender_name
+    app = appender("sshaw", config)
+
+    refute_nil Logging.logger["sshaw"]
+    refute_same app, Logging.appenders.airbrake
+
+    assert_equal config[:api_key], Airbrake.configuration.api_key
+    assert_equal config[:host], Airbrake.configuration.host
+    config[:ignore].each do |name|
+      assert_includes Airbrake.configuration.ignore, name
+    end
+  end
+
+  def test_invalid_configuration
+    assert_raises(ArgumentError, /unknown/) { appender(:ass => "bass") }
+  end
+
+  def test_only_error_level_logged
+    count = 0
+    app = appender
+    app.define_singleton_method(:write) { |e| count += 1 }
+
+    log = Logging.logger[self]
+    log.add_appenders(app)
+
+    log.info("Hi")
+    log.error("Hello hello!")
+    log.error("¡Hola!")
+    log.debug("Oizinho")
+    log.warn("Perigo")
+
+    assert_equal 2, count
+  end
+
+  private
+  def config
+    @config ||= {
+      :api_key => "X123",
+      :host    => "example.com",
+      :ignore  => %w[A B]
+    }
+  end
+
+  def appender(*args)
+    args << { :api_key => "X123" } unless args.last.is_a?(Hash)
+    Logging.appenders.airbrake(*args)
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: logging-appenders-airbrake
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: An appender for the logging gem that will send all messages logged at
+  the :error level to Airbrake
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/logging/appenders/airbrake.rb
+- logging-appenders-airbrake.gemspec
+- test/test_airbrake.rb
+homepage: https://github.com/sshaw/logging-appenders-airbrake
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Airbrake appender for the logging gem
+test_files:
+- test/test_airbrake.rb