sniffer 0.3.1 → 0.5.0

data/lib/sniffer/adapters/patron_adapter.rb

@@ -4,46 +4,78 @@ module Sniffer
   module Adapters
     # HTTP adapter
     module PatronAdapter
-      def self.included(base)
-        base.class_eval do
-          alias_method :request_without_sniffer, :request
-          alias_method :request, :request_with_sniffer
-        end
-      end
-
-      # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       def request_with_sniffer(action_name, url, headers, options = {})
-        if Sniffer.enabled?
-          data_item = Sniffer::DataItem.new
-          uri = URI(base_url)
-          data_item.request = Sniffer::DataItem::Request.new(host: uri.host,
-                                                             method: action_name,
-                                                             query: url,
-                                                             headers: headers.dup,
-                                                             body: options[:data].to_s,
-                                                             port: uri.port)
-
-          Sniffer.store(data_item)
-        end
+        data_item = request_sniffer_before(action_name, url, headers, options)
 
         bm = Benchmark.realtime do
           @res = request_without_sniffer(action_name, url, headers, options)
         end
 
-        if Sniffer.enabled?
-          data_item.response = Sniffer::DataItem::Response.new(status: @res.status,
-                                                               headers: @res.headers,
-                                                               body: @res.body.to_s,
-                                                               timing: bm)
-
-          data_item.log
-        end
+        request_sniffer_after(data_item, bm)
 
         @res
       end
-      # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+
+      private
+
+      # rubocop:disable Metrics/MethodLength
+      def request_sniffer_before(action_name, url, headers, options)
+        return unless Sniffer.enabled?
+
+        data_item = Sniffer::DataItem.new
+        uri = URI(base_url)
+        data_item.request = Sniffer::DataItem::Request.new(host: uri.host,
+                                                           method: action_name,
+                                                           query: url,
+                                                           headers: headers.dup,
+                                                           body: options[:data].to_s,
+                                                           port: uri.port)
+
+        Sniffer.store(data_item)
+
+        data_item
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def request_sniffer_after(data_item, benchmark)
+        return unless Sniffer.enabled?
+
+        data_item.response = Sniffer::DataItem::Response.new(status: @res.status,
+                                                             headers: @res.headers,
+                                                             body: @res.body.to_s,
+                                                             timing: benchmark)
+
+        Sniffer.notify_response(data_item)
+      end
+
+      # Only used when prepending, see all_prepend.rb
+      module Prepend
+        include PatronAdapter
+
+        def request(action_name, url, headers, options = {})
+          data_item = request_sniffer_before(action_name, url, headers, options)
+
+          bm = Benchmark.realtime do
+            @res = super(action_name, url, headers, options)
+          end
+
+          request_sniffer_after(data_item, bm)
+
+          @res
+        end
+      end
     end
   end
 end
 
-::Patron::Session.send(:include, Sniffer::Adapters::PatronAdapter) if defined?(::Patron::Session)
+if defined?(::Patron::Session)
+  if defined?(Sniffer::Adapters::PatronAdapter::PREPEND)
+    Patron::Session.prepend Sniffer::Adapters::PatronAdapter::Prepend
+  else
+    Patron::Session.class_eval do
+      include Sniffer::Adapters::PatronAdapter
+      alias_method :request_without_sniffer, :request
+      alias_method :request, :request_with_sniffer
+    end
+  end
+end

data/lib/sniffer/config.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "anyway_config"
+require_relative "middleware/chain"
+require_relative "middleware/logger"
 
 module Sniffer
   # Sniffer configuration
@@ -24,6 +26,15 @@ module Sniffer
                 url_whitelist: nil,
                 url_blacklist: nil
 
+    def middleware
+      @middleware ||= Middleware::Chain.new.tap do |chain|
+        chain.add(Sniffer::Middleware::Logger, logger, severity)
+      end
+
+      yield @middleware if block_given?
+      @middleware
+    end
+
     def capacity?
       store.is_a?(Hash) && store.key?(:capacity)
     end
