notable 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b698c7c6e4b8d027912deb4740e3713b61acac0eb56130d4e917bd55752b12b8
-  data.tar.gz: 66dd7ddb28daf9422772e23db13acf401c53b33a7acdb017909e66df3aa6db8d
+  metadata.gz: f7ba556539ddc3c2c67a5fc37623c138c15432f32e962ff60118863ecd5ff3b7
+  data.tar.gz: a301a3c1a1f84c0bce4dd83e1a965210d6ccb08586c9b2bb6f51fb10676d3f8c
 SHA512:
-  metadata.gz: 7f3c6625ffe35bf197a0110071bda6d76c0f00c4de99921e39d8e24dacf940015a597c1437b4ac8100ef744b3af343f7fef9c84c3783969a666389f642efc39b
-  data.tar.gz: d67e694ebb51daae26242fe59e7a3b43178b44f33b77e6d0dbbd639106cc4a6b20d4bcc8f7a6b068338f01b3c0c4cd2df9e22f7c19fe703e57f2197c72af97ad
+  metadata.gz: 9f7cb09c2f95526ebd6862199fcbe8889a50919c93e63293a5142efd5346998b7d9c803c358c0e283db43967e7f7303e22409b3afbc5206ea78939de7846ab84
+  data.tar.gz: c7612312bafaefbe1cee0f3b70f1bb0dff3bc0963e8116f1c110452d2b6634a8f3df1c7455dce10a058c934a2da71edb5569396d020292c15a075bdfa63e48f7

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.4.0 (2022-01-10)
+
+- Dropped support for Ruby < 2.6 and Rails < 5.2
+
+## 0.3.4 (2020-09-07)
+
+- Use `datetime` type in migration
+
+## 0.3.3 (2020-07-26)
+
+- Added support for `queued_time` for Active Job 6
+
+## 0.3.2 (2020-07-24)
+
+- Added support for Rails API
+- Fixed blocked requests with Rack::Attack
+
 ## 0.3.1 (2020-05-20)
 
 - Fixed deprecation warning in Ruby 2.7

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2019 Andrew Kane
+Copyright (c) 2014-2022 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,12 +1,8 @@
 # Notable
 
-:star2: Extraordinary insight into your users and background jobs
+:star2: :star2: :star2:
 
-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.
+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:
 
@@ -23,12 +19,14 @@ You can track custom notes as well.
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
+[![Build Status](https://github.com/ankane/notable/workflows/build/badge.svg?branch=master)](https://github.com/ankane/notable/actions)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'notable'
+gem "notable"
 ```
 
 And run:
@@ -41,26 +39,18 @@ rails db:migrate
 
 To explore the data, check out [Blazer](https://github.com/ankane/blazer).
 
-## Requests
+## How It Works
 
 A `Notable::Request` is created for:
 
 - errors
 - 404s
 - slow requests
-- timeouts
+- timeouts from [Slowpoke](https://github.com/ankane/slowpoke)
 - validation failures
 - [CSRF failures](https://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?
+- blocked and throttled requests from [Rack Attack](https://github.com/kickstarter/rack-attack)
 
 A `Notable::Job` is created for:
 
@@ -68,19 +58,13 @@ A `Notable::Job` is created for:
 - slow jobs
 - validation failures
 
-## Manual Tracking
+Create a custom note inside a request or job with:
 
 ```ruby
-Notable.track(note_type, note)
+Notable.track("Note Type", "Optional extra info")
 ```
 
-Like
-
-```ruby
-Notable.track("Auth Event", "Signed In")
-```
-
-## Customize
+## Customization
 
 Disable tracking in certain environments
 
@@ -150,6 +134,10 @@ Notable.track_job_method = lambda do |data|
 end
 ```
 
+## History
+
+View the [changelog](https://github.com/ankane/notable/blob/master/CHANGELOG.md)
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
@@ -165,4 +153,5 @@ To get started with development:
 git clone https://github.com/ankane/notable.git
 cd notable
 bundle install
+bundle exec rake test
 ```

data/lib/generators/notable/templates/create_jobs.rb.tt

@@ -8,7 +8,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.string :queue
       t.float :runtime
       t.float :queued_time
-      t.timestamp :created_at
+      t.datetime :created_at
     end
   end
 end

data/lib/generators/notable/templates/create_requests.rb.tt

@@ -3,8 +3,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
     create_table :notable_requests do |t|
       t.string :note_type
       t.text :note
-      t.integer :user_id
-      t.string :user_type
+      t.references :user, polymorphic: true
       t.text :action
       t.integer :status
       t.text :url
@@ -14,9 +13,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.text :referrer
       t.text :params
       t.float :request_time
-      t.timestamp :created_at
+      t.datetime :created_at
     end
-
-    add_index :notable_requests, [:user_id, :user_type]
   end
 end

data/lib/notable/job_extensions.rb

@@ -4,8 +4,8 @@ module Notable
 
     included do
       around_perform do |job, block|
-        # no way to get queued_at time :(
-        Notable.track_job(job.class.name, job.job_id, job.queue_name, nil, try(:notable_slow_job_threshold)) do
+        # enqueued_at is only available in Active Job 6+
+        Notable.track_job(job.class.name, job.job_id, job.queue_name, job.try(:enqueued_at), try(:notable_slow_job_threshold)) do
           block.call
         end
       end

data/lib/notable/throttle.rb

@@ -1,7 +1,7 @@
 ActiveSupport::Notifications.subscribe "rack.attack" do |_name, _start, _finish, _request_id, req|
   request = req.is_a?(Hash) ? req[:request] : req
 
-  if [:blacklist, :throttle].include?(request.env["rack.attack.match_type"])
+  if [:blacklist, :blocklist, :throttle].include?(request.env["rack.attack.match_type"])
     Notable.track "Throttle", request.env["rack.attack.matched"]
   end
 end

data/lib/notable/unverified_request.rb

@@ -7,7 +7,7 @@ module Notable
     end
 
     def track_unverified_request
-      if !verified_request?
+      if respond_to?(:verified_request?, true) && !verified_request?
         expected = form_authenticity_token
         actual = form_authenticity_param || request.headers["X-CSRF-Token"]
         Notable.track "Unverified Request", "#{actual || "nil"} != #{expected}"

data/lib/notable/version.rb

@@ -1,3 +1,3 @@
 module Notable
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/notable.rb

@@ -70,6 +70,7 @@ module Notable
     exception = nil
     notes = nil
     start_time = Time.now
+    created_at = Time.parse(created_at) if created_at.is_a?(String)
     queued_time = created_at ? start_time - created_at : nil
     begin
       yield

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notable
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: safely_block
   requirement: !ruby/object:Gem::Requirement
@@ -38,36 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.1
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email: andrew@chartkick.com
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,7 +67,7 @@ homepage: https://github.com/ankane/notable
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,15 +75,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Track notable requests and background jobs
 test_files: []