http_debug_output-parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21c17e896d8a98fc500c71b6b7a5fcf42328281013e1da0400b76d4b6e5e9e9f
+  data.tar.gz: 6ac253909248d0795892fe4c545628697b3b9338153a76f54db37893910c9625
+SHA512:
+  metadata.gz: 12987812dcd7db3dd44b05cdd22f3820c5094ed631429797132d94e6f8bc146c3391a42564c3d8ec1f67523f9f58556c7c9c464dc8f77d525e1b0e76cad54a90
+  data.tar.gz: 273c6a10ed566070edba9f2e9dd3fcbcceaa38fbc718f974cd2f9aca733bc3ba3e990cfcf08bffea3712dc2ac7b160eb0d7a83b59bc47aab64c8752546a53c93

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  Exclude:
+    - 'rails_simple_event_sourcing.gemspec'
+    - 'vendor/bundle/**/*'
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Damian Baćkowski
+
+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,125 @@
+# HttpDebugOutput::Parser ![tests](https://github.com/dbackowski/http_debug_output-parser/actions/workflows/rspec.yml/badge.svg) ![codecheck](https://github.com/dbackowski/http_debug_output-parser/actions/workflows/rubocop.yml/badge.svg)
+
+`HttpDebugOutput::Parser` is a Ruby gem designed to parse and transform the debug output from Ruby's Net::HTTP library into a structured, easy-to-read hash. This gem is particularly useful for developers who need to analyze HTTP requests and responses in a more human-readable and programmatically accessible format.
+
+### Features
+
+* Parses Debug Output: Converts raw Net::HTTP debug output into a structured Hash.
+
+* Request and Response Details: Extracts and organizes details such as HTTP method, path, headers, status codes, and payloads.
+
+* Easy Integration: Simple to integrate into existing Ruby projects, making it easier to debug and log HTTP interactions.
+
+
+### Example
+
+Given the raw debug output from Net::HTTP, the gem transforms it into a structured hash:
+
+```ruby
+{
+  :request => {
+    :method => "GET",
+    :path => "/astros.json",
+    :protocol => "HTTP/1.1",
+    :headers => [
+      "Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+      "Accept: */*",
+      "User-Agent: Ruby",
+      "Connection: close",
+      "Host: api.open-notify.org"
+    ],
+    :payload => nil
+  },
+  :response => {
+    :protocol => "HTTP/1.1",
+    :status => "200",
+    :message => "OK",
+    :headers => [
+      "Server: nginx/1.10.3",
+      "Date: Thu, 13 Feb 2025 18:58:02 GMT",
+      "Content-Type: application/json",
+      "Content-Length: 587",
+      "Connection: close",
+      "access-control-allow-origin: *"
+    ],
+    :payload => {
+      "people" => [
+        { "craft" => "ISS", "name" => "Oleg Kononenko" },
+        { "craft" => "ISS", "name" => "Nikolai Chub" },
+        { "craft" => "ISS", "name" => "Tracy Caldwell Dyson" },
+        { "craft" => "ISS", "name" => "Matthew Dominick" },
+        { "craft" => "ISS", "name" => "Michael Barratt" },
+        { "craft" => "ISS", "name" => "Jeanette Epps" },
+        { "craft" => "ISS", "name" => "Alexander Grebenkin" },
+        { "craft" => "ISS", "name" => "Butch Wilmore" },
+        { "craft" => "ISS", "name" => "Sunita Williams" },
+        { "craft" => "Tiangong", "name" => "Li Guangsu" },
+        { "craft" => "Tiangong", "name" => "Li Cong" },
+        { "craft" => "Tiangong", "name" => "Ye Guangfu" }
+      ],
+      "number" => 12,
+      "message"=>"success"
+    }
+  }
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'http_debug_output-parser'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install http_debug_output-parser
+```
+
+## Usage
+
+```ruby
+require 'http_debug_output-parser'
+
+debug_output = <<~DEBUG
+opening connection to api.open-notify.org:80...
+opened
+<- "GET /astros.json HTTP/1.1\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nUser-Agent: Ruby\r\nConnection: close\r\nHost: api.open-notify.org\r\n\r\n"
+-> "HTTP/1.1 200 OK\r\n"
+-> "Server: nginx/1.10.3\r\n"
+-> "Date: Thu, 13 Feb 2025 18:58:02 GMT\r\n"
+-> "Content-Type: application/json\r\n"
+-> "Content-Length: 587\r\n"
+-> "Connection: close\r\n"
+-> "access-control-allow-origin: *\r\n"
+-> "\r\n"
+reading 587 bytes...
+-> "{\"people\": [{\"craft\": \"ISS\", \"name\": \"Oleg Kononenko\"}, {\"craft\": \"ISS\", \"name\": \"Nikolai Chub\"}, {\"craft\": \"ISS\", \"name\": \"Tracy Caldwell Dyson\"}, {\"craft\": \"ISS\", \"name\": \"Matthew Dominick\"}, {\"craft\": \"ISS\", \"name\": \"Michael Barratt\"}, {\"craft\": \"ISS\", \"name\": \"Jeanette Epps\"}, {\"craft\": \"ISS\", \"name\": \"Alexander Grebenkin\"}, {\"craft\": \"ISS\", \"name\": \"Butch Wilmore\"}, {\"craft\": \"ISS\", \"name\": \"Sunita Williams\"}, {\"craft\": \"Tiangong\", \"name\": \"Li Guangsu\"}, {\"craft\": \"Tiangong\", \"name\": \"Li Cong\"}, {\"craft\": \"Tiangong\", \"name\": \"Ye Guangfu\"}], \"number\": 12, \"message\": \"success\"}"
+read 587 bytes
+Conn close
+DEBUG
+
+pp HttpDebugOutput::Parser.new(debug_output).call
+```
+
+## 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/dbackowski/http_debug_output-parser.
+
+## 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/http_debug_output-parser.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/http_debug_output/parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'http_debug_output-parser'
+  spec.version = HttpDebugOutput::Parser::VERSION
+  spec.authors = ['Damian Baćkowski']
+  spec.email = ['damianbackowski@gmail.com']
+
+  spec.summary = "Ruby's Net::HTTP debug output parser"
+  spec.description = "A gem that parses debug output from Ruby's Net::HTTP."
+  spec.homepage = 'https://github.com/dbackowski/http_debug_output-parser'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  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, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/http_debug_output/parser/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module HttpDebugOutput
+  class Parser
+    VERSION = '1.0.0'
+  end
+end

data/lib/http_debug_output/parser.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'parser/version'
+require 'json'
+
+module HttpDebugOutput
+  class Parser
+    def initialize(debug_output)
+      @debug_output = debug_output.split("\n")
+    end
+
+    def call
+      {
+        request: parse_request,
+        response: parse_response
+      }
+    end
+
+    private
+
+    def parse_request # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      request_lines = @debug_output[find_range_for_start_and_end_strings('<- ', '-> ')]
+                      .map { |line| clean_line(line.gsub('<- ', '')) }
+      method, path, protocol = request_lines.first.split
+      headers = request_lines[1..].take_while { |line| line != '' }
+      payload = request_lines[headers.count + 1..].join
+
+      {
+        method:,
+        path:,
+        protocol:,
+        headers:,
+        payload: payload.empty? ? nil : JSON.parse(payload)
+      }
+    end
+
+    def parse_response # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      response_lines = @debug_output[find_range_for_start_and_end_strings('-> ', 'read ')]
+                       .map { |line| clean_line(line.gsub('-> ', '')) }
+                       .filter { |line| line != '' }
+      protocol, status, *message = response_lines.first.split
+      headers = response_lines[1..].take_while { |line| !line.start_with?('reading') }
+      payload = response_lines[headers.count + 2..].join
+
+      {
+        protocol:,
+        status:,
+        message: message.join(' '),
+        headers:,
+        payload: payload.empty? ? nil : JSON.parse(payload)
+      }
+    end
+
+    def find_range_for_start_and_end_strings(start_index_string, end_index_string)
+      start_index = @debug_output.find_index { |line| line.start_with?(start_index_string) }
+      end_index = @debug_output.find_index { |line| line.start_with?(end_index_string) }
+      start_index..end_index - 1
+    end
+
+    def clean_line(line)
+      line.gsub("\r", '').gsub(/\A"/, '').gsub(/"\Z/, '')
+    end
+  end
+end

data/sig/http_debug_output/parser.rbs

@@ -0,0 +1,6 @@
+module HttpDebugOutput
+  module Parser
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: http_debug_output-parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Damian Baćkowski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-19 00:00:00.000000000 Z
+dependencies: []
+description: A gem that parses debug output from Ruby's Net::HTTP.
+email:
+- damianbackowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- http_debug_output-parser.gemspec
+- lib/http_debug_output/parser.rb
+- lib/http_debug_output/parser/version.rb
+- sig/http_debug_output/parser.rbs
+homepage: https://github.com/dbackowski/http_debug_output-parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dbackowski/http_debug_output-parser
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Ruby's Net::HTTP debug output parser
+test_files: []