contentful 2.11.1 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1fbecbc8ac849d1c1c4388b0dfcb53db763b237195c03f1e2fbdea09d8544d8
-  data.tar.gz: acbc31c3bfe0073f945ba181ab16f0bc878327182fc15c7fe222ba8ee4ad11aa
+  metadata.gz: ee3c004cc764ee56ec8a0f8a9cf739f5e5ab10e8fda5c327e1708829b8585145
+  data.tar.gz: 57d48057485ff6260801e2090bd3dd37e71c1fb6afb53628f1f1e93bc5eabb3f
 SHA512:
-  metadata.gz: f1fc0748c09d0bb5a70f26f35ac90805443b87e3a3a71189a08b0c682a846b9fa53de2b4fb1f07c754ccaae81a692a73598b9059c89fe79fad7d4a06911e71ae
-  data.tar.gz: 786f075c50d8588cddbe9cbe77ec565fb4ad504176a112e522e9e8018e3d0b9f4901848fb91f68833c47c242383e5ed98fa353264d13152179e21f6b9957041a
+  metadata.gz: 88eb373835acf4f0cf9d90a48c407fa082efb9e73052c33b0c89c4ed1f685cf37d6ea6f90306a683e2b4f49c972e4aa0f3c5784fe4c2e44a4da0124373d5ec85
+  data.tar.gz: 5d7f33c79174fb1867a6509af1c59a76afec8b04d5a3cc557117d0e90cbd394bdd3243522404bba18e210d50aa941c773614a2815f868e1358f28dae0e665898

data/.rubocop.yml

@@ -19,7 +19,7 @@ AllCops:
     - Rakefile
 
 Metrics/ClassLength:
-  Max: 250
+  Max: 280
 
 Style/MutableConstant:
   Enabled: false

data/.rubocop_todo.yml

@@ -12,7 +12,7 @@ Metrics/AbcSize:
 
 # Offense count: 5
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 10
 
 # Offense count: 1
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
@@ -28,8 +28,8 @@ Metrics/MethodLength:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 499
+  Max: 500
 
 # Offense count: 4
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 10

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 2.12.0
+### Added
+* Add HTTP timeout configuration. [#196](https://github.com/contentful/contentful.rb/pull/196)
+
 ## 2.11.1
 ### Fixed
 * Fixed coercion error when same entry was included more than once in the same RichText field. [#194](https://github.com/contentful/contentful.rb/pull/194)

data/README.md

@@ -337,6 +337,21 @@ client = Contentful::Client.new(
       <td><code>nil</code></td>
       <td>Password for proxy authentication.</td>
     </tr>
+    <tr>
+      <td><code>timeout_read</code></td>
+      <td><code>nil</code></td>
+      <td>Number of seconds the request waits to read from the server before timing out.</td>
+    </tr>
+    <tr>
+      <td><code>timeout_write</code></td>
+      <td><code>nil</code></td>
+      <td>Number of seconds the request waits when writing to the server before timing out.</td>
+    </tr>
+    <tr>
+      <td><code>timeout_connect</code></td>
+      <td><code>nil</code></td>
+      <td>Number of seconds the request waits to connect to the server before timing out.</td>
+    </tr>
     <tr>
       <td><code>logger</code></td>
       <td><code>nil</code></td>

data/lib/contentful/base_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'support'
 
 module Contentful
@@ -63,12 +65,15 @@ module Contentful
       end
     end
 
+    LINKS = %w[space contentType environment].freeze
+    TIMESTAMPS = %w[createdAt updatedAt deletedAt].freeze
+
     def hydrate_sys
       result = {}
       raw.fetch('sys', {}).each do |k, v|
-        if %w[space contentType environment].include?(k)
+        if LINKS.include?(k)
           v = build_link(v)
-        elsif %w[createdAt updatedAt deletedAt].include?(k)
+        elsif TIMESTAMPS.include?(k)
           v = DateTime.parse(v)
         end
         result[Support.snakify(k, @configuration[:use_camel_case]).to_sym] = v

data/lib/contentful/client.rb

@@ -35,6 +35,9 @@ module Contentful
       proxy_username: nil,
       proxy_password: nil,
       proxy_port: nil,
+      timeout_connect: nil,
+      timeout_read: nil,
+      timeout_write: nil,
       max_rate_limit_retries: 1,
       max_rate_limit_wait: 60,
       max_include_resolution_depth: 20,
@@ -49,11 +52,13 @@ module Contentful
 
     # Wraps the actual HTTP request via proxy
     # @private
-    def self.get_http(url, query, headers = {}, proxy = {})
+    def self.get_http(url, query, headers = {}, proxy = {}, timeout = {})
+      http = HTTP[headers]
+      http = http.timeout(timeout) if timeout.any?
       if proxy[:host]
-        HTTP[headers].via(proxy[:host], proxy[:port], proxy[:username], proxy[:password]).get(url, params: query)
+        http.via(proxy[:host], proxy[:port], proxy[:username], proxy[:password]).get(url, params: query)
       else
-        HTTP[headers].get(url, params: query)
+        http.get(url, params: query)
       end
     end
 
@@ -68,6 +73,9 @@ module Contentful
     # @option given_configuration [String] :proxy_username
     # @option given_configuration [String] :proxy_password
     # @option given_configuration [Number] :proxy_port
+    # @option given_configuration [Number] :timeout_read
+    # @option given_configuration [Number] :timeout_write
+    # @option given_configuration [Number] :timeout_connect
     # @option given_configuration [Number] :max_rate_limit_retries
     # @option given_configuration [Number] :max_rate_limit_wait
     # @option given_configuration [Number] :max_include_resolution_depth
@@ -110,6 +118,15 @@ module Contentful
       }
     end
 
+    # @private
+    def timeout_params
+      {
+        connect: configuration[:timeout_connect],
+        read: configuration[:timeout_read],
+        write: configuration[:timeout_write]
+      }.reject { |_, value| value.nil? }
+    end
+
     # Returns the default configuration
     # @private
     def default_configuration
@@ -355,7 +372,8 @@ module Contentful
           url,
           request_query(request.query),
           request_headers,
-          proxy_params
+          proxy_params,
+          timeout_params
         ), request
       )
     end
