sniffer 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df847d342d16a8c26cf1e9711fab6baf465444524ea9eb1e404b2b762a228c8
-  data.tar.gz: 28cbd39a08076ef975e9370d6d49d926a169b6cc1368fd35ee33de96611e1d58
+  metadata.gz: 25c004fd4e29948699cec6a077433d3b0d98f3571c361be81c4f15626f2143a3
+  data.tar.gz: f08cbb6c16a3d572a3536c2a08eff0978f87e4f4d35b489d4cbfdf3ea60c6af9
 SHA512:
-  metadata.gz: ddb474fcfce55fb0875bd27df8a89a35be9ff1516fba2dc3778e2423823a85200cf27970f88efce3508bfcc8c57edc29d3b422755ce7c7d4eb9b22935d8eb3df
-  data.tar.gz: b71fb9b1be1d0715a2b4b2fd856d119ca5e7372cc52c759328e17f4ab714ab68fefbe7b7da1a0183763496ed9ed9f9cfb30a1ad3d35547596bb94b5a305f3aab
+  metadata.gz: 9548307ea9f504e05ce9fa1f789a1e0d697906841f34a317f5c67c3e1c0ae669f69afab0537fe5e331550e10b531016227ff68321c1f4eadb4bc3f3d6d7a896b
+  data.tar.gz: 1cacd254ba99b6167c4d2221061ebbba0cb2565c281fe100df31190ac0e37035c14e008544d5f2f02b980a08609187841886d700354c6e76a95cd31afb84781e

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: aderyabin
+
+---
+
+## What did you do?
+
+## What did you expect to happen?
+
+## What actually happened?
+
+## Additional context
+
+## Environment
+
+**Ruby Version:**
+
+**Framework Version (Rails, whatever):**
+
+**Sniffer Version:**

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: aderyabin
+
+---
+
+## Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+<!--
+  First of all, thanks for contributing!
+
+  If it's a typo fix or minor documentation update feel free to skip the rest of this template!
+-->
+
+## What is the purpose of this pull request?
+
+<!--
+  If it's a bug fix, then link it to the issue, for example:
+
+  Fixes #xxx
+-->
+
+## What changes did you make? (overview)
+
+## Is there anything you'd like reviewers to focus on?
+
+## Checklist
+
+- [ ] I've added tests for this change
+- [ ] I've added a Changelog entry
+- [ ] I've updated a documentation

data/.github/workflows/rspec.yml

@@ -0,0 +1,37 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.1', '3.0', '2.7', '2.6', '2.5']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install Bundler
+        run: |
+          gem install bundler
+      - name: Install deps
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends libcurl4-openssl-dev
+      - name: Install Ruby deps
+        run: |
+          bundle install --jobs 4 --retry 3
+      - name: Run RSpec
+        run: |
+          bundle exec rspec
+      - name: Run RSpec (prepended)
+        run: |
+          bundle exec rspec -r all_prepend

data/.github/workflows/rubocop.yml

@@ -0,0 +1,23 @@
+name: Lint Ruby
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+      - name: Install RuboCop
+        run: |
+          gem install rubocop
+      - name: Run RuboCop
+        run: |
+          rubocop -c .rubocop.yml

data/.rubocop.yml

@@ -1,17 +1,17 @@
 AllCops:
+  TargetRubyVersion: 2.5
   # Include gemspec and Rakefile
   Include:
-    - 'lib/**/*.rb'
-    - 'lib/**/*.rake'
-    - 'spec/**/*.rb'
+    - "lib/**/*.rb"
+    - "lib/**/*.rake"
+    - "spec/**/*.rb"
   Exclude:
-    - 'bin/**/*'
-    - 'Gemfile'
-    - 'Rakefile'
-    - '*.gemspec'
+    - "bin/**/*"
+    - "Gemfile"
+    - "Rakefile"
+    - "*.gemspec"
   DisplayCopNames: true
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
 
 Naming/AccessorMethodName:
   Enabled: false
@@ -24,14 +24,14 @@ Style/TrivialAccessors:
 
 Style/Documentation:
   Exclude:
-    - 'spec/**/*.rb'
+    - "spec/**/*.rb"
 
 Style/StringLiterals:
   Enabled: false
 
 Style/BlockDelimiters:
   Exclude:
-    - 'spec/**/*.rb'
+    - "spec/**/*.rb"
 
 Style/DoubleNegation:
   Enabled: false
@@ -47,22 +47,16 @@ Lint/AmbiguousBlockAssociation:
 
 Metrics/MethodLength:
   Exclude:
-    - 'spec/**/*.rb'
+    - "spec/**/*.rb"
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
   Exclude:
-    - 'spec/**/*.rb'
+    - "spec/**/*.rb"
 
 Metrics/BlockLength:
   Exclude:
-    - 'spec/**/*.rb'
-
-Rails/Date:
-  Enabled: false
-
-Rails/TimeZone:
-  Enabled: false
+    - "spec/**/*.rb"
 
 Security/YAMLLoad:
   Enabled: false

data/CHANGELOG.md

@@ -1,9 +1,23 @@
-## 0.3.0 (January 12, 2018) ##
+## 0.5.0 (May 6, 2022) ##
+
+* Added prepend of all adapters by [@nate-at-gusto](https://github.com/nate-at-gusto)
+* Replaced `active_attr` to `dry-initializer`
+* Added rubies `2.7`, `3.0`, `3.1` support
+
+
+## 0.4.0 (March 19, 2020) ##
+
+* Added middleware support by [@dsalahutdinov](https://github.com/dsalahutdinov)
+
+
+## 0.3.2 (January 12, 2018) ##
+
+* Fix EventMachine::HttpClient not defined in Thin
 
 ## 0.2.0 (January 8, 2018) ##
 
 * Added Excon adapter
-* Added EventMachine adapter  
+* Added EventMachine adapter
 * Added `rotate` option
 * Added storage capacity feature
 * Added ruby 2.2 support

data/README.md

@@ -1,6 +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) [![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)
+[![Build](https://github.com/aderyabin/sniffer/workflows/Run%20Tests/badge.svg)](https://github.com/aderyabin/sniffer/actions) [![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:
 
@@ -19,10 +19,6 @@ Sniffer supports most common HTTP accessing libraries:
 * [EM-HTTP-Request](https://github.com/igrigorik/em-http-request)
 * [Excon](https://github.com/excon/excon)
 
-
-<a href="https://evilmartians.com/">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
-
 ## Demo
 
 ![demo](https://github.com/aderyabin/sniffer/blob/master/assets/demo.gif?raw=true)
@@ -35,6 +31,20 @@ Add this line to your application's Gemfile:
 gem 'sniffer'
 ```
 
+If you wish Sniffer to use `Module#prepend` instead of `alias_method`, you can cause individual adapters to use `prepend` instead with:
+
+```ruby
+gem 'sniffer', require: ['http_prepend', 'httpclient_prepend', 'sniffer']
+```
+
+It's important that `'sniffer'` is the last item in the list. See the `lib` directory for a list of prependable adapters.
+
+If you want all adapters to use `prepend`:
+
+```ruby
+gem 'sniffer', require: ['all_prepend', 'sniffer']
+```
+
 And then execute:
 
     $ bundle
@@ -125,8 +135,8 @@ Sniffer default options:
 
 ```ruby
 Sniffer.config do |c|
-  c.logger = Logger.new($stdout),
-  c.severity = Logger::Severity::DEBUG,
+  c.logger = Logger.new($stdout)
+  c.severity = Logger::Severity::DEBUG
   # HTTP options to log
   c.log = {
     request_url: true,
@@ -137,8 +147,8 @@ Sniffer.config do |c|
     response_headers: true,
     response_body: true,
     timing: true
-  },
-  c.store =  true, # save requests/responses to Sniffer.data
+  }
+  c.store =  true # save requests/responses to Sniffer.data
   c.enabled = false  # Sniffer disabled by default
   c.url_whitelist = nil
   c.url_blacklist = nil
@@ -177,12 +187,45 @@ Sniffer.data[0].to_h
 # => {{:request=>{:host=>"example.com", ...}}
 ```
 
+### Middleware
+
+You can add the middleware to run custom code before/after the sniffed data was logged.
+
+```ruby
+Sniffer.middleware do |chain|
+  chain.add MyHook
+end
+
+class MyHook
+  def request(data_item)
+    puts "Before work"
+    yield
+    puts "After work"
+  end
+
+  def response(data_item)
+    puts "Before work"
+    yield
+    puts "After work"
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
+## Development (with Docker)
+
+Get local development environment working and tests running is very easy with docker-compose:
+```sh
+docker-compose run app bundle
+docker-compose run app bundle exec rspec
+```
+
 ## Contributing
 
 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.
@@ -195,6 +238,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/aderya
 * [Stanislav Chereshkevich](https://github.com/dissident)
 * [Anatoliy Kurichev](https://github.com/russo-matrosso)
 * [Dmitriy Ivliev](https://github.com/moofkit)
+* [Nate Berkopec](https://github.com/nate-at-gusto)
 
 ## License
 

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '3.4'
+
+services:
+  app:
+    image: ruby:latest
+    environment:
+      - BUNDLE_PATH=/bundle
+      - BUNDLE_CONFIG=/app/.bundle/config
+    command: bash
+    working_dir: /app
+    volumes:
+      - .:/app:cached
+      - bundler_data:/bundle
+    tmpfs:
+      - /tmp
+
+volumes:
+  bundler_data:

data/lib/all_prepend.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'curb_prepend'
+require 'ethon_prepend'
+require 'eventmachine_prepend'
+require 'excon_prepend'
+require 'http_prepend'
+require 'httpclient_prepend'
+require 'net_http_prepend'
+require 'patron_prepend'

data/lib/curb_prepend.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    module CurlAdapter
+      PREPEND = true
+    end
+  end
+end

data/lib/ethon_prepend.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    module EthonAdapter
+      PREPEND = true
+    end
+  end
+end

data/lib/eventmachine_prepend.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    module EventMachineAdapter
+      PREPEND = true
+    end
+  end
+end

data/lib/excon_prepend.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    module ExconAdapter
+      PREPEND = true
+    end
+  end
+end

data/lib/http_prepend.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    module HTTPAdapter
+      PREPEND = true
+    end
+  end
+end

data/lib/httpclient_prepend.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    module HTTPClientAdapter
+      PREPEND = true
+    end
+  end
+end

data/lib/net_http_prepend.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    module NetHttpAdapter
+      PREPEND = true
+    end
+  end
+end

data/lib/patron_prepend.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sniffer
+  module Adapters
+    module PatronAdapter
+      PREPEND = true
+    end
+  end
+end

data/lib/sniffer/adapters/curb_adapter.rb

@@ -4,16 +4,6 @@ module Sniffer
   module Adapters
     # Curl adapter
     module CurlAdapter
-      def self.included(base)
-        base.class_eval do
-          alias_method :http_without_sniffer, :http
-          alias_method :http, :http_with_sniffer
-
-          alias_method :http_post_without_sniffer, :http_post
-          alias_method :http_post, :http_post_with_sniffer
-        end
-      end
-
       def http_with_sniffer(verb)
         sniffer_request(verb)
 
@@ -40,6 +30,37 @@ module Sniffer
         @res
       end
 
+      # Only used when prepending, see all_prepend.rb
+      module Prepend
+        include CurlAdapter
+
+        def http(verb)
+          sniffer_request(verb)
+
+          super(verb)
+
+          bm = Benchmark.realtime do
+            @res = super(verb)
+          end
+
+          sniffer_response(bm)
+
+          @res
+        end
+
+        def http_post(*args)
+          sniffer_request(:POST, *args)
+
+          bm = Benchmark.realtime do
+            @res = super(*args)
+          end
+
+          sniffer_response(bm)
+
+          @res
+        end
+      end
+
       private
 
       def data_item
@@ -76,10 +97,23 @@ module Sniffer
                                                              body: body_str,
                                                              timing: timing)
 
-        data_item.log
+        Sniffer.notify_response(data_item)
       end
     end
   end
 end
 
-Curl::Easy.send(:include, Sniffer::Adapters::CurlAdapter) if defined?(::Curl::Easy)
+if defined?(::Curl::Easy)
+  if defined?(Sniffer::Adapters::CurlAdapter::PREPEND)
+    Curl::Easy.prepend Sniffer::Adapters::CurlAdapter::Prepend
+  else
+    Curl::Easy.class_eval do
+      include Sniffer::Adapters::CurlAdapter
+      alias_method :http_without_sniffer, :http
+      alias_method :http, :http_with_sniffer
+
+      alias_method :http_post_without_sniffer, :http_post
+      alias_method :http_post, :http_post_with_sniffer
+    end
+  end
+end