faraday-excon 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b78b8cf1e6b7dfecc1beb94c545a64be9c7c29f2dc71b88ddf52a954154f99d2
+  data.tar.gz: d6f22b96924c1221e19d62250a2250cdb3990f7da1d6bdfdd524ee7d969d5f9d
+SHA512:
+  metadata.gz: 4db552b4e3b61fa66dd169405cb113f6b0de62f75f07b822c91b7152d01de96b761ba5528b9b8c9c09889c070d2e4788b31441216b75af1a188e67a7779915ec
+  data.tar.gz: 0a82f49683023ff4c9099820fe70fdb2f2c446dd2abcfeff30e180546ddc40eec6f39f1ea946cf94cae267a0cbc1d9ffdbe68c62f3147439a917da20a446958e

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,59 @@
+# Faraday Excon adapter
+
+This gem is a [Faraday][faraday] adapter for the [Excon][excon] 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 Excon.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-excon'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install faraday-excon
+
+## Usage
+
+Configure your Faraday connection to use this adapter like this:
+
+```ruby
+connection = Faraday.new(url, conn_options) do |conn|
+  conn.adapter(:excon)
+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 Excon 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
+[excon]: https://github.com/excon/excon
+[rubygems]: https://rubygems.org
+[repo]: https://github.com/lostisland/faraday-excon
+[license]: https://github.com/lostisland/faraday-excon/blob/main/LICENSE.md
+[code-of-conduct]: https://github.com/lostisland/faraday-excon/blob/main/CODE_OF_CONDUCT.md

data/lib/faraday/adapter/excon.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Faraday
+  class Adapter
+    # Excon adapter.
+    class Excon < Faraday::Adapter
+      dependency 'excon'
+
+      def build_connection(env)
+        opts = opts_from_env(env)
+        ::Excon.new(env[:url].to_s, opts.merge(@connection_options))
+      end
+
+      def call(env)
+        super
+
+        req_opts = {
+          method: env[:method].to_s.upcase,
+          headers: env[:request_headers],
+          body: read_body(env)
+        }
+
+        req = env[:request]
+        if req&.stream_response?
+          total = 0
+          req_opts[:response_block] = lambda do |chunk, _remain, _total|
+            req.on_data.call(chunk, total += chunk.size)
+          end
+        end
+
+        resp = connection(env) { |http| http.request(req_opts) }
+        save_response(env, resp.status.to_i, resp.body, resp.headers,
+                      resp.reason_phrase)
+
+        @app.call(env)
+      rescue ::Excon::Errors::SocketError => e
+        raise Faraday::TimeoutError, e if e.message.match?(/\btimeout\b/)
+
+        raise Faraday::SSLError, e if e.message.match?(/\bcertificate\b/)
+
+        raise Faraday::ConnectionFailed, e
+      rescue ::Excon::Errors::Timeout => e
+        raise Faraday::TimeoutError, e
+      end
+
+      # TODO: support streaming requests
+      def read_body(env)
+        env[:body].respond_to?(:read) ? env[:body].read : env[:body]
+      end
+
+      private
+
+      def opts_from_env(env)
+        opts = {}
+        amend_opts_with_ssl!(opts, env[:ssl]) if needs_ssl_settings?(env)
+
+        if (req = env[:request])
+          amend_opts_with_timeouts!(opts, req)
+          amend_opts_with_proxy_settings!(opts, req)
+        end
+
+        opts
+      end
+
+      def needs_ssl_settings?(env)
+        env[:url].scheme == 'https' && env[:ssl]
+      end
+
+      OPTS_KEYS = [
+        %i[client_cert client_cert],
+        %i[client_key client_key],
+        %i[certificate certificate],
+        %i[private_key private_key],
+        %i[ssl_ca_path ca_path],
+        %i[ssl_ca_file ca_file],
+        %i[ssl_version version],
+        %i[ssl_min_version min_version],
+        %i[ssl_max_version max_version]
+      ].freeze
+
+      def amend_opts_with_ssl!(opts, ssl)
+        opts[:ssl_verify_peer] = !!ssl.fetch(:verify, true)
+        # https://github.com/geemus/excon/issues/106
+        # https://github.com/jruby/jruby-ossl/issues/19
+        opts[:nonblock] = false
+
+        OPTS_KEYS.each do |(key_in_opts, key_in_ssl)|
+          next unless ssl[key_in_ssl]
+
+          opts[key_in_opts] = ssl[key_in_ssl]
+        end
+      end
+
+      def amend_opts_with_timeouts!(opts, req)
+        if (sec = request_timeout(:read, req))
+          opts[:read_timeout] = sec
+        end
+
+        if (sec = request_timeout(:write, req))
+          opts[:write_timeout] = sec
+        end
+
+        return unless (sec = request_timeout(:open, req))
+
+        opts[:connect_timeout] = sec
+      end
+
+      def amend_opts_with_proxy_settings!(opts, req)
+        opts[:proxy] = proxy_settings_for_opts(req[:proxy]) if req[:proxy]
+      end
+
+      def proxy_settings_for_opts(proxy)
+        {
+          host: proxy[:uri].host,
+          hostname: proxy[:uri].hostname,
+          port: proxy[:uri].port,
+          scheme: proxy[:uri].scheme,
+          user: proxy[:user],
+          password: proxy[:password]
+        }
+      end
+    end
+  end
+end

data/lib/faraday/excon.rb

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

data/lib/faraday/excon/version.rb

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

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: faraday-excon
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mattia Giuffrida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.27.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.27.4
+- !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: 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: 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: 0.91.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.91.1
+- !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 Excon
+email:
+- giuffrida.mattia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/faraday/adapter/excon.rb
+- lib/faraday/excon.rb
+- lib/faraday/excon/version.rb
+homepage: https://github.com/lostisland/faraday-excon
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lostisland/faraday-excon
+  source_code_uri: https://github.com/lostisland/faraday-excon
+  changelog_uri: https://github.com/lostisland/faraday-excon
+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.4
+signing_key: 
+specification_version: 4
+summary: Faraday adapter for Excon
+test_files: []