delivery-sdk-ruby 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcfd75f3bee26c46149ed8faef71642ead7dfc5948f583d87056e0cdf2556f0a
-  data.tar.gz: 0b18049d740dd31e8abf162bcd26b6b9a06ed35b155a446dd891fe33e8969e9b
+  metadata.gz: c6d87b3a7e5e623b5a4cb2a7895f013a728f0db61b1262d45b54164dd5643f1f
+  data.tar.gz: d67e6da84bbb02eb12c7c12c79e3e7ef0dd19e37344b9009205106c41b61a9c2
 SHA512:
-  metadata.gz: 2a68250979aa4433a51288ea4e0df5a32d92c4cf42bebc4c97fa4ba140f7ea29f1675fdefb15ee2278af37cb34a1c896a22e393e4916246ca2f90903ed4251c9
-  data.tar.gz: 276eef68b913365d19e49db57eace88f0325caeb534fd0928fe237521bca34b0c3395610bbd58011017162f5703504fb85b1c739c0cc9411c4557a9ee1cecce4
+  metadata.gz: 21039d8c46e5404f0997f7ffbb71ed997d1b3ce5d8d83770da3701dca4b2263533ab20e3b17cd10e1370c24dd4bf84ca4735784efc00c38dfe097bd5bfe055c1
+  data.tar.gz: 2c1e1f3a77db72f6e19943d932d0357f8f06efbf2945a2780d8e09287dfa784381d493a4c3b981d0785ebddd332de49308030d0d05644dbf94faad1e53122c33

data/README.md

