Merge pull request #5 from mbaydin/feature/UCMS-10933-faraday

[UCMS-10933][B] OneCMS, BebopAPI: Вынести FaradayWithRetries в unity-utils

Author: kopylovvlad

Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    unity-utils (0.1.2)
+    unity-utils (0.3.0)
       activesupport (>= 4.2)
+      faraday (>= 1.0, < 1.4)
+      rspec-core (>= 3.9)
       ruby-progressbar (>= 1.11.0)
 
 GEM
@@ -17,10 +19,16 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
     diff-lcs (1.4.4)
+    faraday (1.3.1)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (1.0.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.19.0)
+    multipart-post (2.3.0)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
@@ -57,6 +65,7 @@ GEM
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)

lib/unity/utils.rb

@@ -8,11 +8,13 @@
 
 # Utils
 require_relative 'utils/ci_formatter'
+require_relative 'utils/faraday_with_retries'
 require_relative 'utils/retrier'
 require_relative 'utils/thread_pool'
 require_relative 'utils/url_formatter'
 require_relative 'utils/url_validator'
 
+
 I18n.load_path += Dir[File.join(File.dirname(__FILE__), 'config/locales/*.yml')]
 
 module Unity

lib/unity/utils/faraday_with_retries.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Faraday connection inintializer.
+# It creates `Faraday::Connection` object with pre-defined retries.
+module Unity
+  module Utils
+    require 'faraday'
+
+    class FaradayWithRetries
+      DEFAULT_EXCEPTIONS = [
+        *(Faraday::Request::Retry::DEFAULT_EXCEPTIONS if defined?(Faraday::Request::Retry)),
+        Faraday::TimeoutError, Faraday::ConnectionFailed
+      ].freeze
+
+      # @param exceptions [Array<Exception>]
+      # @param max [Integer] retries count
+      # @param interval [Float] in seconds
+      # @param interval_randomness [Float] in seconds
+      # @param backoff_factor [Integer] amount to multiplyeach successive retry's interval
+      def initialize(exceptions: [], max: 3, interval: 1.0, interval_randomness: 0.1, backoff_factor: 1)
+        @exceptions = exceptions.presence || DEFAULT_EXCEPTIONS
+
+        @max = max
+        @interval = interval
+        @interval_randomness = interval_randomness
+        @backoff_factor = backoff_factor
+      end
+
+      # @param url [String]
+      # @return [Faraday::Connection]
+      def call(url)
+        Faraday.new(url: url) do |i|
+          i.request(:retry,
+                    max:                 @max,
+                    interval:            @interval,
+                    interval_randomness: @interval_randomness,
+                    backoff_factor:      @backoff_factor,
+                    exceptions:          @exceptions)
+          if block_given?
+            yield(i)
+          else
+            i.adapter Faraday.default_adapter
+          end
+        end
+      end
+    end
+  end
+end

lib/unity/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Unity
+  VERSION = '0.3.0'
+end

spec/unity/utils/faraday_with_retries_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'faraday'
+
+RSpec.describe Unity::Utils::FaradayWithRetries do
+  let(:instance) { described_class.new }
+  let(:url) { nil }
+
+  describe 'args' do
+    subject do
+      instance
+        .call(url).as_json['builder']['handlers']
+        .find { |h| h['name'] == 'Faraday::Request::Retry' }['args']
+    end
+
+    before { stub_const('Unity::Utils::FaradayWithRetries::DEFAULT_EXCEPTIONS', ['boom!']) }
+
+    let(:correct_args) do
+      [{ backoff_factor: 1, interval: 1.0, interval_randomness: 0.1, max: 3,
+        exceptions: ['boom!'] }.stringify_keys]
+    end
+
+    it { is_expected.to eq(correct_args) }
+
+    context 'with args' do
+      let(:instance) do
+        described_class.new(exceptions: [ZeroDivisionError], max: 2, interval: 2.0,
+                            interval_randomness: 0.2, backoff_factor: 2)
+      end
+      let(:correct_args) do
+        [{ backoff_factor: 2, interval: 2.0, interval_randomness: 0.2, max: 2,
+          exceptions: [ZeroDivisionError] }.stringify_keys]
+      end
+
+      before { stub_const('ZeroDivisionError', 'boom!') }
+
+      it { is_expected.to eq(correct_args) }
+    end
+  end
+end

unity-utils.gemspec

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'lib/unity/version'
+
 Gem::Specification.new do |spec|
   spec.name          = 'unity-utils'
-  spec.version       = '0.2.0'
+  spec.version       = Unity::VERSION
   spec.authors       = ['Mikhail Georgievskiy']
   spec.email         = ['[email protected]']
 
@@ -18,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 4.2'
+  spec.add_dependency 'faraday', '>= 1.0', '< 1.4'
   spec.add_dependency 'rspec-core', '>= 3.9'
   spec.add_dependency 'ruby-progressbar', '>= 1.11.0'
 end