little_sniffer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82602fd9f0307822fe635ce7d08e1c74958099be1a0a9502300487369ae2e8aa
+  data.tar.gz: 298de648aa253edb97a1b4f949ce78fa614028901c37c364c04d456a0842492f
+SHA512:
+  metadata.gz: cda69983acb023f8e9ec8c21ce04f4045f27054bd5e19b74125d1922cb6c5d0f3c399a2560c6cf4035e2f1107fb35d140063ca993732d5e57fd66a0eaea3e0c9
+  data.tar.gz: 66f4157f339fafda49b864163869248b013f357035510dc3393bfd53b9c98df39d41c2ff7d4f4b2dbce1db657274e99c64387d2ce9bba56301a16ef47f5bbb19

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/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,62 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  # Include gemspec and Rakefile
+  Include:
+    - "lib/**/*.rb"
+    - "lib/**/*.rake"
+    - "spec/**/*.rb"
+  Exclude:
+    - "bin/**/*"
+    - "Gemfile"
+    - "Rakefile"
+    - "*.gemspec"
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/StringLiterals:
+  Enabled: false
+
+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"
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+Security/YAMLLoad:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (March 16, 2021) ##
+
+* Initial version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at deriabin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sniffer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andrey Deryabin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# Little Sniffer
+It's like [Sniffer](https://github.com/aderyabin/sniffer), but not global.
+
+LittleSniffer aims to help:
+
+  * Watch for needed http requests (request groups) and passing their raw data to provided handler. It doesn't store data!
+
+Sniffer supports only [Net::HTTP](http://ruby-doc.org/stdlib-2.4.2/libdoc/net/http/rdoc/Net/HTTP.html) for now, however PR's are welcomed
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'little_sniffer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install little_sniffer
+
+## Usage
+
+Here's some simple examples to get you started:
+
+```ruby
+require 'http'
+require 'little_sniffer'
+
+class YourHandler
+  def handle(data)
+    pp data
+  end
+end
+
+handler = YourHandler.new
+
+LittleSniffer.new(handler) do
+  HTTP.get('http://example.com/?lang=ruby&author=matz')
+end
+
+# => {:request=>
+#   {:host=>"example.com",
+#    :query=>"/?lang=ruby&author=matz",
+#    :port=>80,
+#    :headers=>{"Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3", "Connection"=>"close"},
+#    :body=>"",
+#    :method=>:get},
+#  :response=>
+#   {:status=>200,
+#    :headers=>
+#     {"Content-Encoding"=>"gzip",
+#      "Cache-Control"=>"max-age=604800",
+#      "Content-Type"=>"text/html",
+#      "Date"=>"Thu, 26 Oct 2017 13:47:00 GMT",
+#      "Etag"=>"\"359670651+gzip\"",
+#      "Expires"=>"Thu, 02 Nov 2017 13:47:00 GMT",
+#      "Last-Modified"=>"Fri, 09 Aug 2013 23:54:35 GMT",
+#      "Server"=>"ECS (lga/1372)",
+#      "Vary"=>"Accept-Encoding",
+#      "X-Cache"=>"HIT",
+#      "Content-Length"=>"606",
+#      "Connection"=>"close"},
+#    :body=> "OK",
+#    :timing=>0.23753299983218312}}
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/HolyWalley/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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sniffer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/HolyWalley/sniffer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sniffer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/little_sniffer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "little_sniffer/version"
+require_relative "little_sniffer/adapters/net_http_adapter"
+
+# LittleSniffer allows to log http request locally
+class LittleSniffer
+  UnsupportedAdapterError = Class.new(StandardError)
+  HandlerDoesNotMatchTheInterfaceError = Class.new(StandardError)
+
+  ADAPTERS_MAP = {
+    net_http: Adapters::NetHttpAdapter
+  }.freeze
+
+  def initialize(handler, adapter = :net_http, &block)
+    adapter = validate_adapter(adapter)
+    validate_handler(handler)
+
+    adapter.new(handler).sniff(&block)
+  end
+
+  private
+
+  def validate_handler(handler)
+    return if handler.respond_to?(:handle)
+
+    raise HandlerDoesNotMatchTheInterfaceError
+  end
+
+  def validate_adapter(adapter)
+    adapter = ADAPTERS_MAP[adapter]
+
+    return adapter if adapter
+
+    error_message = "maybe you have misspelled it. Appropriate types are: #{ADAPTERS_MAP.keys.join(', ')}"
+    raise UnsupportedAdapterError, error_message
+  end
+end

data/lib/little_sniffer/adapters/net_http_adapter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "benchmark"
+
+class LittleSniffer
+  module Adapters
+    class NetHttpAdapter
+      def initialize(handler)
+        @handler = handler
+      end
+
+      def sniff
+        Net::HTTP.define_method(:request_with_sniffer, build_request_with_sniffer(@handler))
+        Net::HTTP.alias_method(:request_without_sniffer, :request)
+        Net::HTTP.alias_method(:request, :request_with_sniffer)
+
+        yield
+      ensure
+        Net::HTTP.alias_method(:request, :request_without_sniffer)
+        Net::HTTP.remove_method(:request_with_sniffer)
+        Net::HTTP.remove_method(:request_without_sniffer)
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def build_request_with_sniffer(handler)
+        lambda do |req, body = nil, &block|
+          data = {
+            request: {
+              host: @address,
+              method: req.method,
+              query: req.path,
+              port: @port,
+              headers: req.each_header.collect.to_h,
+              body: req.body.to_s
+            }
+          }
+
+          bm = Benchmark.realtime do
+            @response = request_without_sniffer(req, body, &block)
+          end
+
+          data[:response] = {
+            status: @response.code.to_i,
+            headers: @response.each_header.collect.to_h,
+            body: @response.body.to_s,
+            timing: bm
+          }
+
+          handler.handle(data)
+
+          @response
+        end
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    end
+  end
+end

data/lib/little_sniffer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class LittleSniffer
+  VERSION = "0.1.1"
+end

data/little_sniffer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "little_sniffer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "little_sniffer"
+  spec.version       = LittleSniffer::VERSION
+  spec.authors       = ["Yakau Kranou"]
+  spec.email         = ["yasha.krasnov@gmail.com"]
+
+  spec.summary       = %q{Analyze HTTP Requests}
+  spec.description   = %q{Analyze HTTP Requests}
+  spec.homepage      = "http://github.com/HolyWalley/little_sniffer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  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"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "sinatra", "~> 2.0"
+  spec.add_development_dependency "puma", ">= 3.10.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: little_sniffer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Yakau Kranou
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: Analyze HTTP Requests
+email:
+- yasha.krasnov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/little_sniffer.rb
+- lib/little_sniffer/adapters/net_http_adapter.rb
+- lib/little_sniffer/version.rb
+- little_sniffer.gemspec
+homepage: http://github.com/HolyWalley/little_sniffer
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Analyze HTTP Requests
+test_files: []