rack_hoptoad 0.0.3 → 0.0.4

data/README.md

@@ -11,6 +11,15 @@ Throw something like this in your config.ru to enable notifications.
 
     use Rack::HoptoadNotifier, 'fd48c7d26f724503a0280f808f44b339fc65fab8'
 
+You can also exclude certain sensitive environmental variables using the block syntax
+
+    require 'rack_hoptoad'
+
+    use Rack::HoptoadNotifier, 'fd48c7d26f724503a0280f808f44b339fc65fab8' do |notifier|
+      notifier.environment_filters << %w(MY_SECRET_KEY MY_SECRET_TOKEN)
+    end
+
+
 If your RACK_ENV variable is set to production or staging it'll actually post
 to hoptoad.  It won't process in the other environments.
 
@@ -18,3 +27,14 @@ Installation
 ============
 
     % sudo gem install rack_hoptoad
+
+Sinatra Notes
+=============
+
+In order for exceptions to propagate up to Rack in Sinatra you need to enable raise_errors
+
+    class MyApp < Sinatra::Default
+      enable :raise_errors
+    end
+
+Note that the errors block does not execute so you'll need to handle the 500 elsewhere.

data/Rakefile

@@ -5,10 +5,10 @@ require 'spec/rake/spectask'
 require 'date'
 
 GEM = "rack_hoptoad"
-GEM_VERSION = "0.0.3"
+GEM_VERSION = "0.0.4"
 AUTHOR = "Corey Donohoe"
 EMAIL = "atmos@atmos.org"
-HOMEPAGE = "http://github.com/atmos/rack_hoptoad"
+HOMEPAGE = "http://rubyforge.org/projects/rackhoptoad/"
 SUMMARY = "A gem that provides hoptoad notifications from rack"
 
 spec = Gem::Specification.new do |s|

data/lib/rack/hoptoad_notifier.rb

@@ -9,6 +9,7 @@ module Rack
     def initialize(app, api_key = nil)
       @app = app
       @api_key = api_key
+      @environment_filters = %w(AWS_ACCESS_KEY  AWS_SECRET_ACCESS_KEY AWS_ACCOUNT SSH_AUTH_SOCK)
       yield self if block_given?
     end
 
@@ -26,36 +27,37 @@ module Rack
       [status, headers, body]
     end
 
-  private
-    def environment_filters
-      @environment_filters ||= %w(AWS_ACCESS_KEY  AWS_SECRET_ACCESS_KEY AWS_ACCOUNT SSH_AUTH_SOCK)
+    def environment_filter_keys
+      @environment_filters.flatten
     end
+  private
 
-    def send_notification(exception, env)
-      data = {
-        :api_key       => api_key,
-        :error_class   => exception.class.name,
-        :error_message => "#{exception.class.name}: #{exception.message}",
-        :backtrace     => exception.backtrace,
-        :environment   => env.to_hash
-      }
+    def notice_template
+      ::File.read(::File.join(::File.dirname(__FILE__), 'notice.xml.erb'))
+    end
 
