daemon-kit 0.1.8rc1 → 0.1.8rc2

data/History.txt

@@ -4,6 +4,10 @@
 * Evented XMPP now handled by blather
 * Boot script fixes
 * Removed Jabber generator, deprecating Jabber class (use XMPP)
+* Upgraded Hoptoad notifications to V2 of the notifier API
+* Fix various argument handling bugs
+* Removed support for exception emails
+* Improved log rotation support [mperham]
 
 == 0.1.7.12 2009-12-04
 

data/Rakefile

@@ -15,7 +15,7 @@ begin
     gemspec.post_install_message = IO.read('PostInstall.txt')
     gemspec.extra_rdoc_files.include '*.txt'
 
-    gemspec.add_dependency 'eventmachine', '>=0.12.8'
+    gemspec.add_dependency 'eventmachine', '>=0.12.10'
     gemspec.add_development_dependency 'rspec'
     gemspec.add_development_dependency 'cucumber'
   end

data/daemon-kit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{daemon-kit}
-  s.version = "0.1.8rc1"
+  s.version = "0.1.8rc2"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["kenneth.kalmer@gmail.com"]
-  s.date = %q{2010-04-13}
+  s.date = %q{2010-04-14}
   s.default_executable = %q{daemon-kit}
   s.description = %q{daemon-kit aims to simplify creating Ruby daemons by providing a sound application skeleton (through a generator), task specific generators (jabber bot, etc) and robust environment management code.}
   s.email = %q{kenneth.kalmer@gmail.com}
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
      "Deployment.txt",
      "History.txt",
      "Logging.txt",
-     "Manifest.txt",
      "PostInstall.txt",
      "README.rdoc",
      "RuoteParticipants.txt",
@@ -31,7 +30,6 @@ Gem::Specification.new do |s|
      "Deployment.txt",
      "History.txt",
      "Logging.txt",
-     "Manifest.txt",
      "PostInstall.txt",
      "README.rdoc",
      "Rakefile",
@@ -59,7 +57,6 @@ Gem::Specification.new do |s|
      "lib/daemon_kit/em.rb",
      "lib/daemon_kit/error_handlers/base.rb",
      "lib/daemon_kit/error_handlers/hoptoad.rb",
-     "lib/daemon_kit/error_handlers/mail.rb",
      "lib/daemon_kit/exceptions.rb",
      "lib/daemon_kit/generators.rb",
      "lib/daemon_kit/generators/base.rb",
@@ -211,35 +208,7 @@ Gem::Specification.new do |s|
      "test/test_helper.rb",
      "test/test_nanite_agent_generator.rb",
      "test/test_ruote_generator.rb",
-     "test/test_test_unit_generator.rb",
-     "vendor/tmail-1.2.3/tmail.rb",
-     "vendor/tmail-1.2.3/tmail/address.rb",
-     "vendor/tmail-1.2.3/tmail/attachments.rb",
-     "vendor/tmail-1.2.3/tmail/base64.rb",
-     "vendor/tmail-1.2.3/tmail/compat.rb",
-     "vendor/tmail-1.2.3/tmail/config.rb",
-     "vendor/tmail-1.2.3/tmail/core_extensions.rb",
-     "vendor/tmail-1.2.3/tmail/encode.rb",
-     "vendor/tmail-1.2.3/tmail/header.rb",
-     "vendor/tmail-1.2.3/tmail/index.rb",
-     "vendor/tmail-1.2.3/tmail/interface.rb",
-     "vendor/tmail-1.2.3/tmail/loader.rb",
-     "vendor/tmail-1.2.3/tmail/mail.rb",
-     "vendor/tmail-1.2.3/tmail/mailbox.rb",
-     "vendor/tmail-1.2.3/tmail/main.rb",
-     "vendor/tmail-1.2.3/tmail/mbox.rb",
-     "vendor/tmail-1.2.3/tmail/net.rb",
-     "vendor/tmail-1.2.3/tmail/obsolete.rb",
-     "vendor/tmail-1.2.3/tmail/parser.rb",
-     "vendor/tmail-1.2.3/tmail/port.rb",
-     "vendor/tmail-1.2.3/tmail/quoting.rb",
-     "vendor/tmail-1.2.3/tmail/require_arch.rb",
-     "vendor/tmail-1.2.3/tmail/scanner.rb",
-     "vendor/tmail-1.2.3/tmail/scanner_r.rb",
-     "vendor/tmail-1.2.3/tmail/stringio.rb",
-     "vendor/tmail-1.2.3/tmail/utils.rb",
-     "vendor/tmail-1.2.3/tmail/version.rb",
-     "vendor/tmail.rb"
+     "test/test_test_unit_generator.rb"
   ]
   s.homepage = %q{http://github.com/kennethkalmer/daemon-kit}
   s.post_install_message = %q{
@@ -279,16 +248,16 @@ To get started quickly run 'daemon-kit' without any arguments
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.8"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<cucumber>, [">= 0"])
     else
-      s.add_dependency(%q<eventmachine>, [">= 0.12.8"])
+      s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<cucumber>, [">= 0"])
     end
   else
-    s.add_dependency(%q<eventmachine>, [">= 0.12.8"])
+    s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<cucumber>, [">= 0"])
   end

