faraday-em_http 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8982a4cb78e29659a4903e779305b1d8b949991b60bd5fc9c39f3d9caaa4bcc3
+  data.tar.gz: 65343a1e259389675dc9ef4c5b50772e7a87ad8bbaa601b7433f8697154e9a78
+SHA512:
+  metadata.gz: da88bf5433fef291af85674490b017c8f6356030304a37e6156c2409d776b9e0712a05fe13656029bf400bef0404239d6132a964bdc85a2097321b4051a96494
+  data.tar.gz: ff7dc9115defddc26448b5dce034c56e7abf33375987a4083dd7bdb1f5fab6d0dc1d0e4b24884681cb1d03207717e83692ca2f0d106f5f16656211748750c1f7

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,61 @@
+# Faraday Em::Http adapter
+
+This gem is a [Faraday][faraday] adapter for the [Em::Http::Request][em_http_request] 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 Em::Http::Request.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'em-http-request', '>= 1.1'
+gem 'faraday-em_http'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install them yourself as:
+
+    $ gem install em-http-request -v '>= 1.1'
+    $ gem install faraday-em_http
+
+## Usage
+
+Configure your Faraday connection to use this adapter like this:
+
+```ruby
+connection = Faraday.new(url, conn_options) do |conn|
+  conn.adapter(:em_http)
+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 Em::Http 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
+[em_http_request]: https://github.com/igrigorik/em-http-request
+[rubygems]: https://rubygems.org
+[repo]: https://github.com/lostisland/faraday-em_http
+[license]: https://github.com/lostisland/faraday-em_http/blob/main/LICENSE.md
+[code-of-conduct]: https://github.com/lostisland/faraday-em_http/blob/main/CODE_OF_CONDUCT.md

data/lib/faraday/adapter/em_http.rb

@@ -0,0 +1,289 @@
+# frozen_string_literal: true
+
+module Faraday
+  class Adapter
+    # EventMachine adapter. This adapter is useful for either asynchronous
+    # requests when in an EM reactor loop, or for making parallel requests in
+    # synchronous code.
+    class EMHttp < Faraday::Adapter
+      # Options is a module containing helpers to convert the Faraday env object
+      # into options hashes for EMHTTP method calls.
+      module Options
+        # @return [Hash]
+        def connection_config(env)
+          options = {}
+          configure_proxy(options, env)
+          configure_timeout(options, env)
+          configure_socket(options, env)
+          configure_ssl(options, env)
+          options
+        end
+
+        def request_config(env)
+          options = {
+            body: read_body(env),
+            head: env[:request_headers]
+            # keepalive: true,
+            # file: 'path/to/file', # stream data off disk
+          }
+          configure_compression(options, env)
+          options
+        end
+
+        def read_body(env)
+          body = env[:body]
+          body.respond_to?(:read) ? body.read : body
+        end
+
+        # Reads out proxy settings from env into options
+        def configure_proxy(options, env)
+          proxy = request_options(env)[:proxy]
+          return unless proxy
+
+          options[:proxy] = {
+            host: proxy[:uri].host,
+            port: proxy[:uri].port,
+            authorization: [proxy[:user], proxy[:password]]
+          }
+        end
+
+        # Reads out host and port settings from env into options
+        def configure_socket(options, env)
+          bind = request_options(env)[:bind]
+          return unless bind
+
+          options[:bind] = {
+            host: bind[:host],
+            port: bind[:port]
+          }
+        end
+
+        # Reads out SSL certificate settings from env into options
+        def configure_ssl(options, env)
+          return unless env[:url].scheme == 'https' && env[:ssl]
+
+          options[:ssl] = {
+            cert_chain_file: env[:ssl][:ca_file],
+            verify_peer: env[:ssl].fetch(:verify, true)
+          }
+        end
+
+        # Reads out timeout settings from env into options
+        def configure_timeout(options, env)
+          req = request_options(env)
+          options[:inactivity_timeout] = request_timeout(:read, req)
+          options[:connect_timeout] = request_timeout(:open, req)
+        end
+
+        # Reads out compression header settings from env into options
+        def configure_compression(options, env)
+          return unless (env[:method] == :get) &&
+            !options[:head].key?('accept-encoding')
+
+          options[:head]['accept-encoding'] = 'gzip, compressed'
+        end
+
+        def request_options(env)
+          env[:request]
+        end
+      end
+
+      include Options
+
+      dependency do
+        require 'em-http'
+
+        begin
+          require 'openssl'
+        rescue LoadError
+          warn 'Warning: no such file to load -- openssl. ' \
+            'Make sure it is installed if you want HTTPS support'
+        else
+          require 'em-http/version'
+          if EventMachine::HttpRequest::VERSION < '1.1.6'
+            require 'faraday/adapter/em_http_ssl_patch'
+          end
+        end
+      end
+
+      self.supports_parallel = true
+
+      # @return [Manager]
+      def self.setup_parallel_manager(_options = nil)
+        Manager.new
+      end
+
+      def call(env)
+        super
+        perform_request env
+        @app.call env
+      end
+
+      def perform_request(env)
+        if parallel?(env)
+          manager = env[:parallel_manager]
+          manager.add do
+            perform_single_request(env)
+              .callback { env[:response].finish(env) }
+          end
+        elsif EventMachine.reactor_running?
+          # EM is running: instruct upstream that this is an async request
+          env[:parallel_manager] = true
+          perform_single_request(env)
+            .callback { env[:response].finish(env) }
+            .errback do
+            # TODO: no way to communicate the error in async mode
+            raise NotImplementedError
+          end
+        else
+          error = nil
+          # start EM, block until request is completed
+          EventMachine.run do
+            perform_single_request(env)
+              .callback { EventMachine.stop }
+              .errback do |client|
+              error = error_message(client)
+              EventMachine.stop
+            end
+          end
+          raise_error(error) if error
+        end
+      rescue EventMachine::Connectify::CONNECTError => e
+        if e.message.include?('Proxy Authentication Required')
+          raise Faraday::ConnectionFailed,
+                %(407 "Proxy Authentication Required ")
+        end
+
+        raise Faraday::ConnectionFailed, e
+      rescue StandardError => e
+        if defined?(::OpenSSL::SSL::SSLError) && \
+           e.is_a?(::OpenSSL::SSL::SSLError)
+          raise Faraday::SSLError, e
+        end
+
+        raise
+      end
+
+      # TODO: reuse the connection to support pipelining
+      def perform_single_request(env)
+        req = create_request(env)
+        req = req.setup_request(env[:method], request_config(env))
+        req.callback do |client|
+          if env[:request].stream_response?
+            warn "Streaming downloads for #{self.class.name} " \
+              'are not yet implemented.'
+            env[:request].on_data.call(
+              client.response,
+              client.response.bytesize
+            )
+          end
+          status = client.response_header.status
+          reason = client.response_header.http_reason
+          save_response(env, status, client.response, nil, reason) do |headers|
+            client.response_header.each do |name, value|
+              headers[name.to_sym] = value
+            end
+          end
+        end
+      end
+
+      def create_request(env)
+        EventMachine::HttpRequest.new(
+          env[:url], connection_config(env).merge(@connection_options)
+        )
+      end
+
+      def error_message(client)
+        client.error || 'request failed'
+      end
+
+      def raise_error(msg)
+        error_class = Faraday::ClientError
+        if timeout_message?(msg)
+          error_class = Faraday::TimeoutError
+          msg = 'request timed out'
+        elsif msg == Errno::ECONNREFUSED
+          error_class = Faraday::ConnectionFailed
+          msg = 'connection refused'
+        elsif msg == 'connection closed by server'
+          error_class = Faraday::ConnectionFailed
+        end
+        raise error_class, msg
+      end
+
+      def timeout_message?(msg)
+        msg == Errno::ETIMEDOUT ||
+          (msg.is_a?(String) && msg.include?('timeout error'))
+      end
+
+      # @return [Boolean]
+      def parallel?(env)
+        !!env[:parallel_manager]
+      end
+
+      # This parallel manager is designed to start an EventMachine loop
+      # and block until all registered requests have been completed.
+      class Manager
+        # @see reset
+        def initialize
+          reset
+        end
+
+        # Re-initializes instance variables
+        def reset
+          @registered_procs = []
+          @num_registered = 0
+          @num_succeeded = 0
+          @errors = []
+          @running = false
+        end
+
+        # @return [Boolean]
+        def running?
+          @running
+        end
+
+        def add(&block)
+          if running?
+            perform_request(&block)
+          else
+            @registered_procs << block
+          end
+          @num_registered += 1
+        end
+
+        def run
+          if @num_registered.positive?
+            @running = true
+            EventMachine.run do
+              @registered_procs.each do |proc|
+                perform_request(&proc)
+              end
+            end
+            unless @errors.empty?
+              raise Faraday::ClientError, @errors.first || 'connection failed'
+            end
+          end
+        ensure
+          reset
+        end
+
+        def perform_request
+          client = yield
+          client.callback do
+            @num_succeeded += 1
+            check_finished
+          end
+          client.errback do
+            @errors << client.error
+            check_finished
+          end
+        end
+
+        def check_finished
+          EventMachine.stop if @num_succeeded + @errors.size == @num_registered
+        end
+      end
+    end
+  end
+end

data/lib/faraday/adapter/em_http_ssl_patch.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'em-http'
+
+# EventMachine patch to make SSL work.
+module EmHttpSslPatch
+  def ssl_verify_peer(cert_string)
+    begin
+      @last_seen_cert = OpenSSL::X509::Certificate.new(cert_string)
+    rescue OpenSSL::X509::CertificateError
+      return false
+    end
+
+    unless certificate_store.verify(@last_seen_cert)
+      raise OpenSSL::SSL::SSLError,
+            %(unable to verify the server certificate for "#{host}")
+    end
+
+    begin
+      certificate_store.add_cert(@last_seen_cert)
+    rescue OpenSSL::X509::StoreError => e
+      raise e unless e.message == 'cert already in hash table'
+    end
+    true
+  end
+
+  def ssl_handshake_completed
+    return true unless verify_peer?
+
+    unless verified_cert_identity?
+      raise OpenSSL::SSL::SSLError,
+            %(host "#{host}" does not match the server certificate)
+    end
+
+    true
+  end
+
+  def verify_peer?
+    parent.connopts.tls[:verify_peer]
+  end
+
+  def verified_cert_identity?
+    OpenSSL::SSL.verify_certificate_identity(@last_seen_cert, host)
+  end
+
+  def host
+    parent.uri.host
+  end
+
+  def certificate_store
+    @certificate_store ||= begin
+      store = OpenSSL::X509::Store.new
+      store.set_default_paths
+      ca_file = parent.connopts.tls[:cert_chain_file]
+      store.add_file(ca_file) if ca_file
+      store
+    end
+  end
+end
+
+EventMachine::HttpStubConnection.include(EmHttpSslPatch)

data/lib/faraday/em_http.rb

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

data/lib/faraday/em_http/version.rb

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

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: faraday-em_http
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- "@iMacTia"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: 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: 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 Em::Http
+email:
+- giuffrida.mattia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/faraday/adapter/em_http.rb
+- lib/faraday/adapter/em_http_ssl_patch.rb
+- lib/faraday/em_http.rb
+- lib/faraday/em_http/version.rb
+homepage: https://github.com/lostisland/faraday-em_http
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lostisland/faraday-em_http
+  source_code_uri: https://github.com/lostisland/faraday-em_http
+  changelog_uri: https://github.com/lostisland/faraday-em_http
+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 Em::Http
+test_files: []