rack_hoptoad 0.0.5 → 0.1.0

data/README.md

@@ -7,15 +7,15 @@ Usage
 =====
 Throw something like this in your config.ru to enable notifications.
 
-    require 'rack_hoptoad'
+    require 'rack/hoptoad'
 
-    use Rack::HoptoadNotifier, 'fd48c7d26f724503a0280f808f44b339fc65fab8'
+    use Rack::Hoptoad, 'fd48c7d26f724503a0280f808f44b339fc65fab8'
 
 You can also exclude certain sensitive environmental variables using the block syntax
 
-    require 'rack_hoptoad'
+    require 'rack/hoptoad'
 
-    use Rack::HoptoadNotifier, 'fd48c7d26f724503a0280f808f44b339fc65fab8' do |notifier|
+    use Rack::Hoptoad, 'fd48c7d26f724503a0280f808f44b339fc65fab8' do |notifier|
       notifier.environment_filters << %w(MY_SECRET_KEY MY_SECRET_TOKEN)
     end
 
@@ -37,4 +37,4 @@ In order for exceptions to propagate up to Rack in Sinatra you need to enable ra
       enable :raise_errors
     end
 
-Note that the errors block does not execute so you'll need to handle the 500 elsewhere.
+Note that the errors block does not execute so you'll need to handle the 500 elsewhere.  Normally this is done with a 500.html in the document root.

data/Rakefile

@@ -3,9 +3,10 @@ require 'rake/gempackagetask'
 require 'rubygems/specification'
 require 'spec/rake/spectask'
 require 'date'
+require 'bundler'
 
 GEM = "rack_hoptoad"
-GEM_VERSION = "0.0.5"
+GEM_VERSION = "0.1.0"
 AUTHOR = "Corey Donohoe"
 EMAIL = "atmos@atmos.org"
 HOMEPAGE = "http://github.com/atmos/rack_hoptoad"
@@ -23,11 +24,13 @@ spec = Gem::Specification.new do |s|
   s.email = EMAIL
   s.homepage = HOMEPAGE
 
-  # Uncomment this to add a dependency
-  s.add_dependency "rack"
+  manifest = Bundler::Environment.load(File.dirname(__FILE__) + '/Gemfile')
+  manifest.dependencies.each do |d|
+    next unless d.only && d.only.include?('release')
+    s.add_dependency(d.name, d.version)
+  end
 
   s.require_path = 'lib'
-  s.autorequire = GEM
   s.files = %w(LICENSE README.md Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
 end
 
@@ -35,11 +38,6 @@ Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
-desc "install the gem locally"
-task :install => [:package] do
-  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
-end
-
 desc "create a gemspec file"
 task :make_spec do
   File.open("#{GEM}.gemspec", "w") do |file|
@@ -60,6 +58,5 @@ namespace :rack_hoptoad do
     t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
     t.rcov_opts << '--text-summary'
     t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
-#    t.rcov_opts << '--only-uncovered'
   end
 end

data/lib/rack/hoptoad.rb

@@ -0,0 +1,63 @@
+require 'rack'
+require 'erb'
+require 'toadhopper'
+
+module Rack
+  # Catches all exceptions raised from the app it wraps and
+  # posts the results to hoptoad.
+  class Hoptoad
+    attr_accessor :api_key, :environment_filters
+
+    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
+
+    def call(env)
+      status, headers, body =
+        begin
+          @app.call(env)
+        rescue StandardError, LoadError, SyntaxError => boom
+          # TODO don't allow exceptions from send_notification to
+          # propogate
+          send_notification boom, env 
+          raise
+        end
+      send_notification env['rack.exception'], env if env['rack.exception']
+      [status, headers, body]
+    end
+
+    def environment_filter_keys
+      @environment_filters.flatten
+    end
+  private
+
+    def send_notification(exception, env)
+      request      = Rack::Request.new(env)
+
+      options = {
+        :api_key           => api_key,
+        :url               => "#{request.scheme}://#{request.host}#{request.path}",
+        :request           => request,
+        :framework_env     => ENV['RACK_ENV'] || 'development',
+        :notifier_name     => 'Rack::Hoptoad',
+        :notifier_version  => '0.0.6',
+        :session           => env['rack.session']
+      }
+
+      if %w(staging production).include?(ENV['RACK_ENV'])
+        ToadHopper.new(api_key).post!(exception, options, {'X-Hoptoad-Client-Name' => 'Rack::Hoptoad'})
+      end
+      env['hoptoad.notified'] = true
+    end
+
+    def extract_body(env)
+      if io = env['rack.input']
+        io.rewind if io.respond_to?(:rewind)
+        io.read
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: rack_hoptoad
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Corey Donohoe
-autorequire: rack_hoptoad
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 -08:00
+date: 2009-12-15 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: toadhopper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
 description: A gem that provides hoptoad notifications from rack
 email: atmos@atmos.org
 executables: []
@@ -36,9 +46,7 @@ files:
 - README.md
 - Rakefile
 - TODO
-- lib/rack/hoptoad_notifier.rb
-- lib/rack/notice.xml.erb
-- lib/rack_hoptoad.rb
+- lib/rack/hoptoad.rb
 has_rdoc: true
 homepage: http://github.com/atmos/rack_hoptoad
 licenses: []

data/lib/rack/hoptoad_notifier.rb

@@ -1,130 +0,0 @@
-require 'net/http'
-
-module Rack
-  # Catches all exceptions raised from the app it wraps and
-  # posts the results to hoptoad.
-  class HoptoadNotifier
-    attr_accessor :api_key, :environment_filters
-
-    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
-
-    def call(env)
-      status, headers, body =
-        begin
-          @app.call(env)
-        rescue StandardError, LoadError, SyntaxError => boom
-          # TODO don't allow exceptions from send_notification to
-          # propogate
-          send_notification boom, env 
-          raise
-        end
-      send_notification env['rack.exception'], env if env['rack.exception']
-      [status, headers, body]
-    end
-
-    def environment_filter_keys
-      @environment_filters.flatten
-    end
-  private
-
-    def notice_template
-      ::File.read(::File.join(::File.dirname(__FILE__), 'notice.xml.erb'))
-    end
-
-    INPUT_FORMAT = %r{^([^:]+):(\d+)(?::in `([^']+)')?$}.freeze
-
-    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
-
-    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)
-
-      document = ERB.new(notice_template).result(binding)
-
-      if %w(staging production).include?(ENV['RACK_ENV'])
-        send_to_hoptoad document
-      end
-      env['hoptoad.notified'] = true
-    end
-
-    def extract_body(env)
-      if io = env['rack.input']
-        io.rewind if io.respond_to?(:rewind)
-        io.read
-      end
-    end
-
-    def send_to_hoptoad(data) #:nodoc:
-      url = URI.parse("http://hoptoadapp.com:80/notifier_api/v2/notices")
-
-      Net::HTTP.start(url.host, url.port) do |http|
-        headers = {
-          '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, data, headers)
-                   rescue TimeoutError => e
-                     logger "Timeout while contacting the Hoptoad server."
-                     nil
-                   end
-        case response
-        when Net::HTTPSuccess then
-          logger "Hoptoad Success: #{response.class}"
-        else
-          logger "Hoptoad Failure: #{response.class}\n#{response.body if response.respond_to? :body}"
-        end
-      end
-    end
-
-    def logger(str)
-      puts str if ENV['RACK_DEBUG']
-    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
-        h
-      end
-    end
-
-    def clean_hoptoad_environment(environment) #:nodoc:
-      clean_non_serializable_data(environment).each do |key, value|
-        environment[key] = "[FILTERED]" if filter?(key)
-      end
-    end
-
-    def filter?(key)
-      environment_filter_keys.any? do |filter|
-        key.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

@@ -1,40 +0,0 @@
-<?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.5</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>
-    <% if @request.params.any? %>
-      <params>
-        <% @request.params.each do |key,value| %>
-          <var key="<%= key %>"><%= value %></var>
-        <% end %>
-      </params>
-    <% end %>
-    <% if @environment.any? %>
-      <cgi-data>
-        <% @environment.each do |key,value| %>
-          <var key="<%= key %>"><%= value %></var>
-        <% end %>
-      </cgi-data>
-    <% end %>
-  </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 +0,0 @@
-require 'rack'
-require 'erb'
-
-root = File.expand_path(File.dirname(__FILE__))
-require root + '/rack/hoptoad_notifier.rb'