har-net-http 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0df5b1f6701543c334307d5d34f16a15102a1b4eb896ec1278b311320bf2bea
+  data.tar.gz: 57f7661081856ccd6ed81b051e670531fd53bdb5031cd786043643c0d8813221
+SHA512:
+  metadata.gz: 87170d3b023a77ad530b3698199e5773e5d58fdcc2651cac0cbedd752bd147e5de9db1e3f08b13acdb9c69b2239167efe1461e24a2be4157b782bf34fc28b278
+  data.tar.gz: 5203d9cb082297fe3e3373c1831be7e4b71bbf11b6ab03d7d44954d5f798cd266fff643e248e9f773a2f27f77c7669e71143180363d62fe902513cd057c636ec

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.6
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-20
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in har-net-http.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    har-net-http (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.15.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  har-net-http!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Smartbear
+
+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,58 @@
+# Har::Net::Http
+
+This library captures HTTP(S) traffic made by `net/http` as [HAR](http://www.softwareishard.com/blog/har-12-spec/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'har-net-http'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install har-net-http
+
+## Usage
+
+To capture a HAR, load this library:
+
+```ruby
+require 'har/net/http'
+
+# Reset the har, so that future requests will create a new HAR
+Har::Net::HTTP.har = nil
+```
+
+Then, [make some HTTP requests](https://docs.ruby-lang.org/en/master/Net/HTTP.html).
+If you prefer, you can also make HTTP requests with higher level libraries such as
+[faraday](https://lostisland.github.io/faraday/), [http.rb](https://github.com/httprb/http),
+[rest-client](https://github.com/rest-client/rest-client), [httparty](https://github.com/jnunemaker/httparty)
+or any other library that is built on top of Ruby's `net/http` library.
+
+When you're done, capture the HAR:
+
+```ruby
+har = JSON.stringify(Har::Net::HTTP.har)
+
+# Do what you want with it!
+```
+
+## 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 the created tag, 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/cucumber/har-net-http.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "har/net/http"
+
+# 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/har-net-http.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/har/net/http/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "har-net-http"
+  spec.version       = Har::Net::HTTP::VERSION
+  spec.authors       = ["Aslak Hellesøy"]
+  spec.email         = ["aslak.hellesoy@smartbear.com"]
+
+  spec.summary       = "Capture HAR files from net/http requests."
+  spec.homepage      = "https://github.com/cucumber/har-net-http"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cucumber/har-net-http"
+  spec.metadata["changelog_uri"] = "https://github.com/cucumber/har-net-http/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/har/net/http.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "net/http"
+require_relative "http/version"
+
+module Har
+  module Net
+    module HTTP
+      class << self
+        attr_accessor :har
+      end
+    end
+  end
+end
+
+module Net
+  # Reopen and monkey-patch the request method to capture traffic
+  class HTTP
+    alias original_request request
+
+    def request(req, body = nil, &block)
+      start_time = Time.now
+      res = original_request(req, body, &block)
+      end_time = Time.now
+      duration = ((end_time.to_f - start_time.to_f) * 1000).round
+
+      har_entry = {
+        # https://gist.github.com/dstagner/193207fed46acf5b5bae
+        startedDateTime: start_time.round(10).iso8601(6),
+        time: duration,
+        request: {
+          method: req.method,
+          url: req.uri.to_s,
+          httpVersion: "HTTP/1.1",
+          cookies: [],
+          headers: req.to_hash.map { |name, value| { name: name, value: value, comment: "" } },
+          queryString: [],
+          headersSize: -1,
+          bodySize: -1
+        },
+        response: {
+          status: res.code,
+          statusText: res.message,
+          httpVersion: res.http_version,
+          cookies: [],
+          headers: [],
+          content: {},
+          redirectURL: "",
+          headersSize: 160,
+          bodySize: 850,
+          comment: ""
+        },
+        cache: {},  # Not applicable to server-side logging.
+        timings: {
+          send: 0,  # Mandatory, but not applicable to server-side logging.
+          wait: duration,
+          receive: 0  # Mandatory, but not applicable to server-side logging.
+        }
+      }
+      har = ::Har::Net::HTTP.har ||= {
+        log: {
+          version: "1.2",
+          creator: {
+            name: "har-net-http",
+            version: ::Har::Net::HTTP::VERSION,
+            comment: ""
+          },
+          browser: {
+            name: RUBY_ENGINE,
+            version: RUBY_VERSION,
+            comment: ""
+          },
+          pages: [],
+          entries: [],
+          comment: ""
+        }
+      }
+      har[:log][:entries] << har_entry
+
+      res
+    end
+  end
+end

data/lib/har/net/http/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Har
+  module Net
+    module HTTP
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: har-net-http
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aslak Hellesøy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-20 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- aslak.hellesoy@smartbear.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- har-net-http.gemspec
+- lib/har/net/http.rb
+- lib/har/net/http/version.rb
+homepage: https://github.com/cucumber/har-net-http
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cucumber/har-net-http
+  source_code_uri: https://github.com/cucumber/har-net-http
+  changelog_uri: https://github.com/cucumber/har-net-http/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Capture HAR files from net/http requests.
+test_files: []