lhc 7.0.1 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9e147beaadc8fe3e310a38644dccd8b35f4054c
-  data.tar.gz: d84dacb1f0997890b2c82d8b74d09b374c14ff28
+  metadata.gz: ad563c7a18adf9ec842d204bed81599304dac1c4
+  data.tar.gz: ef62b6ce7f4b80475ee0adbb4c502e6918706d8f
 SHA512:
-  metadata.gz: b41ec31a4305805cc15f3847dc32a1bcd2bc57aceba386947fe0b94c974237f9634bed91cf64edeec2ae486e1283b9883c6e49828b66af781ee0b91b50ca8937
-  data.tar.gz: 145f320dee707973d2ee7f675f51a5c7592f818b02cb942dcbfa1ea648fcd67d92a77bf9b64d0c96c52e0e7f2dd5022cbea566524fa321535437fa185ddde42a
+  metadata.gz: cc1a310cd83690e9aeea40affabae0c47eda9abaccac038efb52440d806cb675b410b4dd0252989e88cb9b529fb6b9d4525029cb63d3a2f2385e3d9ed3750db5
+  data.tar.gz: 34307e36153349564b30d2e5aeb62aff588911cbcd0bd3646aab83ba0c05b484b39d00c5c6b1bb7774a97ef6e488d984c05b364c150a990939264d8266c10093

data/README.md

@@ -112,6 +112,21 @@ You can configure global endpoints, placeholders and interceptors.
 
 → [Read more about configuration](docs/configuration.md)
 
+## Timeout
+
+Working and configuring timeouts is important, to ensure your app stays alive when services you depend on start to get really slow...
+
+LHC forwards two timeout options directly to typhoeus:
+
+`timeout` (in seconds) - The maximum time in seconds that you allow the libcurl transfer operation to take. Normally, name lookups can take a considerable time and limiting operations to less than a few seconds risk aborting perfectly normal operations. This option may cause libcurl to use the SIGALRM signal to timeout system calls.
+`connecttimeout` (in seconds) - It should contain the maximum time in seconds that you allow the connection phase to the server to take. This only limits the connection phase, it has no impact once it has connected. Set to zero to switch to the default built-in connection timeout - 300 seconds. 
+
+```ruby
+LHC.get('http://local.ch', timeout: 5, connecttimeout: 1)
+```
+
+LHC provides a [timeout interceptor](docs/interceptors/default_timeout.md) that lets you apply default timeout values to all the requests that you are performig in your application.
+
 ## URL-Templates
 
 Instead of using concrete urls you can also use url-templates that contain placeholders.

data/docs/interceptors.md

