notable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a96170589cc298003cda848d8ed27894f9094072
-  data.tar.gz: ad6a05312428b0bfcbfe1f91ee6614ca83c34f7b
+  metadata.gz: c4d9ade6391e626b6456ce4fbbea37d0978327c1
+  data.tar.gz: 3c5baf92e0867ae2e94790613a28ab843217ecb0
 SHA512:
-  metadata.gz: 5420ef74ab8da9b01df98b04081f1a4ef68f2b3eb1d3d4ba609904a0bf19108797e0d2f95cc8ef525e77869bbe5853aa45cf8951c8b56a9c50fa21cc6e8480ac
-  data.tar.gz: d4022d63822a6e97289760f63e228db4c84dabf61b9188d9f5e1a2718e006b40cee7913eebaae3e3381c8cd9670b91cdb52f2f08dfa129ab114a705b16bdfa25
+  metadata.gz: 2b46b38463983747feb4521469f6896c20a682b5c41a465743548ab6a6fcb811c991270039dc9b631086984273eee8b1f43560c5de23d1667bafc32df979ad4e
+  data.tar.gz: 07573eecf3ea2442f48ef5cd22e00130b815e866e36e1bcbc3062ac1bdae56b1c719590f46f9deba10f9cce6525759edb38381eb309efcdab015587a79ccd97f

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.2.0
+
+- Switched to ActiveJob for jobs
+- Fixed deprecation warnings
+
+## 0.1.0
+
+- Launched

data/README.md

@@ -35,7 +35,7 @@ And run:
 
 ```sh
 rails generate notable:requests
-rails generate notable:jobs # optional
+rails generate notable:jobs
 rake db:migrate
 ```
 
@@ -68,8 +68,6 @@ A `Notable::Job` is created for:
 - slow jobs
 - validation failures
 
-Currently works with Delayed Job and Sidekiq.
-
 ## Manual Tracking
 
 ```ruby
@@ -101,23 +99,23 @@ Notable.slow_request_threshold = 5 # seconds (default)
 Custom user method
 
 ```ruby
-Notable.user_method = proc do |env|
+Notable.user_method = -> (env) {
   env["warden"].try(:user) || env["action_controller.instance"].try(:current_visit)
-end
+}
 ```
 
 Custom track method
 
 ```ruby
-Notable.track_request_method = proc do |data, env|
+Notable.track_request_method = -> (data, env) {
   Notable::Request.create!(data)
-end
+}
 ```
 
 Skip tracking CSRF failures
 
 ```ruby
-skip_before_filter :track_unverified_request
+skip_before_action :track_unverified_request
 ```
 
 ### Jobs
@@ -131,9 +129,9 @@ Notable.slow_job_threshold = 60 # seconds (default)
 Custom track method
 
 ```ruby
