ezclient 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '088411a531c19317ffbfe1807ef89e17b5db1607410c2f1797c1a673e65cbf17'
-  data.tar.gz: eec6f54dcf8f648ae6685d5aacfcebeeb3e9861941a73c356d143e929be499a2
+  metadata.gz: 9bbefbed2ebd4c6b412246062c09bf178b39b10b54631963e559fbb6d6150023
+  data.tar.gz: 586fa332053ce325be892e05fb7eabfc7daecaf9c60a4aeae607d0fbb646366c
 SHA512:
-  metadata.gz: 6014665fd4078412b21cd9c60dd0ca569dcff3e2649662dd04c32ece299c507f8565f7c3069b69b4bdf3551fa9f8bcb66f8a82d64ef192b537e808f33a3fb2c9
-  data.tar.gz: '0430985d0af80a195f1e97b9a4d5f44c213dd3b60aeb4040d9ae256fd6ee7808b6b3c253a010d05cad367b7a8a5d68ee6039f211d28dad22794f27ca6dcd2634'
+  metadata.gz: d4e2142b3f825390f39dde75b2145da1485ba1211e2202639a0d88d5785373bbbf97e2dd4d8c12c0a4c7d4e0f57c927eec12300152ea757fd11ae6d33c019812
+  data.tar.gz: bc99bcb243ea9c4c70e4916e8252fac60cdefbdbd136193a6b6db0611b5bfbb6609233ba3d5c0fa21f6775ada8354e07aa6e4c0bff488eec9516bbeb14a62e3e

data/.rubocop.yml

@@ -3,7 +3,15 @@ inherit_gem:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.3
+  Include:
+    - bin/console
+    - Gemfile
+    - ezclient.gemspec
+    - Rakefile
+    - lib/**/*
+    - spec/**/*
+    - gemfile/**/*
   Exclude:
     - vendor/**/*
     - gemfiles/**/*

data/.travis.yml

@@ -1,26 +1,18 @@
 language: ruby
-
 sudo: false
-
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - ruby-head
-
+cache: bundler
 before_install: gem install bundler
-
 env: SUITE="rspec"
-
 script: bundle exec $SUITE
-
 matrix:
   fast_finish: true
-  # Only run RuboCop on the latest Ruby
   include:
+    - rvm: 2.3
+    - rvm: 2.4
     - rvm: 2.5
+    - rvm: 2.6
+    - rvm: ruby-head
+    - rvm: 2.6
       env: SUITE="rubocop"
   allow_failures:
     - rvm: ruby-head
-
-cache: bundler

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
@@ -40,10 +44,12 @@ Valid client options are:
 - `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
+- `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/bin/console

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

data/ezclient.gemspec

@@ -1,20 +1,22 @@
 # 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.3.8"
 
-  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", ">= 4"

data/lib/ezclient/client.rb

@@ -14,6 +14,7 @@ class EzClient::Client
     retry_exceptions
     ssl_context
     timeout
+    follow
   ].freeze
 
   def initialize(options = {})

data/lib/ezclient/request.rb

@@ -101,13 +101,23 @@ class EzClient::Request
   end
 
   def perform_request
+    with_retry do
+      # Use original client so that connection can be reused
+      # client.perform(http_request, http_options)
+      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
@@ -152,6 +162,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}"

data/lib/ezclient/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezclient
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -139,6 +139,7 @@ dependencies:
 description: 
 email:
 - tycooon@yandex.ru
+- oss@umbrellio.biz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -151,6 +152,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - ezclient.gemspec
 - gemfiles/http3.gemfile
 - lib/ezclient.rb
@@ -172,15 +174,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An HTTP gem wrapper for easy persistent connections and more.