logger_facade 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d784e71c70884c488dd4ef8ae10ccff6a683be1
-  data.tar.gz: 3bd33d57268557c45be71199770893c458a68a97
+  metadata.gz: 0180ea9d2371adfb7dc9745b2b5c550fada71357
+  data.tar.gz: 9969640e45a3c0f9f1be24f52834c9c5f1a37b83
 SHA512:
-  metadata.gz: ce943da29d63815307c019927f4d6e1c67347398f9406c2a0fd816fa8d711f265bf637a7b557c9523659aea9d6b86d4fd6d894405fcc78523384daae614ce4da
-  data.tar.gz: b1968c2095b653bb77b20938b0080f54176ab7da012b8b86dd745318470efafa36c43916cfba21de10c795426858a101b08ba75fcb829246bfdcd55ad84acbd4
+  metadata.gz: 20a421d2ff5f652551b050047652034c374974eca980c68787815f4910acefb7d79032d033353ab64e1dbadeb80612e044c259fdb4da0a3c879fae971df7f8cc
+  data.tar.gz: f15e7d566a1b471521260c54d4555a1a82ff6b48d9cbfce7c6aceee9112ed7e30ccae0e5921911a8963d32aa452365d6dbe6ef18ac31b0c6c04ba8afeaa5c51a

data/Gemfile.lock

@@ -1,13 +1,21 @@
 PATH
   remote: .
   specs:
-    logger_facade (0.1.0)
+    logger_facade (0.2.0)
+      airbrake (~> 4.0)
       hashie (~> 3.2)
+      sucker_punch (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    airbrake (4.0.0)
+      builder
+      multi_json
+    builder (3.2.2)
     bump (0.5.0)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
     codeclimate-test-reporter (0.3.0)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
@@ -39,6 +47,9 @@ GEM
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
     slop (3.6.0)
+    sucker_punch (1.1)
+      celluloid (~> 0.15.2)
+    timers (1.1.0)
 
 PLATFORMS
   ruby

data/lib/logger_facade/plugins.rb

@@ -1 +1,2 @@
 require_relative 'plugins/console'
+require_relative 'plugins/airbrake'

data/lib/logger_facade/plugins/airbrake.rb

@@ -0,0 +1,86 @@
+require 'airbrake'
+
+module LoggerFacade::Plugins
+
+  class Airbrake
+
+    attr_reader :name, :environment
+
+    def initialize(environment = nil)
+      @name = "LoggerFacade::Plugins::Airbrake"
+      @environment = environment.to_s
+
+      ::Airbrake.configure do |config|
+        config.host    = nil
+        config.port    = 80
+        config.secure  = config.port == 443
+        config.async   = true
+        config.development_environments = %w(development test)
+      end
+    end
+
+    def configure(&block)
+      ::Airbrake.configure do |config|
+        yield config
+      end
+    end
+
+    def is_debug
+      false
+    end
+
+    def trace(logger, message)
+      # do nothing
+    end
+
+    def debug(logger, message)
+      # do nothing
+    end
+
+    def info(logger, message)
+      # do nothing
+    end
+
+    def warn(logger, message)
+      # do nothing
+    end
+
+    def error(logger, message)
+      return unless valid_config
+
+      if message.is_a? Exception
+        notify_exception(message, logger)
+      else
+        notify_error_log(message, logger)
+      end
+    end
+
+    private
+
+    def valid_config
+      config = ::Airbrake.configuration
+      config.api_key && config.host
+    end
+
+    def notify_error_log(message, logger)
+      ::Airbrake.notify_or_ignore(
+        :error_class      => "#{logger}::LogError",
+        :error_message    => "#{logger}::LogError: #{message}",
+        :backtrace        => $@,
+        :cgi_data         => ENV.to_hash,
+        :environment_name => environment
+      )
+    end
+
+    def notify_exception(e, logger)
+      ::Airbrake.notify_or_ignore(
+        e,
+        :backtrace        => $@,
+        :cgi_data         => ENV.to_hash,
+        :environment_name => environment
+      )
+    end
+
+  end
+
+end

data/lib/logger_facade/version.rb

@@ -1,3 +1,3 @@
 module LoggerFacade
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/logger_facade.gemspec

@@ -31,4 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bump', '~> 0.5'
 
   spec.add_dependency 'hashie', '~> 3.2'
+  spec.add_dependency 'airbrake', '~> 4.0'
+  # sucker punch is used to use airbrake async
+  spec.add_dependency 'sucker_punch', '~> 1.1'
 end

data/spec/unit/plugins/airbrake_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe LoggerFacade::Plugins::Airbrake do
+
+  subject { described_class.new(:test) }
+
+  before :each do
+
+    subject.configure do |c|
+      c.host = "host.test"
+      c.api_key = "key.test"
+    end
+
+  end
+
+  describe('#is_debug') do
+
+    it('returns false') do
+      expect(subject.is_debug).to be false
+    end
+
+  end
+
+  describe('#configure') do
+
+    it('overrides Airbrake configurations') do
+
+      subject.configure do |config|
+        config.api_key = "key"
+      end
+
+      expect(::Airbrake.configuration.api_key).to eq("key")
+    end
+
+  end
+
+  %w(trace debug info warn).each do |level|
+
+    context("logging in #{level} level") do
+
+      it("doesn't notify") do
+        message = "call with message"
+        expect(::Airbrake).not_to receive(:notify_or_ignore)
+        subject.send(level.to_sym, "name", message)
+      end
+
+    end
+
+  end
+
+  context("logging in error level") do
+
+    context('with message') do
+
+      it("notify") do
+        message = "call with message"
+        expect(::Airbrake).to receive(:notify_or_ignore)
+           .with(hash_including(
+             :error_class     => "NAME::LogError",
+             :error_message   => "NAME::LogError: #{message}",
+             :backtrace       => anything,
+             :cgi_data        => anything,
+             :environment_name=> "test"
+           )) { nil }
+        subject.error("NAME", message)
+      end
+    end
+
+    context('with exception') do
+
+      it("notify") do
+        e = Exception.new 'test notify'
+        expect(::Airbrake).to receive(:notify_or_ignore)
+           .with(e, hash_including(
+             :backtrace       => anything,
+             :cgi_data        => anything,
+             :environment_name=> "test"
+           )) { nil }
+        subject.error("NAME", e)
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logger_facade
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pedro Januário
@@ -122,6 +122,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: |-
   Simple class library to work as logger facade.
                           This simple logger facade allows you to hook plugins to execute logging.
@@ -145,6 +173,7 @@ files:
 - lib/logger_facade/loggable.rb
 - lib/logger_facade/manager.rb
 - lib/logger_facade/plugins.rb
+- lib/logger_facade/plugins/airbrake.rb
 - lib/logger_facade/plugins/console.rb
 - lib/logger_facade/version.rb
 - logger_facade.gemspec
@@ -152,6 +181,7 @@ files:
 - spec/unit/log_spec.rb
 - spec/unit/loggable_spec.rb
 - spec/unit/manager_spec.rb
+- spec/unit/plugins/airbrake_spec.rb
 - spec/unit/plugins/console_spec.rb
 homepage: https://github.com/pjanuario/logger-facade-ruby
 licenses:
@@ -184,4 +214,5 @@ test_files:
 - spec/unit/log_spec.rb
 - spec/unit/loggable_spec.rb
 - spec/unit/manager_spec.rb
+- spec/unit/plugins/airbrake_spec.rb
 - spec/unit/plugins/console_spec.rb