frontend_rescue 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a6c20e54e95fdfe549fb62a0a392aae1eba0b0
-  data.tar.gz: 9f73647e5fee5d0fd519b1c9bf1111eeb629460f
+  metadata.gz: f46c33388484b2bcfdc187c3cfcaab52ee25407d
+  data.tar.gz: e7c6fd26ce64f0142bdb5010c9a50641df0ba2f6
 SHA512:
-  metadata.gz: 4ba0c0e0adc1fd5b131ee8f2d0d3b3ec05554c21fec23d0839553d840c21f944937338d0407154bdb2e7727e165548da4bcbe23baff6c92d3b2fd3fb7c8c1994
-  data.tar.gz: 6971c865f0cb68f1471c555e8a3e026112200a4406357a891ed27f04de630dd431e8d6d714f822798d00a1bc5d23673789149c1920b8e4bb5f5bd045dbb2756d
+  metadata.gz: 238e7f96750be12c652e7721078159fe56c5c5eb848f4915cedb25fef2992a68560070285484ea9f179bf4ec0da2cb47d7e01ba950a31ff37f62276bd9a1e0f1
+  data.tar.gz: ad567c6f91ab1860f41aaff23154c971d58e391265e8e60a0933722ee971bb978338553ffb80f9ce34a392f9027123797dd332fff3d9405a6dac7cf2d7e37443

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: "bundle install && bundle exec rake"
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.1

data/README.md

@@ -1,5 +1,7 @@
 #### Frontend Rescue
 