@@ -27,6 +27,8 @@ like [Caching](/docs/interceptors/caching.md), [Monitoring](/docs/interceptors/m
 
 ## Callbacks
 
+`before_raw_request(request)` is called before the raw typhoeus request is prepared/created.
+
 `before_request(request)` is called when the request is prepared and about to be executed.
 
 `after_request(request)` is called after request was started.

data/docs/interceptors/default_timeout.md

@@ -0,0 +1,17 @@
+# Default Timeout Interceptor
+
+Applies default timeout values to all requests made in an application, that uses LHC.
+
+```ruby
+  LHC.config.interceptors = [LHC::DefaultTimeout]
+```
+
+`timeout` default: 15 seconds
+`connecttimeout` default: 1 second
+
+## Overwrite defaults
+
+```ruby
+LHC::DefaultTimeout.timeout = 5 # seconds
+LHC::DefaultTimeout.connecttimeout = 2 # seconds
+```

data/lib/lhc.rb

@@ -21,6 +21,8 @@ module LHC
     'lhc/interceptors/prometheus'
   autoload :Retry,
     'lhc/interceptors/retry'
+  autoload :DefaultTimeout,
+    'lhc/interceptors/default_timeout'
   autoload :Config,
     'lhc/config'
   autoload :Endpoint,

data/lib/lhc/interceptor.rb

@@ -1,5 +1,7 @@
 class LHC::Interceptor
 
+  def before_raw_request(request); end
+
   def before_request(request); end
 
   def after_request(request); end

data/lib/lhc/interceptors/default_timeout.rb

@@ -0,0 +1,14 @@
+class LHC::DefaultTimeout < LHC::Interceptor
+  include ActiveSupport::Configurable
+
+  config_accessor :timeout, :connecttimeout
+
+  CONNECTTIMEOUT = 1 # second
+  TIMEOUT = 15 # seconds
+
+  def before_raw_request(request)
+    request_options = (request.options || {})
+    request_options[:timeout] ||= timeout || TIMEOUT
+    request_options[:connecttimeout] ||= connecttimeout || CONNECTTIMEOUT
+  end
+end

data/lib/lhc/request.rb

@@ -17,6 +17,7 @@ class LHC::Request
     use_configured_endpoint!
     generate_url_from_template!
     self.iprocessor = LHC::InterceptorProcessor.new(self)
+    iprocessor.intercept(:before_raw_request, self)
     self.raw = create_request
     self.format = options.delete('format') || LHC::Formats::JSON.new
     iprocessor.intercept(:before_request, self)

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= '7.0.1'
+  VERSION ||= '7.1.0'
 end

data/spec/interceptors/default_timeout/main_spec.rb

@@ -0,0 +1,32 @@
+require 'rails_helper'
+
+describe LHC::DefaultTimeout do
+  before(:each) do
+    LHC.config.interceptors = [LHC::DefaultTimeout]
+    LHC::DefaultTimeout.timeout = nil
+    LHC::DefaultTimeout.connecttimeout = nil
+  end
+
+  let(:stub) { stub_request(:get, 'http://local.ch').to_return(status: 200, body: 'The Website') }
+
+  it 'applies default timeouts to all requests made' do
+    stub
+    expect_any_instance_of(Ethon::Easy).to receive(:http_request)
+      .with(anything, anything, hash_including(timeout: 15, connecttimeout: 1)).and_call_original
+    LHC.get('http://local.ch')
+  end
+
+  context 'with changed default timesouts' do
+    before(:each) do
+      LHC::DefaultTimeout.timeout = 10
+      LHC::DefaultTimeout.connecttimeout = 3
+    end
+
+    it 'applies custom default timeouts to all requests made' do
+      stub
+      expect_any_instance_of(Ethon::Easy).to receive(:http_request)
+        .with(anything, anything, hash_including(timeout: 10, connecttimeout: 3)).and_call_original
+      LHC.get('http://local.ch')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.1.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2018-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -194,6 +194,7 @@ files:
 - docs/interceptors.md
 - docs/interceptors/authentication.md
 - docs/interceptors/caching.md
+- docs/interceptors/default_timeout.md
 - docs/interceptors/monitoring.md
 - docs/interceptors/prometheus.md
 - docs/interceptors/retry.md
@@ -219,6 +220,7 @@ files:
 - lib/lhc/interceptor_processor.rb
 - lib/lhc/interceptors/auth.rb
 - lib/lhc/interceptors/caching.rb
+- lib/lhc/interceptors/default_timeout.rb
 - lib/lhc/interceptors/monitoring.rb
 - lib/lhc/interceptors/prometheus.rb
 - lib/lhc/interceptors/retry.rb
@@ -305,6 +307,7 @@ files:
 - spec/interceptors/caching/response_status_spec.rb
 - spec/interceptors/caching/to_cache_spec.rb
 - spec/interceptors/default_interceptors_spec.rb
+- spec/interceptors/default_timeout/main_spec.rb
 - spec/interceptors/define_spec.rb
 - spec/interceptors/monitoring/main_spec.rb
 - spec/interceptors/prometheus_spec.rb
@@ -359,7 +362,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.0.0
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: LocalHttpClient
@@ -436,6 +439,7 @@ test_files:
 - spec/interceptors/caching/response_status_spec.rb
 - spec/interceptors/caching/to_cache_spec.rb
 - spec/interceptors/default_interceptors_spec.rb
+- spec/interceptors/default_timeout/main_spec.rb
 - spec/interceptors/define_spec.rb
 - spec/interceptors/monitoring/main_spec.rb
 - spec/interceptors/prometheus_spec.rb