@@ -90,6 +90,26 @@ KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
                                            secure_key: '<your-secure-key>'
 ```
 
+### Retry policy
+
+By default, the SDK uses a retry policy, asking for requested content again in case of an error. The default policy retries the HTTP requests if the following status codes are returned:
+
+* 408 - `RequestTimeout`
+* 500 - `InternalServerError`
+* 502 - `BadGateway`
+* 503 - `ServiceUnavailable`
+* 504 - `GatewayTimeout`
+
+The default policy retries requests 5 times, totaling 6 overall attempts to retrieve content before returning a `ResponseBase` object containing the error. The consecutive attempts are delayed exponentially: 200 milliseconds, 400 milliseconds, 800 milliseconds, etc.
+
+To disable the retry policy, you can use the `with_retry_policy` argument:
+
+```ruby
+KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
+                                           secure_key: '<your-secure-key>',
+                                           with_retry_policy: false
+```
+
 ## Listing items
 
 
@@ -354,7 +374,7 @@ link_resolver = KenticoCloud::Delivery::Resolvers::ContentLinkResolver.new(lambd
         return "/coffees/#{link.url_slug}" if link.type.eql? 'coffee'
         return "/brewers/#{link.url_slug}" if link.type.eql? 'brewer'
       end, lambda do |id|
-        # link broken
+        # Link broken
         return "/notfound?id=#{id}"
       end)
 delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',

data/lib/delivery-sdk-ruby.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/delivery/client/delivery_client'
 require File.dirname(__FILE__) + '/delivery/client/delivery_query'
+require File.dirname(__FILE__) + '/delivery/client/request_manager'
 require File.dirname(__FILE__) + '/delivery/models/content_item'
 require File.dirname(__FILE__) + '/delivery/models/content_type'
 require File.dirname(__FILE__) + '/delivery/models/taxonomy_group'

data/lib/delivery/client/delivery_client.rb

@@ -23,12 +23,14 @@ module KenticoCloud
       #     - secure_key (+string+)
       #     - content_link_url_resolver ( KenticoCloud::Delivery::Resolvers::ContentLinkResolver )
       #     - inline_content_item_resolver ( KenticoCloud::Delivery::Resolvers::InlineContentItemResolver )
+      #     - with_retry_policy (+bool+)
       def initialize(config)
         @project_id = config.fetch(:project_id)
         @preview_key = config.fetch(:preview_key, nil)
         @secure_key = config.fetch(:secure_key, nil)
         @content_link_url_resolver = config.fetch(:content_link_url_resolver, nil)
         @inline_content_item_resolver = config.fetch(:inline_content_item_resolver, nil)
+        @with_retry_policy = config.fetch(:with_retry_policy, true)
         self.use_preview = !@preview_key.nil?
       end
 
@@ -39,7 +41,8 @@ module KenticoCloud
       def types
         DeliveryQuery.new project_id: @project_id,
                           secure_key: @secure_key,
-                          query_type: QUERY_TYPE_TYPES
+                          query_type: QUERY_TYPE_TYPES,
+                          with_retry_policy: @with_retry_policy
       end
 
       # Return a single content type of the project
@@ -53,7 +56,8 @@ module KenticoCloud
         DeliveryQuery.new project_id: @project_id,
                           secure_key: @secure_key,
                           code_name: code_name,
-                          query_type: QUERY_TYPE_TYPES
+                          query_type: QUERY_TYPE_TYPES,
+                          with_retry_policy: @with_retry_policy
       end
 
       # Return all content items of the project
@@ -69,7 +73,8 @@ module KenticoCloud
                               qp: query_parameters,
                               content_link_url_resolver: @content_link_url_resolver,
                               inline_content_item_resolver: @inline_content_item_resolver,
-                              query_type: QUERY_TYPE_ITEMS
+                              query_type: QUERY_TYPE_ITEMS,
+                              with_retry_policy: @with_retry_policy
         q.use_preview = use_preview
         q.preview_key = @preview_key
         q
@@ -90,7 +95,8 @@ module KenticoCloud
                               qp: query_parameters,
                               content_link_url_resolver: @content_link_url_resolver,
                               inline_content_item_resolver: @inline_content_item_resolver,
-                              query_type: QUERY_TYPE_ITEMS
+                              query_type: QUERY_TYPE_ITEMS,
+                              with_retry_policy: @with_retry_policy
         q.use_preview = use_preview
         q.preview_key = @preview_key
         q
@@ -107,7 +113,8 @@ module KenticoCloud
         DeliveryQuery.new project_id: @project_id,
                           secure_key: @secure_key,
                           qp: query_parameters,
-                          query_type: QUERY_TYPE_TAXONOMIES
+                          query_type: QUERY_TYPE_TAXONOMIES,
+                          with_retry_policy: @with_retry_policy
       end
 
       # Return a single taxonomy group of the project
@@ -121,7 +128,8 @@ module KenticoCloud
         DeliveryQuery.new project_id: @project_id,
                           secure_key: @secure_key,
                           code_name: code_name,
-                          query_type: QUERY_TYPE_TAXONOMIES
+                          query_type: QUERY_TYPE_TAXONOMIES,
+                          with_retry_policy: @with_retry_policy
       end
 
       # Return a single element of a content type
@@ -137,7 +145,8 @@ module KenticoCloud
                           secure_key: @secure_key,
                           code_name: element,
                           content_type: content_type,
-                          query_type: QUERY_TYPE_ELEMENT
+                          query_type: QUERY_TYPE_ELEMENT,
+                          with_retry_policy: @with_retry_policy
       end
     end
   end

data/lib/delivery/client/delivery_query.rb

@@ -1,4 +1,3 @@
-require 'rest-client'
 require 'delivery/builders/url_builder'
 require 'delivery/query_parameters/query_string'
 require 'delivery/version'
@@ -22,7 +21,8 @@ module KenticoCloud
                     :inline_content_item_resolver,
                     :query_type,
                     :query_string,
-                    :content_type
+                    :content_type,
+                    :with_retry_policy
 
       # Setter for a custom URL.
       #
@@ -61,21 +61,14 @@ module KenticoCloud
       # * *Returns*:
       #   - KenticoCloud::Delivery::Responses::ResponseBase or a class extending it
       def execute
-        provide_url
-        begin
-          resp = execute_rest
-        rescue RestClient::ExceptionWithResponse => err
-          resp = KenticoCloud::Delivery::Responses::ResponseBase.new err.http_code, err.response
-        rescue RestClient::SSLCertificateNotVerified => err
-          resp = KenticoCloud::Delivery::Responses::ResponseBase.new 500, err
-        rescue SocketError => err
-          resp = KenticoCloud::Delivery::Responses::ResponseBase.new 500, err.message
-        else
-          resp = make_response resp
-        ensure
-          yield resp if block_given?
-          resp
-        end
+        headers = @headers.clone
+        headers['X-KC-SDKID'] = provide_sdk_header
+        headers['Authorization'] = "Bearer #{preview_key}" if should_preview
+        headers['Authorization'] = "Bearer #{secure_key}" if !should_preview && secure_key
+
+        resp = KenticoCloud::Delivery::RequestManager.start self, headers
+        yield resp if block_given?
+        resp
       end
 
       # Sets a content link resolver to render links contained in rich text. See
@@ -198,18 +191,22 @@ module KenticoCloud
         self
       end
 
-      private
-
       # Uses KenticoCloud::Delivery::Builders::UrlBuilder.provide_url to set
       # the URL for the query. The +UrlBuilder+ also validates the URL.
       #
       # * *Raises*:
       #   - +UriFormatException+ if the URL is 65,519 characters or more
+      #
+      # * *Returns*:
+      #   - +string+ The full URL for this query
       def provide_url
         @url = KenticoCloud::Delivery::Builders::UrlBuilder.provide_url self if @url.nil?
         KenticoCloud::Delivery::Builders::UrlBuilder.validate_url @url
+        @url
       end
 
+      private
+
       # Initializes the +query_string+ attribute with the passed array of
       # KenticoCloud::Delivery::QueryParameters::Filter objects.
       #
@@ -242,72 +239,9 @@ module KenticoCloud
         use_preview && !preview_key.nil?
       end
 
-      # Executes the REST request using the +rest-client+ gem.
-      #
-      # * *Returns*:
-      #   - +Object+ The response from the server
-      def execute_rest
-        headers = @headers.clone
-
-        headers['X-KC-SDKID'] = provide_sdk_header
-        headers['Authorization'] = "Bearer #{preview_key}" if should_preview
-        headers['Authorization'] = "Bearer #{secure_key}" if !should_preview && secure_key
-
-        RestClient.get @url, headers
-      end
-
       def provide_sdk_header
         "rubygems.org;delivery-sdk-ruby;#{KenticoCloud::Delivery::VERSION}"
       end
-
-      # Converts a standard REST response based on the type of query.
-      #
-      # * *Returns*:
-      #   - An object derived from the KenticoCloud::Delivery::Responses::ResponseBase class
-      def make_response(response)
-        case query_type
-        when KenticoCloud::Delivery::QUERY_TYPE_ITEMS
-          respond_item response
-        when KenticoCloud::Delivery::QUERY_TYPE_TYPES
-          respond_type response
-        when KenticoCloud::Delivery::QUERY_TYPE_TAXONOMIES
-          respond_taxonomy response
-        when KenticoCloud::Delivery::QUERY_TYPE_ELEMENT
-          KenticoCloud::Delivery::Responses::DeliveryElementResponse.new JSON.parse(response)
-        end
-      end
-
-      def respond_type(response)
-        if code_name.nil?
-          KenticoCloud::Delivery::Responses::DeliveryTypeListingResponse.new JSON.parse(response)
-        else
-          KenticoCloud::Delivery::Responses::DeliveryTypeResponse.new JSON.parse(response)
-        end
-      end
-
-      def respond_taxonomy(response)
-        if code_name.nil?
-          KenticoCloud::Delivery::Responses::DeliveryTaxonomyListingResponse.new JSON.parse(response)
-        else
-          KenticoCloud::Delivery::Responses::DeliveryTaxonomyResponse.new JSON.parse(response)
-        end
-      end
-
-      def respond_item(response)
-        if code_name.nil?
-          KenticoCloud::Delivery::Responses::DeliveryItemListingResponse.new(
-            JSON.parse(response),
-            content_link_url_resolver,
-            inline_content_item_resolver
-          )
-        else
-          KenticoCloud::Delivery::Responses::DeliveryItemResponse.new(
-            JSON.parse(response),
-            content_link_url_resolver,
-            inline_content_item_resolver
-          )
-        end
-      end
     end
   end
 end

data/lib/delivery/client/request_manager.rb

@@ -0,0 +1,96 @@
+require 'rest-client'
+
+module KenticoCloud
+  module Delivery
+    class RequestManager
+      class << self
+        MAX_ATTEMPTS = 6
+        INITIAL_DELAY = 0.2
+        RETRY_WHEN_CODE = [408, 500, 502, 503, 504].freeze
+
+        def start(query, headers)
+          @query = query
+          @headers = headers
+          @times_run = 1
+          @delay = INITIAL_DELAY
+          @url = @query.provide_url
+          continue
+        end
+
+        private
+
+        def should_retry(potential_response)
+          return potential_response if @times_run == MAX_ATTEMPTS ||
+                                       !RETRY_WHEN_CODE.include?(potential_response.http_code) ||
+                                       !@query.with_retry_policy
+
+          @times_run += 1
+          @delay *= 2
+          sleep(@delay)
+          continue
+        end
+
+        def continue
+          resp = RestClient.get @url, @headers
+        rescue RestClient::ExceptionWithResponse => err
+          should_retry KenticoCloud::Delivery::Responses::ResponseBase.new err.http_code, err.response
+        rescue RestClient::SSLCertificateNotVerified => err
+          should_retry KenticoCloud::Delivery::Responses::ResponseBase.new 500, err
+        rescue SocketError => err
+          should_retry KenticoCloud::Delivery::Responses::ResponseBase.new 500, err.message
+        else
+          make_response resp
+        end
+
+        # Converts a standard REST response based on the type of query.
+        #
+        # * *Returns*:
+        #   - An object derived from the KenticoCloud::Delivery::Responses::ResponseBase class
+        def make_response(response)
+          case @query.query_type
+          when KenticoCloud::Delivery::QUERY_TYPE_ITEMS
+            respond_item response
+          when KenticoCloud::Delivery::QUERY_TYPE_TYPES
+            respond_type response
+          when KenticoCloud::Delivery::QUERY_TYPE_TAXONOMIES
+            respond_taxonomy response
+          when KenticoCloud::Delivery::QUERY_TYPE_ELEMENT
+            KenticoCloud::Delivery::Responses::DeliveryElementResponse.new JSON.parse(response)
+          end
+        end
+
+        def respond_type(response)
+          if @query.code_name.nil?
+            KenticoCloud::Delivery::Responses::DeliveryTypeListingResponse.new JSON.parse(response)
+          else
+            KenticoCloud::Delivery::Responses::DeliveryTypeResponse.new JSON.parse(response)
+          end
+        end
+
+        def respond_taxonomy(response)
+          if @query.code_name.nil?
+            KenticoCloud::Delivery::Responses::DeliveryTaxonomyListingResponse.new JSON.parse(response)
+          else
+            KenticoCloud::Delivery::Responses::DeliveryTaxonomyResponse.new JSON.parse(response)
+          end
+        end
+
+        def respond_item(response)
+          if @query.code_name.nil?
+            KenticoCloud::Delivery::Responses::DeliveryItemListingResponse.new(
+              JSON.parse(response),
+              @query.content_link_url_resolver,
+              @query.inline_content_item_resolver
+            )
+          else
+            KenticoCloud::Delivery::Responses::DeliveryItemResponse.new(
+              JSON.parse(response),
+              @query.content_link_url_resolver,
+              @query.inline_content_item_resolver
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/version.rb

@@ -1,5 +1,5 @@
 module KenticoCloud
   module Delivery
-    VERSION = '1.0.2'.freeze
+    VERSION = '1.0.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Eric Dugre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -122,6 +122,7 @@ files:
 - lib/delivery/builders/url_builder.rb
 - lib/delivery/client/delivery_client.rb
 - lib/delivery/client/delivery_query.rb
+- lib/delivery/client/request_manager.rb
 - lib/delivery/models/content_item.rb
 - lib/delivery/models/content_type.rb
 - lib/delivery/models/pagination.rb