graylog2_exceptions 0.5.3 → 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/
+coverage/
+Manifest

data/README

@@ -0,0 +1 @@
+See http://www.graylog2.org/ for more information. Use gem as installation source. This is just the development repository.

data/Rakefile

@@ -1,11 +1,42 @@
 require 'rubygems'
 require 'rake'
-require 'echoe'
-
-Echoe.new('graylog2_exceptions', '0.5.3') do |p|
-  p.description = "A Rack middleware that sends every Exception as GELF message to your Graylog2 server"
-  p.url = 'http://www.graylog2.org/'
-  p.author = 'Lennart Koopmann'
-  p.email = 'lennart@socketfeed.com'
-  p.runtime_dependencies = ["gelf"]
+
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "graylog2_exceptions"
+    gem.summary = 'Graylog2 exception notifier'
+    gem.description = 'A Rack middleware that sends every Exception as GELF message to your Graylog2 server'
+    gem.email = "lennart@socketfeed.com"
+    gem.homepage = "http://www.graylog2.org/"
+    gem.authors = "Lennart Koopmann"
+    gem.add_dependency "gelf", "= 1.0.0"
+    # 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.rcov_opts << '--exclude gem'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: gem install rcov"
+  end
 end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/graylog2_exceptions.rb

@@ -3,11 +3,17 @@ require 'gelf'
 require 'socket'
 
 class Graylog2Exceptions
-  def initialize(app, options)
-    @gl2_hostname = options[:host] || "localhost"
-    @gl2_port = options[:port] || 12201
-    @local_app_name = options[:local_app_name] || Socket::gethostname
+  attr_reader :args
 
+  def initialize(app, args = {})
+    standard_args = {
+      :hostname => "localhost",
+      :port => 12201,
+      :local_app_name => Socket::gethostname,
+      :level => 3
+    }
+
+    @args = standard_args.merge(args)
     @app = app
   end
 
@@ -20,7 +26,7 @@ class Graylog2Exceptions
     begin
       # Call the app we are monitoring
       @app.call(env)
-    rescue StandardError, SyntaxError, LoadError => err
+    rescue => err
       # An exception has been raised. Send to Graylog2!
       send_to_graylog2(err)
 
@@ -31,14 +37,15 @@ class Graylog2Exceptions
 
   def send_to_graylog2 err
     begin
-      gelf = Gelf.new @gl2_hostname, @gl2_port
-      gelf.short_message = err.message
-      gelf.full_message = err.backtrace.join("\n")
-      gelf.level = @level
-      gelf.host = @local_app_name
-      gelf.file = err.backtrace[0].split(":")[0]
-      gelf.line = err.backtrace[0].split(":")[1]
-      gelf.send
+      notifier = GELF::Notifier.new(@args[:hostname], @args[:port])
+      notifier.notify!(
+        :short_message => err.message,
+        :full_message => err.backtrace.join("\n"),
+        :level => @args[:level],
+        :host => @args[:local_app_name],
+        :file => err.backtrace[0].split(":")[0],
+        :line => err.backtrace[0].split(":")[1]
+      )
     rescue => i_err
       puts "Graylog2 Exception logger. Could not send message: " + i_err.message
     end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+require 'zlib'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'graylog2_exceptions.rb'

data/test/test_graylog2_exceptions.rb