+[![Build Status](https://travis-ci.org/jdurand/frontend_rescue.svg)](https://travis-ci.org/jdurand/frontend_rescue)
+
 frontend_rescue provides a backend endpoint as a rack middleware 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.
@@ -27,7 +29,7 @@ Or install it yourself as:
 Use the frontend_rescue middleware :
 
     Rails.application.configure do
-      config.middleware.use ClientErrorHandler::Middleware, paths: ['/frontend-error']
+      config.middleware.use FrontendRescue::Middleware, paths: ['/frontend-error']
     end
 
 #### Options
@@ -38,7 +40,7 @@ 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'],
+    config.middleware.use FrontendRescue::Middleware, paths: ['/frontend-error'],
                                                           status_code: 200
 
 **silent**
@@ -47,11 +49,15 @@ 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.
 
+**exclude_user_agent**
+
+You might want to ignore certain user agents. You can exlude user agents with a Regexp: ```exclude_user_agent: /Googlebot/```.
+
 **&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'],
+    config.middleware.use FrontendRescue::Middleware, paths: ['/frontend-error'],
                                                           status_code: 200,
                                                           silent: true do |error, request|
       NewRelic::Agent.notice_error(error)
@@ -60,7 +66,7 @@ You can pass in a block to frontend_rescue and it will be called and passed a Fr
 
 #### Sinatra
 
-    use ClientErrorHandler::Middleware, paths: ['/frontend-error']
+    use FrontendRescue::Middleware, paths: ['/frontend-error']
 
 With the options described above.
 
@@ -90,7 +96,3 @@ Ember example :
 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

@@ -1,2 +1,11 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
+Rake::TestTask.new do |t|
+  t.libs << 'lib/frontend_rescue'
+  t.test_files = FileList['test/lib/frontend_rescue/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/frontend_rescue.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5.1"
+  spec.add_development_dependency "pry", "~> 0.10.1"
 end

data/lib/frontend_rescue/error.rb

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

data/lib/frontend_rescue/middleware.rb

@@ -1,13 +1,15 @@
+require 'rack'
+
 module FrontendRescue
   class Middleware
-    def initialize(app, opts, &block)
+    def initialize(app, opts={}, &block)
       @app = app
-      @opts = opts
+      @opts = default_options.merge(opts)
       @block = block
     end
 
     def call(env)
-      if env['REQUEST_METHOD'] == 'POST' && @opts[:paths].include?(env['PATH_INFO'])
+      if frontend_error_request?(env)
         handle_error Rack::Request.new(env)
       else
         @app.call(env)
@@ -21,21 +23,42 @@ module FrontendRescue
                                           request.params['message'],
                                           request.params['stack']
 
-        request.env['rack.errors'].puts "Processing #{error.class}" unless @opts[:silent]
+        request.env['rack.errors'].puts "Processing #{error.class}" unless silent?
 
         if @block
           @block.call(error, request)
         end
 
-        unless @opts[:silent]
+        unless 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, {}, []]
+        request.env['rack.errors'].puts "Completed #{status_code} OK" unless silent?
+        [status_code, {}, []]
+      end
+
+      def default_options
+        {
+          paths: ['/frontend-error'],
+          silent: false,
+          status_code: 500
+        }
+      end
+
+      def frontend_error_request?(env)
+        env['REQUEST_METHOD'] == 'POST' &&
+        @opts[:paths].include?(env['PATH_INFO']) &&
+        (@opts[:exclude_user_agent].nil? || env['HTTP_USER_AGENT'] !~ @opts[:exclude_user_agent])
+      end
+
+      def silent?
+        @opts[:silent]
+      end
+
+      def status_code
+        @opts[:status_code]
       end
 
   end

data/lib/frontend_rescue/version.rb

@@ -1,3 +1,3 @@
 module FrontendRescue
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/lib/frontend_rescue/middleware_test.rb

@@ -0,0 +1,82 @@
+require_relative '../../test_helper'
+
+describe FrontendRescue::Middleware do
+  let(:app) { MockRackApplication.new({'CONTENT_TYPE' => content_type, 'HTTP_USER_AGENT' => user_agent}) }
+  let(:middleware) { FrontendRescue::Middleware.new(app) }
+  let(:request) { Rack::MockRequest.new(middleware) }
+  let(:response) { request.post(request_path, input: post_data) }
+
+  let(:request_path) { "/some/path" }
+  let(:post_data) { "String or IO post data" }
+  let(:content_type) { "text/plain" }
+  let(:user_agent) { "Mozilla/5.0 (iPad; CPU OS 8_1_3 like Mac OS X)..." }
+
+  describe "when called with a POST request" do
+    describe "with any data" do
+      it "passes the request through unchanged" do
+        response['Content-Type'].must_equal 'text/plain'
+        response['Content-Length'].to_i.must_equal post_data.length
+        response.body.must_equal post_data
+      end
+    end
+  end
+
+  describe "when called with a GET request to a given endpoint" do
+    let(:request_path) { "/frontend-error" }
+    let(:response) { request.get(request_path, input: post_data, 'CONTENT_TYPE' => 'text/plain') }
+
+    it "should not handle the request" do
+      response.body.wont_be_empty
+    end
+    it "should return HTTP status 200" do
+      response.status.must_equal 200
+    end
+  end
+
+  describe "when called with a POST request to a given endpoint" do
+    let(:request_path) { "/frontend-error" }
+
+    describe "with any data" do
+      it "should handle the request" do
+        response.body.must_be_empty
+      end
+      it "should return HTTP status 500" do
+        response.status.must_equal 500
+      end
+    end
+
+    describe "when a custom endpoint and HTTP code are passed" do
+      let(:middleware) { FrontendRescue::Middleware.new(app, status_code: 200, paths: ["/my/custom/path"]) }
+      let(:request_path) { "/my/custom/path" }
+      it "should handle the request" do
+        response.body.must_be_empty
+      end
+      it "should return HTTP status 200" do
+        response.status.must_equal 200
+      end
+    end
+
+    describe "when silent option is passed" do
+      let(:middleware) { FrontendRescue::Middleware.new(app, silent: true) }
+      it "should not log to std out" do
+        response.errors.must_be_empty
+      end
+    end
+
+    describe "when a block is passed" do
+      let(:middleware) { FrontendRescue::Middleware.new(app) {|e,r| r.env['rack.errors'].puts 'The answer is 42' }}
+      it "should be executed" do
+        response.errors.must_match /The\sanswer\sis\s42/
+      end
+    end
+
+    describe "when exclude_user_agent is passed" do
+      let(:middleware) { FrontendRescue::Middleware.new(app, exclude_user_agent: /Googlebot/) }
+      let(:user_agent) { 'Googlebot/2.1; +http://www.google.com/bot.html...' }
+      it "should ignore matching user agent" do
+        skip("I don't know how to test this")
+        response.status.must_equal 404
+      end
+    end
+  end
+end

data/test/lib/frontend_rescue/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper'
+
+describe FrontendRescue do
+  it "must be defined" do
+    FrontendRescue::VERSION.wont_be_nil
+  end
+end

data/test/mock_rack_application.rb

@@ -0,0 +1,24 @@
+class MockRackApplication
+  def initialize(headers={})
+    @request_headers = default_request_headers.merge(headers)
+  end
+
+  def call(env)
+    @env = env = env.merge(@request_headers)
+    request_body = env['rack.input'].read
+    [200, {'Content-Type' => 'text/plain'}, [request_body]]
+  end
+
+  def [](key)
+    @env[key]
+  end
+
+  private
+    def default_request_headers
+      {
+        'CONTENT_TYPE' => 'text/plain',
+        'HTTP_USER_AGENT' => 'Mozilla/5.0 (iPad; CPU OS 8_1_3 like Mac OS X)...'
+      }
+    end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'pry'
+
+require_relative 'mock_rack_application'
+
+require File.expand_path('../../lib/frontend_rescue.rb', __FILE__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frontend_rescue
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jim Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
 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.
@@ -62,6 +90,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,6 +100,10 @@ files:
 - lib/frontend_rescue/error.rb
 - lib/frontend_rescue/middleware.rb
 - lib/frontend_rescue/version.rb
+- test/lib/frontend_rescue/middleware_test.rb
+- test/lib/frontend_rescue/version_test.rb
+- test/mock_rack_application.rb
+- test/test_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -96,5 +129,9 @@ 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: []
+test_files:
+- test/lib/frontend_rescue/middleware_test.rb
+- test/lib/frontend_rescue/version_test.rb
+- test/mock_rack_application.rb
+- test/test_helper.rb
 has_rdoc: