kontent-delivery-sdk-ruby 2.0.12 → 2.0.19

data/lib/delivery/client/request_manager.rb

@@ -1,122 +1,126 @@
-require 'rest-client'
-require 'dotenv/load'
-
-module Kentico
-  module Kontent
-    module Delivery
-      class RequestManager
-        class << self
-          MAX_ATTEMPTS = 6
-          MAX_DELAY_SECONDS = 30
-          INITIAL_DELAY = 1
-          RETRY_WHEN_CODE = [408, 429, 500, 502, 503, 504].freeze
-          CODES_WITH_POSSIBLE_RETRY_HEADER = [429, 503].freeze
-
-          def start(query, headers)
-            @query = query
-            @headers = headers
-            @times_run = 1
-            @delay = INITIAL_DELAY
-            @url = @query.provide_url
-            @total_delay = 0
-            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 ||
-                                         @total_delay >= MAX_DELAY_SECONDS
-
-            next_delay
-            sleep(@delay)
-            @total_delay += @delay
-            continue
-          end
-
-          # Generates a random delay based on times_run, then increases times_run
-          def next_delay
-            min = 0.8 * INITIAL_DELAY
-            max = (1.2 * INITIAL_DELAY) * (2**@times_run)
-            @delay = rand(min..max)
-            @times_run += 1
-          end
-
-          def continue
-            if ENV['TEST'] == '1'
-              resp = Kentico::Kontent::Delivery::Tests::FakeResponder.get_response @query, @url, @headers
-              return should_retry(resp) if resp.is_a? Kentico::Kontent::Delivery::Responses::ResponseBase
-
-              make_response resp # resp is pure JSON
-            else
-              begin
-                resp = RestClient.get @url, @headers
-              rescue RestClient::ExceptionWithResponse => err
-                should_retry Kentico::Kontent::Delivery::Responses::ResponseBase.new err.http_code, err.response
-              rescue RestClient::SSLCertificateNotVerified => err
-                should_retry Kentico::Kontent::Delivery::Responses::ResponseBase.new 500, err
-              rescue SocketError => err
-                should_retry Kentico::Kontent::Delivery::Responses::ResponseBase.new 500, err.message
-              else
-                make_response resp
-              end
-            end
-          end
-
-          # Converts a standard REST response based on the type of query.
-          #
-          # * *Returns*:
-          #   - An object derived from the Kentico::Kontent::Delivery::Responses::ResponseBase class
-          def make_response(response)
-            case @query.query_type
-            when Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS
-              respond_item response
-            when Kentico::Kontent::Delivery::QUERY_TYPE_TYPES
-              respond_type response
-            when Kentico::Kontent::Delivery::QUERY_TYPE_TAXONOMIES
-              respond_taxonomy response
-            when Kentico::Kontent::Delivery::QUERY_TYPE_ELEMENT
-              Kentico::Kontent::Delivery::Responses::DeliveryElementResponse.new response.headers, response.body
-            end
-          end
-
-          def respond_type(response)
-            if @query.code_name.nil?
-              Kentico::Kontent::Delivery::Responses::DeliveryTypeListingResponse.new response.headers, response.body
-            else
-              Kentico::Kontent::Delivery::Responses::DeliveryTypeResponse.new response.headers, response.body
-            end
-          end
-
-          def respond_taxonomy(response)
-            if @query.code_name.nil?
-              Kentico::Kontent::Delivery::Responses::DeliveryTaxonomyListingResponse.new response.headers, response.body
-            else
-              Kentico::Kontent::Delivery::Responses::DeliveryTaxonomyResponse.new response.headers, response.body
-            end
-          end
-
-          def respond_item(response)
-            if @query.code_name.nil?
-              Kentico::Kontent::Delivery::Responses::DeliveryItemListingResponse.new(
-                response.headers,
-                response.body,
-                @query.content_link_url_resolver,
-                @query.inline_content_item_resolver
-              )
-            else
-              Kentico::Kontent::Delivery::Responses::DeliveryItemResponse.new(
-                response.headers,
-                response.body,
-                @query.content_link_url_resolver,
-                @query.inline_content_item_resolver
-              )
-            end
-          end
-        end
-      end
-    end
-  end
+require 'rest-client'
+require 'dotenv/load'
+
+module Kentico
+  module Kontent
+    module Delivery
+      class RequestManager
+        class << self
+          MAX_ATTEMPTS = 6
+          MAX_DELAY_SECONDS = 30
+          INITIAL_DELAY = 1
+          RETRY_WHEN_CODE = [408, 429, 500, 502, 503, 504].freeze
+          CODES_WITH_POSSIBLE_RETRY_HEADER = [429, 503].freeze
+
+          def start(query, headers)
+            @query = query
+            @headers = headers
+            @times_run = 1
+            @delay = INITIAL_DELAY
+            @url = @query.provide_url
+            @total_delay = 0
+            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 ||
+                                         @total_delay >= MAX_DELAY_SECONDS
+
+            next_delay
+            sleep(@delay)
+            @total_delay += @delay
+            continue
+          end
+
+          # Generates a random delay based on times_run, then increases times_run
+          def next_delay
+            min = 0.8 * INITIAL_DELAY
+            max = (1.2 * INITIAL_DELAY) * (2**@times_run)
+            @delay = rand(min..max)
+            @times_run += 1
+          end
+
+          def continue
+            if ENV['TEST'] == '1'
+              resp = Kentico::Kontent::Delivery::Tests::FakeResponder.get_response @query, @url, @headers
+              return should_retry(resp) if resp.is_a? Kentico::Kontent::Delivery::Responses::ResponseBase
+
+              make_response resp # resp is pure JSON
+            else
+              begin
+                resp = RestClient.get @url, @headers
+              rescue RestClient::ExceptionWithResponse => err
+                should_retry Kentico::Kontent::Delivery::Responses::ResponseBase.new err.http_code, err.response
+              rescue RestClient::SSLCertificateNotVerified => err
+                should_retry Kentico::Kontent::Delivery::Responses::ResponseBase.new 500, err
+              rescue SocketError => err
+                should_retry Kentico::Kontent::Delivery::Responses::ResponseBase.new 500, err.message
+              else
+                make_response resp
+              end
+            end
+          end
+
+          # Converts a standard REST response based on the type of query.
+          #
+          # * *Returns*:
+          #   - An object derived from the Kentico::Kontent::Delivery::Responses::ResponseBase class
+          def make_response(response)
+            case @query.query_type
+            when Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS_FEED
+              Kentico::Kontent::Delivery::Responses::DeliveryItemsFeedResponse.new(
+                response.headers,
+                response.body,
+                @query
+              )
+            when Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS
+              respond_item response
+            when Kentico::Kontent::Delivery::QUERY_TYPE_TYPES
+              respond_type response
+            when Kentico::Kontent::Delivery::QUERY_TYPE_TAXONOMIES
+              respond_taxonomy response
+            when Kentico::Kontent::Delivery::QUERY_TYPE_ELEMENT
+              Kentico::Kontent::Delivery::Responses::DeliveryElementResponse.new response.headers, response.body
+            end
+          end
+
+          def respond_type(response)
+            if @query.code_name.nil?
+              Kentico::Kontent::Delivery::Responses::DeliveryTypeListingResponse.new response.headers, response.body
+            else
+              Kentico::Kontent::Delivery::Responses::DeliveryTypeResponse.new response.headers, response.body
+            end
+          end
+
+          def respond_taxonomy(response)
+            if @query.code_name.nil?
+              Kentico::Kontent::Delivery::Responses::DeliveryTaxonomyListingResponse.new response.headers, response.body
+            else
+              Kentico::Kontent::Delivery::Responses::DeliveryTaxonomyResponse.new response.headers, response.body
+            end
+          end
+
+          def respond_item(response)
+            if @query.code_name.nil?
+              Kentico::Kontent::Delivery::Responses::DeliveryItemListingResponse.new(
+                response.headers,
+                response.body,
+                @query
+              )
+            else
+              Kentico::Kontent::Delivery::Responses::DeliveryItemResponse.new(
+                response.headers,
+                response.body,
+                @query
+              )
+            end
+          end
+        end
+      end
+    end
+  end
 end

data/lib/delivery/models/content_item.rb

@@ -1,153 +1,153 @@
-require 'ostruct'
-require 'nokogiri'
-
-module Kentico
-  module Kontent
-    module Delivery
-      class ContentItem
-        attr_accessor :content_link_url_resolver,
-                      :inline_content_item_resolver
-
-        # Parses the 'elements' JSON object as a dynamic OpenStruct object.
-        #
-        # * *Returns*:
-        #   - +OpenStruct+ The elements of the content item
-        def elements
-          @elements unless @elements.nil?
-          @elements = JSON.parse(
-            JSON.generate(@source['elements']),
-            object_class: OpenStruct
-          )
-        end
-
-        # Parses the 'system' JSON object as a dynamic OpenStruct object.
-        #
-        # * *Returns*:
-        #   - +OpenStruct+ The system properties of the content item
-        def system
-          @system unless @system.nil?
-          @system = JSON.parse(
-            JSON.generate(@source['system']),
-            object_class: OpenStruct
-          )
-        end
-
-        # Constructor.
-        #
-        # * *Args*:
-        #   - *source* (+JSON+) The response from a REST request for content items. The item may be on the root or under the 'item' node
-        #   - *content_link_url_resolver* ( Kentico::Kontent::Delivery::Resolvers::ContentLinkResolver )
-        #   - *inline_content_item_resolver* ( Kentico::Kontent::Delivery::Resolvers::InlineContentItemResolver )
-        #   - *linked_items_resolver* ( Kentico::Kontent::Delivery::Resolvers::LinkedItemResolver )
-        def initialize(source, content_link_url_resolver, inline_content_item_resolver, linked_items_resolver)
-          @source =
-            if source['item'].nil?
-              source
-            else
-              source['item']
-            end
-          @linked_items_resolver = linked_items_resolver
-          self.content_link_url_resolver = content_link_url_resolver
-          self.inline_content_item_resolver = inline_content_item_resolver
-        end
-
-        # Gets a string representation of the data stored in the element. Using this
-        # method instead of directly accessing the +elements+ collection causes
-        # the content to be resolved using the resolvers passed during instantiation.
-        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#resolving-links
-        #
-        # * *Args*:
-        #   - *code_name* (+string+) The code name of the desired element
-        #
-        # * *Returns*:
-        #   - +string+ The data converted to a string, resolved if the element is a 'rich_text' element
-        def get_string(code_name)
-          element = get_element code_name
-          content = element['value']
-
-          if element['type'] == 'rich_text'
-            content = content_link_url_resolver.resolve content, element['links'] if should_resolve_links element
-            inline_items = get_inline_items code_name
-            content = inline_content_item_resolver.resolve content, inline_items if should_resolve_inline_content element
-          end
-          content.to_s
-        end
-
-        # Returns an array of assets inserted into the specified element of the
-        # 'asset' type.
-        #
-        # * *Args*:
-        #   - *code_name* (+string+) The code name of the desired element
-        #
-        # * *Returns*:
-        #   - +Array+ The element's assets parsed as +OpenStruct+ objects
-        def get_assets(code_name)
-          element = get_element code_name
-          element['value'].map { |n| OpenStruct.new(n) }
-        end
-
-        # Returns an array of ContentItems that are linked in a 'modular_content'
-        # element.
-        #
-        # * *Args*:
-        #   - *code_name* (+string+) The code name of the desired element
-        #
-        # * *Returns*:
-        #   - +Array+ The element's linked items parsed as +ContentItem+ objects
-        def get_links(code_name)
-          element = get_element code_name
-          get_linked_items element['value']
-        end
-
-        # Returns an array of ContentItems that are inserted as inline content
-        # items or componenets of a 'rich_text' element.
-        #
-        # * *Args*:
-        #   - *code_name* (+string+) The code name of the desired element
-        #
-        # * *Returns*:
-        #   - +Array+ The element's inline content items parsed as +ContentItem+ objects
-        def get_inline_items(code_name)
-          element = get_element code_name
-          get_linked_items element['modular_content']
-        end
-
-        private
-
-        def should_resolve_links(element)
-          !element['links'].nil? && !content_link_url_resolver.nil?
-        end
-
-        def should_resolve_inline_content(element)
-          !element['modular_content'].nil? && !inline_content_item_resolver.nil?
-        end
-
-        # Gets the JSON object from the 'elements' collection with the specified key
-        #
-        # * *Args*:
-        #   - *code_name* (+string+, +symbol+) The code name or symbol of the desired element
-        #
-        # * *Returns*:
-        #   - +JSON+ The element as a JSON object
-        #
-        # * *Raises*:
-        #   - +ArgumentError+ if +code_name+ is +nil+
-        def get_element(code_name)
-          raise ArgumentError, "Argument 'code_name' cannot be null" if code_name.nil?
-
-          code_name = code_name.to_s if code_name.is_a? Symbol
-          @source['elements'][code_name]
-        end
-
-        def get_linked_items(codenames)
-          return [] unless codenames.class == Array
-
-          codenames.each_with_object([]) do |codename, items|
-            item = @linked_items_resolver.resolve codename
-            items << item if item
-          end
-        end
-      end
-    end
-  end
-end
+require 'ostruct'
+require 'nokogiri'
+
+module Kentico
+  module Kontent
+    module Delivery
+      class ContentItem
+        attr_accessor :content_link_url_resolver,
+                      :inline_content_item_resolver
+
+        # Parses the 'elements' JSON object as a dynamic OpenStruct object.
+        #
+        # * *Returns*:
+        #   - +OpenStruct+ The elements of the content item
+        def elements
+          @elements unless @elements.nil?
+          @elements = JSON.parse(
+            JSON.generate(@source['elements']),
+            object_class: OpenStruct
+          )
+        end
+
+        # Parses the 'system' JSON object as a dynamic OpenStruct object.
+        #
+        # * *Returns*:
+        #   - +OpenStruct+ The system properties of the content item
+        def system
+          @system unless @system.nil?
+          @system = JSON.parse(
+            JSON.generate(@source['system']),
+            object_class: OpenStruct
+          )
+        end
+
+        # Constructor.
+        #
+        # * *Args*:
+        #   - *source* (+JSON+) The response from a REST request for content items. The item may be on the root or under the 'item' node
+        #   - *content_link_url_resolver* ( Kentico::Kontent::Delivery::Resolvers::ContentLinkResolver )
+        #   - *inline_content_item_resolver* ( Kentico::Kontent::Delivery::Resolvers::InlineContentItemResolver )
+        #   - *linked_items_resolver* ( Kentico::Kontent::Delivery::Resolvers::LinkedItemResolver )
+        def initialize(source, content_link_url_resolver, inline_content_item_resolver, linked_items_resolver)
+          @source =
+            if source['item'].nil?
+              source
+            else
+              source['item']
+            end
+          @linked_items_resolver = linked_items_resolver
+          self.content_link_url_resolver = content_link_url_resolver
+          self.inline_content_item_resolver = inline_content_item_resolver
+        end
+
+        # Gets a string representation of the data stored in the element. Using this
+        # method instead of directly accessing the +elements+ collection causes
+        # the content to be resolved using the resolvers passed during instantiation.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#resolving-links
+        #
+        # * *Args*:
+        #   - *code_name* (+string+) The code name of the desired element
+        #
+        # * *Returns*:
+        #   - +string+ The data converted to a string, resolved if the element is a 'rich_text' element
+        def get_string(code_name)
+          element = get_element code_name
+          content = element['value']
+
+          if element['type'] == 'rich_text'
+            content = content_link_url_resolver.resolve content, element['links'] if should_resolve_links element
+            inline_items = get_inline_items code_name
+            content = inline_content_item_resolver.resolve content, inline_items if should_resolve_inline_content element
+          end
+          content.to_s
+        end
+
+        # Returns an array of assets inserted into the specified element of the
+        # 'asset' type.
+        #
+        # * *Args*:
+        #   - *code_name* (+string+) The code name of the desired element
+        #
+        # * *Returns*:
+        #   - +Array+ The element's assets parsed as +OpenStruct+ objects
+        def get_assets(code_name)
+          element = get_element code_name
+          element['value'].map { |n| OpenStruct.new(n) }
+        end
+
+        # Returns an array of ContentItems that are linked in a 'modular_content'
+        # element.
+        #
+        # * *Args*:
+        #   - *code_name* (+string+) The code name of the desired element
+        #
+        # * *Returns*:
+        #   - +Array+ The element's linked items parsed as +ContentItem+ objects
+        def get_links(code_name)
+          element = get_element code_name
+          get_linked_items element['value']
+        end
+
+        # Returns an array of ContentItems that are inserted as inline content
+        # items or componenets of a 'rich_text' element.
+        #
+        # * *Args*:
+        #   - *code_name* (+string+) The code name of the desired element
+        #
+        # * *Returns*:
+        #   - +Array+ The element's inline content items parsed as +ContentItem+ objects
+        def get_inline_items(code_name)
+          element = get_element code_name
+          get_linked_items element['modular_content']
+        end
+
+        private
+
+        def should_resolve_links(element)
+          !element['links'].nil? && !content_link_url_resolver.nil?
+        end
+
+        def should_resolve_inline_content(element)
+          !element['modular_content'].nil? && !inline_content_item_resolver.nil?
+        end
+
+        # Gets the JSON object from the 'elements' collection with the specified key
+        #
+        # * *Args*:
+        #   - *code_name* (+string+, +symbol+) The code name or symbol of the desired element
+        #
+        # * *Returns*:
+        #   - +JSON+ The element as a JSON object
+        #
+        # * *Raises*:
+        #   - +ArgumentError+ if +code_name+ is +nil+
+        def get_element(code_name)
+          raise ArgumentError, "Argument 'code_name' cannot be null" if code_name.nil?
+
+          code_name = code_name.to_s if code_name.is_a? Symbol
+          @source['elements'][code_name]
+        end
+
+        def get_linked_items(codenames)
+          return [] unless codenames.class == Array
+
+          codenames.each_with_object([]) do |codename, items|
+            item = @linked_items_resolver.resolve codename
+            items << item if item
+          end
+        end
+      end
+    end
+  end
+end