faraday-httpclient 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38e42915fda909553a3e9df19af6d3d4caa7873b7a085e94c71fd9db2aebd931
+  data.tar.gz: c8de5147fb1e9328f99df5156ab494e1c83fdb218ab64007f1f18245e8df52a2
+SHA512:
+  metadata.gz: 4044cf8c2ce0303953d5ff0f1488f0221ea633ae37ec43902bbc50b7ecd270ef8c6f86438e94d9d33e4b989206ac59ed6ab5a02eb1b2b6e6184bf4ab7c94d96a
+  data.tar.gz: c8877551110b9d0bbb70ec820f04161d3edb2b6a0b04143016baccc3523e8a823a1ee4b87e9fc6c5e5adafe4d57d17545dee15dd94ab7dca40541defc1e91bc5

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jan van der Pas
+
+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,62 @@
+# Faraday HTTPClient adapter
+
+This gem is a [Faraday][faraday] adapter for the [HTTPClient][httpclient] library.
+Faraday is an HTTP client library that provides a common interface over many adapters.
+Every adapter is defined into its own gem. This gem defines the adapter for HTTPClient.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'httpclient', '>= 2.2'
+gem 'faraday'
+gem 'faraday-httpclient'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install them yourself as:
+
+    $ gem install httpclient -v '>= 2.2'
+    $ gem install faraday faraday-httpclient
+
+## Usage
+
+Configure your Faraday connection to use this adapter like this:
+
+```ruby
+connection = Faraday.new(url, conn_options) do |conn|
+  conn.adapter(:httpclient)
+end
+```
+
+For more information on how to setup your Faraday connection and adapters usage, please refer to the [Faraday Website][faraday-website].
+
+## 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).
+
+## 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].
+
+## Code of Conduct
+
+Everyone interacting in the Faraday HTTPClient adapter project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct][code-of-conduct].
+
+[faraday]: https://github.com/lostisland/faraday
+[faraday-website]: https://lostisland.github.io/faraday
+[httpclient]: https://github.com/nahi/httpclient
+[rubygems]: https://rubygems.org
+[repo]: https://github.com/lostisland/faraday-httpclient
+[license]: https://github.com/lostisland/faraday-httpclient/blob/main/LICENSE.md
+[code-of-conduct]: https://github.com/lostisland/faraday-httpclient/blob/main/CODE_OF_CONDUCT.md

data/lib/faraday/adapter/httpclient.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+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 HTTPClient < Faraday::Adapter
+      def build_connection(env)
+        @client ||= ::HTTPClient.new.tap do |cli|
+          # enable compression
+          cli.transparent_gzip_decompression = true
+        end
+
+        if (req = env[:request])
+          if (proxy = req[:proxy])
+            configure_proxy @client, proxy
+          end
+
+          if (bind = req[:bind])
+            configure_socket @client, bind
+          end
+
+          configure_timeouts @client, req
+        end
+
+        if env[:url].scheme == 'https' && (ssl = env[:ssl])
+          configure_ssl @client, ssl
+        end
+
+        configure_client @client
+
+        @client
+      end
+
+      def call(env)
+        super
+
+        # TODO: Don't stream yet.
+        # https://github.com/nahi/httpclient/pull/90
+        env[:body] = env[:body].read if env[:body].respond_to? :read
+
+        connection(env) do |http|
+          resp = http.request env[:method], env[:url],
+                              body: env[:body],
+                              header: env[:request_headers]
+
+          if (req = env[:request]).stream_response?
+            warn "Streaming downloads for #{self.class.name} " \
+              'are not yet implemented.'
+            req.on_data.call(resp.body, resp.body.bytesize)
+          end
+          save_response env, resp.status, resp.body, resp.headers, resp.reason
+
+          @app.call env
+        end
+      rescue ::HTTPClient::TimeoutError, Errno::ETIMEDOUT
+        raise Faraday::TimeoutError, $ERROR_INFO
+      rescue ::HTTPClient::BadResponseError => e
+        if e.message.include?('status 407')
+          raise Faraday::ConnectionFailed,
+                %(407 "Proxy Authentication Required ")
+        end
+
+        raise Faraday::ClientError, $ERROR_INFO
+      rescue Errno::EADDRNOTAVAIL, Errno::ECONNREFUSED, IOError, SocketError
+        raise Faraday::ConnectionFailed, $ERROR_INFO
+      rescue StandardError => e
+        if defined?(::OpenSSL::SSL::SSLError) && \
+           e.is_a?(::OpenSSL::SSL::SSLError)
+          raise Faraday::SSLError, e
+        end
+
+        raise
+      end
+
+      # @param bind [Hash]
+      def configure_socket(client, bind)
+        client.socket_local.host = bind[:host]
+        client.socket_local.port = bind[:port]
+      end
+
+      # Configure proxy URI and any user credentials.
+      #
+      # @param proxy [Hash]
+      def configure_proxy(client, proxy)
+        client.proxy = proxy[:uri]
+        return unless proxy[:user] && proxy[:password]
+
+        client.set_proxy_auth(proxy[:user], proxy[:password])
+      end
+
+      # @param ssl [Hash]
+      def configure_ssl(client, ssl)
+        ssl_config = client.ssl_config
+        ssl_config.verify_mode = ssl_verify_mode(ssl)
+        ssl_config.cert_store = ssl_cert_store(ssl)
+
+        ssl_config.add_trust_ca ssl[:ca_file] if ssl[:ca_file]
+        ssl_config.add_trust_ca ssl[:ca_path] if ssl[:ca_path]
+        ssl_config.client_cert = ssl[:client_cert] if ssl[:client_cert]
+        ssl_config.client_key = ssl[:client_key] if ssl[:client_key]
+        ssl_config.verify_depth = ssl[:verify_depth] if ssl[:verify_depth]
+      end
+
+      # @param req [Hash]
+      def configure_timeouts(client, req)
+        if (sec = request_timeout(:open, req))
+          client.connect_timeout = sec
+        end
+
+        if (sec = request_timeout(:write, req))
+          client.send_timeout = sec
+        end
+
+        return unless (sec = request_timeout(:read, req))
+
+        client.receive_timeout = sec
+      end
+
+      def configure_client(client)
+        @config_block&.call(client)
+      end
+
+      # @param ssl [Hash]
+      # @return [OpenSSL::X509::Store]
+      def ssl_cert_store(ssl)
+        return ssl[:cert_store] if ssl[:cert_store]
+
+        # Memoize the cert store so that the same one is passed to
+        # HTTPClient each time, to avoid resyncing SSL sessions when
+        # it's changed
+
+        # Use the default cert store by default, i.e. system ca certs
+        @ssl_cert_store ||= OpenSSL::X509::Store.new.tap(&:set_default_paths)
+      end
+
+      # @param ssl [Hash]
+      def ssl_verify_mode(ssl)
+        ssl[:verify_mode] || begin
+          if ssl.fetch(:verify, true)
+            OpenSSL::SSL::VERIFY_PEER |
+              OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+          else
+            OpenSSL::SSL::VERIFY_NONE
+          end
+        end
+      end
+    end
+  end
+end

data/lib/faraday/httpclient.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'adapter/httpclient'
+require_relative 'httpclient/version'
+
+module Faraday
+  # Main Faraday::HTTPClient module
+  module HTTPClient
+    Faraday::Adapter.register_middleware(httpclient: Faraday::Adapter::HTTPClient)
+  end
+end

data/lib/faraday/httpclient/version.rb

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

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: faraday-httpclient
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- "@iMacTia"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: multipart-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Faraday adapter for HTTPClient
+email:
+- giuffrida.mattia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/faraday/adapter/httpclient.rb
+- lib/faraday/httpclient.rb
+- lib/faraday/httpclient/version.rb
+homepage: https://github.com/lostisland/faraday-httpclient
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lostisland/faraday-httpclient
+  source_code_uri: https://github.com/lostisland/faraday-httpclient
+  changelog_uri: https://github.com/lostisland/faraday-httpclient
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Faraday adapter for HTTPClient
+test_files: []