@@ -34,6 +45,7 @@ module Sniffer
 
     def rotate?
       return false unless capacity?
+
       store.fetch(:rotate, true)
     end
   end

data/lib/sniffer/data.rb

@@ -4,8 +4,6 @@ module Sniffer
   # Data class stores the data and controls capacity
   class Data < Array
     def store(data_item)
-      return unless data_item.allowed_to_sniff?
-
       if config.rotate?
         rotate(data_item)
       else

data/lib/sniffer/data_item.rb

@@ -1,44 +1,45 @@
 # frozen_string_literal: true
 
-require 'active_attr'
+require 'dry-initializer'
 require 'json'
 require_relative 'request_policy'
 
 module Sniffer
   # Sniffer data item stores a request info
   class DataItem
-    include ActiveAttr::MassAssignment
-    attr_accessor :request, :response
+    extend Dry::Initializer
+
+    attr_writer :request, :response
+
+    option :request, optional: true
+    option :response, optional: true
 
     def to_h
       {
-        request: request && request.to_h,
-        response: response && response.to_h
+        request: request&.to_h,
+        response: response&.to_h
       }
     end
 
-    def log
-      return unless Sniffer.logger && allowed_to_sniff?
-      Sniffer.logger.log(Sniffer.config.severity, to_json)
-    end
-
     def to_log
       return {} unless Sniffer.config.logger
+
       request.to_log.merge(response.to_log)
     end
 
-    def to_json
+    def to_json(*_args)
       to_log.to_json
     end
 
     def allowed_to_sniff?
       return true unless request
+
       RequestPolicy.call(request)
     end
 
     # Basic object for request and response objects
     class HttpObject
-      include ActiveAttr::MassAssignment
+      extend Dry::Initializer
 
       def log_message
         raise NotImplementedError
@@ -51,7 +52,14 @@ module Sniffer
 
     # Stores http request data
     class Request < HttpObject
-      attr_accessor :host, :port, :query, :method, :headers, :body
+      option :host, optional: true
+      option :port, optional: true
+      option :query, optional: true
+      option :method, optional: true
+      option :headers, optional: true
+      option :body, optional: true
+
+      attr_writer :host, :port, :query, :method, :headers, :body
 
       def to_h
         {
@@ -59,7 +67,7 @@ module Sniffer
           query: query,
           port: port,
           headers: headers,
-          body: body && body.to_s,
+          body: body&.to_s,
           method: method
         }
       end
@@ -88,13 +96,18 @@ module Sniffer
 
     # Stores http response data
     class Response < HttpObject
-      attr_accessor :status, :headers, :body, :timing
+      attr_writer :status, :headers, :body, :timing
+
+      option :status, optional: true
+      option :headers, optional: true
+      option :body, optional: true
+      option :timing, optional: true
 
       def to_h
         {
           status: status,
           headers: headers,
-          body: body && body.to_s,
+          body: body&.to_s,
           timing: timing
         }
       end

data/lib/sniffer/middleware/chain.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "entry"
+
+module Sniffer
+  # Middleware is code configured to run before/after
+  # storing sniffed request/response
+  # To add middleware
+  #
+  # Sniffer.middleware do |chain|
+  #   chain.add MyHook
+  # end
+  #
+  # class MyHook
+  #   def request(data_item)
+  #     puts "Before request work"
+  #     yield
+  #     puts "After request work"
+  #   end
+  #
+  #   def response(data_item)
+  #     puts "Before response work"
+  #     yield
+  #     puts "After response work"
+  #   end
+  # end
+  module Middleware
+    # Stores all the middleware configs
+    class Chain
+      include Enumerable
+
+      def entries
+        @entries ||= []
+      end
+
+      def each(&block)
+        entries.each(&block)
+      end
+
+      def add(klass, *args)
+        entries.push(Entry.new(klass, *args))
+      end
+
+      def remove(klass)
+        entries.delete_if { |entry| entry.klass == klass }
+      end
+
+      def invoke_request(*args)
+        chain = map(&:make_new).dup
+        traverse_chain = lambda do
+          if chain.empty?
+            yield
+          else
+            chain.shift.request(*args, &traverse_chain)
+          end
+        end
+        traverse_chain.call
+      end
+
+      def invoke_response(*args)
+        chain = map(&:make_new).dup
+        traverse_chain = lambda do
+          if chain.empty?
+            yield
+          else
+            chain.shift.response(*args, &traverse_chain)
+          end
+        end
+        traverse_chain.call
+      end
+    end
+  end
+end

