adhearsion-reporter 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17f5c0367eeb44fbd42e9bbcdf159cca503a9098
-  data.tar.gz: 5b00b2a43441bad7ce6b740936762dd91dd63249
+  metadata.gz: 55eccb6f3f9822e1bb2fcfb3bf543dba08da7d9f
+  data.tar.gz: 8f9a673465445f6bd37e65a694f54f298496d08c
 SHA512:
-  metadata.gz: 03f27058cbf2a58674d511ce938bf4d11b5f178650d8bce00d9e8ca1cc74de3695305d2f0ceaa615b91395d9496909768a7c6ae927f53bc0d827a139d642d5cd
-  data.tar.gz: 02fdfcd86a300414090036727f3c412bad3c47b150a24760fdbc571f17c59d640de14bf9ee889253f593e8c44d21c83468eda447faf2394f9c45910e08acfb92
+  metadata.gz: af79d4b1a6c6664347b609e24fef1cf88d10b36bec698cdc637a1ad248bab2485bd45a2ef3a01cfb5263c6da1ebde5466e423223842bf20c8fb9f688b3b13f3e
+  data.tar.gz: f69ff9fdfe2ba9265e42d95729ca8a9105b51380b9752bd876a93dc68196e99dd7855681da2aa9d3cb7c8c3b5628da0d8e8229ec8d78e3a876a0db7a1726a530

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--colour
+--tty

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: 1.9.2
+    - rvm: ruby-head
+    - rvm: rbx-19mode
+notifications:
+  irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # develop
 
+# v2.1.0
+  * Bugfix: record the correct environment with each notification
+  * Feature: include a little more metadata with each notification
+  * Feature: ignore notification from configurable list of environments (default: development and test)
+  * Feature: include hostname and Adhearsion version in environment portion of report
+
 # v2.0.1
   * Bugfix: Adhearsion may pass a logger object with exception events
 

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :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' }
+end
+

data/Rakefile

@@ -1,2 +1,7 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/adhearsion-reporter.gemspec

@@ -4,7 +4,7 @@ require "adhearsion/reporter/version"
 
 Gem::Specification.new do |s|
   s.name        = "adhearsion-reporter"
-  s.version     = Adhearsion::REPORTER_VERSION
+  s.version     = Adhearsion::Reporter::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ben Klang"]
   s.email       = %w{bklang@mojolingo.com}
@@ -24,4 +24,7 @@ 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_development_dependency 'guard-rspec'
 end

data/lib/adhearsion/reporter.rb

@@ -1,24 +1,41 @@
 # encoding: utf-8
+
 require 'toadhopper'
 
+require 'adhearsion'
+require 'adhearsion/reporter/airbrake_notifier'
+require 'adhearsion/reporter/newrelic_notifier'
+
 module Adhearsion
-  class Reporter < Plugin
-    config :reporter do
-      api_key nil,                  :desc => "The Airbrake/Errbit API key"
-      url     "http://airbrake.io", :desc => "Base URL for notification service"
+  class Reporter
+    class << self
+      def config
+        Plugin.config
+      end
     end
 
-    init :reporter do
-      config = Adhearsion.config[:reporter]
-      notifier = Toadhopper.new config.api_key, :notify_host => config.url
-      Events.register_callback(:exception) do |e, logger|
-        response = notifier.post!(e)
-        if !response.errors.empty? || !(200..299).include?(response.status.to_i)
-          logger.error "Error posting exception to #{config.url}! Response code #{response.status}"
-          response.errors.each do |error|
-            logger.error "#{error}"
-          end
-          logger.warn "Original exception message: #{e.message}"
+    class Plugin < Adhearsion::Plugin
+      config :reporter do
+        api_key nil,                  desc: "The Airbrake/Errbit API key"
+        url     "http://airbrake.io", desc: "Base URL for notification service"
+        notifier Adhearsion::Reporter::AirbrakeNotifier,
+          desc: "The class that will act as the notifier. Built-in classes are Adhearsion::Reporter::AirbrakeNotifier and Adhearsion::Reporter::NewrelicNotifier",
+          transform: Proc.new { |v| const_get(v.to_s) }
+        enable true, desc: "Disables notifications. 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"
+          app_name "My Application", desc: "The name of your application as you'd like it show up in New Relic"
+          monitor_mode false, desc: "Whether the agent collects performance data about your application"
+          developer_mode false, desc: "More information but very high overhead in memory"
+          log_level 'info', desc: "The newrelic's agent log level"
+        }
+      end
+
+      init :reporter do
+        Reporter.config.notifier.init
+        Events.register_callback(:exception) do |e, logger|
+          Reporter.config.notifier.instance.notify e
         end
       end
     end

