sniffer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e61d38c32a8f74c8fabdd9113a45892685be34c8
-  data.tar.gz: 5ab43be1021421ec32cde7df4d2f33692318fda9
+  metadata.gz: 8a791b41dd917e6bd37ad0a30f52edfb29316305
+  data.tar.gz: '08393e568d23b31a060406b390b85ddee72c20a5'
 SHA512:
-  metadata.gz: 66ed0687f93be90af88b3a6b440350163f1f25284827e8359ed36dec78554c4fc8f55607f365090a358539f4a1e4e8db7ba4ac4f7b993c1a7d6c477c6c47fe55
-  data.tar.gz: ae3bb49ab20fd5fb84f9fe7e70c05c00e16141f43ee04aec53b627ec2e9f0269a2feb3fd54cd66a2de897390ebb96bfecd392f1e9bc4ce7945a75b7058002463
+  metadata.gz: 70eea24423a67f79778531924b3957d87f64d73ef62198bd7ad76dc05f24ae363706e5a29f69b99a961f2e4dc86509b2e6a35fa5c6d65ca69fc7b585ab678b33
+  data.tar.gz: d0178703da107888ebd02bd115f64ebed1421fc72618708b649b7d711e3f0ac5da58e3ffcb07c7da30318ee2f8146b7802b4c33eab1a22a8bd2eff21a2104054

data/.rubocop.yml

@@ -33,12 +33,18 @@ Style/BlockDelimiters:
   Exclude:
     - 'spec/**/*.rb'
 
+Style/DoubleNegation:
+  Enabled: false
+
 Layout/SpaceInsideStringInterpolation:
   EnforcedStyle: no_space
 
 Lint/AmbiguousRegexpLiteral:
   Enabled: false
 
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
 Metrics/MethodLength:
   Exclude:
     - 'spec/**/*.rb'

data/.travis.yml

@@ -1,14 +1,5 @@
 sudo: false
 language: ruby
-env:
-  global:
-    - CC_TEST_REPORTER_ID=bc054bdf814431bf40559f1cd62a86956fa5666296895400e1282a47ec6d1c69
 rvm:
+  - 2.2.2
   - 2.4.2
-before_install: gem install bundler -v 1.15.4
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.2.0 (January 8, 2018) ##
+
+* Added Excon adapter
+* Added EventMachine adapter  
+* Added `rotate` option
+* Added storage capacity feature
+* Added ruby 2.2 support
+
+
+## 0.1.0 (November 14, 2017) ##
+
+* Initial version

data/README.md

@@ -1,5 +1,6 @@
-# Sniffer [![Build Status](https://travis-ci.org/aderyabin/sniffer.svg?branch=master)](https://travis-ci.org/aderyabin/sniffer) [![Gem Version](https://badge.fury.io/rb/sniffer.svg)](https://rubygems.org/gems/sniffer) [![Maintainability](https://api.codeclimate.com/v1/badges/640cb17b3d748a49653f/maintainability)](https://codeclimate.com/github/aderyabin/sniffer/maintainability)
+# Sniffer
 