-Notable.track_job_method = proc do |data|
+Notable.track_job_method = -> (data) {
   Notable::Job.create!(data)
-end
+}
 ```
 
 ## TODO

data/lib/notable/engine.rb

@@ -3,9 +3,10 @@ module Notable
     isolate_namespace Notable
 
     initializer "notable" do |app|
-      app.config.middleware.insert_after RequestStore::Middleware, Notable::Middleware
-
-      ActionDispatch::DebugExceptions.send(:prepend, Notable::DebugExceptions)
+      if Notable.requests_enabled?
+        app.config.middleware.insert_after RequestStore::Middleware, Notable::Middleware
+        ActionDispatch::DebugExceptions.send(:prepend, Notable::DebugExceptions)
+      end
     end
   end
 end

data/lib/notable/job_extensions.rb

@@ -0,0 +1,14 @@
+module Notable
+  module JobExtensions
+    extend ActiveSupport::Concern
+
+    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
+          block.call
+        end
+      end
+    end
+  end
+end

data/lib/notable/middleware.rb

@@ -6,71 +6,64 @@ module Notable
     end
 
     def call(env)
-      if Notable.enabled
-        start_time = Time.now
-        status, headers, body = @app.call(env)
-        request_time = Time.now - start_time
+      start_time = Time.now
+      status, headers, body = @app.call(env)
+      request_time = Time.now - start_time
 
-        safely do
-          if env["action_dispatch.exception"]
-            e = env["action_dispatch.exception"]
-            message =
-              case status.to_i
-              when 404
-                "Not Found"
-              when 503
-                "Timeout"
-              else
-                "Error"
-              end
-            Notable.track message, "#{e.class.name}: #{e.message}"
-          elsif (!status or status.to_i >= 400) and !Notable.notes.any?
-            Notable.track Rack::Utils::HTTP_STATUS_CODES[status.to_i]
-          end
+      Safely.safely do
+        if env["action_dispatch.exception"]
+          e = env["action_dispatch.exception"]
+          message =
+            case status.to_i
+            when 404
+              "Not Found"
+            when 503
+              "Timeout"
+            else
+              "Error"
+            end
+          Notable.track message, "#{e.class.name}: #{e.message}"
+        elsif (!status or status.to_i >= 400) and !Notable.notes.any?
+          Notable.track Rack::Utils::HTTP_STATUS_CODES[status.to_i]
+        end
 
-          if request_time > Notable.slow_request_threshold and status.to_i != 503
-            Notable.track "Slow Request"
-          end
+        if request_time > Notable.slow_request_threshold and status.to_i != 503
+          Notable.track "Slow Request"
+        end
 
-          notes = Notable.notes
-          if notes.any?
-            request = ActionDispatch::Request.new(env)
+        notes = Notable.notes
+        if notes.any?
+          request = ActionDispatch::Request.new(env)
 
-            # hack since Rails modifies PATH_INFO
-            # and we don't want to modify env
-            url = request.base_url + request.script_name + env["REQUEST_PATH"]
-            url << "?#{request.query_string}" unless request.query_string.empty?
+          url = request.original_url
 
-            controller = env["action_controller.instance"]
-            action = controller && "#{controller.params["controller"]}##{controller.params["action"]}"
-            params = controller && controller.request.filtered_parameters.except("controller", "action")
+          controller = env["action_controller.instance"]
+          action = controller && "#{controller.params["controller"]}##{controller.params["action"]}"
+          params = controller && controller.request.filtered_parameters.except("controller", "action")
 
-            user = Notable.user_method.call(env)
+          user = Notable.user_method.call(env)
 
-            notes.each do |note|
-              data = {
-                note_type: note[:note_type],
-                note: note[:note],
-                user: user,
-                action: action,
-                status: status,
-                params: params,
-                request_id: request.uuid,
-                ip: request.remote_ip,
-                user_agent: request.user_agent,
-                url: url,
-                referrer: request.referer,
-                request_time: request_time
-              }
-              Notable.track_request_method.call(data, env)
-            end
+          notes.each do |note|
+            data = {
+              note_type: note[:note_type],
+              note: note[:note],
+              user: user,
+              action: action,
+              status: status,
+              params: params,
+              request_id: request.uuid,
+              ip: request.remote_ip,
+              user_agent: request.user_agent,
+              url: url,
+              referrer: request.referer,
+              request_time: request_time
+            }
+            Notable.track_request_method.call(data, env)
           end
         end
-
-        [status, headers, body]
-      else
-        @app.call(env)
       end
+
+      [status, headers, body]
     end
 
   end

data/lib/notable/unverified_request.rb

@@ -3,7 +3,7 @@ module Notable
     extend ActiveSupport::Concern
 
     included do
-      prepend_before_filter :track_unverified_request
+      prepend_before_action :track_unverified_request
     end
 
     def track_unverified_request

data/lib/notable/version.rb

@@ -1,3 +1,3 @@
 module Notable
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/notable.rb

@@ -1,7 +1,7 @@
 require "notable/version"
 
 require "request_store"
-require "safely_block"
+require "safely/core"
 require "action_dispatch/middleware/debug_exceptions"
 
 # middleware
@@ -15,13 +15,11 @@ require "notable/validation_errors"
 require "notable/debug_exceptions"
 require "notable/throttle"
 
-# jobs
-require "notable/job_backends/sidekiq" if defined?(Sidekiq)
-require "notable/job_backends/delayed_job" if defined?(Delayed::Job)
-
 module Notable
   class << self
     attr_accessor :enabled
+    attr_accessor :requests_enabled
+    attr_accessor :jobs_enabled
 
     # requests
     attr_accessor :track_request_method
@@ -33,14 +31,24 @@ module Notable
     attr_accessor :slow_job_threshold
   end
   self.enabled = true
+  self.requests_enabled = true
+  self.jobs_enabled = true
+
+  def self.requests_enabled?
+    enabled && requests_enabled
+  end
+
+  def self.jobs_enabled?
+    enabled && jobs_enabled
+  end
 
   # requests
-  self.track_request_method = proc{|data, env| Notable::Request.create!(data) }
-  self.user_method = proc{|env| env["warden"].user if env["warden"] }
+  self.track_request_method = -> (data, env) { Notable::Request.create!(data) }
+  self.user_method = -> (env) { env["warden"].user if env["warden"] }
   self.slow_request_threshold = 5
 
   # jobs
-  self.track_job_method = proc{|data| Notable::Job.create!(data) }
+  self.track_job_method = -> (data) { Notable::Job.create!(data) }
   self.slow_job_threshold = 60
 
   def self.track(note_type, note = nil)
@@ -59,44 +67,47 @@ module Notable
     RequestStore.store.delete(:notable_notes)
   end
 
-  def self.track_job(job, job_id, queue, created_at, &block)
-    if Notable.enabled
-      exception = nil
-      notes = nil
-      start_time = Time.now
-      queued_time = start_time - created_at
-      begin
-        yield
-      rescue Exception => e
-        exception = e
-        track_error(e)
-      ensure
-        notes = Notable.notes
-        Notable.clear_notes
-      end
-      runtime = Time.now - start_time
-
-      safely do
-        notes << {note_type: "Slow Job"} if runtime > Notable.slow_job_threshold
-
-        notes.each do |note|
-          data = {
-            note_type: note[:note_type],
-            note: note[:note],
-            job: job,
-            job_id: job_id,
-            queue: queue,
-            runtime: runtime,
-            queued_time: queued_time
-          }
-
-          Notable.track_job_method.call(data)
-        end
-      end
-
-      raise exception if exception
-    else
+  def self.track_job(job, job_id, queue, created_at)
+    exception = nil
+    notes = nil
+    start_time = Time.now
+    queued_time = created_at ? start_time - created_at : nil
+    begin
       yield
+    rescue Exception => e
+      exception = e
+      track_error(e)
+    ensure
+      notes = Notable.notes
+      Notable.clear_notes
+    end
+    runtime = Time.now - start_time
+
+    Safely.safely do
+      notes << {note_type: "Slow Job"} if runtime > Notable.slow_job_threshold
+
+      notes.each do |note|
+        data = {
+          note_type: note[:note_type],
+          note: note[:note],
+          job: job,
+          job_id: job_id,
+          queue: queue,
+          runtime: runtime,
+          queued_time: queued_time
+        }
+
+        Notable.track_job_method.call(data)
+      end
     end
+
+    raise exception if exception
+  end
+end
+
+ActiveSupport.on_load(:active_job) do
+  if Notable.jobs_enabled?
+    require "notable/job_extensions"
+    include Notable::JobExtensions
   end
 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 "safely_block"
+  spec.add_dependency "safely_block", ">= 0.1.1"
 
   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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-21 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,8 +88,7 @@ files:
 - lib/notable.rb
 - lib/notable/debug_exceptions.rb
 - lib/notable/engine.rb
-- lib/notable/job_backends/delayed_job.rb
-- lib/notable/job_backends/sidekiq.rb
+- lib/notable/job_extensions.rb
 - lib/notable/middleware.rb
 - lib/notable/throttle.rb
 - lib/notable/unpermitted_parameters.rb
@@ -116,9 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Track notable requests and background jobs
 test_files: []
-has_rdoc: 

data/lib/notable/job_backends/delayed_job.rb

@@ -1,15 +0,0 @@
-module Notable
-  module JobBackends
-    class DelayedJob < Delayed::Plugin
-      callbacks do |lifecycle|
-        lifecycle.around(:invoke_job) do |job, *args, &block|
-          Notable.track_job job.name, job.id, job.queue, job.created_at do
-            block.call(job, *args)
-          end
-        end
-      end
-    end
-  end
-end
-
-Delayed::Worker.plugins << Notable::JobBackends::DelayedJob

data/lib/notable/job_backends/sidekiq.rb

@@ -1,26 +0,0 @@
-module Notable
-  module JobBackends
-    class Sidekiq
-      WRAPPER_CLASSES = Set.new(["ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"])
-
-      def call(_worker, job, queue)
-        name =
-          if WRAPPER_CLASSES.include?(job["class"])
-            job["args"].first["job_class"]
-          else
-            job["class"]
-          end
-
-        Notable.track_job name, job["jid"], queue, Time.at(job["enqueued_at"]) do
-          yield
-        end
-      end
-    end
-  end
-end
-
-Sidekiq.configure_server do |config|
-  config.server_middleware do |chain|
-    chain.add Notable::JobBackends::Sidekiq
-  end
-end