-      bad_request = Rack::Request.new(env)
+    INPUT_FORMAT = %r{^([^:]+):(\d+)(?::in `([^']+)')?$}.freeze
 
-      data[:request] = {
-        :params => {'request.path' => bad_request.script_name + bad_request.path_info}.merge(bad_request.params)
-      }
+    class Backtrace < Struct.new(:file, :number, :method); end
+    def build_backtrace(exception)
+      exception.backtrace.map do |line|
+        _, file, number, method = line.match(INPUT_FORMAT).to_a
+        Backtrace.new(file, number, method)
+      end
+    end
 
-      data[:environment] = clean_hoptoad_environment(ENV.to_hash.merge(env))
-      data[:environment][:RAILS_ENV] = ENV['RACK_ENV'] || 'development'
+    def send_notification(exception, env)
+      @error        = exception
+      @api_key      = api_key
+      @request      = Rack::Request.new(env)
+      @request_path = @request.script_name + @request.path_info
+      @environment  = clean_hoptoad_environment(ENV.to_hash.merge(env))
+      @backtrace    = build_backtrace(exception)
 
-      data[:session] = {
-         :key         => env['rack.session'] || 42,
-         :data        => env['rack.session'] || { }
-      }
+      document = ERB.new(notice_template).result(binding)
 
       if %w(staging production).include?(ENV['RACK_ENV'])
-        send_to_hoptoad :notice => default_notice_options.merge(data)
+        send_to_hoptoad document
       end
       env['hoptoad.notified'] = true
     end
@@ -68,18 +70,19 @@ module Rack
     end
 
     def send_to_hoptoad(data) #:nodoc:
-      url = URI.parse("http://hoptoadapp.com:80/notices/")
+      url = URI.parse("http://hoptoadapp.com:80/notifier_api/v2/notices")
 
       Net::HTTP.start(url.host, url.port) do |http|
         headers = {
-          'Content-type' => 'application/x-yaml',
-          'Accept' => 'text/xml, application/xml'
+          'Content-type' => 'text/xml',
+          'Accept'       => 'text/xml, application/xml'
         }
+
         http.read_timeout = 5 # seconds
         http.open_timeout = 2 # seconds
         # http.use_ssl = HoptoadNotifier.secure
         response = begin
-                     http.post(url.path, clean_non_serializable_data(data).to_yaml, headers)
+                     http.post(url.path, data, headers)
                    rescue TimeoutError => e
                      logger "Timeout while contacting the Hoptoad server."
                      nil
@@ -97,17 +100,6 @@ module Rack
       puts str if ENV['RACK_DEBUG']
     end
 
-    def default_notice_options #:nodoc:
-      {
-        :api_key       => api_key,
-        :error_message => 'Notification',
-        :backtrace     => nil,
-        :request       => {},
-        :session       => {},
-        :environment   => {}
-      }
-    end
-
     def clean_non_serializable_data(notice) #:nodoc:
       notice.select{|k,v| serializable?(v) }.inject({}) do |h, pair|
         h[pair.first] = pair.last.is_a?(Hash) ? clean_non_serializable_data(pair.last) : pair.last
@@ -115,27 +107,24 @@ module Rack
       end
     end
 
-    def serializable?(value) #:nodoc:
-      value.is_a?(Fixnum) || 
-      value.is_a?(Array)  || 
-      value.is_a?(String) || 
-      value.is_a?(Hash)   || 
-      value.is_a?(Bignum)
+    def clean_hoptoad_environment(environment) #:nodoc:
+      clean_non_serializable_data(environment).each do |key, value|
+        environment[key] = "[FILTERED]" if filter?(key)
+      end
     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
+    def filter?(key)
+      environment_filter_keys.any? do |filter|
+        key.to_s.match(/#{filter}/)
       end
     end
 
-    def clean_hoptoad_environment(environ) #:nodoc:
-      environ.each do |k, v|
-        environ[k] = "[FILTERED]" if environment_filters.any? do |filter|
-          k.to_s.match(/#{filter}/)
-        end
-      end
+    def serializable?(value) #:nodoc:
+      value.is_a?(Fixnum) ||
+      value.is_a?(Array)  ||
+      value.is_a?(String) ||
+      value.is_a?(Hash)   ||
+      value.is_a?(Bignum)
     end
   end
 end

data/lib/rack/notice.xml.erb

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notice version="2.0.0">
+  <api-key><%= @api_key %></api-key>
+  <notifier>
+    <name>Rack Hoptoad Notifier</name>
+    <version>0.0.4</version>
+    <url>http://github.com//atmos/rack_hoptoad</url>
+  </notifier>
+  <error>
+    <class><%= @error.class.name %></class>
+    <message><%= @error.message %></message>
+    <backtrace>
+      <% @backtrace.each do |line| %>
+        <line method="<%= line.method %>" file="<%= line.file %>" number="<%= line.number %>"/>
+      <% end %>
+    </backtrace>
+  </error>
+  <request>
+    <url><%= @request_path %></url>
+    <component><%= @request_path %></component>
+    <params>
+      <% @request.params.each do |key,value| %>
+        <var key="<%= key %>"><%= value %></var>
+      <% end %>
+    </params>
+    <cgi-data>
+      <% @environment.each do |key,value| %>
+        <var key="<%= key %>"><%= value %></var>
+      <% end %>
+    </cgi-data>
+  </request>
+  <server-environment>
+    <project-root><%= Dir.pwd %></project-root>
+    <environment-name><%= ENV['RACK_ENV'] || 'development' %></environment-name>
+  </server-environment>
+</notice>

data/lib/rack_hoptoad.rb

@@ -1,5 +1,5 @@
-gem 'rack', '>=0.9.1'
 require 'rack'
+require 'erb'
 
 root = File.expand_path(File.dirname(__FILE__))
 require root + '/rack/hoptoad_notifier.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack_hoptoad
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Corey Donohoe
@@ -9,7 +9,7 @@ autorequire: rack_hoptoad
 bindir: bin
 cert_chain: []
 
-date: 2009-05-13 00:00:00 -06:00
+date: 2009-11-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,11 +36,13 @@ files:
 - README.md
 - Rakefile
 - TODO
-- lib/rack
 - lib/rack/hoptoad_notifier.rb
+- lib/rack/notice.xml.erb
 - lib/rack_hoptoad.rb
 has_rdoc: true
-homepage: http://github.com/atmos/rack_hoptoad
+homepage: http://rubyforge.org/projects/rackhoptoad/
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -61,9 +63,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A gem that provides hoptoad notifications from rack
 test_files: []