merb_hoptoad_notifier 1.0.10

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Corey Donohoe<atmos@atmos.org>, Joakim Kolsjö<trejje@gmail.com>
+
+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

@@ -0,0 +1,59 @@
+merb_hoptoad_notifier
+---------------------------------------------
+This is merb plugin for exception notification with hoptoad. It should work with
+any merb app that's based on merb 1.0 and higher
+
+This plugin: http://github.com/atmos/merb_hoptoad_notifier/tree/master
+The original: http://github.com/thoughtbot/hoptoad_notifier/tree/master
+
+Usage:
+
+1) Get your api key for your app from hoptoadapp.com
+
+2) Add the api key to config/hoptoad.yml with a similar syntax as the following
+---
+:development: &defaults
+  :api_key: ZOMGLOLROFLMAO
+
+:rake:
+  <<: *defaults
+
+:test:
+  <<: *defaults
+
+:production:
+  :api_key: UBERSECRETSHIT
+
+
+3) Require hoptoad in init.rb
+require 'merb_hoptoad_notifier'
+
+4) Add the following method to your Exceptions controller.  Depending on your merb version you'll need to use the exceptions,standard_error, or internal_server error as the action name.  Kinda weak, but the API changed a lot in 0.9.x
+
+class Exceptions < Merb::Controller
+  if %w( staging production ).include?(Merb.env)
+    def standard_error
+      HoptoadNotifier.notify_hoptoad(request, session)
+      render
+    end
+  end
+end
+
+5) Restart the server, trigger an error(in staging or prod) and check that it arrived at hoptoad :)
+
+
+Filtersing your post environment
+--------------------------------
+If you have environmental variables set in your ruby process that should not be sent to hoptoad,
+there's a mechanism for filtering those attributes now.  Throw something like this in 
+config/init.rb
+
+Merb::BootLoader.after_app_loads do
+  HoptoadNotifier.environment_filters = %w(^AWS ^EC2 SECRET PRIVATE KEY)
+end
+
+Each of these words will be compiled into a regex so you should be able to use anchors if needed.
+
+Thanks to the following GitHubbers
+----------------------------------
+joakimk, fairchild and cv.

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'merb-core/version'
+require 'spec/rake/spectask'
+require 'bundler'
+
+install_home = ENV['GEM_HOME'] ? "-i #{ENV['GEM_HOME']}" : ""
+
+NAME = "merb_hoptoad_notifier"
+GEM_VERSION = "1.0.10"
+AUTHOR = "Corey Donohoe"
+EMAIL = 'atmos@atmos.org'
+HOMEPAGE = "http://github.com/atmos/merb_hoptoad_notifier"
+SUMMARY = "Merb plugin that provides hoptoad exception notification"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+  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.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+Spec::Rake::SpecTask.new(:default) do |t|
+  t.spec_opts << %w(-fs --color) << %w(-O spec/spec.opts)
+  t.spec_opts << '--loadby' << 'random'
+  t.spec_files = Dir["spec/*_spec.rb"]
+  t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+  t.rcov_opts << '--exclude' << '.gem/'
+
+  t.rcov_opts << '--text-summary'
+  t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  t.rcov_opts << '--only-uncovered'
+end

data/TODO

@@ -0,0 +1,2 @@
+TODO:
+See if there's any more rich information we could provide to hoptoad

data/lib/merb_hoptoad_notifier/hoptoad_notifier.rb

@@ -0,0 +1,40 @@
+module HoptoadNotifier
+  class << self
+    attr_accessor :api_key, :logger
+  end
+
+  def self.configure
+    key = YAML.load_file(Merb.root / 'config' / 'hoptoad.yml')
+
+    if key
+      env = key[Merb.env.to_sym]
+      env ? @api_key = env[:api_key] : raise(ArgumentError, "No hoptoad key for Merb environment #{Merb.env}")
+    end
+  end
+
+  def self.logger
+    @logger || Merb.logger
+  end
+
+  def self.notify_hoptoad(request, session)
+    request.exceptions.each do |exception|
+      options = {
+        :api_key          => HoptoadNotifier.api_key,
+        :url              => "#{request.protocol}://#{request.host}#{request.path}",
+        :component        => request.params['controller'],
+        :action           => request.params['action'],
+        :request          => request,
+        :framework_env    => Merb.env,
+        :notifier_name    => 'Merb::HoptoadNotifier',
+        :notifier_version => '1.0.10',
+        :session          => session.to_hash
+      }
+      dispatcher.post!(exception, options, {'X-Hoptoad-Client-Name' => 'Merb::HoptoadNotifier'})
+    end
+    true
+  end
+
+  def self.dispatcher
+    @dispatcher ||= ToadHopper.new(api_key)
+  end
+end

data/lib/merb_hoptoad_notifier.rb

@@ -0,0 +1,9 @@
+if defined?(Merb::Plugins)
+  libdir = File.join(File.dirname(__FILE__), 'merb_hoptoad_notifier')
+  require 'toadhopper'
+  require File.join(libdir, 'hoptoad_notifier')
+
+  Merb::BootLoader.after_app_loads do
+    HoptoadNotifier.configure
+  end
+end

data/spec/fixtures/hoptoad.yml

@@ -0,0 +1,9 @@
+---
+:development: &defaults
+  :api_key: ZOMGLOLROFLMAO
+
+:test:
+  <<: *defaults
+
+:production:
+  :api_key: UBERSECRETSHIT

data/spec/merb_hoptoad_notifier_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "HoptoadNotifier" do
+  before(:each) do
+    config = { :development => { :api_key=> ENV['MY_HOPTOAD_API_KEY'] || 'blah' } }
+    mock(YAML).load_file(File.join(Merb.root / 'config' / 'hoptoad.yml')) { config }
+
+    HoptoadNotifier.configure
+  end
+  describe "notification" do
+    it "posts to hoptoad" do
+      HoptoadNotifier.notify_hoptoad(fake_request_with_exceptions, { :user_id => 42 })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+Bundler.require_env(:test)
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rr'
+require 'merb-core'
+require 'merb_hoptoad_notifier'
+require 'tmpdir'
+require 'pp'
+
+class TestError < RuntimeError
+end
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+  def fake_request
+    Merb::Test::RequestHelper::FakeRequest.new
+  end
+  def fake_request_with_exceptions(params = { :controller => 'Application', :action => 'index' })
+    request = Merb::Test::RequestHelper::FakeRequest.new(:params => params)
+    begin
+      raise(TestError, 'I like turtles')
+    rescue => e
+      request.exceptions = [ e ]
+    end
+    request
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: merb_hoptoad_notifier
+version: !ruby/object:Gem::Version 
+  version: 1.0.10
+platform: ruby
+authors: 
+- Corey Donohoe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.9
+    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: Merb plugin that provides hoptoad exception notification
+email: atmos@atmos.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb_hoptoad_notifier/hoptoad_notifier.rb
+- lib/merb_hoptoad_notifier.rb
+- spec/fixtures/hoptoad.yml
+- spec/merb_hoptoad_notifier_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/atmos/merb_hoptoad_notifier
+licenses: []
+
+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: merb
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Merb plugin that provides hoptoad exception notification
+test_files: []
+