errplane 0.1.9 → 0.2.0

data/README.md

@@ -1,6 +1,62 @@
 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.
+This gem integrates your 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.
+This gem currently has support for Ruby on Rails (3.x), Sinatra, Resque, and Capistrano.
+
+Support
+-------
+
+Running into any issues? Get in touch with us at [support@errplane.com](mailto:support@errplane.com).
+
+Ruby on Rails Installation
+--------------------------
+
+Start by adding the gem to your Gemfile:
+
+    gem "errplane"
+
+Then, issue the following commands in your application's root directory:
+
+    bundle
+    rails g errplane --api-key your-api-key-goes-here
+
+This will create `config/initializers/errplane.rb` for you automatically. If you want to make sure that everything's working correctly, just run:
+
+    bundle exec rake errplane:test
+
+You should be able to view the exception at [http://errplane.com](http://errplane.com) and also receive an email notification of the test exception.
+
+Capistrano Integration
+----------------------
+
+In your `config/deploy.rb`, add the following line:
+
+    require 'errplane/capistrano'
+
+This will automatically pull your API key from the Rails initializer and notify Errplane of every deployment.
+
+Resque Integration With Multiple Failure Backends
+-------------------------------------------------
+
+This gem also supports notifications from failed Resque jobs. Just add the following to the an initializer:
+
+    require 'resque/failure/multiple'
+    require 'resque/failure/redis'
+    require 'errplane/resque'
+
+    Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Errplane]
+    Resque::Failure.backend = Resque::Failure::Multiple
+
+Don't forget that you can refer to `config/initializers/errplane.rb` for the relevant configuration values.
+
+Contributing
+------------
+
+We love contributions. Want to add support for something you don't already see here? Fork this repository and send us a pull request.
+
+Copyright
+---------
+
+Copyright (c) 2012 Errplane, Inc.

data/lib/errplane/black_box.rb

@@ -6,6 +6,7 @@ module Errplane
     attr_reader :controller
     attr_reader :action
     attr_reader :request_url
+    attr_reader :custom_data
 
     def initialize(params = {})
       @exception = params[:exception]
@@ -14,6 +15,7 @@ module Errplane
       @controller = params[:controller]
       @action = params[:action]
       @request_url = params[:request_url]
+      @custom_data = params[:custom_data] || {}
     end
 
     def to_json
@@ -30,7 +32,8 @@ module Errplane
         :language_version => "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
         :environment_variables => ENV.to_hash,
         :reporter => reporter,
-        :request_data => request_data
+        :request_data => request_data,
+        :custom_data => @custom_data
       }.to_json
     end
 
@@ -38,7 +41,7 @@ module Errplane
       {
         :name => "Errplane",
         :version => Errplane::VERSION,
-        :url => "http://github.com/errplane/gem"
+        :url => "https://github.com/errplane/gem"
       }
     end
 

data/lib/errplane/capistrano.rb

@@ -10,14 +10,16 @@ Capistrano::Configuration.instance(:must_exist).load do
       puts "Notifying Errplane of the deployment.."
       framework_env = fetch(:rails_env, fetch(:errplane_env, 'production'))
       load File.join(Dir.pwd, "config/initializers/errplane.rb")
+      Errplane.configuration.rails_environment = framework_env
 
       deploy_options = {
-        :framework_env => framework_env,
-        :scm_revision => current_revision,
-        :scm_repository => repository,
-        :api_key => Errplane.configuration.api_key
+        :environment => framework_env,
+        :revision => current_revision,
+        :repository => repository,
+        :scm => scm,
+        :host => host
       }
-      Errplane::Deployment.new.announce!(deploy_options)
+      Errplane::Transmitter.new.relay(deploy_options, true)
       puts 'Done.'
     end
   end

data/lib/errplane/resque.rb

@@ -0,0 +1,21 @@
+begin
+  require 'errplane'
+rescue LoadError
+  raise "Can't find 'errplane' gem. Please add it to your Gemfile or install it."
+end
+
+module Resque
+  module Failure
+    class Errplane < Base
+      def save
+        ::Errplane.transmit_unless_ignorable(exception, :custom_data => {
+          :resque => {
+            :payload => payload,
+            :worker => worker,
+            :queue => queue
+          }
+        })
+      end
+    end
+  end
+end

data/lib/errplane/transmitter.rb

@@ -3,15 +3,15 @@ module Errplane
     def initialize(params = {})
     end
 
-    def relay(black_box)
+    def relay(black_box, deployment = false)
       http = initialize_http_connection
       data = black_box.to_json
       response = begin
-                   url = "/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/#{Errplane.configuration.rails_environment}?api_key=#{Errplane.configuration.api_key}"
-                   ::Rails.logger.info("\nURL: #{url}")
-                   ::Rails.logger.info("\nData: #{data.inspect}")
+                   url = "/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/#{Errplane.configuration.rails_environment}#{"/deploy" if deployment}?api_key=#{Errplane.configuration.api_key}"
+                   Errplane.configuration.logger.info("\nURL: #{url}") if Errplane.configuration.debug?
+                   Errplane.configuration.logger.info("\nData: #{data.inspect}") if Errplane.configuration.debug?
                    response = http.post(url, data)
-                   ::Rails.logger.info("\nException Response: #{response.inspect}")
+                   Errplane.configuration.logger.info("\nException Response: #{response.inspect}") if Errplane.configuration.debug?
                    response
                  rescue Exception => e
                    # e

data/lib/errplane/version.rb

@@ -1,3 +1,3 @@
 module Errplane
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errplane
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-29 00:00:00.000000000 Z
+date: 2012-07-03 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides exception reporting with Errplane for Rails 3.x applications.
 email:
@@ -29,11 +29,11 @@ files:
 - lib/errplane/black_box.rb
 - lib/errplane/capistrano.rb
 - lib/errplane/configuration.rb
-- lib/errplane/deployment.rb
 - lib/errplane/rack.rb
 - lib/errplane/rails/air_traffic_controller.rb
 - lib/errplane/rails/middleware/hijack_render_exception.rb
 - lib/errplane/railtie.rb
+- lib/errplane/resque.rb
 - lib/errplane/sinatra.rb
 - lib/errplane/transmitter.rb
 - lib/errplane/version.rb

data/lib/errplane/deployment.rb

@@ -1,21 +0,0 @@
-module Errplane
-  class Deployment
-    def announce
-      http = Net::HTTP.new(Errplane.configuration.api_host, "80")
-      url = "/api/v1/deployments"
-      data = {}
-      response = begin
-                   http.post(url, data)
-                 rescue Exception => e
-                   # e
-                 end
-
-      case response
-      when Net::HTTPSuccess
-        # Success
-      else
-        # Failure
-      end
-    end
-  end
-end