faraday-net-http2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e8099be6e0ad053b6fc8eefd9114f1bfbd05b8a58b9727b9fe751e1ef70ce75
+  data.tar.gz: e084f41c03c7bb8b78084db42be8a0e77005e236dd0136ee3e0e6ab9efad58f7
+SHA512:
+  metadata.gz: fd8bbd059b16384aad30e2d8eaaa7d2957ce955b16d8401575478da00062f7255d36798a903d65d8927cf203f56365b7c39e4447f68f33f665321865004bda84
+  data.tar.gz: 34f640e1ea88196fe89e0dfccff98f1049d1d937b7e80d104c1d9f862c26f27e990183897c79315fff4b08f6791c052145f282a881363a30d2056323a6433c9c

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 André Luis Leal Cardoso Junior
+
+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,52 @@
+# Faraday NetHttp2 Adapter
+
+This is an initial implementation of a [Faraday 2][faraday] adapter for the [NetHttp2][net-http2] HTTP client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-net-http2'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself with `gem install faraday-net-http2` and require it in your ruby code with `require 'faraday/net-http2'`
+
+## Usage
+
+### Basic
+
+```ruby
+conn = Faraday.new(...) do |f|
+  f.adapter :net_http2
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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](rubygems).
+
+### TODO
+
+- [ ] Enable all possible faraday features on spec/faraday/adapter/net_http2_spec.rb.
+- [ ] Streaming support?
+- [ ] Review custom webmock adapter, and maybe push it back to the main repo
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub][repo].
+
+## License
+
+The gem is available as open source under the terms of the [license][license].
+
+[faraday]: https://github.com/lostisland/faraday
+[net-http2]: https://github.com/ostinelli/net-http2
+[repo]: https://github.com/andrehjr/faraday-net-http2
+[license]: LICENSE.md

data/lib/faraday/adapter/net_http2.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'net-http2'
+require 'net/http/status'
+
+module Faraday
+  class Adapter
+    # This class provides the main implementation for your adapter.
+    # There are some key responsibilities that your adapter should satisfy:
+    # * Initialize and store internally the client you chose (e.g. Net::HTTP)
+    # * Process requests and save the response (see `#call`)
+    class NetHttp2 < Faraday::Adapter
+      # The initialize method is lazy-called ONCE when the connection stack is built.
+      # See https://github.com/lostisland/faraday/blob/master/lib/faraday/rack_builder.rb
+      #
+      # @param app [#call] the "rack app" wrapped in middleware. See https://github.com/lostisland/faraday/blob/master/lib/faraday/rack_builder.rb#L157
+      # @param opts [Hash] the options hash with all the options necessary for the adapter to correctly configure itself.
+      #   These are automatically stored into `@connection_options` when you call `super`.
+      # @param block [Proc] the configuration block for the adapter. This usually provides the possibility to access the internal client from the outside
+      #   and set properties that are not included in Faraday's API. It's automatically stored into `@config_block` when you call `super`.
+      def initialize(app = nil, opts = {}, &block)
+        super(app, opts, &block)
+      end
+
+      # This is the main method in your adapter. Since an adapter is a middleware, this method will be called FOR EVERY REQUEST.
+      # The main task of this method is to perform a call using the internal client and save the response.
+      # Since this method is not called directly f`rom the outside, you'll need to use `env` in order to:
+      # * Get the request parameters (see `Faraday::Env` and `Faraday::RequestOptions` for the full list). This includes processing:
+      #   * The request method, url, headers, parameters and body
+      #   * The SSL configuration (env[:ssl])
+      #   * The request configuration (env[:request]), i.e. things like: timeout, proxy, etc...
+      # * Set the response attributes. This can be done easily by calling `save_response`. These include:
+      #   * Response headers and body
+      #   * Response status and reason_phrase
+      #
+      # @param env [Faraday::Env] the environment of the request being processed
+      def call(env)
+        # First thing to do should be to call `super`. This will take care of the following for you:
+        # * Clear the body if the request supports a body
+        # * Initialize `env.response` to a `Faraday::Response`
+        super
+
+        client = ::NetHttp2::Client.new(env[:url], connect_timeout: env[:open_timeout])
+
+        opts = {
+          method: env[:method],
+          body: env[:body],
+          headers: env[:request_headers],
+          accept_encoding: ''
+        }.merge(@connection_options)
+
+        response = client.call(env[:method], env[:url].request_uri, opts)
+
+        # Now that you got the response in the client's format, you need to call `save_response` to store the necessary
+        # details into the `env`. This method accepts a block to make it easier for you to set response headers using
+        # `Faraday::Utils::Headers`. Simply provide a block that given a `response_headers` hash sets the necessary key/value pairs.
+        # Faraday will automatically take care of things like capitalising keys and coercing values.
+        reason_phrase = Net::HTTP::STATUS_CODES.fetch(response.status.to_i)
+        save_response(env, response.status, response.body, response.headers, reason_phrase) do |response_headers|
+          response.headers.each do |key, value|
+            response_headers[key] = value
+          end
+        end
+
+        client.close
+
+        # NOTE: An adapter `call` MUST return the `env.response`. If `save_response` is the last line in your `call`
+        # method implementation, it will automatically return the response for you.
+        # Otherwise, you'll need to manually do so. You can do this with any (not both) of the following lines:
+
+        # @app.call(env)
+        env.response
+      rescue Errno::ETIMEDOUT, ::NetHttp2::AsyncRequestTimeout => e
+        raise Faraday::TimeoutError, e
+      rescue Errno::ECONNREFUSED => e
+        raise Faraday::ConnectionFailed, e
+      end
+    end
+  end
+end

data/lib/faraday/net-http2.rb

@@ -0,0 +1 @@
+require_relative 'net_http2'

data/lib/faraday/net_http2/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module NetHttp2
+    VERSION = '0.1.0'
+  end
+end

data/lib/faraday/net_http2/webmock_adapter.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'webmock'
+
+module WebMock
+  module HttpLibAdapters
+    class WebMockNetHttp2Client < NetHttp2::Client
+
+      def call(method, path, options={})
+        request = prepare_request(method, path, options)
+
+        request_signature = WebMock::RequestSignature.new method, request.uri, body: request.body, headers: request.headers
+        WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
+
+        if (mock_response = WebMock::StubRegistry.instance.response_for_request(request_signature))
+          raise Errno::ETIMEDOUT if mock_response.should_timeout
+          response = NetHttp2::Response.new(
+            headers: { ":status" => mock_response.status[0] }.merge(mock_response.headers || {}),
+            body:    mock_response.body
+          )
+
+          WebMock::CallbackRegistry.invoke_callbacks({ lib: :net_http2 }, request_signature, mock_response)
+          response
+        elsif WebMock.net_connect_allowed?(request_signature.uri)
+          super
+        else
+          raise WebMock::NetConnectNotAllowedError, request_signature
+        end
+      end
+    end
+
+    class NetHttp2Adapter < WebMock::HttpLibAdapter
+      adapter_for :net_http2
+
+      OriginalNetHttp2Client = ::NetHttp2::Client unless const_defined?(:OriginalNetHttp2Client)
+
+      def self.enable!
+        ::NetHttp2.send(:remove_const, :Client)
+        ::NetHttp2.send(:const_set, :Client, WebMockNetHttp2Client)
+      end
+
+      def self.disable!
+        ::NetHttp2.send(:remove_const, :Client)
+        ::NetHttp2.send(:const_set, :Client, OriginalNetHttp2Client)
+      end
+    end
+  end
+end

data/lib/faraday/net_http2.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'adapter/net_http2'
+require_relative 'net_http2/version'
+
+module Faraday
+  module NetHttp2
+    Faraday::Adapter.register_middleware(net_http2: Faraday::Adapter::NetHttp2)
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: faraday-net-http2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- André Luis Leal Cardoso Junior
+bindir: bin
+cert_chain: []
+date: 2024-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: net-http2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Faraday adapter for NetHttp2
+email:
+- andrehjr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/faraday/adapter/net_http2.rb
+- lib/faraday/net-http2.rb
+- lib/faraday/net_http2.rb
+- lib/faraday/net_http2/version.rb
+- lib/faraday/net_http2/webmock_adapter.rb
+homepage: https://github.com/andrehjr/faraday-net-http2
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andrehjr/faraday-net-http2
+  source_code_uri: https://github.com/andrehjr/faraday-net-http2
+  changelog_uri: https://github.com/andrehjr/faraday-net-http2
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: Faraday adapter for NetHttp2
+test_files: []