adhearsion-reporter 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55eccb6f3f9822e1bb2fcfb3bf543dba08da7d9f
-  data.tar.gz: 8f9a673465445f6bd37e65a694f54f298496d08c
+  metadata.gz: 2f64fe44bf22a4f443f8ea106405880fd6b8a072
+  data.tar.gz: a6066fc3c57366b8c92f043d108397bf34ce73a7
 SHA512:
-  metadata.gz: af79d4b1a6c6664347b609e24fef1cf88d10b36bec698cdc637a1ad248bab2485bd45a2ef3a01cfb5263c6da1ebde5466e423223842bf20c8fb9f688b3b13f3e
-  data.tar.gz: f69ff9fdfe2ba9265e42d95729ca8a9105b51380b9752bd876a93dc68196e99dd7855681da2aa9d3cb7c8c3b5628da0d8e8229ec8d78e3a876a0db7a1726a530
+  metadata.gz: 16cde73a7ca5a67970bd2beacc160b46155d2b54a4426bf0ff16c62fc8ce28de77cd7e590c4e82f1efcc6db1855a70d465efcc064edc2185aacca98521997da2
+  data.tar.gz: 4f0091592f7ede2c3000e312e3d6a59cdbc7ece490a9f55eabd449ca77264ba0c7e6c83147045a91ded58930d53d5c00564c4408a52e868379acc68c637bf909

data/CHANGELOG.md

@@ -1,4 +1,6 @@
 # develop
+  * New notifiers: EmailNotifier and SentryNotifier
+  * Allow configuring multiple notifiers as a list. The `notifier` option is deprecated in favour of `notifiers`, which can be used the same for a single notifier.
 
 # v2.1.0
   * Bugfix: record the correct environment with each notification

data/Guardfile

@@ -1,24 +1,9 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard :rspec do
+guard 'rspec', cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-
-  # Rails example
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-
-  # Capybara features specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
-
-  # Turnip features and steps
-  watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
 end
 

data/README.md

