lhc 6.6.0 → 6.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8592e613a6a21d6dfc84973f2ab064d9e441246
-  data.tar.gz: 73b9069f8c0793e5775c95e754c9160f70fc158a
+  metadata.gz: b67eccab540898da2aa4314e60c3f5b2488f0890
+  data.tar.gz: f2389139e0adab0fd12393a2be3550de57aa1798
 SHA512:
-  metadata.gz: 9fc936bc72038bfb6833307dc9594d7f3e9721f406df6ed9eac1036ea6b45afa3e149d8b333ca1b29c067308ad2c3762e77333c9a3abb9e12b6e77610ff1f82e
-  data.tar.gz: ec2dda75db78848b877bd5bcfcc2f88aedb6694aeda1c70eec419c7df6f52dfe684397a30a60aebaf157769916b0ed34c309ca43e0215dfd2cdb9cdbf70b5f43
+  metadata.gz: e82e6da39f0aa9f0d6b4ca46843f376c78a87fe4f4bdd8da58548291783f213a0aa346d0a2ca2c56157f8a028ba99d050f17d958ad30cc472a8b35b7558c76dd
+  data.tar.gz: f5f99a5be4829ab641c3aedc4ef3ebc19d63786290c8c5050abace75ee659ebf16f826ac605659169bd2bab8c768150a679ef4709e279881a1e8df7c9da61554

data/.rubocop.yml

@@ -38,3 +38,6 @@ RSpec/VerifiedDoubles:
 
 Style/RedundantReturn:
   Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false

data/README.md

@@ -76,7 +76,7 @@ You will get back an array of LHC::Response objects in the same order of the pas
 ```
 
 ```ruby
-LHC.get([request1, request2, request3])
+LHC.request([request1, request2, request3])
 # returns [response1, response2, response3]
 ```
 
@@ -148,7 +148,7 @@ If a error handler is provided nothing is raised.
 If your error handler returns anything else but `nil` it replaces the response body.
 
 ```ruby
