sinatra-exceptional 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-exceptional.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kyle Drake
+
+MIT License
+
+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,64 @@
+# Sinatra::Exceptional
+
+This is a plugin for exceptional and Sinatra. I am using it manually via the Sinatra error block, and it doesn't really work automatically yet. As such, it's probably not very useful for most people.
+
+But it's a good starting point for Sinatra support, so if you'd like to hack on this, let me know and I'll add you as a contributor!
+
+The one feature I've added (for reason of personal requirement) is params filtering, so you can block out passwords from your exception reports.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-exceptional', :require => 'sinatra/exceptional'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-exceptional
+
+## Usage
+
+    require 'sinatra'
+    require 'sinatra/exceptional'
+
+    configure do
+      Exceptional.logger
+    end
+
+    set :exceptional_options, {
+      key: 'YOUR APP KEY',
+      params_filter: /password/i
+    }
+
+    # Test with curl -d "password=sex" http://127.0.0.1:4567
+    post '/' do
+      raise StandardError, 'testing!'
+    end
+
+    error do
+      report_exception # This sends the exception to Exceptional, but does not halt.
+      'derp'
+    end
+
+## Running the Tests
+
+    $ bundle install
+    $ bundle exec rake
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+* Automatic exceptions
+* Tests need to use webmock
+* Tests for password filter (can't really do it without the mock)

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+# To run tests in the order of a seed: bundle exec rake test TESTOPTS="--seed=987"
+Rake::TestTask.new do |t| 
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :test

data/lib/sinatra/exceptional.rb

@@ -0,0 +1,71 @@
+require 'exceptional'
+require 'sinatra/base'
+require 'sinatra/exceptional/version'
+require 'digest/md5'
+
+module Exceptional
+  class Catcher
+    class << self
+      def handle_with_sinatra(exception, environment, request, opts)
+        if Config.should_send_to_api?
+          data = SinatraExceptionData.new exception, environment, request, opts
+          Remote.error data
+        end
+      end
+    end
+  end
+
+  class SinatraExceptionData < ExceptionData
+    FILTERED_TEXT = '[FILTERED]'
+
+    def initialize(exception, environment, request, opts={})
+      super exception
+      @opts = opts
+      @environment = environment
+      @request = request
+    end
+
+    def framework
+      "sinatra"
+    end
+
+    def extra_stuff
+      params = {}
+
+      if @opts && @opts[:params_filter]
+        @request.params.each do |k,v|
+          params[k] =  k.to_s.match(@opts[:params_filter]) ? FILTERED_TEXT : v
+        end
+      else
+        params = @request.params
+      end
+
+      return {} if @request.nil?
+      {
+        'request' => {
+          'url' => "#{@request.url}",
+          'parameters' => params,
+          'request_method' => @request.request_method.to_s,
+          'remote_ip' => @request.ip,
+          'headers' => extract_http_headers(@environment),
+          'session' => self.class.sanitize_session(@request)
+        }
+      }
+    end
+  end
+end
+
+module Sinatra
+  module Exceptional
+    def self.registered(app)
+      app.helpers do
+        def report_exception
+          ::Exceptional.configure settings.exceptional_options[:key] unless ::Exceptional::Config.api_key
+          ::Exceptional::Catcher.handle_with_sinatra env['sinatra.error'], ENV, request, settings.exceptional_options
+        end
+      end
+    end
+  end
+
+  register Exceptional
+end

data/lib/sinatra/exceptional/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Exceptional
+    VERSION = "0.0.1"
+  end
+end

data/sinatra-exceptional.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sinatra/exceptional/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kyle Drake"]
+  gem.email         = ["kyledrake@gmail.com"]
+  gem.description   = %q{Sinatra adapter for use with exceptional}
+  gem.summary       = %q{Sinatra adapter for use with exceptional, in case you need it}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "sinatra-exceptional"
+  gem.require_paths = ["lib"]
+  gem.version       = Sinatra::Exceptional::VERSION
+  gem.add_dependency 'exceptional'
+  gem.add_dependency 'sinatra'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'json_pure'
+  gem.add_development_dependency 'pry'
+end

data/spec/sinatra_exceptional_spec.rb

@@ -0,0 +1,69 @@
+ENV['RACK_ENV'] = 'production'
+require File.join(File.join(File.expand_path(File.dirname(__FILE__))), '..', 'lib', 'sinatra', 'exceptional')
+require 'rack/test'
+require 'minitest/autorun'
+require 'webmock'
+require 'json'
+
+include Rack::Test::Methods
+include WebMock::API
+
+def mock_app(&block)
+  @app = Sinatra.new PartyHard, &block
+end
+
+class PartyHard < Sinatra::Base
+  class AndrewWKPartyError < StandardError; end
+
+  set :exceptional_options, {
+    key: 'key'
+  }
+  register Sinatra::Exceptional
+
+  set :show_exceptions, false
+  set :raise_errors,    true
+
+  get '/partyhard' do
+    'HELL YEAH'
+  end
+
+  get '/partyfail' do
+    raise AndrewWKPartyError, 'you were just kicked in the face by a crowd surfer wearing combat boots'
+  end
+  
+  post '/login' do
+    raise 'hell'
+  end
+
+  error do
+    report_exception
+  end
+
+end
+
+def app
+  @app || mock_app
+end
+
+describe 'A mock app' do
+  it 'doesnt blow anything up' do
+    get '/partyhard'
+    last_response.ok?.must_equal true
+    last_response.body.must_equal 'HELL YEAH'
+  end
+
+  it 'throws an party error like a boss' do
+    lambda {
+      get '/partyfail'
+    }.must_raise PartyHard::AndrewWKPartyError
+  end
+
+  it 'returns error with raise errors false' do
+    mock_app {
+      set :raise_errors, false
+    }
+    get '/partyfail'
+    last_response.status.must_equal 500
+    last_response.errors.must_match /AndrewWKPartyError/
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-exceptional
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kyle Drake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: exceptional
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: pry
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: Sinatra adapter for use with exceptional
+email: 
+- kyledrake@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/exceptional.rb
+- lib/sinatra/exceptional/version.rb
+- sinatra-exceptional.gemspec
+- spec/sinatra_exceptional_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Sinatra adapter for use with exceptional, in case you need it
+test_files: 
+- spec/sinatra_exceptional_spec.rb