+[![Build Status](https://travis-ci.org/aderyabin/sniffer.svg?branch=master)](https://travis-ci.org/aderyabin/sniffer) [![Gem Version](https://badge.fury.io/rb/sniffer.svg)](https://rubygems.org/gems/sniffer) [![Join the chat at https://gitter.im/aderyabin/sniffer](https://badges.gitter.im/aderyabin/sniffer.svg)](https://gitter.im/aderyabin/sniffer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Sniffer aims to help:
 
@@ -15,6 +16,8 @@ Sniffer supports most common HTTP accessing libraries:
 * [Curb](https://github.com/taf2/curb/)
 * [Ethon](https://github.com/typhoeus/ethon)
 * [Typhoeus](https://github.com/typhoeus/typhoeus)
+* [EM-HTTP-Request](https://github.com/igrigorik/em-http-request)
+* [Excon](https://github.com/excon/excon)
 
 
 <a href="https://evilmartians.com/">
@@ -45,11 +48,11 @@ Or install it yourself as:
 Sniffer default options:
 
 ```ruby
-Sniffer.config do
-  logger: Logger.new($stdout),
-  severity: Logger::Severity::DEBUG,
+Sniffer.config do |c|
+  c.logger = Logger.new($stdout),
+  c.severity = Logger::Severity::DEBUG,
   # HTTP options to log
-  log: {
+  c.log = {
     request_url: true,
     request_headers: true,
     request_body: true,
@@ -59,8 +62,8 @@ Sniffer.config do
     response_body: true,
     timing: true
   },
-  store: true, # save requests/responses to Sniffer.data
-  enabled: false  # Sniffer disabled by default
+  c.store =  true, # save requests/responses to Sniffer.data
+  c.enabled = false  # Sniffer disabled by default
 end
 ```
 
@@ -108,6 +111,18 @@ You can clear saved data
 Sniffer.clear!
 ```
 
+You can configure capacity of storage to prevent the huge memory usage and set up log rotation.
+By default log rotation is active (when capacity is set) and log works like a queue.
+If rotation is disabled - requests will be logged until result log size reaches the capacity.
+
+```
+# will fill the storage and stop logging
+Sniffer.config.store = {capacity: 1000, rotate: false}
+
+# will rotate logs to fit 1000 results (rotate is true by default)
+Sniffer.config.store = {capacity: 1000}
+```
+
 You can reset config to default
 
 ```
@@ -139,6 +154,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/aderyabin/sniffer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## Acknowledge
+
+* [Sergey Ponomarev](https://github.com/sponomarev)
+* [Salahutdinov Dmitry](https://github.com/dsalahutdinov)
+* [Stanislav Chereshkevich](https://github.com/dissident)
+* [Anatoliy Kurichev](https://github.com/russo-matrosso)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/sniffer.rb

@@ -5,14 +5,11 @@ require "logger"
 require_relative "sniffer/version"
 require_relative "sniffer/config"
 require_relative "sniffer/data_item"
+require_relative "sniffer/data"
 
 # Sniffer allows to log http requests
 module Sniffer
-  @data = Set.new
-
   class << self
-    attr_reader :data
-
     def config
       @config ||= Config.new
       yield @config if block_given?
@@ -20,15 +17,16 @@ module Sniffer
     end
 
     def enable!
-      config.enabled = true
+      Thread.current[:sniffer] = true
     end
 
     def disable!
-      config.enabled = false
+      Thread.current[:sniffer] = false
     end
 
     def enabled?
-      config.enabled
+      Thread.current[:sniffer] = config.enabled if Thread.current[:sniffer].nil?
+      !!Thread.current[:sniffer]
     end
 
     def configure
@@ -41,11 +39,16 @@ module Sniffer
 
     def reset!
       @config = Config.new
+      Thread.current[:sniffer] = config.enabled
       clear!
     end
 
+    def data
+      @data ||= Sniffer::Data.new
+    end
+
     def store(data_item)
-      @data.add(data_item) if config.store
+      data.store(data_item)
     end
 
     def logger
@@ -60,3 +63,5 @@ require_relative "sniffer/adapters/http_adapter"
 require_relative "sniffer/adapters/patron_adapter"
 require_relative "sniffer/adapters/curb_adapter"
 require_relative "sniffer/adapters/ethon_adapter"
+require_relative "sniffer/adapters/eventmachine_adapter"
+require_relative "sniffer/adapters/excon_adapter"

data/lib/sniffer/adapters/curb_adapter.rb

@@ -14,7 +14,6 @@ module Sniffer
         end
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def http_with_sniffer(verb)
         sniffer_request(verb)
 
@@ -47,6 +46,7 @@ module Sniffer
         @data_item ||= Sniffer::DataItem.new if Sniffer.enabled?
       end
 
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def sniffer_request(verb, *args)
         return unless data_item
 
@@ -63,6 +63,7 @@ module Sniffer
 
         Sniffer.store(data_item)
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       def sniffer_response(timing)
         return unless data_item

data/lib/sniffer/adapters/ethon_adapter.rb

@@ -70,9 +70,7 @@ module Sniffer
 
           end
 
-          if Ethon.logger.debug?
-            Ethon.logger.debug { "ETHON: performed #{log_inspect}" }
-          end
+          Ethon.logger.debug { "ETHON: performed #{log_inspect}" } if Ethon.logger.debug?
           complete
 
           @return_code

data/lib/sniffer/adapters/eventmachine_adapter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    # Em-Http-Connection Adapter
+    module EventMachineAdapter
+      # Overrides #send_request, #parse_response, #on_body_data
+      module Client
+        def self.included(base)
+          base.class_eval do
+            alias_method :send_request_without_sniffer, :send_request
+            alias_method :send_request, :send_request_with_sniffer
+            alias_method :parse_response_header_without_sniffer, :parse_response_header
+            alias_method :parse_response_header, :parse_response_header_with_sniffer
+            alias_method :on_body_data_without_sniffer, :on_body_data
+            alias_method :on_body_data, :on_body_data_with_sniffer
+          end
+        end
+
+        # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        def send_request_with_sniffer(head, body)
+          if Sniffer.enabled?
+            @data_item = Sniffer::DataItem.new
+            @data_item.response = Sniffer::DataItem::Response.new
+            @data_item.request = Sniffer::DataItem::Request.new(host: @req.host,
+                                                                method: @req.method.to_sym,
+                                                                query: encode_query(@req.uri, @req.query),
+                                                                headers: @req.headers,
+                                                                body: @req.body.to_s,
+                                                                port: @req.port)
+            Sniffer.store(@data_item)
+
+            @start_time = Time.now
+          end
+
+          send_request_without_sniffer(head, body)
+        end
+        # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+
+        def parse_response_header_with_sniffer(header, version, status)
+          if Sniffer.enabled?
+            @data_item.response.timing = Time.now - @start_time
+            @data_item.response.status = status
+            @data_item.response.headers = header
+          end
+
+          parse_response_header_without_sniffer(header, version, status)
+        end
+
+        def on_body_data_with_sniffer(data)
+          if Sniffer.enabled?
+            @data_item.response.body = data
+            @data_item.log
+          end
+
+          on_body_data_without_sniffer(data)
+        end
+      end
+    end
+  end
+end
+
+EventMachine::HttpClient.send(:include, Sniffer::Adapters::EventMachineAdapter::Client) if defined?(::EventMachine)

data/lib/sniffer/adapters/excon_adapter.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    # Excon adapter
+    module ExconAdapter
+      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(params = {}, &block)
+        if Sniffer.enabled?
+          datum = data.merge(params)
+          data_item = Sniffer::DataItem.new
+          data_item.request = Sniffer::DataItem::Request.new(host: datum[:host],
+                                                             method: datum[:method],
+                                                             query: datum[:path] + ::Excon::Utils.query_string(datum),
+                                                             headers: datum[:headers] || {},
+                                                             body: datum[:body].to_s,
+                                                             port: datum[:port])
+
+          Sniffer.store(data_item)
+        end
+
+        bm = Benchmark.realtime do
+          @response = request_without_sniffer(params, &block)
+        end
+
+        if Sniffer.enabled?
+          data_item.response = Sniffer::DataItem::Response.new(status: @response.status,
+                                                               headers: @response.headers,
+                                                               body: @response.body,
+                                                               timing: bm)
+
+          data_item.log
+        end
+
+        @response
+      end
+      # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+    end
+  end
+end
+
+::Excon::Connection.send(:include, Sniffer::Adapters::ExconAdapter) if defined?(::Excon::Connection)

data/lib/sniffer/config.rb

@@ -21,5 +21,18 @@ module Sniffer
                 },
                 store: true,
                 enabled: false
+
+    def capacity?
+      store.is_a?(Hash) && store.key?(:capacity)
+    end
+
+    def capacity
+      store.fetch(:capacity).to_i
+    end
+
+    def rotate?
+      return false unless capacity?
+      store.fetch(:rotate, true)
+    end
   end
 end

data/lib/sniffer/data.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sniffer
+  # Data class stores the data and controls capacity
+  class Data < Array
+    def store(data_item)
+      return unless config.store
+
+      if config.rotate?
+        rotate(data_item)
+      else
+        push(data_item) unless overflow?
+      end
+    end
+
+    private
+
+    def rotate(data_item)
+      shift if overflow?
+      push(data_item)
+    end
+
+    def overflow?
+      config.capacity? && length >= config.capacity
+    end
+
+    def config
+      Sniffer.config
+    end
+  end
+end

data/lib/sniffer/data_item.rb

@@ -11,8 +11,8 @@ module Sniffer
 
     def to_h
       {
-        request: request&.to_h,
-        response: response&.to_h
+        request: request && request.to_h,
+        response: response && response.to_h
       }
     end
 

data/lib/sniffer/version.rb

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

data/sniffer.gemspec

@@ -35,4 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "curb", ">= 0.9.4"
   spec.add_development_dependency "ethon", ">= 0.11.0"
   spec.add_development_dependency "typhoeus", ">= 0.9.0"
+  spec.add_development_dependency "em-http-request", ">= 1.1.0"
+  spec.add_development_dependency "excon", ">= 0.60.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sniffer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Deryabin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -220,6 +220,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.60.0
 description: Analyze HTTP Requests
 email:
 - aderyabin@evilmartians.com
@@ -232,6 +260,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -243,11 +272,14 @@ files:
 - lib/sniffer.rb
 - lib/sniffer/adapters/curb_adapter.rb
 - lib/sniffer/adapters/ethon_adapter.rb
+- lib/sniffer/adapters/eventmachine_adapter.rb
+- lib/sniffer/adapters/excon_adapter.rb
 - lib/sniffer/adapters/http_adapter.rb
 - lib/sniffer/adapters/httpclient_adapter.rb
 - lib/sniffer/adapters/net_http_adapter.rb
 - lib/sniffer/adapters/patron_adapter.rb
 - lib/sniffer/config.rb
+- lib/sniffer/data.rb
 - lib/sniffer/data_item.rb
 - lib/sniffer/version.rb
 - sniffer.gemspec