notable 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 388cbc24d5dae49059d56fdc1eb0151b88413642696510648be056498258e5b0
-  data.tar.gz: f0dab808379c2b143ca41b443ce5b07930e8f87e6d83caf4a369f81ea644590b
+  metadata.gz: 0a1ecb0013fc63daaa3bec5b0b451fca47d39617ca73c18f72f6dfcefb368bbc
+  data.tar.gz: f156679280ff767f0c99c6dc768f1b25cfc761759935b86cc5d64092d1a6d19a
 SHA512:
-  metadata.gz: 1f7774c7eec961cbda78bd0652dc640e283f32907375fb344ad5098bafba794f7539562d8fc6808cf2b101f340b706a6b55a2be83c7c25ca90fdc7372b6a7b2b
-  data.tar.gz: 54fbe03343496f1d8b87b115458bae361db725f66b2996ce32f4fd00f5b43a4784bbd631bb346523abf8caa6d1b7b4d5a4762b24ef8bdb3451b978a5a5e422a6
+  metadata.gz: bc5ae406db635275367d0f609b2e28311e1e467ee99c13b7acc1184a22dc998a2a5e645a9a4f3b529403ded4e7aa2f52a818bbd0da7bd40a021163be207fd742
+  data.tar.gz: 84a13882970bec183ae857ad5641531a4267c1cea855842e3a77606923271cbd92246ae4d43df5a997a63fb569b8fa6fb012ffb214eccbce9bc8c7c63c7842a2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.0
+
+- Added support for Rack::Attack 6
+- Added job-specific slow job threshold
+- Dropped support for Rails 4.2
+
 ## 0.2.2
 
 - Added `mask_ips` option

data/LICENSE.txt

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

data/README.md

@@ -36,10 +36,10 @@ And run:
 ```sh
 rails generate notable:requests
 rails generate notable:jobs
-rake db:migrate
+rails db:migrate
 ```
 
