snitch_reporting 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e965004438aae664e6f6be5804b3acd7d323dd89f783ee2653cc5430cf61bf0
-  data.tar.gz: e3f025872529d46fcffa7125e9db3558865de3f845fa8420c33bd2fed99726e6
+  metadata.gz: a378afd285e3d04001fcefd7e4782f410ffbd0cb7cfd19430c97fac7a56f99bd
+  data.tar.gz: 3e70eec20386c0efce472c340b0a2b221be59edde1e99abd0f29346160d1bf52
 SHA512:
-  metadata.gz: 77d1632dd5b318b2528453a3b61ad6a245f193a4e86f96c55f976d1221508b1540c3619e3520d720846ed53a22b9601bc02bd586762574fb6a6a42c77f8e4ae7
-  data.tar.gz: 17bc5ca841a7e858a6e2149160d8ceb83c5c3fa07b5406716063a9f828c88c050e118f3e1a7dc25d1893a4fdfad0b55483e1eccc7cf1e1ee167f7524c266cfbb
+  metadata.gz: cc59994c9b2e6015ce5d47098ed12b7258be0e5b0981d84bf5c77fabd76a610a717f762e897daf06b9e95ee0dd3ad6264eb5ff282c9ca72b5c5b49eb17aba1dc
+  data.tar.gz: bf33d23beaae10b1b7bb7e07a34e40babe04f585d6359498d963648ee971cf80bd73bc80fb57557ea287f828d6a958398861d874fc72ceacf6e9833a6d6152c2

data/README.md

@@ -2,9 +2,6 @@
 Snitch Reporting adds middleware to your Rails app to automatically track errors.
 This is a self-hosted gem that plugs directly into your app.
 
-## Usage
-Install the gem, run the migrations, add to your middleware, then mount the route to view. Let the gem find and track your bugs for you!
-
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -22,6 +19,20 @@ Or install it yourself as:
 $ gem install snitch_reporting
 ```
 
+Include assets:
+
+application.js
+```js
+//= require snitch_reporting/snitch_report
+```
+
+application.css
+```css
+/*
+*= require snitch_reporting/snitch_report
+/*
+```
+
 Add the migrations to your app with
 ```bash
 rails g snitch_reporting:install
@@ -35,6 +46,11 @@ Rails.application.config.middleware.use SnitchReporting::Rack, ->(occurrence) {
 }
 ```
 
+Finally, mount the routes within your route file to give you access to the report pages.
+```ruby
+mount SnitchReporting::Engine, at: "/snitches"
+```
+
 ## Contributing
 Lots of things to do, and would love some PRs! Feel free to pull the code down and submit a PR with some changes.
 A few things I'd like to do:

data/lib/snitch_reporting/engine.rb

@@ -1,7 +1,5 @@
 module SnitchReporting
   class Engine < ::Rails::Engine
     isolate_namespace SnitchReporting
-
-    # config.app_middleware.use ::SnitchReporting::Rack
   end
 end

data/lib/snitch_reporting/rack.rb

@@ -11,11 +11,11 @@ class SnitchReporting::Rack
     response = @app.call(env)
     _, headers, = response
 
-    if headers["X-Cascade"] == "pass"
-      msg = "This exception means that the preceding Rack middleware set the 'X-Cascade' header to 'pass' -- in " \
-      "Rails, this often means that the route was not found (404 error)."
-      raise SnitchException, msg
-    end
+  #   if headers["X-Cascade"] == "pass"
+  #     msg = "This exception means that the preceding Rack middleware set the 'X-Cascade' header to 'pass' -- in " \
+  #     "Rails, this often means that the route was not found (404 error)."
+  #     raise SnitchException, msg
+  #   end
 
     response
   rescue Exception => exception

data/lib/snitch_reporting/version.rb

@@ -1,3 +1,3 @@
 module SnitchReporting
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/snitch_reporting.rb

@@ -1,6 +1,6 @@
 require "snitch_reporting"
-require "snitch_reporting/rack"
 require "snitch_reporting/engine"
+require "snitch_reporting/rack"
 require "snitch_reporting/version"
 
 module SnitchReporting

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snitch_reporting
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Rocco Nicholls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails