frontend_rescue 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2ced1a4be7ab52073b8406376cfdaac662b2814
+  data.tar.gz: da28ed7391db65902d5287fd28b10087c094e01c
+SHA512:
+  metadata.gz: be65b4db96136789ebb756a43bcad79258b6d3740a50eaa34494243061f4337fc3c9f72effcdaf42f355989a336613453e040c9378d7d46c819799d9e4c600cb
+  data.tar.gz: 351e679c08cdb0b9d43c01a5614fc402f0f21a8748547d81b4489acda559f25e33759960b8c58a991d4c27dc24dff38e6c3649ec1240b8ae017e406edc9818cd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jim Durand
+
+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,94 @@
+#### Frontend Rescue
+
+frontend_rescue provides a backend endpoint for your frontend JavaScript application to send errors to when they’re caught.
+
+This makes it easier to integrate your frontend stack traces to your backend analytics.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'frontend_rescue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install frontend_rescue
+
+## Backend Usage
+
+#### Rails
+
+    Rails.application.configure do
+      config.middleware.use ClientErrorHandler::Middleware, paths: ['/frontend-error']
+    end
+
+#### Options
+
+**status_code**
+
+By default, frontend_rescue will respond with a ```500 (Server Error)```.
+
+You can override this value with any HTTP status code you like :
+
+    config.middleware.use ClientErrorHandler::Middleware, paths: ['/frontend-error'],
+                                                          status_code: 200
+
+**silent**
+
+By default, frontend_rescue will output the frontend error to the logs.
+
+You can pass in ```silent: true```, frontend errors are not logged. You will likely use this option when passing a block.
+
+**&block**
+
+You can pass in a block to frontend_rescue and it will be called and passed a FrontendRescue::Error and a Rack::Request :
+
+    config.middleware.use ClientErrorHandler::Middleware, paths: ['/frontend-error'],
+                                                          status_code: 200,
+                                                          silent: true do |error, request|
+      NewRelic::Agent.notice_error(error)
+    end
+
+
+#### Sinatra
+
+    use ClientErrorHandler::Middleware, paths: ['/frontend-error']
+
+With the options described above.
+
+## Frontend Usage
+
+Ideally you should catch all JavaScript errors and **post** them to your endpoint. Frontend frameworks like ember.js make this easy.
+
+Ember example :
+
+    Ember.onerror = function(error) {
+      Ember.$.ajax('/frontend-error', {
+        type: 'POST',
+        data: {
+          name: 'My App',
+          user_agent: navigator.userAgent,
+          message: error.message,
+          stack: error.stack
+        }
+      });
+    };
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/frontend_rescue/fork )
+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 a new Pull Request
+
+## TODO
+
+1. Tests...

data/Rakefile

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

data/frontend_rescue.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'frontend_rescue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "frontend_rescue"
+  spec.version       = FrontendRescue::VERSION
+  spec.authors       = ["Jim Durand"]
+  spec.email         = ["me@jdurand.com"]
+  spec.summary       = "Provides a backend endpoint for your frontend JavaScript application to send errors to when they’re caught"
+  spec.description   = "Provides a backend endpoint for your frontend JavaScript application to send errors to when they’re caught. This makes it easier to integrate your frontend stack traces to your backend analytics."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/frontend_rescue/error.rb

@@ -0,0 +1,17 @@
+module FrontendRescue
+  class Error < StandardError
+    def initialize(name, user_agent, message, trace)
+      @trace = trace.split("\n") if trace.is_a? String
+      @user_agent = user_agent
+      super "Uncaught #{name} Error: #{message}"
+    end
+
+    def backtrace
+      ["User Agent: #{user_agent}"] + @trace
+    end
+
+    def user_agent
+      @user_agent
+    end
+  end
+end

data/lib/frontend_rescue/middleware.rb

@@ -0,0 +1,42 @@
+module FrontendRescue
+  class Middleware
+    def initialize(app, opts, &block)
+      @app = app
+      @opts = opts
+      @block = block
+    end
+
+    def call(env)
+      if env['REQUEST_METHOD'] == 'POST' && @opts[:paths].include?(env['PATH_INFO'])
+        handle_error Rack::Request.new(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+      def handle_error(request)
+        error = FrontendRescue::Error.new request.params['name'],
+                                          request.params['user_agent'],
+                                          request.params['message'],
+                                          request.params['stack']
+
+        request.env['rack.errors'].puts "Processing #{error.class}" unless @opts[:silent]
+
+        if @block
+          @block.call(error, request)
+        end
+
+        unless @opts[:silent]
+          request.env['rack.errors'].puts error.message
+          request.env['rack.errors'].puts error.backtrace.join("\n")
+          request.env['rack.errors'].flush
+        end
+
+        code = @opts[:status_code] || 500
+        request.env['rack.errors'].puts "Completed #{code} OK"
+        [code, {}, []]
+      end
+
+  end
+end

data/lib/frontend_rescue/version.rb

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

data/lib/frontend_rescue.rb

@@ -0,0 +1,6 @@
+require "frontend_rescue/version"
+require "frontend_rescue/error"
+require "frontend_rescue/middleware"
+
+module FrontendRescue
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: frontend_rescue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jim Durand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Provides a backend endpoint for your frontend JavaScript application
+  to send errors to when they’re caught. This makes it easier to integrate your frontend
+  stack traces to your backend analytics.
+email:
+- me@jdurand.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- frontend_rescue.gemspec
+- lib/frontend_rescue.rb
+- lib/frontend_rescue/error.rb
+- lib/frontend_rescue/middleware.rb
+- lib/frontend_rescue/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Provides a backend endpoint for your frontend JavaScript application to send
+  errors to when they’re caught
+test_files: []
+has_rdoc: