errorinbox 0.0.1a

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rack"
+gem "rspec", "~> 2.14.1"
+gem "webmock", "~> 1.13.0"
+gem "timecop", "~> 0.6.3"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rafael Souza
+
+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,29 @@
+# ErrorInbox
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'error_inbox'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install error_inbox
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/errorinbox.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "error_inbox/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "errorinbox"
+  spec.version       = ErrorInbox::VERSION
+  spec.authors       = ["Rafael Souza"]
+  spec.email         = ["me@rafaelss.com"]
+  spec.description   = %q{Send exceptions to errorinbox.com}
+  spec.summary       = %q{Capture and send all exceptions raised by your app to errorinbox.com}
+  spec.homepage      = "http://github.com/rafaelss/errorinbox"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/error_inbox/configuration.rb

@@ -0,0 +1,5 @@
+module ErrorInbox
+  class Configuration
+    attr_accessor :username, :password
+  end
+end

data/lib/error_inbox/notifier.rb

@@ -0,0 +1,72 @@
+require "net/http"
+require "json"
+
+module ErrorInbox
+  class Notifier
+    def initialize(options)
+      @options = options
+    end
+
+    def save(ex)
+      unless ErrorInbox.configuration.username && ErrorInbox.configuration.password
+        raise MissingCredentialsError
+      end
+
+      uri = URI("http://oops.errorinbox.com/")
+      req = Net::HTTP::Post.new(uri.path)
+      req.basic_auth(ErrorInbox.configuration.username, ErrorInbox.configuration.password)
+      req["Content-Type"] = "application/json"
+      req.body = prepare_body(ex)
+      res = Net::HTTP.start(uri.host, uri.port) do |http|
+        http.request(req)
+      end
+
+      case res
+      when Net::HTTPCreated
+        JSON.load(res.body)["id"]
+      when Net::HTTPForbidden
+        raise InvalidCredentialsError
+      else
+        raise "Unknow error: #{res}"
+      end
+    end
+
+    protected
+
+    def prepare_body(ex)
+      body = {
+        :type => ex.class.name,
+        :message => ex.message,
+        :backtrace => ex.backtrace.join("\n"),
+        :environmentName => ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development",
+        :occurredAt => Time.now.xmlschema
+      }
+
+      if rack_env
+        require "rack"
+        body[:request] = { :url => ::Rack::Request.new(rack_env).url }
+
+        body[:environment] = {}
+        rack_env.each do |key, value|
+          body[:environment][key] = value.to_s
+        end
+
+        if rack_session
+          rack_session.each do |key, value|
+            body[:session][key] = value.to_s
+          end
+        end
+      end
+
+      JSON.dump(body)
+    end
+
+    def rack_env
+      @rack_env ||= @options[:rack_env] if @options[:rack_env].respond_to?(:each)
+    end
+
+    def rack_session
+      @rack_session ||= rack_env["rack.session"] if rack_env["rack.session"].respond_to?(:each)
+    end
+  end
+end

data/lib/error_inbox/rack.rb

@@ -0,0 +1,28 @@
+module ErrorInbox
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        response = @app.call(env)
+      rescue Exception => raised
+        ErrorInbox.notify(raised, env)
+        raise raised
+      end
+
+      if framework_exception(env)
+        ErrorInbox.notify(framework_exception(env), env)
+      end
+
+      response
+    end
+
+    protected
+
+    def framework_exception(env)
+      env["rack.exception"] || env["action_dispatch.exception"] || env["sinatra.error"]
+    end
+  end
+end

data/lib/error_inbox/version.rb

@@ -0,0 +1,3 @@
+module ErrorInbox
+  VERSION = "0.0.1a"
+end

data/lib/error_inbox.rb

@@ -0,0 +1,21 @@
+require "error_inbox/version"
+require "error_inbox/notifier"
+require "error_inbox/configuration"
+
+module ErrorInbox
+  class MissingCredentialsError < StandardError; end
+  class InvalidCredentialsError < StandardError; end
+
+  def self.notify(ex, env)
+    notifier = Notifier.new(env)
+    notifier.save(ex)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end

data/lib/errorinbox.rb

@@ -0,0 +1 @@
+require "error_inbox"