data/lib/adhearsion/reporter/airbrake_notifier.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'toadhopper'
+require 'socket'
+require 'adhearsion/reporter/version'
+
+module Adhearsion
+  class Reporter
+    class AirbrakeNotifier
+      include Singleton
+
+      def init
+        @notifier = Toadhopper.new Reporter.config.api_key, :notify_host => Reporter.config.url
+        @options = {
+          framework_env: Adhearsion.config.platform.environment,
+          notifier_name: 'adhearsion-reporter',
+          notifier_version: Adhearsion::Reporter::VERSION,
+          project_root: Adhearsion.config.platform[:root],
+          environment: {
+            'HOSTNAME' => Socket.gethostname,
+            'AHN_VERSION' => Adhearsion::VERSION
+          }
+        }
+      end
+
+      def notify(ex)
+        return unless should_post?
+        response = @notifier.post!(ex, @options)
+        if !response.errors.empty? || !(200..299).include?(response.status.to_i)
+          logger.error "Error posting exception to #{Reporter.config.url}! Response code #{response.status}"
+          response.errors.each do |error|
+            logger.error "#{error}"
+          end
+          logger.warn "Original exception message: #{ex.message}"
+        end
+      end
+
+      def self.method_missing(m, *args, &block)
+        instance.send m, *args, &block
+      end
+
+    private
+      def should_post?
+        Reporter.config.enable &&
+          !Reporter.config.excluded_environments.include?(@options[:framework_env])
+      end
+    end
+  end
+end

data/lib/adhearsion/reporter/newrelic_notifier.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'new_relic/control'
+
+module Adhearsion
+  class Reporter
+    class NewrelicNotifier
+      include Singleton
+
+      def init
+        NewRelic::Agent.manual_start(Adhearsion::Reporter.config.newrelic.to_hash)
+      end
+
+      def notify(ex)
+        NewRelic::Agent.notice_error(ex)
+      rescue Exception => e
+        logger.error "Error posting exception to Newrelic"
+        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,3 +1,5 @@
 module Adhearsion
-  REPORTER_VERSION = '2.0.1'
+  class Reporter
+    VERSION = '2.1.0'
+  end
 end

data/spec/reporter_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Adhearsion::Reporter do
+  EventClass = Class.new
+  ExceptionClass = Class.new StandardError
+
+  context "with a DummyNotifier" do
+    class DummyNotifier
+      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
+
+    before(:each) do
+      Adhearsion::Reporter.config.notifier = DummyNotifier
+      Adhearsion::Plugin.init_plugins
+      Adhearsion::Events.trigger_immediately :exception, ExceptionClass.new
+    end
+
+    it "calls init on the notifier instance" do
+      Adhearsion::Reporter.config.notifier.instance.initialized.should == true
+    end
+
+    it "logs an exception event" do
+      sleep 0.25
+      Adhearsion::Reporter.config.notifier.instance.notified.class.should == ExceptionClass
+    end
+  end
+
+  context "with a AirbrakeNotifier" do
+    before(:each) do
+      Adhearsion::Reporter.config.notifier = Adhearsion::Reporter::AirbrakeNotifier
+    end
+
+    it "should initialize correctly" do
+      Toadhopper.should_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 }
+
+      before { Toadhopper.should_receive(:new).at_least(:once).and_return(mock_notifier) }
+
+      after do
+        Adhearsion::Plugin.init_plugins
+        Adhearsion::Events.trigger_immediately :exception, event_error
+      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)
+      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)
+        end
+      end
+
+      context "in excluded environments" do
+        before do
+          Adhearsion.config.platform.environment = :development
+          Adhearsion::Plugin.init_plugins
+        end
+        it "should not report errors for excluded environments" do
+          mock_notifier.should_not_receive(:post!)
+        end
+      end
+    end
+  end
+
+  context "with a NewrelicNotifier" do
+    before(:each) do
+      Adhearsion::Reporter.config.notifier = Adhearsion::Reporter::NewrelicNotifier
+    end
+
+    it "should initialize correctly" do
+      NewRelic::Agent.should_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)
+
+      event_error = ExceptionClass.new
+      NewRelic::Agent.should_receive(:notice_error).at_least(:once).with(event_error)
+
+      Adhearsion::Plugin.init_plugins
+      Adhearsion::Events.trigger_immediately :exception, event_error
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -1,43 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: adhearsion-reporter
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Ben Klang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2014-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adhearsion
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: toadhopper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: guard-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'
 description: |
   Report Adhearsion application exceptions and deployments to:
 
@@ -50,16 +78,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - adhearsion-reporter.gemspec
 - lib/adhearsion-reporter.rb
 - lib/adhearsion/reporter.rb
+- lib/adhearsion/reporter/airbrake_notifier.rb
+- lib/adhearsion/reporter/newrelic_notifier.rb
 - lib/adhearsion/reporter/version.rb
+- spec/reporter_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/adhearsion/adhearsion-reporter
 licenses: []
 metadata: {}
@@ -69,18 +104,21 @@ 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.0
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Report Adhearsion application deployments and exceptions
-test_files: []
+test_files:
+- spec/reporter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: