axial_notifier 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.md

@@ -0,0 +1,35 @@
+# axial_notifier
+
+Send exception notifications to the axially.net service.
+
+# Usage
+
+## Installation
+
+`config.gem axial_notifier` in Rails
+
+OR
+
+`gem axial_notifier` with Bundler
+
+## Configure
+
+We use the syslog service already running on your system. We will configure it to send messages
+from the local7 facility. Edit /etc/syslog.conf (or your system's syslog configuration) adding:
+
+`local7.*						@axially.net:5140`
+
+In your environment configure your api\_key:
+
+<pre><code>
+  AxialNotifier.configure do |config|
+    config.api_key = 'abcdefg12345'
+    config.environment = 'production'
+  end
+</code></pre>
+
+If you do not set the environment you would like, we default to 'development'.
+
+# Copyright
+
+Copyright (c) 2009 [Tony Pitale](mailto:tony.pitale@viget.com) released under the MIT license

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "axial_notifier"
+    gem.summary = %Q{Send Rails exception to the Axial Service via Syslog}
+    gem.description = %Q{Send Rails exception to the Axial Service via Syslog}
+    gem.email = "tpitale@gmail.com"
+    gem.homepage = "http://github.com/tpitale/axial_notifier"
+    gem.authors = ["tpitale"]
+    gem.add_dependency "json", ">= 1.2.0"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "jferris-mocha", ">= 0.9.7"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "axial_notifier #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/axial_notifier.rb

@@ -0,0 +1,26 @@
+require 'syslog'
+require 'json'
+require 'axial_notifier/sender'
+require 'axial_notifier/catcher'
+require 'axial_notifier/configuration'
+
+module AxialNotifier
+  extend self
+
+  attr_accessor :configuration, :sender
+
+  def configure
+    yield(self.configuration ||= Configuration.new)
+  end
+
+  def log(exception)
+    self.sender ||= Sender.new(self.configuration)
+    self.sender.log(exception)
+  end
+end
+
+AxialNotifier.configure do |config|
+  config.api_key = ''
+  config.environment = 'development'
+  config.facility = Syslog::LOG_LOCAL7
+end

data/lib/axial_notifier/catcher.rb

@@ -0,0 +1,10 @@
+module AxialNotifier
+  module Catcher
+    def log_error(exception)
+      super # still log normally in Rails
+
+      # send to axial
+      AxialNotifier.log(exception)
+    end
+  end
+end

data/lib/axial_notifier/configuration.rb

@@ -0,0 +1,5 @@
+module AxialNotifier
+  class Configuration
+    attr_accessor :api_key, :environment, :facility
+  end
+end

data/lib/axial_notifier/sender.rb

@@ -0,0 +1,25 @@
+module AxialNotifier
+  class Sender
+    def initialize(configuration)
+      @config = configuration
+      @syslog = Syslog.open(@config.api_key, nil, @config.facility)
+    end
+
+    def log(exception)
+      @syslog.err parse(exception)
+    end
+
+    def parse(exception)
+      if exception.is_a?(String)
+        {:message => exception}.to_json
+      else
+        {
+          :environment => (@config.environment),
+          :exception => exception.class,
+          :message => exception.message,
+          :backtrace => exception.backtrace.join('\n')
+        }.to_json
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# include so we can wrap Rescue#log_error
+ActionController::Base.class_eval {include AxialNotifier::Catcher}

data/test/axial_notifier/catcher_test.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), '..', 'helper')
+
+module SuperLog
+  def log_error(exception)
+  end
+end
+
+class CatcherMixer
+  include SuperLog
+  include AxialNotifier::Catcher
+end
+
+module AxialNotifier
+  class CatcherTest < Test::Unit::TestCase
+    context "A class with the Catcher module mixed in" do
+      should "log exceptions to Axial" do
+        AxialNotifier.stubs(:log)
+
+        CatcherMixer.new.log_error("exception")
+
+        assert_received(AxialNotifier, :log) {|e| e.with("exception")}
+      end
+    end
+  end
+end

data/test/axial_notifier/configuration_test.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '..', 'helper')
+
+module AxialNotifier
+  class ConfigurationTest < Test::Unit::TestCase
+    context "A Configuration" do
+      should "have no tests" do
+        assert true
+      end
+    end
+  end
+end

data/test/axial_notifier/sender_test.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), '..', 'helper')
+
+module AxialNotifier
+  class SenderTest < Test::Unit::TestCase
+    context "A Sender" do
+      setup do
+        @syslog = stub
+        Syslog.stubs(:open).returns(@syslog)
+
+        @config = stub(:api_key => '1234', :facility => 'local7')
+
+        @sender = Sender.new(@config)
+      end
+
+      should "parse strings" do
+        assert_equal '{"message":"volleyball"}', @sender.parse('volleyball')
+      end
+
+      should "parse exceptions" do
+        exception = stub
+        exception.stubs(:class).returns(StandardError)
+        exception.stubs(:message).returns("panthers")
+        exception.stubs(:backtrace).returns(["abcdefg","12345"])
+        @config.stubs(:environment).returns('development')
+
+        Hash.any_instance.stubs(:to_json)
+
+        @sender.parse(exception)
+
+        assert_received(exception, :class)
+        assert_received(exception, :message)
+        assert_received(exception, :backtrace)
+        assert_received(@config, :environment)
+      end
+
+      should "log with syslog" do
+        @syslog.stubs(:err)
+        @sender.stubs(:parse).returns("message to log")
+
+        @sender.log("something")
+
+        assert_received(@sender, :parse) {|e| e.with("something")}
+        assert_received(@syslog, :err) {|e| e.with("message to log")}
+      end
+    end
+  end
+end

data/test/axial_notifier_test.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class AxialNotifierTest < Test::Unit::TestCase
+  context "The AxialNotifier Module" do
+    setup do
+      @config = stub
+      AxialNotifier.configuration = @config
+      @sender = stub
+      AxialNotifier.sender = @sender
+    end
+
+    should "log to Sender" do
+      @sender.stubs(:log)
+
+      AxialNotifier.log("exception")
+
+      assert_received(@sender, :log) {|e| e.with("exception")}
+    end
+
+    should "yield its a configuration" do
+      AxialNotifier.configure do |config|
+        assert_equal @config, config
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'axial_notifier'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: axial_notifier
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- tpitale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-21 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jferris-mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.7
+    version: 
+description: Send Rails exception to the Axial Service via Syslog
+email: tpitale@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .document
+- .gitignore
+- README.md
+- Rakefile
+- VERSION
+- lib/axial_notifier.rb
+- lib/axial_notifier/catcher.rb
+- lib/axial_notifier/configuration.rb
+- lib/axial_notifier/sender.rb
+- rails/init.rb
+- test/axial_notifier/catcher_test.rb
+- test/axial_notifier/configuration_test.rb
+- test/axial_notifier/sender_test.rb
+- test/axial_notifier_test.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/tpitale/axial_notifier
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Send Rails exception to the Axial Service via Syslog
+test_files: 
+- test/axial_notifier/catcher_test.rb
+- test/axial_notifier/configuration_test.rb
+- test/axial_notifier/sender_test.rb
+- test/axial_notifier_test.rb
+- test/helper.rb