sniffer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a791b41dd917e6bd37ad0a30f52edfb29316305
-  data.tar.gz: '08393e568d23b31a060406b390b85ddee72c20a5'
+  metadata.gz: 1a09ca069eb76f2fc329bf27351cc2499138ca6d
+  data.tar.gz: cb8e52bd4c2ad6ffe509ea85c7a1df80d5d79489
 SHA512:
-  metadata.gz: 70eea24423a67f79778531924b3957d87f64d73ef62198bd7ad76dc05f24ae363706e5a29f69b99a961f2e4dc86509b2e6a35fa5c6d65ca69fc7b585ab678b33
-  data.tar.gz: d0178703da107888ebd02bd115f64ebed1421fc72618708b649b7d711e3f0ac5da58e3ffcb07c7da30318ee2f8146b7802b4c33eab1a22a8bd2eff21a2104054
+  metadata.gz: c34b3b15837f64f6a7c9e45c71fa5f2392854122eb6f462656553a27aa12c875be6146cb0b0aacbe182c229ba2516ea41c8b0431dab33bf16e6f6a88b7f5f9e5
+  data.tar.gz: 0dac7a4e9d90125899d8100d168e5659c37d872b514f57cc94867ac0750b53f5ce2accc2d7527a38d48efa6cd20cf1e91d72b1f8e2c37b6f29fa91232668237f

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-version

data/.travis.yml

@@ -3,3 +3,4 @@ language: ruby
 rvm:
   - 2.2.2
   - 2.4.2
+  - 2.5.0

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 0.3.0 (January 12, 2018) ##
+
 ## 0.2.0 (January 8, 2018) ##
 
 * Added Excon adapter

data/README.md

@@ -43,30 +43,6 @@ Or install it yourself as:
 
     $ gem install sniffer
 
-## Configuration
-
-Sniffer default options:
-
-```ruby
-Sniffer.config do |c|
-  c.logger = Logger.new($stdout),
-  c.severity = Logger::Severity::DEBUG,
-  # HTTP options to log
-  c.log = {
-    request_url: true,
-    request_headers: true,
-    request_body: true,
-    request_method: true,
-    response_status: true,
-    response_headers: true,
-    response_body: true,
-    timing: true
-  },
-  c.store =  true, # save requests/responses to Sniffer.data
-  c.enabled = false  # Sniffer disabled by default
-end
-```
-
 ## Usage
 
 Here's some simple examples to get you started:
@@ -143,6 +119,63 @@ D, [2017-10-26T16:47:14.007152 #59511] DEBUG -- : {"port":80,"host":"example.com
 ```
 where `rq_xxx` is request header and `rs_xxx` - response header
 
+## Configuration
+
+Sniffer default options:
+
+```ruby
+Sniffer.config do |c|
+  c.logger = Logger.new($stdout),
+  c.severity = Logger::Severity::DEBUG,
+  # HTTP options to log
+  c.log = {
+    request_url: true,
+    request_headers: true,
+    request_body: true,
+    request_method: true,
+    response_status: true,
+    response_headers: true,
+    response_body: true,
+    timing: true
+  },
+  c.store =  true, # save requests/responses to Sniffer.data
+  c.enabled = false  # Sniffer disabled by default
+  c.url_whitelist = nil
+  c.url_blacklist = nil
+end
+```
+
+### Whitelist
+
+You can add specific host url to whitelist as regexp or string. Sniffer will store only requests that matched.
+
+```ruby
+Sniffer.config.url_whitelist = /whitelisted.com/
+
+HTTP.get('http://example.com')
+Sniffer.data[0].to_h
+# => {}
+
+HTTP.get('http://whitelisted.com/')
+Sniffer.data[0].to_h
+# => {{:request=>{:host=>"whitelisted.com", ....}}
+```
+
+### Blacklist
+
+You can add specific host url to blacklist as regexp or string. Sniffer will ignore all matched requests.
+
+```ruby
+Sniffer.config.url_blacklist = /blacklisted.com/
+
+HTTP.get('http://blacklisted.com')
+Sniffer.data[0].to_h
+# => {}
+
+HTTP.get('http://example.com')
+Sniffer.data[0].to_h
+# => {{:request=>{:host=>"example.com", ...}}
+```
 
 ## Development
 
@@ -160,6 +193,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/aderya
 * [Salahutdinov Dmitry](https://github.com/dsalahutdinov)
 * [Stanislav Chereshkevich](https://github.com/dissident)
 * [Anatoliy Kurichev](https://github.com/russo-matrosso)
+* [Dmitriy Ivliev](https://github.com/moofkit)
 
 ## License
 

data/lib/sniffer.rb

@@ -48,7 +48,7 @@ module Sniffer
     end
 
     def store(data_item)
-      data.store(data_item)
+      data.store(data_item) if config.store
     end
 
     def logger

data/lib/sniffer/config.rb

@@ -20,7 +20,9 @@ module Sniffer
                   timing: true
                 },
                 store: true,
-                enabled: false
+                enabled: false,
+                url_whitelist: nil,
+                url_blacklist: nil
 
     def capacity?
       store.is_a?(Hash) && store.key?(:capacity)

data/lib/sniffer/data.rb

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

data/lib/sniffer/data_item.rb

@@ -2,6 +2,7 @@
 
 require 'active_attr'
 require 'json'
+require_relative 'request_policy'
 
 module Sniffer
   # Sniffer data item stores a request info
@@ -17,6 +18,7 @@ module Sniffer
     end
 
     def log
+      return unless allowed_to_sniff?
       Sniffer.logger.log(Sniffer.config.severity, to_json)
     end
 
@@ -29,6 +31,11 @@ module Sniffer
       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

data/lib/sniffer/request_policy.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Sniffer
+  # match request with white and black lists
+  module RequestPolicy
+    class << self
+      def call(request)
+        url = "#{request.host}:#{request.port}"
+        if config.url_whitelist
+          whitelist_url?(url)
+        elsif config.url_blacklist
+          !blacklist_url?(url)
+        else
+          true
+        end
+      end
+
+      private
+
+      def whitelist_url?(url)
+        !url.match(config.url_whitelist).nil?
+      end
+
+      def blacklist_url?(url)
+        !url.match(config.url_blacklist).nil?
+      end
+
+      def config
+        Sniffer.config
+      end
+    end
+  end
+end

data/lib/sniffer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sniffer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrey Deryabin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -258,7 +258,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -281,6 +280,7 @@ files:
 - lib/sniffer/config.rb
 - lib/sniffer/data.rb
 - lib/sniffer/data_item.rb
+- lib/sniffer/request_policy.rb
 - lib/sniffer/version.rb
 - sniffer.gemspec
 homepage: http://github.com/aderyabin/sniffer
@@ -303,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Analyze HTTP Requests

data/.ruby-version

@@ -1 +0,0 @@
-2.4.2