errplane 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p125@errplane_rails --create

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  gem "capybara"
+  gem "combustion"
+  gem "rspec-rails"
+  gem "sqlite3"
+  gem "webmock"
+end

data/README.md

@@ -0,0 +1,6 @@
+Errplane
+========
+
+This gem helps you integrate your Ruby on Rails applications with [Errplane](http://errplane.com), a cloud-based tool for handling exceptions, log aggregation, uptime monitoring, and alerting.
+
+It's a gem. You can figure out the rest.

data/Rakefile

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

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/errplane.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "errplane/version"
+
+Gem::Specification.new do |s|
+  s.name        = "errplane"
+  s.version     = Errplane::VERSION
+  s.authors     = ["Todd Persen"]
+  s.email       = ["todd@errplane.com"]
+  s.homepage    = "http://errplane.com"
+  s.summary     = %q{Rails exception reporting for Errplane.}
+  s.description = %q{This gem provides exception reporting with Errplane for Rails 3.x applications.}
+
+  s.rubyforge_project = "errplane"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # s.add_development_dependency "combustion"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/errplane.rb

@@ -0,0 +1,57 @@
+require 'net/http'
+require 'net/https'
+require 'rubygems'
+
+begin
+  require 'active_support'
+  require 'active_support/core_ext'
+rescue LoadError
+  require 'activesupport'
+  require 'activesupport/core_ext'
+end
+
+require "errplane/version"
+require "errplane/black_box"
+require "errplane/configuration"
+require "errplane/transmitter"
+require "errplane/rack"
+
+require "errplane/railtie" #if defined?(Rails)
+
+module Errplane
+  API_HOST = "api.errplane.com"
+
+  class << self
+    attr_writer :configuration
+    attr_accessor :transmitter
+
+    def configure(silent = false)
+      yield(configuration)
+      self.transmitter = Transmitter.new(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def transmit_to_api(exception)
+      transmitter.relay(assemble_black_box_for(exception))
+    end
+
+    private
+    def assemble_black_box_for(exception, options = {})
+      exception = unwrap_exception(exception)
+      black_box = BlackBox.new(exception: exception)
+    end
+
+    def unwrap_exception(exception)
+      if exception.respond_to?(:original_exception)
+        exception.original_exception
+      elsif exception.respond_to?(:continued_exception)
+        exception.continued_exception
+      else
+        exception
+      end
+    end
+  end
+end

data/lib/errplane/black_box.rb

@@ -0,0 +1,17 @@
+module Errplane
+  class BlackBox
+    attr_reader :exception
+
+    def initialize(params = {})
+      @exception = params[:exception]
+    end
+
+    def to_json
+      {
+        :time => Time.now.to_i,
+        :message => @exception.message,
+        :backtrace => @exception.backtrace
+      }.to_json
+    end
+  end
+end

data/lib/errplane/configuration.rb

@@ -0,0 +1,11 @@
+module Errplane
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :application_id
+
+    attr_accessor :logger
+    attr_accessor :environment_name
+    attr_accessor :project_root
+    attr_accessor :framework
+  end
+end

data/lib/errplane/rack.rb

@@ -0,0 +1,18 @@
+module Errplane
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        response = @app.call(env)
+      rescue => e
+        Errplane.transmit_to_api(e)
+        raise
+      end
+
+      response
+    end
+  end
+end

data/lib/errplane/rails/middleware/hijack_render_exception.rb

@@ -0,0 +1,17 @@
+module Errplane
+  module Rails
+    module Middleware
+      module HijackRenderException
+        def self.included(base)
+          base.send(:alias_method_chain,:render_exception,:errplane)
+        end
+
+        def render_exception_with_errplane(env,exception)
+          Errplane.transmit_to_api(exception)
+          render_exception_without_errplane(env,exception)
+        end
+      end
+    end
+  end
+end
+

data/lib/errplane/railtie.rb

@@ -0,0 +1,30 @@
+require 'errplane'
+require 'rails'
+
+module Errplane
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+    end
+
+    initializer "errplane.insert_rack_middleware" do |app|
+      app.config.middleware.insert 0, Errplane::Rack
+    end
+
+    config.after_initialize do
+      Errplane.configure(true) do |config|
+        config.logger           ||= ::Rails.logger
+        config.environment_name ||= ::Rails.env
+        config.project_root     ||= ::Rails.root
+        config.framework        = "Rails: #{::Rails::VERSION::STRING}"
+      end
+
+      if defined?(::ActionDispatch::DebugExceptions)
+        require 'errplane/rails/middleware/hijack_render_exception'
+        ::ActionDispatch::DebugExceptions.send(:include,Errplane::Rails::Middleware::HijackRenderException)
+      elsif defined?(::ActionDispatch::ShowExceptions)
+        require 'errplane/rails/middleware/hijack_render_exception'
+        ::ActionDispatch::ShowExceptions.send(:include,Errplane::Rails::Middleware::HijackRenderException)
+      end
+    end
+  end
+end

data/lib/errplane/transmitter.rb

@@ -0,0 +1,33 @@
+module Errplane
+  class Transmitter
+    def initialize(params = {})
+    end
+
+    def relay(black_box)
+      http = initialize_http_connection
+      data = black_box.to_json
+      response = begin
+                   url = "/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/#{Errplane.configuration.environment_name}?api_key=#{Errplane.configuration.api_key}"
+                   ::Rails.logger.info(url)
+                   http.post("/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/#{Errplane.configuration.environment_name}?api_key=#{Errplane.configuration.api_key}", data)
+                 rescue Exception => e
+                   e
+                 end
+      ::Rails.logger.info("Exception Data: #{data}")
+      ::Rails.logger.info("Exception Body: #{response.body}")
+      ::Rails.logger.info("Exception Response: #{response.inspect}")
+
+      case response
+      when Net::HTTPSuccess
+        # Success
+      else
+        # Failure
+      end
+    end
+
+    private
+    def initialize_http_connection
+      connection = Net::HTTP.new(API_HOST, "80")
+    end
+  end
+end

data/lib/errplane/version.rb

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

data/lib/rails/generators/errplane/errplane_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+
+class ErrplaneGenerator < Rails::Generators::Base
+  desc "Description:\n  This creates a Rails initializer for Errplane."
+
+  source_root File.expand_path('../templates', __FILE__)
+  argument :api_key,
+    required: false,
+    type: :string,
+    description: "API Key for your Errplane Organization"
+  argument :application_id,
+    required: false,
+    default: lambda { Time.now.to_s },
+    type: :string,
+    description: "API Key for your Errplane Organization"
+
+  def copy_initializer_file
+    template "initializer.rb", "config/initializers/errplane.rb"
+  end
+
+  def install
+  end
+end

data/lib/rails/generators/errplane/templates/initializer.rb

@@ -0,0 +1,4 @@
+Errplane.configure do |config|
+  config.api_key = "<%= api_key %>"
+  config.application_id = "<%= application_id %>"
+end

data/spec/controllers/widgets_controller_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe WidgetsController do
+  describe "#new" do
+    it "should raise an exception" do
+      expect { get :new }.to raise_error(ZeroDivisionError)
+    end
+  end
+
+  describe "#index" do
+    it "should not raise an exception" do
+      expect { get :index }.to_not raise_error
+    end
+  end
+end

data/spec/integration/exceptions_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + "/integration_helper"
+
+feature "exception handling" do
+  describe "in an action that raises an exception" do
+    scenario "should make an HTTP call to the API" do
+      stub_request(:post, "#{Errplane::API_HOST}/exceptions").to_return(status: 200)
+
+      lambda { visit new_widget_path }.should raise_error
+
+      assert_requested :post, "#{Errplane::API_HOST}/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012"
+    end
+  end
+
+  describe "in an action that does not raise an exception" do
+    scenario "should not make an HTTP call to the API" do
+      lambda { visit widgets_path }.should_not raise_error
+
+      assert_not_requested :post, "#{Errplane::API_HOST}/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012"
+    end
+  end
+end

data/spec/integration/integration_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../spec_helper"

data/spec/internal/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/internal/app/controllers/widgets_controller.rb

@@ -0,0 +1,9 @@
+class WidgetsController < ApplicationController
+  def index
+    render :nothing => true
+  end
+
+  def new
+    return 1/0
+  end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/initializers/errplane.rb

@@ -0,0 +1,4 @@
+Errplane.configure do |config|
+  config.api_key = "f123-e456-d789c012"
+  config.application_id = "b12r8c72"
+end

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :widgets
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+require 'capybara/rspec'
+require 'webmock/rspec'
+
+Combustion.initialize!
+
+require 'rspec/rails'
+require 'capybara/rails'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end
+
+class Combustion::Application < Rails::Application
+  config.action_dispatch.show_exceptions = false
+end

data/spec/unit/black_box_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Errplane::BlackBox do
+  before do
+    begin
+      1/0
+    rescue Exception => e
+      @exception = e
+    end
+  end
+
+  describe ".new" do
+    it "should create a new BlackBox" do
+      black_box = Errplane::BlackBox.new
+    end
+
+    it "should accept an exception as a parameter" do
+
+      black_box = Errplane::BlackBox.new(exception: @exception)
+      black_box.should_not be_nil
+    end
+  end
+
+  describe "#to_json" do
+    it "should return a JSON string" do
+      black_box = Errplane::BlackBox.new(exception: @exception)
+      json = JSON.parse(black_box.to_json)
+
+      json["message"].should == "divided by 0"
+      json["time"].should_not be_nil
+      json["backtrace"].should_not be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: errplane
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Todd Persen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-08 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides exception reporting with Errplane for Rails 3.x applications.
+email:
+- todd@errplane.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- config.ru
+- errplane.gemspec
+- lib/errplane.rb
+- lib/errplane/black_box.rb
+- lib/errplane/configuration.rb
+- lib/errplane/rack.rb
+- lib/errplane/rails/middleware/hijack_render_exception.rb
+- lib/errplane/railtie.rb
+- lib/errplane/transmitter.rb
+- lib/errplane/version.rb
+- lib/rails/generators/errplane/errplane_generator.rb
+- lib/rails/generators/errplane/templates/initializer.rb
+- spec/controllers/widgets_controller_spec.rb
+- spec/integration/exceptions_spec.rb
+- spec/integration/integration_helper.rb
+- spec/internal/app/controllers/application_controller.rb
+- spec/internal/app/controllers/widgets_controller.rb
+- spec/internal/config/database.yml
+- spec/internal/config/initializers/errplane.rb
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+- spec/unit/black_box_spec.rb
+homepage: http://errplane.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: errplane
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rails exception reporting for Errplane.
+test_files:
+- spec/controllers/widgets_controller_spec.rb
+- spec/integration/exceptions_spec.rb
+- spec/integration/integration_helper.rb
+- spec/internal/app/controllers/application_controller.rb
+- spec/internal/app/controllers/widgets_controller.rb
+- spec/internal/config/database.yml
+- spec/internal/config/initializers/errplane.rb
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+- spec/unit/black_box_spec.rb