@@ -31,6 +31,21 @@ Adhearsion.config do |config|
 end
 ```
 
+Email Notifier
+--------------
+Email notification uses the [pony](https://github.com/benprew/pony) gem.
+The `email` configuration key is passed to Pony on initialization using `Pony.options`.
+
+To set the destination address and the sender address, for example, you can use:
+
+```ruby
+Adhearsion::Reporter.config.email = {
+  via: :sendmail,
+  to: 'recv@domain.ext',
+  from: 'send@domain.ext'
+}
+```
+
 Copyright
 ---------
 

data/adhearsion-reporter.gemspec

@@ -13,9 +13,10 @@ Gem::Specification.new do |s|
   s.description = <<EOF
 Report Adhearsion application exceptions and deployments to:
 
-Airbrake
-Errbit
-This Adhearsion plugin requires Adhearsion 2.0 or later. For Adhearsion 1.0 try the previous version of this gem ahn_hoptoad
+Airbrake / Errbit
+Email
+Newrelic
+Sentry
 EOF
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -25,6 +26,9 @@ EOF
   s.add_runtime_dependency "adhearsion", ["~> 2.0"]
   s.add_runtime_dependency "toadhopper", [">= 1.3.0"]
   s.add_runtime_dependency "newrelic_rpm", ["~> 3.6"]
+  s.add_runtime_dependency "pony", ["~> 1.10"]
+  s.add_runtime_dependency "sentry-raven", ["~> 0.15.0"]
 
   s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'timecop'
 end

data/lib/adhearsion/reporter.rb

@@ -5,6 +5,8 @@ require 'toadhopper'
 require 'adhearsion'
 require 'adhearsion/reporter/airbrake_notifier'
 require 'adhearsion/reporter/newrelic_notifier'
+require 'adhearsion/reporter/email_notifier'
+require 'adhearsion/reporter/sentry_notifier'
 
 module Adhearsion
   class Reporter
@@ -18,10 +20,14 @@ module Adhearsion
       config :reporter do
         api_key nil,                  desc: "The Airbrake/Errbit API key"
         url     "http://airbrake.io", desc: "Base URL for notification service"
+        app_name "Adhearsion", desc: "Application name, used for reporting"
         notifier Adhearsion::Reporter::AirbrakeNotifier,
-          desc: "The class that will act as the notifier. Built-in classes are Adhearsion::Reporter::AirbrakeNotifier and Adhearsion::Reporter::NewrelicNotifier",
+          desc: "The class that will act as the notifier. Built-in classes are Adhearsion::Reporter::AirbrakeNotifier, Adhearsion::Reporter::NewrelicNotifier, and Adhearsion::Reporter::SentryNotifier. This option is deprecated; please specify in `notifiers`.",
           transform: Proc.new { |v| const_get(v.to_s) }
-        enable true, desc: "Disables notifications. Useful for testing"
+        notifiers [],
+          desc: "Collection of classes that will act as notifiers",
+          transform: Proc.new { |v| v.split(',').map { |n| n.to_s.constantize } }
+        enable true, desc: "Whether to send notifications - set to false to disable all notifications globally (useful for testing)"
         excluded_environments [:development, :test], desc: "Skip reporting errors for the listed environments (comma delimited when set by environment variable", transform: Proc.new { |v| names = v.split(','); names = names.each.map &:to_sym }
         newrelic {
           license_key 'MYKEY', desc: "Your license key for New Relic"
@@ -30,12 +36,26 @@ module Adhearsion
           developer_mode false, desc: "More information but very high overhead in memory"
           log_level 'info', desc: "The newrelic's agent log level"
         }
+        email Hash.new(via: :sendmail), desc: "Used to configure the email notifier, with options accepted by the pony (https://github.com/benprew/pony) gem"
+        sentry {
+          dsn 'https://<user>:<password>@app.getsentry.com/<application>', desc: "The SENTRY_DSN, or client key that has been created in Sentry"
+          current_environment 'production', 'The current execution environment'
+          environments ['production'], 'The environments for which Sentry is active'
+        }
       end
 
       init :reporter do
-        Reporter.config.notifier.init
-        Events.register_callback(:exception) do |e, logger|
-          Reporter.config.notifier.instance.notify e
+        # If a collection of multiple notifiers is not set, fall back to the individual option for BC.
+        # TODO: Remove the `notifier` option in v3.0
+        if Reporter.config.notifiers.empty?
+          Reporter.config.notifiers = [Reporter.config.notifier]
+        end
+
+        Reporter.config.notifiers.each do |notifier|
+          notifier.init
+          Events.register_callback(:exception) do |e, logger|
+            notifier.notify e
+          end
         end
       end
     end

data/lib/adhearsion/reporter/email_notifier.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'pony'
+require 'socket'
+
+module Adhearsion
+  class Reporter
+    class EmailNotifier
+      include Singleton
+
+      def init
+        Pony.options = Adhearsion::Reporter.config.email
+      end
+
+      def notify(ex)
+        Pony.mail({
+          subject: email_subject(ex),
+          body: exception_text(ex),
+          from: hostname
+        })
+      end
+
+      def self.method_missing(m, *args, &block)
+        instance.send m, *args, &block
+      end
+
+    private
+      def email_subject(exception)
+        "[#{Adhearsion::Reporter.config.app_name}-#{environment}] Exception: #{exception.class} (#{exception.message})"
+      end
+
+      def exception_text(exception)
+        backtrace = exception.backtrace || ["EMPTY BACKTRACE"]
+        "#{Adhearsion::Reporter.config.app_name} reported an exception at #{Time.now.to_s}" +
+        "\n\n#{exception.class} (#{exception.message}):\n" +
+        backtrace.join("\n") +
+        "\n\n"
+      end
+
+      def environment
+        Adhearsion.config.platform.environment.to_s.upcase
+      end
+
+      def hostname
+        Socket.gethostname
+      end
+    end
+  end
+end

data/lib/adhearsion/reporter/sentry_notifier.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'raven'
+
+module Adhearsion
+  class Reporter
+    class SentryNotifier
+      include Singleton
+
+      def init
+        Raven.configure do |config|
+          Reporter.config.sentry.each do |k,v|
+            config.send("#{k}=", v) unless v.nil?
+          end
+        end
+      end
+
+      def notify(ex)
+        Raven.capture_exception(ex)
+      rescue Exception => e
+        logger.error "Error posting exception to Sentry"
+        logger.warn "Original exception message: #{e.message}"
+        raise
+      end
+
+      def self.method_missing(m, *args, &block)
+        instance.send m, *args, &block
+      end
+
+    end
+  end
+end

data/lib/adhearsion/reporter/version.rb

@@ -1,5 +1,5 @@
 module Adhearsion
   class Reporter
-    VERSION = '2.1.0'
+    VERSION = '2.2.0'
   end
 end

data/spec/reporter_spec.rb

@@ -4,6 +4,11 @@ describe Adhearsion::Reporter do
   EventClass = Class.new
   ExceptionClass = Class.new StandardError
 
+  before do
+    Adhearsion::Reporter.config.notifier = nil
+    Adhearsion::Reporter.config.notifiers = []
+  end
+
   context "with a DummyNotifier" do
     class DummyNotifier
       include Singleton
@@ -28,12 +33,12 @@ describe Adhearsion::Reporter do
     end
 
     it "calls init on the notifier instance" do
-      Adhearsion::Reporter.config.notifier.instance.initialized.should == true
+      expect(Adhearsion::Reporter.config.notifier.instance.initialized).to be(true)
     end
 
     it "logs an exception event" do
       sleep 0.25
-      Adhearsion::Reporter.config.notifier.instance.notified.class.should == ExceptionClass
+      expect(Adhearsion::Reporter.config.notifier.instance.notified.class).to eq(ExceptionClass)
     end
   end
 
@@ -43,16 +48,16 @@ describe Adhearsion::Reporter do
     end
 
     it "should initialize correctly" do
-      Toadhopper.should_receive(:new).with(Adhearsion::Reporter.config.api_key, notify_host: Adhearsion::Reporter.config.url)
+      expect(Toadhopper).to receive(:new).with(Adhearsion::Reporter.config.api_key, notify_host: Adhearsion::Reporter.config.url)
       Adhearsion::Plugin.init_plugins
     end
 
     context "exceptions" do
       let(:mock_notifier) { double 'notifier' }
       let(:event_error)   { ExceptionClass.new }
-      let(:response)      { double('response').as_null_object }
+      let(:response)      { double('response', status: '200').as_null_object }
 
-      before { Toadhopper.should_receive(:new).at_least(:once).and_return(mock_notifier) }
+      before { expect(Toadhopper).to receive(:new).at_least(:once).and_return(mock_notifier) }
 
       after do
         Adhearsion::Plugin.init_plugins
@@ -60,14 +65,14 @@ describe Adhearsion::Reporter do
       end
 
       it "should notify Airbrake" do
-        mock_notifier.should_receive(:post!).at_least(:once).with(event_error, hash_including(framework_env: :production)).and_return(response)
+        expect(mock_notifier).to receive(:post!).at_least(:once).with(event_error, hash_including(framework_env: :production)).and_return(response)
       end
 
       context "with an environment set" do
         before { Adhearsion.config.platform.environment = :foo }
 
         it "notifies airbrake with that environment" do
-          mock_notifier.should_receive(:post!).at_least(:once).with(event_error, hash_including(framework_env: :foo)).and_return(response)
+          expect(mock_notifier).to receive(:post!).at_least(:once).with(event_error, hash_including(framework_env: :foo)).and_return(response)
         end
       end
 
@@ -77,7 +82,7 @@ describe Adhearsion::Reporter do
           Adhearsion::Plugin.init_plugins
         end
         it "should not report errors for excluded environments" do
-          mock_notifier.should_not_receive(:post!)
+          expect(mock_notifier).to_not receive(:post!)
         end
       end
     end
@@ -89,18 +94,148 @@ describe Adhearsion::Reporter do
     end
 
     it "should initialize correctly" do
-      NewRelic::Agent.should_receive(:manual_start).with(Adhearsion::Reporter.config.newrelic.to_hash)
+      expect(NewRelic::Agent).to receive(:manual_start).with(Adhearsion::Reporter.config.newrelic.to_hash)
       Adhearsion::Plugin.init_plugins
     end
 
     it "should notify Newrelic" do
-      NewRelic::Agent.should_receive(:manual_start)
+      expect(NewRelic::Agent).to receive(:manual_start)
 
       event_error = ExceptionClass.new
-      NewRelic::Agent.should_receive(:notice_error).at_least(:once).with(event_error)
+      expect(NewRelic::Agent).to receive(:notice_error).at_least(:once).with(event_error)
 
       Adhearsion::Plugin.init_plugins
       Adhearsion::Events.trigger_immediately :exception, event_error
     end
   end
+
+  context 'with an EmailNotifier' do
+    let(:email_options) do
+      {
+        via: :sendmail,
+        to: 'recv@domain.ext'
+      }
+    end
+
+    let(:time_freeze) { Time.parse("2014-07-24 17:30:00") }
+
+    let(:fake_backtrace) do
+      [
+        '1: foo',
+        '2: bar'
+      ]
+    end
+
+    let(:error_message) { "Something bad" }
+
+    before(:each) do
+      Adhearsion::Reporter.config.notifier = Adhearsion::Reporter::EmailNotifier
+      Adhearsion::Reporter.config.email = email_options
+    end
+
+    it "should initialize correctly" do
+      Adhearsion::Plugin.init_plugins
+      expect(Pony.options).to be(email_options)
+    end
+
+    it "should notify via email" do
+
+      event_error = ExceptionClass.new error_message
+      event_error.set_backtrace(fake_backtrace)
+
+      hostname = Socket.gethostname
+      environment = Adhearsion.config.platform.environment.to_s.upcase
+
+      Timecop.freeze(time_freeze) do
+        expect(Pony).to receive(:mail).at_least(:once).with({
+          subject: "[#{Adhearsion::Reporter.config.app_name}-#{environment}] Exception: ExceptionClass (#{error_message})",
+          body: "#{Adhearsion::Reporter.config.app_name} reported an exception at #{time_freeze.to_s}\n\nExceptionClass (#{error_message}):\n#{event_error.backtrace.join("\n")}\n\n",
+          from: hostname
+        })
+
+        Adhearsion::Plugin.init_plugins
+        Adhearsion::Events.trigger_immediately :exception, event_error
+      end
+    end
+  end
+
+  context "with a SentryNotifier" do
+    let(:sentry_options) do
+      {
+        "dsn" => 'https://123abc:def456@app.getsentry.com/98765',
+        "environments" => ['production', 'staging'],
+        "current_environment" => 'production'
+      }
+    end
+
+    before(:each) do
+      Adhearsion::Reporter.config.notifier = Adhearsion::Reporter::SentryNotifier
+      Adhearsion::Reporter.config.sentry = sentry_options
+    end
+
+    it "should initialize correctly" do
+      Adhearsion::Plugin.init_plugins
+
+      config = Raven.configuration
+      sentry_options.each do |k, v|
+        if k == "dsn"   #There is no getter for this attribute, so we have to get it through it components
+          expect("#{config.scheme}://#{config.public_key}:#{config.secret_key}@#{config.host}/#{config.path}#{config.project_id}").to eq v
+        else
+          expect(Raven.configuration.send("#{k}")).to eq v
+        end
+      end
+    end
+
+    it "should notify Sentry" do
+      expect(Raven).to receive(:configure)
+      event_error = ExceptionClass.new
+      expect(Raven).to receive(:capture_exception).at_least(:once).with(event_error)
+
+      Adhearsion::Plugin.init_plugins
+      Adhearsion::Events.trigger_immediately :exception, event_error
+    end
+  end
+
+  context "with multiple notifiers" do
+
+    class BaseNotifier
+      include Singleton
+
+      attr_reader :initialized, :notified
+
+      def init
+        @initialized = true
+      end
+
+      def notify(ex)
+        @notified = ex
+      end
+
+      def self.method_missing(m, *args, &block)
+        instance.send m, *args, &block
+      end
+    end
+
+    class MockNotifier < BaseNotifier; end
+    class AnotherMockNotifier < BaseNotifier; end
+
+    before(:each) do
+      Adhearsion::Events.clear_handlers(:exception)
+      Adhearsion::Reporter::config.notifiers = [MockNotifier, AnotherMockNotifier]
+      Adhearsion::Plugin.init_plugins
+      Adhearsion::Events.trigger_immediately :exception, ExceptionClass.new
+    end
+
+    it "calls init on each of the notifier instances" do
+      Adhearsion::Reporter::config.notifiers.each do |notifier|
+        expect(notifier.instance.initialized).to be(true)
+      end
+    end
+
+    it "logs an exception in each of the registered notifiers" do
+      Adhearsion::Reporter::config.notifiers.each do |notifier|
+        expect(notifier.instance.notified.class).to eq(ExceptionClass)
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 require 'adhearsion'
 require 'adhearsion/reporter'
 require 'socket'
+require 'timecop'
 
 ENV['AHN_ENV'] = 'production'
 
 RSpec.configure do |config|
-  config.color_enabled = true
   config.tty = true
 
   config.filter_run :focus => true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion-reporter
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Ben Klang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adhearsion
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,12 +94,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: |
   Report Adhearsion application exceptions and deployments to:
 
-  Airbrake
-  Errbit
-  This Adhearsion plugin requires Adhearsion 2.0 or later. For Adhearsion 1.0 try the previous version of this gem ahn_hoptoad
+  Airbrake / Errbit
+  Email
+  Newrelic
+  Sentry
 email:
 - bklang@mojolingo.com
 executables: []
@@ -91,7 +134,9 @@ files:
 - lib/adhearsion-reporter.rb
 - lib/adhearsion/reporter.rb
 - lib/adhearsion/reporter/airbrake_notifier.rb
+- lib/adhearsion/reporter/email_notifier.rb
 - lib/adhearsion/reporter/newrelic_notifier.rb
+- lib/adhearsion/reporter/sentry_notifier.rb
 - lib/adhearsion/reporter/version.rb
 - spec/reporter_spec.rb
 - spec/spec_helper.rb
@@ -114,11 +159,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Report Adhearsion application deployments and exceptions
 test_files:
 - spec/reporter_spec.rb
 - spec/spec_helper.rb
-has_rdoc: