rack_hoptoad 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Corey Donohoe
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+rack_hoptoad
+============
+
+A gem that provides exception notifications to [hoptoad](http://hoptoadapp.com) as rack middleware.
+
+Usage
+=====
+Throw something like this in your config.ru to enable notifications.
+
+    require 'rack_hoptoad'
+
+    ENV['RACK_ENV'] = 'production'
+
+    use Rack::HoptoadNotifier, 'fd48c7d26f724503a0280f808f44b339fc65fab8'
+
+If your RACK_ENV variable is set to production it'll actually post to hoptoad.
+It won't process in the other environments.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'spec/rake/spectask'
+require 'date'
+
+GEM = "rack_hoptoad"
+GEM_VERSION = "0.0.1"
+AUTHOR = "Corey Donohoe"
+EMAIL = "atmos@atmos.org"
+HOMEPAGE = "http://github.com/atmos/rack_hoptoad"
+SUMMARY = "A gem that provides hoptoad notifications from rack"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+  # Uncomment this to add a dependency
+  s.add_dependency "rack"
+
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.md Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
+end
+
+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|
+    file.puts spec.to_ruby
+  end
+end
+
+task :default => 'rack_hoptoad:spec'
+
+namespace :rack_hoptoad do
+  desc "Run unit specifications"
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts << %w(-fs --color)
+    t.spec_opts << '--loadby' << 'random'
+    t.spec_files = Dir["spec/*_spec.rb"]
+
+    t.rcov_opts << '--exclude' << 'spec'
+    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/TODO

@@ -0,0 +1 @@
+TODO:

data/lib/rack/hoptoad_notifier.rb

@@ -0,0 +1,139 @@
+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
+      yield self if block_given?
+    end
+
+    def call(env)
+      status, headers, body =
+        begin
+          @app.call(env)
+        rescue => 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
+
+  private
+    def environment_filters
+      @environment_filters ||= %w(AWS_ACCESS_KEY  AWS_SECRET_ACCESS_KEY AWS_ACCOUNT SSH_AUTH_SOCK)
+    end
+
+    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
+      }
+
+      data[:request] = {
+        :params => Rack::Request.new(env).params
+      }
+
+      data[:environment] = clean_hoptoad_environment(ENV.to_hash.merge(env))
+      data[:environment][:RAILS_ENV] = ENV['RACK_ENV'] || 'development'
+
+      data[:session] = {
+         :key         => env['rack.session'] || 42,
+         :data        => env['rack.session'] || { }
+      }
+
+      if %w(staging production).include?(ENV['RACK_ENV'])
+        send_to_hoptoad :notice => default_notice_options.merge(data)
+      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/notices/")
+
+      Net::HTTP.start(url.host, url.port) do |http|
+        headers = {
+          'Content-type' => 'application/x-yaml',
+          '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)
+                   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 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
+        h
+      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
+
+    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
+    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
+    end
+  end
+end

data/lib/rack_hoptoad.rb

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

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: rack_hoptoad
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Corey Donohoe
+autorequire: rack_hoptoad
+bindir: bin
+cert_chain: []
+
+date: 2009-05-11 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A gem that provides hoptoad notifications from rack
+email: atmos@atmos.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- lib/rack
+- lib/rack/hoptoad_notifier.rb
+- lib/rack_hoptoad.rb
+has_rdoc: true
+homepage: http://github.com/atmos/rack_hoptoad
+post_install_message: 
+rdoc_options: []
+
+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.1
+signing_key: 
+specification_version: 2
+summary: A gem that provides hoptoad notifications from rack
+test_files: []
+