-For a web interface, check out [Notable Web](https://github.com/ankane/notable_web).
+To explore the data, check out [Blazer](https://github.com/ankane/blazer).
 
 ## Requests
 
@@ -93,23 +93,23 @@ Notable.enabled = Rails.env.production?
 Set slow threshold
 
 ```ruby
-Notable.slow_request_threshold = 5 # seconds (default)
+Notable.slow_request_threshold = 5.seconds
 ```
 
 Custom user method
 
 ```ruby
-Notable.user_method = -> (env) {
+Notable.user_method = lambda do |env|
   env["warden"].try(:user) || env["action_controller.instance"].try(:current_visit)
-}
+end
 ```
 
 Custom track method
 
 ```ruby
-Notable.track_request_method = -> (data, env) {
+Notable.track_request_method = lambda do |data, env|
   Notable::Request.create!(data)
-}
+end
 ```
 
 Skip tracking CSRF failures
@@ -129,21 +129,26 @@ Notable.mask_ips = true
 Set slow threshold
 
 ```ruby
-Notable.slow_job_threshold = 60 # seconds (default)
+Notable.slow_job_threshold = 60.seconds
 ```
 
-Custom track method
+To set a threshold for a specific job, use:
 
 ```ruby
-Notable.track_job_method = -> (data) {
-  Notable::Job.create!(data)
-}
+class CustomJob < ApplicationJob
+  def notable_slow_job_threshold
+    5.minutes
+  end
+end
 ```
 
-## TODO
+Custom track method
 
-- ability to disable features
-- add indexes
+```ruby
+Notable.track_job_method = lambda do |data|
+  Notable::Job.create!(data)
+end
+```
 
 ## Contributing
 

data/lib/generators/notable/jobs_generator.rb

@@ -26,9 +26,7 @@ module Notable
       end
 
       def migration_version
-        if ActiveRecord::VERSION::MAJOR >= 5
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

data/lib/generators/notable/requests_generator.rb

@@ -26,9 +26,7 @@ module Notable
       end
 
       def migration_version
-        if ActiveRecord::VERSION::MAJOR >= 5
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

data/lib/generators/notable/templates/{create_jobs.rb → create_jobs.rb.tt}

@@ -6,8 +6,8 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.text :job
       t.string :job_id
       t.string :queue
-      t.decimal :runtime
-      t.decimal :queued_time
+      t.float :runtime
+      t.float :queued_time
       t.timestamp :created_at
     end
   end

data/lib/generators/notable/templates/{create_requests.rb → create_requests.rb.tt}

@@ -13,7 +13,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.text :user_agent
       t.text :referrer
       t.text :params
-      t.decimal :request_time
+      t.float :request_time
       t.timestamp :created_at
     end
 

data/lib/notable.rb

@@ -1,19 +1,15 @@
-require "notable/version"
-
-require "request_store"
+# dependencies
+require "active_support"
 require "safely/core"
-require "action_dispatch/middleware/debug_exceptions"
-
-# middleware
-require "notable/middleware"
-require "notable/engine" if defined?(Rails)
 
-# requests
-require "notable/unpermitted_parameters"
-require "notable/unverified_request"
-require "notable/validation_errors"
+# modules
 require "notable/debug_exceptions"
+require "notable/middleware"
 require "notable/throttle"
+require "notable/unpermitted_parameters"
+require "notable/version"
+
+require "notable/engine" if defined?(Rails)
 
 module Notable
   class << self
@@ -45,7 +41,7 @@ module Notable
   end
 
   # requests
-  self.track_request_method = -> (data, env) { Notable::Request.create!(data) }
+  self.track_request_method = -> (data, _) { Notable::Request.create!(data) }
   self.user_method = -> (env) { env["warden"].user if env["warden"] }
   self.slow_request_threshold = 5
 
@@ -54,7 +50,7 @@ module Notable
   self.slow_job_threshold = 60
 
   def self.track(note_type, note = nil)
-    (RequestStore.store[:notable_notes] ||= []) << {note_type: note_type, note: note}
+    notes << {note_type: note_type, note: note}
   end
 
   def self.track_error(e)
@@ -62,14 +58,15 @@ module Notable
   end
 
   def self.notes
-    RequestStore.store[:notable_notes].to_a
+    Thread.current[:notable_notes] ||= []
   end
 
   def self.clear_notes
-    RequestStore.store.delete(:notable_notes)
+    Thread.current[:notable_notes] = nil
   end
 
-  def self.track_job(job, job_id, queue, created_at)
+  def self.track_job(job, job_id, queue, created_at, slow_job_threshold = nil)
+    slow_job_threshold ||= Notable.slow_job_threshold
     exception = nil
     notes = nil
     start_time = Time.now
@@ -86,7 +83,7 @@ module Notable
     runtime = Time.now - start_time
 
     Safely.safely do
-      notes << {note_type: "Slow Job"} if runtime > Notable.slow_job_threshold
+      notes << {note_type: "Slow Job"} if runtime > slow_job_threshold
 
       notes.each do |note|
         data = {
@@ -118,6 +115,16 @@ module Notable
   end
 end
 
+ActiveSupport.on_load(:action_controller) do
+  require "notable/unverified_request"
+  include Notable::UnverifiedRequest
+end
+
+ActiveSupport.on_load(:active_record) do
+  require "notable/validation_errors"
+  include Notable::ValidationErrors
+end
+
 ActiveSupport.on_load(:active_job) do
   if Notable.jobs_enabled?
     require "notable/job_extensions"

data/lib/notable/engine.rb

@@ -4,8 +4,9 @@ module Notable
 
     initializer "notable" do |app|
       if Notable.requests_enabled?
-        app.config.middleware.insert_after RequestStore::Middleware, Notable::Middleware
-        ActionDispatch::DebugExceptions.send(:prepend, Notable::DebugExceptions)
+        # insert in same place as request_store
+        app.config.middleware.insert_after ActionDispatch::RequestId, Notable::Middleware
+        ActionDispatch::DebugExceptions.prepend Notable::DebugExceptions
       end
     end
   end

data/lib/notable/job_extensions.rb

@@ -5,7 +5,7 @@ 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) do
+        Notable.track_job(job.class.name, job.job_id, job.queue_name, nil, try(:notable_slow_job_threshold)) do
           block.call
         end
       end

data/lib/notable/middleware.rb

@@ -1,6 +1,5 @@
 module Notable
   class Middleware
-
     def initialize(app)
       @app = app
     end
@@ -69,7 +68,8 @@ module Notable
       end
 
       [status, headers, body]
+    ensure
+      Notable.clear_notes
     end
-
   end
 end

data/lib/notable/throttle.rb

@@ -1,5 +1,7 @@
-ActiveSupport::Notifications.subscribe "rack.attack" do |name, start, finish, request_id, req|
-  if [:blacklist, :throttle].include?(req.env["rack.attack.match_type"])
-    Notable.track "Throttle", req.env["rack.attack.matched"]
+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"])
+    Notable.track "Throttle", request.env["rack.attack.matched"]
   end
 end

data/lib/notable/unpermitted_parameters.rb

@@ -1,3 +1,3 @@
-ActiveSupport::Notifications.subscribe "unpermitted_parameters.action_controller" do |name, start, finish, id, payload|
+ActiveSupport::Notifications.subscribe "unpermitted_parameters.action_controller" do |_name, _start, _finish, _id, payload|
   Notable.track "Unpermitted Parameters", payload[:keys].join(", ")
 end

data/lib/notable/unverified_request.rb

@@ -15,5 +15,3 @@ module Notable
     end
   end
 end
-
-ActionController::Base.send(:include, Notable::UnverifiedRequest)

data/lib/notable/validation_errors.rb

@@ -13,5 +13,3 @@ module Notable
     end
   end
 end
-
-ActiveRecord::Base.send(:include, Notable::ValidationErrors)

data/lib/notable/version.rb

@@ -1,3 +1,3 @@
 module Notable
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: notable
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: request_store
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: safely_block
   requirement: !ruby/object:Gem::Requirement
@@ -42,49 +42,45 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: Track notable requests and background jobs
-email:
-- andrew@chartkick.com
+        version: '0'
+description: 
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - app/models/notable/job.rb
 - app/models/notable/request.rb
 - lib/generators/notable/jobs_generator.rb
 - lib/generators/notable/requests_generator.rb
-- lib/generators/notable/templates/create_jobs.rb
-- lib/generators/notable/templates/create_requests.rb
+- lib/generators/notable/templates/create_jobs.rb.tt
+- lib/generators/notable/templates/create_requests.rb.tt
 - lib/notable.rb
 - lib/notable/debug_exceptions.rb
 - lib/notable/engine.rb
@@ -95,7 +91,6 @@ files:
 - lib/notable/unverified_request.rb
 - lib/notable/validation_errors.rb
 - lib/notable/version.rb
-- notable.gemspec
 homepage: https://github.com/ankane/notable
 licenses:
 - MIT
@@ -108,15 +103,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Track notable requests and background jobs

data/.gitignore

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

data/Gemfile

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

data/Rakefile

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

data/notable.gemspec

@@ -1,26 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "notable/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "notable"
-  spec.version       = Notable::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "Track notable requests and background jobs"
-  spec.description   = "Track notable requests and background jobs"
-  spec.homepage      = "https://github.com/ankane/notable"
-  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_dependency "request_store"
-  spec.add_dependency "safely_block", ">= 0.1.1"
-
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-end