data/lib/sniffer/middleware/entry.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Middleware
+    # Middleware entry, represented with klass and arguments for initializer
+    class Entry
+      attr_reader :klass
+
+      def initialize(klass, *args)
+        @klass = klass
+        @args = args
+      end
+
+      def make_new
+        @klass.new(*@args)
+      end
+    end
+  end
+end

data/lib/sniffer/middleware/logger.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Middleware
+    # Response logging build-in middleware
+    class Logger
+      attr_reader :logger, :severity
+
+      def initialize(logger, severity)
+        @logger = logger
+        @severity = severity
+      end
+
+      def request(_data_item)
+        yield
+      end
+
+      def response(data_item)
+        yield
+
+        return unless logger
+
+        logger.log(severity, data_item.to_json)
+      end
+    end
+  end
+end

data/lib/sniffer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sniffer
-  VERSION = "0.3.1"
+  VERSION = "0.5.0"
 end

data/lib/sniffer.rb

@@ -48,11 +48,20 @@ module Sniffer
     end
 
     def store(data_item)
-      data.store(data_item) if config.store
+      return unless config.store
+      return unless data_item.allowed_to_sniff?
+
+      config.middleware.invoke_request(data_item) do
+        data.store(data_item)
+      end
     end
 
-    def logger
-      config.logger
+    def notify_response(data_item)
+      return unless config.store
+      return unless data_item.allowed_to_sniff?
+
+      config.middleware.invoke_response(data_item) do
+      end
     end
   end
 end

data/sniffer.gemspec

@@ -19,13 +19,13 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "anyway_config", "~> 1.0"
-  spec.add_dependency "active_attr", ">= 0.10.2"
+  spec.add_dependency "anyway_config", ">= 1.0"
+  spec.add_dependency "dry-initializer", "~> 3"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 0.50"
+  spec.add_development_dependency "rubocop"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "sinatra", "~> 2.0"
   spec.add_development_dependency "puma", ">= 3.10.0"

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: sniffer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrey Deryabin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: active_attr
+  name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -255,10 +255,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -268,6 +272,16 @@ files:
 - assets/demo.gif
 - bin/console
 - bin/setup
+- docker-compose.yml
+- lib/all_prepend.rb
+- lib/curb_prepend.rb
+- lib/ethon_prepend.rb
+- lib/eventmachine_prepend.rb
+- lib/excon_prepend.rb
+- lib/http_prepend.rb
+- lib/httpclient_prepend.rb
+- lib/net_http_prepend.rb
+- lib/patron_prepend.rb
 - lib/sniffer.rb
 - lib/sniffer/adapters/curb_adapter.rb
 - lib/sniffer/adapters/ethon_adapter.rb
@@ -280,6 +294,9 @@ files:
 - lib/sniffer/config.rb
 - lib/sniffer/data.rb
 - lib/sniffer/data_item.rb
+- lib/sniffer/middleware/chain.rb
+- lib/sniffer/middleware/entry.rb
+- lib/sniffer/middleware/logger.rb
 - lib/sniffer/request_policy.rb
 - lib/sniffer/version.rb
 - sniffer.gemspec
@@ -302,8 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Analyze HTTP Requests

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.2
-  - 2.4.2
-  - 2.5.0