data/lib/daemon_kit.rb

@@ -13,7 +13,7 @@ $:.unshift( File.dirname(__FILE__).to_absolute_path ) unless
   $:.include?( File.dirname(__FILE__).to_absolute_path )
 
 module DaemonKit
-  VERSION = '0.1.8rc1'
+  VERSION = '0.1.8rc2'
 
   autoload :Initializer,    'daemon_kit/initializer'
   autoload :Application,    'daemon_kit/application'

data/lib/daemon_kit/error_handlers/base.rb

@@ -7,21 +7,21 @@ module DaemonKit
     class Base
 
       class << self
-        
+
         @instance = nil
 
         def instance
           @instance ||= new
         end
         private :new
-        
+
         # When we're inherited, immediately register the handler with
         # the safety net
         def inherited( child ) #:nodoc:
           Safety.register_error_handler( child )
         end
       end
-      
+
       # Error handlers should overwrite this method and implement
       # their own reporting method.
       def handle_exception( exception )

data/lib/daemon_kit/error_handlers/hoptoad.rb

@@ -5,21 +5,127 @@ module DaemonKit
     # Error reporting via Hoptoad.
     class Hoptoad < Base
 
+      # Front end to parsing the backtrace for each notice
+      # (Graciously borrowed from http://github.com/thoughtbot/hoptoad_notifier)
+      class Backtrace
+
+        # Handles backtrace parsing line by line
+        # (Graciously borrowed from http://github.com/thoughtbot/hoptoad_notifier)
+        class Line
+
+          INPUT_FORMAT = %r{^([^:]+):(\d+)(?::in `([^']+)')?$}.freeze
+
+          # The file portion of the line (such as app/models/user.rb)
+          attr_reader :file
+
+          # The line number portion of the line
+          attr_reader :number
+
+          # The method of the line (such as index)
+          attr_reader :method
+
+          # Parses a single line of a given backtrace
+          # @param [String] unparsed_line The raw line from +caller+ or some backtrace
+          # @return [Line] The parsed backtrace line
+          def self.parse(unparsed_line)
+            _, file, number, method = unparsed_line.match(INPUT_FORMAT).to_a
+            new(file, number, method)
+          end
+
+          def initialize(file, number, method)
+            self.file   = file
+            self.number = number
+            self.method = method
+          end
+
+          # Reconstructs the line in a readable fashion
+          def to_s
+            "#{file}:#{number}:in `#{method}'"
+          end
+
+          def ==(other)
+            to_s == other.to_s
+          end
+
+          def inspect
+            "<Line:#{to_s}>"
+          end
+
+          def to_xml
+            data = [ method, file, number ].map { |s| URI.escape( s, %q{"'<>&} ) }
+            %q{<line method="%s" file="%s" number="%s" />} % data
+          end
+
+          private
+
+          attr_writer :file, :number, :method
+        end
+
+        # holder for an Array of Backtrace::Line instances
+        attr_reader :lines
+
+        def self.parse(ruby_backtrace, opts = {})
+          ruby_lines = split_multiline_backtrace(ruby_backtrace)
+
+          filters = opts[:filters] || []
+          filtered_lines = ruby_lines.to_a.map do |line|
+            filters.inject(line) do |line, proc|
+              proc.call(line)
+            end
+          end.compact
+
+          lines = filtered_lines.collect do |unparsed_line|
+            Line.parse(unparsed_line)
+          end
+
+          instance = new(lines)
+        end
+
+        def initialize(lines)
+          self.lines = lines
+        end
+
+        def inspect
+          "<Backtrace: " + lines.collect { |line| line.inspect }.join(", ") + ">"
+        end
+
+        def ==(other)
+          if other.respond_to?(:lines)
+            lines == other.lines
+          else
+            false
+          end
+        end
+
+        private
+
+        attr_writer :lines
+
+        def self.split_multiline_backtrace(backtrace)
+          if backtrace.to_a.size == 1
+            backtrace.to_a.first.split(/\n\s*/)
+          else
+            backtrace
+          end
+        end
+      end
+
       # Your hoptoad API key
       @api_key = nil
       attr_accessor :api_key
 
       def handle_exception( exception )
         headers = {
-          'Content-type' => 'application/x-yaml',
+          'Content-type' => 'text/xml',
           'Accept' => 'text/xml, application/xml'
         }
 
         http = Net::HTTP.new( url.host, url.port )
-        data = clean_exception( exception )
+        data = format_exception( exception )
+        DaemonKit.logger.debug("Sending to Hoptoad: #{data}")
 
         response = begin
-                     http.post( url.path, {"notice" => data}.to_yaml, headers )
+                     http.post( url.path, data, headers )
                    rescue TimeoutError => e
                      DaemonKit.logger.error("Timeout while contacting the Hoptoad server.")
                      nil
@@ -33,29 +139,36 @@ module DaemonKit
       end
 
       def url
-        URI.parse("http://hoptoadapp.com/notices/")
+        URI.parse("http://hoptoadapp.com/notifier_api/v2/notices")
       end
 
-      def clean_exception( exception )
-        data = {
-          :api_key       => self.api_key,
-          :error_class   => exception.class.name,
-          :error_message => "#{exception.class.name}: #{exception.message}",
-          :backtrace     => exception.backtrace,
-          :environment   => ENV.to_hash,
-          :request       => {},
-          :session       => {}
-        }
+      def format_exception( exception )
+        lines = Backtrace.parse( exception.backtrace )
 
-        stringify_keys( data )
-      end
-
-      def stringify_keys(hash) #:nodoc:
-        hash.inject({}) do |h, pair|
-          h[pair.first.to_s] = pair.last.is_a?(Hash) ? stringify_keys(pair.last) : pair.last
-          h
-        end
+        <<-EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<notice version="2.0">
+  <api-key>#{self.api_key}</api-key>
+  <notifier>
+    <name>daemon-kit</name>
+    <version>#{DaemonKit::VERSION}</version>
+    <url>http://github.com/kennethkalmer/daemon-kit</url>
+  </notifier>
+  <error>
+    <class>#{exception.class.name}</class>
+    <message>#{exception.message}</message>
+    <backtrace>
+      #{Backtrace.parse( exception.backtrace ).lines.inject('') { |string,line| string << line.to_xml }}
+    </backtrace>
+  </error>
+  <server-environment>
+    <project-root>#{DaemonKit.root}</project-root>
+    <environment-name>#{DaemonKit.env}</environment-name>
+  </server-environment>
+</notice>
+        EOF
       end
     end
+
   end
 end

data/lib/daemon_kit/safety.rb

@@ -81,5 +81,4 @@ end
 
 # Load our error handlers
 require 'daemon_kit/error_handlers/base'
-require 'daemon_kit/error_handlers/mail'
 require 'daemon_kit/error_handlers/hoptoad'

data/lib/generators/daemon_kit/app/templates/config/boot.rb

@@ -3,9 +3,13 @@
 
 DAEMON_ROOT = "#{File.expand_path(File.dirname(__FILE__))}/.." unless defined?( DAEMON_ROOT )
 
-# Use bundler if available
-if File.exists?( File.join( DAEMON_ROOT, 'vendor', 'gems', 'environment.rb' ) )
-  require File.join( DAEMON_ROOT, 'vendor', 'gems', 'environment' )
+# Use Bundler (preferred)
+begin
+  require File.expand_path('../../.bundle/environment', __FILE__)
+rescue LoadError
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
 end
 
 module DaemonKit

data/lib/generators/daemon_kit/app/templates/config/environment.rb.tt

@@ -6,6 +6,9 @@
 # Boot up
 require File.join(File.dirname(__FILE__), 'boot')
 
+# Auto-require default libraries and those for the current Rails environment.
+Bundler.require :default, DaemonKit.env
+
 DaemonKit::Initializer.run do |config|
 
   # The name of the daemon as reported by process monitoring tools
@@ -18,6 +21,6 @@ DaemonKit::Initializer.run do |config|
   # config.backtraces = true
 
   # Configure the safety net (see DaemonKit::Safety)
-  # config.safety_net.handler = :mail # (or :hoptoad )
-  # config.safety_net.mail.host = 'localhost'
+  # config.safety_net.handler = :hoptoad
+  # config.safety_net.hoptoad.api_key = ''
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: daemon-kit
 version: !ruby/object:Gem::Version 
-  version: 0.1.8rc1
+  version: 0.1.8rc2
 platform: ruby
 authors: 
 - kenneth.kalmer@gmail.com
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 +02:00
+date: 2010-04-14 00:00:00 +02:00
 default_executable: daemon-kit
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.12.8
+        version: 0.12.10
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -53,7 +53,6 @@ extra_rdoc_files:
 - Deployment.txt
 - History.txt
 - Logging.txt
-- Manifest.txt
 - PostInstall.txt
 - README.rdoc
 - RuoteParticipants.txt
@@ -64,7 +63,6 @@ files:
 - Deployment.txt
 - History.txt
 - Logging.txt
-- Manifest.txt
 - PostInstall.txt
 - README.rdoc
 - Rakefile
@@ -92,7 +90,6 @@ files:
 - lib/daemon_kit/em.rb
 - lib/daemon_kit/error_handlers/base.rb
 - lib/daemon_kit/error_handlers/hoptoad.rb
-- lib/daemon_kit/error_handlers/mail.rb
 - lib/daemon_kit/exceptions.rb
 - lib/daemon_kit/generators.rb
 - lib/daemon_kit/generators/base.rb
@@ -245,34 +242,6 @@ files:
 - test/test_nanite_agent_generator.rb
 - test/test_ruote_generator.rb
 - test/test_test_unit_generator.rb
-- vendor/tmail-1.2.3/tmail.rb
-- vendor/tmail-1.2.3/tmail/address.rb
-- vendor/tmail-1.2.3/tmail/attachments.rb
-- vendor/tmail-1.2.3/tmail/base64.rb
-- vendor/tmail-1.2.3/tmail/compat.rb
-- vendor/tmail-1.2.3/tmail/config.rb
-- vendor/tmail-1.2.3/tmail/core_extensions.rb
-- vendor/tmail-1.2.3/tmail/encode.rb
-- vendor/tmail-1.2.3/tmail/header.rb
-- vendor/tmail-1.2.3/tmail/index.rb
-- vendor/tmail-1.2.3/tmail/interface.rb
-- vendor/tmail-1.2.3/tmail/loader.rb
-- vendor/tmail-1.2.3/tmail/mail.rb
-- vendor/tmail-1.2.3/tmail/mailbox.rb
-- vendor/tmail-1.2.3/tmail/main.rb
-- vendor/tmail-1.2.3/tmail/mbox.rb
-- vendor/tmail-1.2.3/tmail/net.rb
-- vendor/tmail-1.2.3/tmail/obsolete.rb
-- vendor/tmail-1.2.3/tmail/parser.rb
-- vendor/tmail-1.2.3/tmail/port.rb
-- vendor/tmail-1.2.3/tmail/quoting.rb
-- vendor/tmail-1.2.3/tmail/require_arch.rb
-- vendor/tmail-1.2.3/tmail/scanner.rb
-- vendor/tmail-1.2.3/tmail/scanner_r.rb
-- vendor/tmail-1.2.3/tmail/stringio.rb
-- vendor/tmail-1.2.3/tmail/utils.rb
-- vendor/tmail-1.2.3/tmail/version.rb
-- vendor/tmail.rb
 has_rdoc: true
 homepage: http://github.com/kennethkalmer/daemon-kit
 licenses: []