ezclient 1.0.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 127a10e9346fcbb5498bf8a4d82781f95e1765d7c5208c4337881204f10dd290
-  data.tar.gz: 2a09e878beed9ed75c9aeaf78b07d1e3e6cd6d1e96456775ecc8062489ee01ea
+  metadata.gz: c4f9418b8f7468e16261c321cf17ea9ee34e8c2168fda6b936a56b8c88db20ad
+  data.tar.gz: a82af3a1afcd6baa5cdc8e04521db679670b854631843fe3171714f3f4900488
 SHA512:
-  metadata.gz: 7d562d84a39c415c90b417f5b49afc5330eef0f59112b282e34a69138124f1d4bc73f98ee806b400e92f30ede925f287a0ece9c12f2c136199848ef2a528f649
-  data.tar.gz: 9ef56bc7f181fcd779f0ef1767b94b7304c2e28e6be4b1e5994ceebcd00db62cfe30762a7d81069324c924bc6e6a01387e8bf339a101050ea739420f1f623c60
+  metadata.gz: b0c28a22832ce80a471d1fa16483fb0fcbab35550879e8132b6ee4849633489ce49cac1c03dc377ee0936033c9db9d144892644a598313e6d6a20efbf8eda5e4
+  data.tar.gz: 60fc3ff9026c5984d9548a9f420e65d7c3bd223efb29fd96daafbbcb3d725ac3ddd680d94d3121a60fe5b0a21c9ea8d08fa14128ca6883305e921a151360f270

data/.rubocop.yml

@@ -4,6 +4,14 @@ inherit_gem:
 AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.5
+  Include:
+    - bin/console
+    - Gemfile
+    - ezclient.gemspec
+    - Rakefile
+    - lib/**/*
+    - spec/**/*
+    - gemfile/**/*
   Exclude:
     - vendor/**/*
     - gemfiles/**/*

data/.travis.yml

@@ -1,30 +1,17 @@
 language: ruby
 
-sudo: false
+os: linux
 
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - ruby-head
-
-gemfile:
-  - gemfiles/http3.gemfile
-  - Gemfile
+dist: xenial
 
 before_install: gem install bundler
 
-env: SUITE="rspec"
-
-script: bundle exec $SUITE
-
-matrix:
+jobs:
   fast_finish: true
-  # Only run RuboCop on the latest Ruby
   include:
-    - rvm: 2.5
-      env: SUITE="rubocop"
+  - rvm: 2.5
+  - rvm: 2.6
+  - rvm: 2.7
+  - rvm: ruby-head
   allow_failures:
-    - rvm: ruby-head
-
-cache: bundler
+  - rvm: ruby-head

data/Gemfile

@@ -2,5 +2,3 @@
 
 source "https://rubygems.org"
 gemspec
-
-gem "http", github: "httprb/http"

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Yuri Smirnov
+Copyright (c) 2018-2019 Yuri Smirnov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,9 @@
 # EzClient   [![Gem Version](https://badge.fury.io/rb/ezclient.svg)](https://badge.fury.io/rb/ezclient) [![Build Status](https://travis-ci.org/umbrellio/ezclient.svg?branch=master)](https://travis-ci.org/umbrellio/ezclient) [![Coverage Status](https://coveralls.io/repos/github/umbrellio/ezclient/badge.svg?branch=master)](https://coveralls.io/github/umbrellio/ezclient?branch=master)