@@ -0,0 +1,86 @@
+require 'helper'
+
+class TestGraylog2Exceptions < Test::Unit::TestCase
+
+  # Exceptions raised in the app should be thrown back
+  # to the app after handling. Simulating this by giving
+  # a nil app and expecting the caused exceptions.
+  def test_should_rethrow_exception
+    c = Graylog2Exceptions.new(nil, {})
+    assert_raise NoMethodError do
+      c.call nil
+    end
+  end
+
+  def test_correct_parameters_when_custom_set
+    c = Graylog2Exceptions.new(nil, {:host => "localhost", :port => 1337, :local_app_name => "yomama", :level => 1})
+    
+    assert_equal "yomama", c.args[:local_app_name]
+    assert_equal "localhost", c.args[:hostname]
+    assert_equal 1337, c.args[:port]
+    assert_equal 1, c.args[:level]
+  end
+  
+  def test_correct_parameters_when_not_custom_set
+    c = Graylog2Exceptions.new(nil, {})
+    
+    assert_equal Socket.gethostname, c.args[:local_app_name]
+    assert_equal "localhost", c.args[:hostname]
+    assert_equal 12201, c.args[:port]
+    assert_equal 3, c.args[:level]
+  end
+
+  def test_send_exception_to_graylog2_without_custom_parameters
+    ex = build_exception
+
+    c = Graylog2Exceptions.new(nil, {})
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex).join)
+    json = JSON.parse(sent)
+
+    assert json["short_message"].include?('undefined method `klopfer!')
+    assert json["full_message"].include?('in `build_exception')
+    assert_equal 3, json["level"]
+    assert_equal Socket.gethostname, json["host"]
+    assert_equal ex.backtrace[0].split(":")[1], json["line"]
+    assert_equal ex.backtrace[0].split(":")[0], json["file"]
+  end
+  
+  def test_send_exception_to_graylog2_with_custom_parameters
+    ex = build_exception
+
+    c = Graylog2Exceptions.new(nil, {:local_app_name => "machinexx", :level => 1})
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex).join)
+    json = JSON.parse(sent)
+
+    assert json["short_message"].include?('undefined method `klopfer!')
+    assert json["full_message"].include?('in `build_exception')
+    assert_equal 1, json["level"]
+    assert_equal "machinexx", json["host"]
+    assert_equal ex.backtrace[0].split(":")[1], json["line"]
+    assert_equal ex.backtrace[0].split(":")[0], json["file"]
+  end
+
+  def test_invalid_port_detection
+    ex = build_exception
+
+    c = Graylog2Exceptions.new(nil, {:port => 0})
+
+    # send_to_graylog2 returns nil when nothing was sent
+    # the test is fine when the message is just not sent
+    # and there are no exceptions. the method informs
+    # the user via puts
+    assert_nil c.send_to_graylog2(ex)
+  end
+
+  private
+
+  # Returns a self-caused exception we can send.
+  def build_exception
+    begin
+      klopfer!
+    rescue => e
+      return e
+    end
+  end
+
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: graylog2_exceptions
 version: !ruby/object:Gem::Version 
-  hash: 13
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 5
-  - 3
-  version: 0.5.3
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Lennart Koopmann
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-08 00:00:00 +02:00
+date: 2010-11-19 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,12 +23,13 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
+        - 1
+        - 0
         - 0
-        version: "0"
+        version: 1.0.0
   type: :runtime
   version_requirements: *id001
 description: A Rack middleware that sends every Exception as GELF message to your Graylog2 server
@@ -39,22 +39,22 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- lib/graylog2_exceptions.rb
+- README
 files: 
-- Manifest
+- .gitignore
+- README
 - Rakefile
-- graylog2_exceptions.gemspec
+- VERSION
 - lib/graylog2_exceptions.rb
+- test/helper.rb
+- test/test_graylog2_exceptions.rb
 has_rdoc: true
 homepage: http://www.graylog2.org/
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Graylog2_exceptions
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -62,7 +62,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -71,17 +70,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 11
       segments: 
-      - 1
-      - 2
-      version: "1.2"
+      - 0
+      version: "0"
 requirements: []
 
-rubyforge_project: graylog2_exceptions
+rubyforge_project: 
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A Rack middleware that sends every Exception as GELF message to your Graylog2 server
-test_files: []
-
+summary: Graylog2 exception notifier
+test_files: 
+- test/helper.rb
+- test/test_graylog2_exceptions.rb

data/Manifest

@@ -1,4 +0,0 @@
-Manifest
-Rakefile
-graylog2_exceptions.gemspec
-lib/graylog2_exceptions.rb

data/graylog2_exceptions.gemspec

@@ -1,33 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{graylog2_exceptions}
-  s.version = "0.5.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Lennart Koopmann"]
-  s.date = %q{2010-10-08}
-  s.description = %q{A Rack middleware that sends every Exception as GELF message to your Graylog2 server}
-  s.email = %q{lennart@socketfeed.com}
-  s.extra_rdoc_files = ["lib/graylog2_exceptions.rb"]
-  s.files = ["Manifest", "Rakefile", "graylog2_exceptions.gemspec", "lib/graylog2_exceptions.rb"]
-  s.homepage = %q{http://www.graylog2.org/}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Graylog2_exceptions"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{graylog2_exceptions}
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A Rack middleware that sends every Exception as GELF message to your Graylog2 server}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<gelf>, [">= 0"])
-    else
-      s.add_dependency(%q<gelf>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<gelf>, [">= 0"])
-  end
-end