@@ -431,6 +449,7 @@ module Contentful
       fail ArgumentError, 'The :dynamic_entries mode must be :auto or :manual' unless %i[auto manual].include?(
         configuration[:dynamic_entries]
       )
+      fail ArgumentError, 'Timeout parameters must be all omitted or all present' unless timeout_params.empty? || timeout_params.length == 3
     end
   end
 end

data/lib/contentful/fields_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'support'
 require_relative 'base_resource'
 

data/lib/contentful/support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Contentful
   # Utility methods used by the contentful gem
   module Support

data/lib/contentful/version.rb

@@ -1,5 +1,5 @@
 # Contentful Namespace
 module Contentful
   # Gem Version
-  VERSION = '2.11.1'
+  VERSION = '2.12.0'
 end

data/spec/client_class_spec.rb

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 describe Contentful::Client do
   describe '#get' do
-    let(:client) { create_client }
+    let(:client) { create_client() }
     let(:proxy_client) { create_client(proxy_host: '183.207.232.194',
                                        proxy_port: 8080,
                                        secure: false) }
+    let(:timeout_client) { create_client(timeout_connect: 1, timeout_read: 2, timeout_write: 3) }
     let(:request) { Contentful::Request.new(nil, client.environment_url('/content_types'), nil, 'cat') }
 
     it 'uses #base_url' do
@@ -32,17 +33,37 @@ describe Contentful::Client do
     end
 
     it 'calls #get_http' do
-      expect(client.class).to receive(:get_http).with(client.base_url + request.url, request.query, client.request_headers, client.proxy_params) { raw_fixture('content_type') }
+      expect(client.class).to receive(:get_http).with(client.base_url + request.url, request.query, client.request_headers, client.proxy_params, client.timeout_params) { raw_fixture('content_type') }
       client.get(request)
     end
 
     it 'calls #get_http via proxy' do
-      expect(proxy_client.class).to receive(:get_http).with(proxy_client.base_url + request.url, request.query, proxy_client.request_headers, proxy_client.proxy_params) { raw_fixture('content_type') }
+      expect(proxy_client.class).to receive(:get_http).with(proxy_client.base_url + request.url, request.query, proxy_client.request_headers, proxy_client.proxy_params, client.timeout_params) { raw_fixture('content_type') }
       proxy_client.get(request)
       expect(proxy_client.proxy_params[:host]).to eq '183.207.232.194'
       expect(proxy_client.proxy_params[:port]).to eq 8080
     end
 
+    describe 'timeout params' do
+      context 'with timeouts configured' do
+        it 'calls #get_http with timeouts' do
+          expect(timeout_client.class).to receive(:get_http).with(timeout_client.base_url + request.url, request.query, timeout_client.request_headers, timeout_client.proxy_params, timeout_client.timeout_params) { raw_fixture('content_type') }
+          timeout_client.get(request)
+          expect(timeout_client.timeout_params[:connect]).to eq 1
+          expect(timeout_client.timeout_params[:read]).to eq 2
+          expect(timeout_client.timeout_params[:write]).to eq 3
+        end
+      end
+
+      context 'without timeouts' do
+        it 'calls #get_http with timeouts' do
+          expect(client.class).to receive(:get_http).with(client.base_url + request.url, request.query, client.request_headers, client.proxy_params, client.timeout_params) { raw_fixture('content_type') }
+          client.get(request)
+          expect(client.timeout_params).to eq({})
+        end
+      end
+    end
+
     describe 'build_resources parameter' do
       it 'returns Contentful::Resource object if second parameter is true [default]' do
         res = vcr('content_type') { client.get(request) }

data/spec/client_configuration_spec.rb

@@ -347,4 +347,31 @@ describe 'Client Configuration Options' do
       expect(client.request_headers['X-Contentful-User-Agent']).to eq client.contentful_user_agent
     end
   end
+
+  describe 'timeout options' do
+    let(:full_options) { { timeout_connect: 1, timeout_read: 2, timeout_write: 3 } }
+
+    it 'allows the three options to be present together' do
+      expect do
+        create_client(full_options)
+      end.not_to raise_error
+    end
+
+    it 'allows the three options to be omitted' do
+      expect do
+        create_client()
+      end.not_to raise_error
+    end
+
+    it 'does not allow only some options to be set' do
+      # Test that any combination of 1 or 2 keys is rejected
+      1.upto(2) do |options_count|
+        full_options.keys.combination(options_count).each do |option_keys|
+          expect do
+            create_client(full_options.select { |key, _| option_keys.include?(key) })
+          end.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 2.11.1
+  version: 2.12.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -532,7 +532,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: contentful