-handler = ->{ do_something; return {name: 'unknown'} }
+handler = ->(response){ do_something_with_repsonse; return {name: 'unknown'} }
 response = LHC.get('http://something', error_handler: handler)
 response.data.name # 'unknown'
 ```
@@ -185,10 +185,11 @@ To monitor and manipulate the http communication done with LHC, you can define i
 → [Read more about interceptors](docs/interceptors.md)
 
 A set of core interceptors is part of LHC,
-like 
+like
 [Caching](/docs/interceptors/caching.md),
 [Monitoring](/docs/interceptors/monitoring.md),
 [Authentication](/docs/interceptors/authentication.md),
+[Retry](/docs/interceptors/retry.md),
 [Rollbar](/docs/interceptors/rollbar.md),
 [Prometheus](/docs/interceptors/prometheus.md).
 

data/docs/interceptors/retry.md

@@ -0,0 +1,24 @@
+# Retry Interceptor
+
+If you enable the retry interceptor, you can have lhc retry requests for you:
+
+```ruby
+  LHC.config.interceptors = [LHC::Retry]
+  response = LHC.get('http://local.ch', retry: true)
+```
+
+It will try to retry the request up to 3 times (default) internally, before it passes the last response back, or raises an error for the last response.
+
+Consider, that all other interceptors will run for every single retry.
+
+## Limit the amount of retries while making the request
+
+```ruby
+  LHC.get('http://local.ch', retry: { max: 1 })
+```
+
+## Change the default maximum of retries of the retry interceptor
+
+```ruby
+  LHC::Retry.max = 3
+```

data/lib/lhc.rb

@@ -18,6 +18,8 @@ module LHC
     'lhc/interceptors/caching'
   autoload :Prometheus,
     'lhc/interceptors/prometheus'
+  autoload :Retry,
+    'lhc/interceptors/retry'
   autoload :Config,
     'lhc/config'
   autoload :Endpoint,

data/lib/lhc/interceptors/retry.rb

@@ -0,0 +1,38 @@
+class LHC::Retry < LHC::Interceptor
+  attr_accessor :retries, :current_retry
+
+  class << self
+    attr_accessor :max
+  end
+
+  def after_response(response)
+    response.request.options[:retries] ||= 0
+    return unless retry?(response.request)
+    response.request.options[:retries] += 1
+    current_retry = response.request.options[:retries]
+    begin
+      response.request.run!
+    rescue LHC::Error
+      return
+    end
+    response.request.response if current_retry == response.request.options[:retries]
+  end
+
+  private
+
+  def retry?(request)
+    return false if request.response.success?
+    return false unless request.options.dig(:retry)
+    request.options[:retries] < max(request)
+  end
+
+  def max(request)
+    options(request).is_a?(Hash) ? options(request).fetch(:max, LHC::Retry.max) : LHC::Retry.max
+  end
+
+  def options(request)
+    @options ||= request.options.dig(:retry)
+  end
+end
+
+LHC::Retry.max = 3

data/lib/lhc/request.rb

@@ -20,7 +20,7 @@ class LHC::Request
     self.raw = create_request
     self.format = options.delete('format') || LHC::Formats::JSON.new
     iprocessor.intercept(:before_request, self)
-    raw.run if self_executing && !response
+    run! if self_executing && !response
   end
 
   def url
@@ -43,6 +43,10 @@ class LHC::Request
     ignore_error?
   end
 
+  def run!
+    raw.run
+  end
+
   private
 
   attr_accessor :iprocessor
@@ -100,7 +104,7 @@ class LHC::Request
   end
 
   def on_complete(response)
-    self.response ||= LHC::Response.new(response, self)
+    self.response = LHC::Response.new(response, self)
     iprocessor.intercept(:after_response, self.response)
     handle_error(self.response) unless self.response.success?
   end

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= "6.6.0"
+  VERSION ||= "6.7.0"
 end

data/spec/interceptors/retry/main_spec.rb

@@ -0,0 +1,42 @@
+require 'rails_helper'
+
+describe LHC::Rollbar do
+  before(:each) do
+    LHC.config.interceptors = [LHC::Retry]
+  end
+
+  let(:request_stub) do
+    @retry_count = 0
+    stub_request(:get, 'http://local.ch').to_return do |_|
+      if @retry_count == max_retry_count
+        { status: 200 }
+      else
+        @retry_count += 1
+        { status: 500 }
+      end
+    end
+  end
+
+  let(:max_retry_count) { 3 }
+
+  it 'retries a request up to 3 times (default)' do
+    request_stub
+    response = LHC.get('http://local.ch', retry: true)
+    expect(response.success?).to eq true
+    expect(response.code).to eq 200
+    expect(request_stub).to have_been_requested.times(4)
+  end
+
+  context 'retry only once' do
+    let(:retry_options) { { max: 1 } }
+    let(:max_retry_count) { 1 }
+
+    it 'retries only once' do
+      request_stub
+      response = LHC.get('http://local.ch', retry: { max: 1 })
+      expect(response.success?).to eq true
+      expect(response.code).to eq 200
+      expect(request_stub).to have_been_requested.times(2)
+    end
+  end
+end

data/spec/request/parallel_requests_spec.rb

@@ -26,7 +26,6 @@ describe LHC::Request do
       LHC.configure { |c| c.interceptors = [TestInterceptor] }
     end
 
-    # rubocop:disable RSpec/InstanceVariable
     it 'calls interceptors also for parallel requests' do
       stub_parallel_requests
       @called = 0
@@ -35,6 +34,5 @@ describe LHC::Request do
       LHC.request(request_options)
       expect(@called).to eq 2
     end
-    # rubocop:enable RSpec/InstanceVariable
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 6.6.0
+  version: 6.7.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -182,6 +182,7 @@ files:
 - docs/interceptors/caching.md
 - docs/interceptors/monitoring.md
 - docs/interceptors/prometheus.md
+- docs/interceptors/retry.md
 - docs/interceptors/rollbar.md
 - docs/request.md
 - docs/response.md
@@ -206,6 +207,7 @@ files:
 - lib/lhc/interceptors/caching.rb
 - lib/lhc/interceptors/monitoring.rb
 - lib/lhc/interceptors/prometheus.rb
+- lib/lhc/interceptors/retry.rb
 - lib/lhc/interceptors/rollbar.rb
 - lib/lhc/railtie.rb
 - lib/lhc/request.rb
@@ -292,6 +294,7 @@ files:
 - spec/interceptors/monitoring/main_spec.rb
 - spec/interceptors/prometheus_spec.rb
 - spec/interceptors/response_competition_spec.rb
+- spec/interceptors/retry/main_spec.rb
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
 - spec/rails_helper.rb
@@ -341,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.0.0
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: LocalHttpClient
@@ -421,6 +424,7 @@ test_files:
 - spec/interceptors/monitoring/main_spec.rb
 - spec/interceptors/prometheus_spec.rb
 - spec/interceptors/response_competition_spec.rb
+- spec/interceptors/retry/main_spec.rb
 - spec/interceptors/return_response_spec.rb
 - spec/interceptors/rollbar/main_spec.rb
 - spec/rails_helper.rb