+
 EzClient is [HTTP gem](https://github.com/httprb/http) wrapper for easy persistent connections and more.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -9,6 +11,7 @@ gem "ezclient"
 ```
 
 ## Usage
+
 ```ruby
 url = "http://example.com"
 
@@ -29,6 +32,7 @@ response = client.perform!(:get, url, request_options) # => EzClient::Response o
 ```
 
 Valid client options are:
+
 - `api_auth` – arguments for `ApiAuth.sign!` (see https://github.com/mgomes/api_auth)
 - `basic_auth` – arguments for basic authentication (either a hash with `:user` and `:pass` keys or a two-element array)
 - `headers` – a hash of headers for requests
@@ -39,11 +43,13 @@ Valid client options are:
 - `on_retry` – callback called on request retry
 - `retry_exceptions` – an array of exception classes to retry
 - `ssl_context` – ssl context for requests (an `OpenSSL::SSL::SSLContext` instance)
-- `timeout` – timeout for requests in seconds
+- `timeout` – timeout for requests in seconds or hash like `{ read: 5, write: 5, connect: 1 }`
+- `follow` - enable following redirects (`true` or hash with options – e.g. `{ max_hops: 1, strict: false}`)
 
 All these options are passed to each request made by this client but can be overriden on per-request basis.
 
 Extra per-request only options are:
+
 - `body` – raw request body
 - `form` – hash for urlencoded body
 - `json` – data for json (also adds `application/json` content-type header)
@@ -52,14 +58,32 @@ Extra per-request only options are:
 - `query` – hash for uri query
 
 ## Persistent connections
+
 If you provide `keep_alive` option to the client or particular request, the connection will be stored in the client and then
 reused for all following requests to the same origin within specified amount of time.
 
-Note that, as of now, EzClient will
+Note that if you are using persistent connections, you shouldn't store your client in a variable that is accessable by different threads. See the example:
+
+```ruby
+module MyApp
+  # Bad: multiple threads will use the same socket
+  def self.bad_client
+    @ezclient ||= EzClient.new(keep_alive: 100)
+  end
+
+  # Good: each thread has it's own socket
+  def self.good_client
+    Thread.current[:ezclient] ||= EzClient.new(keep_alive: 100)
+  end
+end
+```
+
+Alose note that, as of now, EzClient will
 automatically retry the request on any `HTTP::ConnectionError` exception in this case which may possibly result in two requests
 received by a server (see https://github.com/httprb/http/issues/459).
 
 ## Callbacks and retrying
+
 You can provide `on_complete`, `on_error` and `on_retry` callbacks like this:
 
 ```ruby
@@ -79,12 +103,14 @@ response = client.perform!(:get, url, metadata: :hello)
 ```
 
 The arguments passed into callbacks are:
+
 - `request` – an `EzClient::Request` instance
 - `response` – an `EzClient::Response` instance
 - `error` – an exception instance
 - `metadata` - the `metadata` option passed into a request
 
 ## Request object
+
 ```ruby
 request = client.request(:post, "http://example.com", json: { a: 1 }, timeout: 15)
 
@@ -95,6 +121,7 @@ request.headers # => { "Content-Type" => "application/json; charset=UTF-8", ...
 ```
 
 ## Response object
+
 ```ruby
 response = request.perform(...)
 
@@ -110,12 +137,15 @@ response.error? # Returns if request was 4xx or 5xx status
 ```
 
 ## Contributing
+
 Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/ezclient.
 
 ## License
+
 Released under MIT License.
 
 ## Authors
+
 Created by Yuri Smirnov.
 
 <a href="https://github.com/umbrellio/">

data/Rakefile

@@ -2,7 +2,9 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
 
-task default: :spec
+task default: %i[lint spec]

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ezclient"
+
+require "pry"
+Pry.start

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/ezclient.gemspec

@@ -1,23 +1,25 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ezclient/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "ezclient"
-  spec.version       = EzClient::VERSION
-  spec.authors       = ["Yuri Smirnov"]
-  spec.email         = ["tycooon@yandex.ru"]
+  spec.required_ruby_version = ">= 2.5.0"
 
-  spec.summary       = "An HTTP gem wrapper for easy persistent connections and more."
-  spec.homepage      = "https://github.com/umbrellio/ezclient"
-  spec.license       = "MIT"
+  spec.name    = "ezclient"
+  spec.version = EzClient::VERSION
+  spec.authors = ["Yuri Smirnov"]
+  spec.email   = ["tycooon@yandex.ru", "oss@umbrellio.biz"]
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.summary  = "An HTTP gem wrapper for easy persistent connections and more."
+  spec.homepage = "https://github.com/umbrellio/ezclient"
+  spec.license  = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "http", ">= 3.3"
+  spec.add_runtime_dependency "http", ">= 4"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "coveralls"

data/lib/ezclient.rb

@@ -1,15 +1,22 @@
 # frozen_string_literal: true
 
 require "http"
-require "ezclient/version"
-require "ezclient/client"
-require "ezclient/request"
-require "ezclient/response"
-require "ezclient/errors"
-require "ezclient/check_options"
+
+require_relative "ezclient/version"
+require_relative "ezclient/client"
+require_relative "ezclient/persistent_client"
+require_relative "ezclient/persistent_client_registry"
+require_relative "ezclient/request"
+require_relative "ezclient/response"
+require_relative "ezclient/errors"
+require_relative "ezclient/check_options"
 
 module EzClient
   def self.new(*args)
     Client.new(*args)
   end
+
+  def self.get_time
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
 end

data/lib/ezclient/client.rb

@@ -14,11 +14,11 @@ class EzClient::Client
     retry_exceptions
     ssl_context
     timeout
+    follow
   ].freeze
 
   def initialize(options = {})
     self.request_options = options
-    self.clients = {}
     EzClient::CheckOptions.call(options, REQUEST_OPTION_KEYS)
   end
 
@@ -29,7 +29,7 @@ class EzClient::Client
     api_auth = options.delete(:api_auth)
 
     if keep_alive_timeout
-      client = persistent_client_for(url, timeout: keep_alive_timeout)
+      client = persistent_client_registry.for(url, timeout: keep_alive_timeout)
     else
       client = HTTP::Client.new
     end
@@ -39,20 +39,19 @@ class EzClient::Client
     end
   end
 
-  def perform(*args)
-    request(*args).perform
+  def perform(*args, **kwargs)
+    request(*args, **kwargs).perform
   end
 
-  def perform!(*args)
-    request(*args).perform!
+  def perform!(*args, **kwargs)
+    request(*args, **kwargs).perform!
   end
 
   private
 
-  attr_accessor :request_options, :clients
+  attr_accessor :request_options
 
-  def persistent_client_for(url, timeout: 600)
-    uri = HTTP::URI.parse(url)
-    clients[uri.origin] ||= HTTP.persistent(uri.origin, timeout: timeout)
+  def persistent_client_registry
+    @persistent_client_registry ||= EzClient::PersistentClientRegistry.new
   end
 end

data/lib/ezclient/persistent_client.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class EzClient::PersistentClient
+  extend Forwardable
+
+  def_delegators :http_client, :build_request, :default_options, :timeout
+
+  attr_accessor :origin, :keep_alive_timeout, :last_request_at
+
+  def initialize(origin, keep_alive_timeout)
+    self.origin = origin
+    self.keep_alive_timeout = keep_alive_timeout
+    self.last_request_at = nil
+  end
+
+  def perform(*args)
+    http_client.perform(*args).tap do
+      self.last_request_at = EzClient.get_time
+    end
+  end
+
+  private
+
+  def http_client
+    @http_client ||= HTTP.persistent(origin, timeout: keep_alive_timeout)
+  end
+end

data/lib/ezclient/persistent_client_registry.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class EzClient::PersistentClientRegistry
+  def initialize
+    self.registry = {}
+  end
+
+  def for(url, timeout:)
+    cleanup_registry!
+    uri = HTTP::URI.parse(url)
+    registry[uri.origin] ||= EzClient::PersistentClient.new(uri.origin, timeout)
+  end
+
+  private
+
+  attr_accessor :registry
+
+  def cleanup_registry!
+    registry.delete_if do |_key, value|
+      EzClient.get_time - value.last_request_at >= value.keep_alive_timeout
+    end
+  end
+end

data/lib/ezclient/request.rb

@@ -47,6 +47,10 @@ class EzClient::Request
     self
   end
 
+  def uri
+    http_request.uri
+  end
+
   def body
     body = +""
     http_request.body.each { |chunk| body << chunk }
@@ -97,13 +101,22 @@ class EzClient::Request
   end
 
   def perform_request
+    with_retry do
+      # Use original client so that connection can be reused
+      res = client.perform(http_request, http_options)
+      return res unless follow
+
+      HTTP::Redirector.new(follow).perform(http_request, res) do |request|
+        client.perform(request, http_options)
+      end
+    end
+  end
+
+  def with_retry(&block)
     retries = 0
 
     begin
-      retry_on_connection_error do
-        # Use original client so that connection can be reused
-        client.perform(http_request, http_options)
-      end
+      retry_on_connection_error(&block)
     rescue *retried_exceptions => error
       if retries < max_retries.to_i
         retries += 1
@@ -119,14 +132,18 @@ class EzClient::Request
     # This may result in 2 requests reaching the server so I hope HTTP fixes it
     # https://github.com/httprb/http/issues/459
     yield
-  rescue HTTP::ConnectionError, IOError, SocketError, SystemCallError => error
-    # TODO: remove IOError, SocketError, SystemCallError after we drop HTTP v3 support
+  rescue HTTP::ConnectionError => error
     on_retry.call(self, error, options[:metadata])
     yield
   end
 
   def timeout
-    options[:timeout]&.to_f
+    case options[:timeout]
+    when Hash
+      options[:timeout].transform_values! { |value| value&.to_f }
+    else
+      options[:timeout]&.to_f
+    end
   end
 
   def on_complete
@@ -149,6 +166,11 @@ class EzClient::Request
     options[:max_retries] || 1
   end
 
+  def follow
+    return unless options[:follow]
+    options[:follow].is_a?(Hash) ? options[:follow] : {}
+  end
+
   def prepare_headers(headers)
     headers = HTTP::Headers.coerce(headers)
     headers[:user_agent] ||= "ezclient/#{EzClient::VERSION}"
@@ -172,17 +194,7 @@ class EzClient::Request
   end
 
   def set_timeout(client)
-    return client unless timeout
-
-    timeout_args =
-      # for HTTP v3
-      if HTTP::Timeout::Global.ancestors.include?(HTTP::Timeout::PerOperation)
-        [:global, read: timeout, write: 0, connect: 0]
-      else
-        [timeout]
-      end
-
-    client.timeout(*timeout_args)
+    timeout ? client.timeout(timeout) : client
   end
 
   def basic_auth

data/lib/ezclient/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzClient
-  VERSION = "1.0.0"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezclient
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Yuri Smirnov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,9 +136,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - tycooon@yandex.ru
+- oss@umbrellio.biz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -151,12 +152,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/rspec
 - ezclient.gemspec
 - gemfiles/http3.gemfile
 - lib/ezclient.rb
 - lib/ezclient/check_options.rb
 - lib/ezclient/client.rb
 - lib/ezclient/errors.rb
+- lib/ezclient/persistent_client.rb
+- lib/ezclient/persistent_client_registry.rb
 - lib/ezclient/request.rb
 - lib/ezclient/response.rb
 - lib/ezclient/version.rb
@@ -164,7 +169,7 @@ homepage: https://github.com/umbrellio/ezclient
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,16 +177,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: An HTTP gem wrapper for easy persistent connections and more.
 test_files: []