notable 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39f31b3937daa5a43922f53cef4cbbe047090895
-  data.tar.gz: 1624b16f9ab8aaf9c37d8532d2ec1403ca0aa6fa
+  metadata.gz: cfeaf681c5c6bca189685a9e36dbf30b589537c0
+  data.tar.gz: 5961aa16bf2c1b84cd7139b9e58fb2f1ab3ea7db
 SHA512:
-  metadata.gz: d040b8cc31f31df4832c462134fc7efa9976bf13326312d8ec4cfe91615a010f04e612c428c756aa1d70a95d36ede5139841e27da0f5d8b01db6a8d3d2d6208c
-  data.tar.gz: dd04f4f6a83a81524c7c0a53c159a4719b6f7d78ba4855ed052ecb96fa26ded0369f159c351b3870efda977b86938bb9196554e563572d31e183997ba1c0178e
+  metadata.gz: 9af63ec903a2c5f00d98db5f44d2a1fc436d12c31f67e27406ac320d635a1afad3c0fc7b028098b34575ca2d6dd48eeb688a2c504909b60656a912cf1aac158a
+  data.tar.gz: eba8cf5a860f802c558eae70b45de5d97945573387a6b578225f99df5b4126bbc7e77b25ba6816164c8f6bee3b457196d5ad52b26f574218fe2885bb463bf0d5

data/README.md

@@ -1,17 +1,26 @@
 # Notable
 
-Track notable requests and background jobs
+:star2: Extraordinary insight into your users and background jobs
 
-See users affected by:
+Wouldn’t it be great to see when one of your users encounters an error, timeout, or validation failure?  Now you can - directly in your admin pages.
+
+#### Introducing Notable
+
+Notable tracks notable requests and background jobs and stores them in your database.  What makes a request or job notable?  There are a number of default situations, but ultimately you decide what interests you.
+
+By default, Notable tracks:
 
 - errors
-- slow requests, jobs, and timeouts
 - 404s
+- slow requests and jobs
+- timeouts
 - validation failures
 - CSRF failures
 - unpermitted parameters
 - blocked and throttled requests
 
+You can track custom notes as well.
+
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com)
 
 ## Installation
@@ -37,19 +46,27 @@ For a web interface, check out [Notable Web](https://github.com/ankane/notable_w
 A `Notable::Request` is created for:
 
 - errors
-- slow requests and timeouts
 - 404s
+- slow requests
+- timeouts
 - validation failures
-- CSRF failures
+- [CSRF failures](http://guides.rubyonrails.org/security.html#cross-site-request-forgery-csrf)
 - unpermitted parameters
 - blocked and throttled requests
 
+For timeouts, use [Slowpoke](https://github.com/ankane/slowpoke).
+
+For blocked and throttled requests, use [Rack Attack](https://github.com/kickstarter/rack-attack).
+
 ## Jobs
 
+Wouldn’t it be great to have a record of exact jobs that fail?
+
 A `Notable::Job` is created for:
 
 - errors
 - slow jobs
+- validation failures
 
 Currently works with Delayed Job and Sidekiq.
 
@@ -59,6 +76,12 @@ Currently works with Delayed Job and Sidekiq.
 Notable.track(note_type, note)
 ```
 
+Like
+
+```ruby
+Notable.track("Auth Event", "Signed In")
+```
+
 ## Customize
 
 Disable tracking in certain environments

data/lib/notable.rb

@@ -1,7 +1,7 @@
 require "notable/version"
 
 require "request_store"
-require "robustly"
+require "safely_block"
 require "action_dispatch/middleware/debug_exceptions"
 
 # middleware
@@ -47,6 +47,10 @@ module Notable
     (RequestStore.store[:notable_notes] ||= []) << {note_type: note_type, note: note}
   end
 
+  def self.track_error(e)
+    track "Error", "#{e.class.name}: #{e.message}"
+  end
+
   def self.notes
     RequestStore.store[:notable_notes].to_a
   end
@@ -65,6 +69,7 @@ module Notable
         yield
       rescue Exception => e
         exception = e
+        track_error(e)
       ensure
         notes = Notable.notes
         Notable.clear_notes
@@ -72,7 +77,6 @@ module Notable
       runtime = Time.now - start_time
 
       safely do
-        notes << {note_type: "Error", note: "#{exception.class.name}: #{exception.message}"} if exception
         notes << {note_type: "Slow Job"} if runtime > Notable.slow_job_threshold
 
         notes.each do |note|

data/lib/notable/version.rb

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

data/notable.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "request_store"
-  spec.add_dependency "robustly"
+  spec.add_dependency "safely_block"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: robustly
+  name: safely_block
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,8 +116,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Track notable requests and background jobs
 test_files: []
+has_rdoc: