faraday-em_synchrony 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adf5bdc8c8903b85d533c3e0e124b5cf55dbce21a695f8cfb0cd859df2f8955e
+  data.tar.gz: 8e5375bea399c465a5f12f6e0d8b9c00c0dc7d3ca1a2641b1e889fe6e5c07e80
+SHA512:
+  metadata.gz: 2e4a52e45b43cffca1e0cea2f99546f5e58097be392028fc0c578a7dfa6c2c43ba1b23a87cda94ca87952a7722f1df005cc0080b2caa277e9b0ce2c67c186d02
+  data.tar.gz: f0b72ccf6a1b1e744c54f75e3ccee84d93488dc66023b71e89881b457b68dcb015d543ececba8c22356001000469aae5129c1f41f019aea6f3beee4bb1b043f3

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

data/lib/faraday/adapter/em_synchrony.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module Faraday
+  class Adapter
+    # EventMachine Synchrony adapter.
+    class EMSynchrony < Faraday::Adapter
+      include EMHttp::Options
+
+      dependency do
+        require 'em-synchrony/em-http'
+        require 'em-synchrony/em-multi'
+        require 'fiber'
+
+        require 'faraday/adapter/em_synchrony/parallel_manager'
+
+        if Faraday::Adapter::EMSynchrony.loaded?
+          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
+      end
+
+      self.supports_parallel = true
+
+      # @return [ParallelManager]
+      def self.setup_parallel_manager(_options = nil)
+        ParallelManager.new
+      end
+
+      def call(env)
+        super
+        request = create_request(env)
+
+        http_method = env[:method].to_s.downcase.to_sym
+
+        if env[:parallel_manager]
+          # Queue requests for parallel execution.
+          execute_parallel_request(env, request, http_method)
+        else
+          # Execute single request.
+          execute_single_request(env, request, http_method)
+        end
+
+        @app.call env
+      rescue Errno::ECONNREFUSED
+        raise Faraday::ConnectionFailed, $ERROR_INFO
+      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 Errno::ETIMEDOUT => e
+        raise Faraday::TimeoutError, e
+      rescue RuntimeError => e
+        if e.message == 'connection closed by server'
+          raise Faraday::ConnectionFailed, e
+        end
+
+        raise Faraday::TimeoutError, e if e.message.include?('timeout error')
+
+        raise
+      rescue StandardError => e
+        if defined?(OpenSSL) && e.is_a?(OpenSSL::SSL::SSLError)
+          raise Faraday::SSLError, e
+        end
+
+        raise
+      end
+
+      def create_request(env)
+        EventMachine::HttpRequest.new(
+          Utils::URI(env[:url].to_s),
+          connection_config(env).merge(@connection_options)
+        )
+      end
+
+      private
+
+      def execute_parallel_request(env, request, http_method)
+        env[:parallel_manager].add(request, http_method,
+                                   request_config(env)) do |resp|
+          if (req = env[:request]).stream_response?
+            warn "Streaming downloads for #{self.class.name} " \
+                'are not yet implemented.'
+            req.on_data.call(resp.response, resp.response.bytesize)
+          end
+
+          save_response(env, resp.response_header.status,
+                        resp.response) do |resp_headers|
+            resp.response_header.each do |name, value|
+              resp_headers[name.to_sym] = value
+            end
+          end
+
+          # Finalize the response object with values from `env`.
+          env[:response].finish(env)
+        end
+      end
+
+      def execute_single_request(env, request, http_method)
+        block = -> { request.send(http_method, request_config(env)) }
+        client = call_block(block)
+
+        raise client.error if client&.error
+
+        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
+
+      def call_block(block)
+        client = nil
+
+        if EM.reactor_running?
+          client = block.call
+        else
+          EM.run do
+            Fiber.new do
+              client = block.call
+              EM.stop
+            end.resume
+          end
+        end
+
+        client
+      end
+    end
+  end
+end

data/lib/faraday/adapter/em_synchrony/parallel_manager.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Faraday
+  class Adapter
+    class EMSynchrony < Faraday::Adapter
+      # A parallel manager for EMSynchrony.
+      class ParallelManager
+        # Add requests to queue.
+        #
+        # @param request [EM::HttpRequest]
+        # @param method [Symbol, String] HTTP method
+        # @param args [Array] the rest of the positional arguments
+        def add(request, method, *args, &block)
+          queue << {
+            request: request,
+            method: method,
+            args: args,
+            block: block
+          }
+        end
+
+        # Run all requests on queue with `EM::Synchrony::Multi`, wrapping
+        # it in a reactor and fiber if needed.
+        def run
+          result = nil
+          if !EM.reactor_running?
+            EM.run do
+              Fiber.new do
+                result = perform
+                EM.stop
+              end.resume
+            end
+          else
+            result = perform
+          end
+          result
+        end
+
+        private
+
+        # The request queue.
+        def queue
+          @queue ||= []
+        end
+
+        # Main `EM::Synchrony::Multi` performer.
+        def perform
+          multi = ::EM::Synchrony::Multi.new
+
+          queue.each do |item|
+            method = "a#{item[:method]}".to_sym
+
+            req = item[:request].send(method, *item[:args])
+            req.callback(&item[:block])
+
+            req_name = "req_#{multi.requests.size}".to_sym
+            multi.add(req_name, req)
+          end
+
+          # Clear the queue, so parallel manager objects can be reused.
+          @queue = []
+
+          # Block fiber until all requests have returned.
+          multi.perform
+        end
+      end
+    end
+  end
+end

data/lib/faraday/em_synchrony.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'faraday/em_http'
+require_relative 'adapter/em_synchrony'
+require_relative 'em_synchrony/version'
+
+module Faraday
+  # Main Faraday::EmSynchrony module
+  module EmSynchrony
+    Faraday::Adapter.register_middleware(em_synchrony: Faraday::Adapter::EMSynchrony)
+  end
+end

data/lib/faraday/em_synchrony/version.rb

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

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: faraday-em_synchrony
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- "@iMacTia"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-26 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: em-synchrony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !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: faraday-em_http
+  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::Synchrony
+email:
+- giuffrida.mattia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/faraday/adapter/em_synchrony.rb
+- lib/faraday/adapter/em_synchrony/parallel_manager.rb
+- lib/faraday/em_synchrony.rb
+- lib/faraday/em_synchrony/version.rb
+homepage: https://github.com/lostisland/faraday-em_synchrony
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lostisland/faraday-em_synchrony
+  source_code_uri: https://github.com/lostisland/faraday-em_synchrony
+  changelog_uri: https://github.com/lostisland/faraday-em_synchrony
+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::Synchrony
+test_files: []