data/spec/error_inbox/notifier_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe ErrorInbox::Notifier do
+  let(:ex) { double("exception", :message => "some message", :backtrace => ["a.rb:10", "b.rb:11"]) }
+
+  around do |example|
+    Timecop.travel(2013, 8, 21, 11, 57, 0) do
+      example.run
+    end
+  end
+
+  it "sends rack exceptions" do
+    ErrorInbox.stub(:configuration => double("configuration", :username => "foo", :password => "bar"))
+
+    stub_request(:post, "http://foo:bar@oops.errorinbox.com").
+      with(
+        :body => "{\"type\":\"RSpec::Mocks::Mock\",\"message\":\"some message\",\"backtrace\":\"a.rb:10\\nb.rb:11\",\"environmentName\":null,\"occurredAt\":\"2013-08-21T11:57:00-03:00\",\"request\":{\"url\":\"://::0\"},\"environment\":{\"foo\":\"bar\"}}",
+        :headers => { "Content-Type" => "application/json" }
+      ).
+      to_return(
+        :status => 201,
+        :body => "{\"id\":1}",
+        :headers => { "Content-Type" => "application/json" }
+      )
+
+    notifier = described_class.new(:rack_env => { :foo => "bar" })
+    expect(notifier.save(ex)).to eq(1)
+  end
+
+  it "raises an error if credentials are missing" do
+    ErrorInbox.stub(:configuration => double("configuration", :username => nil, :password => nil))
+
+    notifier = described_class.new(:rack_env => { :foo => "bar" })
+    expect { notifier.save(ex) }.to raise_error(ErrorInbox::MissingCredentialsError)
+  end
+
+  it "raises an error if credentials are invalid" do
+    ErrorInbox.stub(:configuration => double("configuration", :username => "foo", :password => "bar"))
+
+    stub_request(:post, "http://foo:bar@oops.errorinbox.com").
+      with(
+        :body => "{\"type\":\"RSpec::Mocks::Mock\",\"message\":\"some message\",\"backtrace\":\"a.rb:10\\nb.rb:11\",\"environmentName\":null,\"occurredAt\":\"2013-08-21T11:57:00-03:00\",\"request\":{\"url\":\"://::0\"},\"environment\":{\"foo\":\"bar\"}}",
+        :headers => { 'Content-Type'=>'application/json' }
+      ).
+      to_return(
+        :status => 403,
+        :body => "{\"error\":\"forbidden\"}",
+        :headers => { "Content-Type" => "application/json" }
+      )
+
+    notifier = described_class.new(:rack_env => { :foo => "bar" })
+    expect { notifier.save(ex) }.to raise_error(ErrorInbox::InvalidCredentialsError)
+  end
+end

data/spec/error_inbox/rack_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+require "error_inbox/rack"
+
+describe ErrorInbox::Rack do
+  let(:app) { double("app") }
+  subject { described_class.new(app) }
+
+  it "sends exception raised by app#call" do
+    app.
+      should_receive(:call).
+      with({}).
+      and_raise(RuntimeError)
+
+    ErrorInbox.
+      should_receive(:notify).
+      with(an_instance_of(RuntimeError), {}).
+      once
+
+    expect { subject.call({}) }.to raise_error(RuntimeError)
+  end
+
+  it "sends exception stored in rack.exception env variable" do
+    error = double("error")
+    env = { "rack.exception" => error }
+
+    app.
+      should_receive(:call).
+      with(env).
+      and_return("response")
+
+    ErrorInbox.
+      should_receive(:notify).
+      with(error, env).
+      once
+
+    expect(subject.call(env)).to eq("response")
+  end
+
+  it "sends exception stored in action_dispatch.exception env variable" do
+    error = double("error")
+    env = { "action_dispatch.exception" => error }
+
+    app.
+      should_receive(:call).
+      with(env).
+      and_return("response")
+
+    ErrorInbox.
+      should_receive(:notify).
+      with(error, env).
+      once
+
+    expect(subject.call(env)).to eq("response")
+  end
+
+  it "sends exception stored in sinatra.error env variable" do
+    error = double("error")
+    env = { "sinatra.error" => error }
+
+    app.
+      should_receive(:call).
+      with(env).
+      and_return("response")
+
+    ErrorInbox.
+      should_receive(:notify).
+      with(error, env).
+      once
+
+    expect(subject.call(env)).to eq("response")
+  end
+
+  it "does nothing if no errors at all" do
+    app.
+      should_receive(:call).
+      with({}).
+      and_return("response")
+
+    expect(subject.call({})).to eq("response")
+  end
+end

data/spec/error_inbox_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe ErrorInbox do
+  describe ".notify" do
+    let(:ex) { double("exception") }
+    let(:env) { { :foo => "bar" } }
+
+    it "calls notifier to handle the exception" do
+      ErrorInbox::Notifier.
+        should_receive(:new).
+        with(env).
+        and_return(notifier = double("notifier"))
+
+      notifier.
+        should_receive(:save).
+        with(ex).
+        and_return(true)
+
+      expect(described_class.notify(ex, env)).to eq(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "errorinbox"
+require "webmock/rspec"
+require "timecop"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: errorinbox
+version: !ruby/object:Gem::Version
+  version: 0.0.1a
+  prerelease: 5
+platform: ruby
+authors:
+- Rafael Souza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send exceptions to errorinbox.com
+email:
+- me@rafaelss.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- errorinbox.gemspec
+- lib/error_inbox.rb
+- lib/error_inbox/configuration.rb
+- lib/error_inbox/notifier.rb
+- lib/error_inbox/rack.rb
+- lib/error_inbox/version.rb
+- lib/errorinbox.rb
+- spec/error_inbox/notifier_spec.rb
+- spec/error_inbox/rack_spec.rb
+- spec/error_inbox_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rafaelss/errorinbox
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1940987844180716958
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Capture and send all exceptions raised by your app to errorinbox.com
+test_files:
+- spec/error_inbox/notifier_spec.rb
+- spec/error_inbox/rack_spec.rb
+- spec/error_inbox_spec.rb
+- spec/spec_helper.rb