kontent-delivery-sdk-ruby 2.0.12 → 2.0.19

data/lib/delivery/builders/url_builder.rb

@@ -1,117 +1,120 @@
-module Kentico
-  module Kontent
-    module Delivery
-      module Builders
-        # Internal class which generates the URL required for Delivery REST API
-        class UrlBuilder
-          URL_TEMPLATE_BASE = 'https://deliver.kontent.ai/%s'.freeze
-          URL_TEMPLATE_PREVIEW = 'https://preview-deliver.kontent.ai/%s'.freeze
-          URL_TEMPLATE_ITEM = '/items/%s'.freeze
-          URL_TEMPLATE_ITEMS = '/items'.freeze
-          URL_TEMPLATE_TYPE = '/types/%s'.freeze
-          URL_TEMPLATE_TYPES = '/types'.freeze
-          URL_TEMPLATE_ELEMENTS = '/types/%s/elements/%s'.freeze
-          URL_TEMPLATE_TAXONOMY = '/taxonomies/%s'.freeze
-          URL_TEMPLATE_TAXONOMIES = '/taxonomies'.freeze
-
-          URL_MAX_LENGTH = 65_519
-          MSG_LONG_QUERY = 'The request url is too long. Split your query into multiple calls.'.freeze
-
-          class << self
-            # Returns the proper domain for the request along with the
-            # query string parameters configured by the +DeliveryQuery+.
-            #
-            # * *Args*:
-            #   - *query* ( Kentico::Kontent::Delivery::DeliveryQuery )
-            #
-            # * *Returns*:
-            #   - +string+ The full URL for a Delivery request
-            def provide_url(query)
-              url = provide_base_url(query)
-              url += provide_path_part(query)
-
-              if query.query_string.empty?
-                url
-              else
-                url + query.query_string.to_s
-              end
-            end
-
-            # Checks whether the provided URL is too long and raises an error if so.
-            #
-            # * *Args*:
-            #   - *url* (+string+) A full Delivery URL
-            #
-            # * *Raises*:
-            #   - +UriFormatException+ if the URL is 65,519 characters or more
-            def validate_url(url)
-              raise UriFormatException, MSG_LONG_QUERY if url.length > URL_MAX_LENGTH
-            end
-
-            private
-
-            # Returns relative path part of URL depending on query type.
-            #
-            # * *Args*:
-            #   - *query* ( Kentico::Kontent::Delivery::DeliveryQuery )
-            #
-            # * *Returns*:
-            #   - +string+ The URL path part (without protocol or domain)
-            def provide_path_part(query)
-              case query.query_type
-              when Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS
-                provide_item query
-              when Kentico::Kontent::Delivery::QUERY_TYPE_TYPES
-                provide_type query
-              when Kentico::Kontent::Delivery::QUERY_TYPE_TAXONOMIES
-                provide_taxonomy query
-              when Kentico::Kontent::Delivery::QUERY_TYPE_ELEMENT
-                format(URL_TEMPLATE_ELEMENTS, query.content_type, query.code_name)
-              end
-            end
-
-            def provide_item(query)
-              if query.code_name.nil?
-                URL_TEMPLATE_ITEMS
-              else
-                format(URL_TEMPLATE_ITEM, query.code_name)
-              end
-            end
-
-            def provide_taxonomy(query)
-              if query.code_name.nil?
-                URL_TEMPLATE_TAXONOMIES
-              else
-                format(URL_TEMPLATE_TAXONOMY, query.code_name)
-              end
-            end
-
-            def provide_type(query)
-              if query.code_name.nil?
-                URL_TEMPLATE_TYPES
-              else
-                format(URL_TEMPLATE_TYPE, query.code_name)
-              end
-            end
-
-            # Returns the protocol and domain with project ID. Domain changes
-            # according to the query's +use_preview+ attribute.
-            #
-            # * *Args*:
-            #   - *query* ( Kentico::Kontent::Delivery::DeliveryQuery )
-            #
-            # * *Returns*:
-            #   - +string+ The URL with the project ID
-            def provide_base_url(query)
-              if query.use_preview
-                format(URL_TEMPLATE_PREVIEW, query.project_id)
-              else
-                format(URL_TEMPLATE_BASE, query.project_id)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Kentico
+  module Kontent
+    module Delivery
+      module Builders
+        # Internal class which generates the URL required for Delivery REST API
+        class UrlBuilder
+          URL_TEMPLATE_BASE = 'https://deliver.kontent.ai/%s'.freeze
+          URL_TEMPLATE_PREVIEW = 'https://preview-deliver.kontent.ai/%s'.freeze
+          URL_TEMPLATE_ITEM = '/items/%s'.freeze
+          URL_TEMPLATE_ITEMS = '/items'.freeze
+          URL_TEMPLATE_TYPE = '/types/%s'.freeze
+          URL_TEMPLATE_TYPES = '/types'.freeze
+          URL_TEMPLATE_ELEMENTS = '/types/%s/elements/%s'.freeze
+          URL_TEMPLATE_TAXONOMY = '/taxonomies/%s'.freeze
+          URL_TEMPLATE_TAXONOMIES = '/taxonomies'.freeze
+          URL_TEMPLATE_ITEMS_FEED = '/items-feed'.freeze
+
+          URL_MAX_LENGTH = 65_519
+          MSG_LONG_QUERY = 'The request url is too long. Split your query into multiple calls.'.freeze
+
+          class << self
+            # Returns the proper domain for the request along with the
+            # query string parameters configured by the +DeliveryQuery+.
+            #
+            # * *Args*:
+            #   - *query* ( Kentico::Kontent::Delivery::DeliveryQuery )
+            #
+            # * *Returns*:
+            #   - +string+ The full URL for a Delivery request
+            def provide_url(query)
+              url = provide_base_url(query)
+              url += provide_path_part(query)
+
+              if query.query_string.empty?
+                url
+              else
+                url + query.query_string.to_s
+              end
+            end
+
+            # Checks whether the provided URL is too long and raises an error if so.
+            #
+            # * *Args*:
+            #   - *url* (+string+) A full Delivery URL
+            #
+            # * *Raises*:
+            #   - +UriFormatException+ if the URL is 65,519 characters or more
+            def validate_url(url)
+              raise UriFormatException, MSG_LONG_QUERY if url.length > URL_MAX_LENGTH
+            end
+
+            private
+
+            # Returns relative path part of URL depending on query type.
+            #
+            # * *Args*:
+            #   - *query* ( Kentico::Kontent::Delivery::DeliveryQuery )
+            #
+            # * *Returns*:
+            #   - +string+ The URL path part (without protocol or domain)
+            def provide_path_part(query)
+              case query.query_type
+              when Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS
+                provide_item query
+              when Kentico::Kontent::Delivery::QUERY_TYPE_TYPES
+                provide_type query
+              when Kentico::Kontent::Delivery::QUERY_TYPE_TAXONOMIES
+                provide_taxonomy query
+              when Kentico::Kontent::Delivery::QUERY_TYPE_ELEMENT
+                format(URL_TEMPLATE_ELEMENTS, query.content_type, query.code_name)
+              when Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS_FEED
+                URL_TEMPLATE_ITEMS_FEED
+              end
+            end
+
+            def provide_item(query)
+              if query.code_name.nil?
+                URL_TEMPLATE_ITEMS
+              else
+                format(URL_TEMPLATE_ITEM, query.code_name)
+              end
+            end
+
+            def provide_taxonomy(query)
+              if query.code_name.nil?
+                URL_TEMPLATE_TAXONOMIES
+              else
+                format(URL_TEMPLATE_TAXONOMY, query.code_name)
+              end
+            end
+
+            def provide_type(query)
+              if query.code_name.nil?
+                URL_TEMPLATE_TYPES
+              else
+                format(URL_TEMPLATE_TYPE, query.code_name)
+              end
+            end
+
+            # Returns the protocol and domain with project ID. Domain changes
+            # according to the query's +use_preview+ attribute.
+            #
+            # * *Args*:
+            #   - *query* ( Kentico::Kontent::Delivery::DeliveryQuery )
+            #
+            # * *Returns*:
+            #   - +string+ The URL with the project ID
+            def provide_base_url(query)
+              if query.use_preview
+                format(URL_TEMPLATE_PREVIEW, query.project_id)
+              else
+                format(URL_TEMPLATE_BASE, query.project_id)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/client/delivery_client.rb

@@ -1,155 +1,176 @@
-require 'delivery/client/delivery_query'
-require 'delivery/responses/delivery_item_listing_response'
-require 'delivery/responses/delivery_item_response'
-require 'json'
-
-module Kentico
-  module Kontent
-    module Delivery
-      QUERY_TYPE_TYPES = 'QUERY_TYPE_TYPES'.freeze
-      QUERY_TYPE_ITEMS = 'QUERY_TYPE_ITEMS'.freeze
-      QUERY_TYPE_TAXONOMIES = 'QUERY_TYPE_TAXONOMIES'.freeze
-      QUERY_TYPE_ELEMENT = 'QUERY_TYPE_ELEMENT'.freeze
-
-      # Executes requests against the Kentico Kontent Delivery API.
-      class DeliveryClient
-        attr_accessor :use_preview
-
-        # Constructor. Accepts a hash with the options for client.
-        #
-        # * *Args*:
-        #   - *config* (+Hash+) May contain the following keys:
-        #     - project_id (+string+) _required_
-        #     - preview_key (+string+)
-        #     - secure_key (+string+)
-        #     - content_link_url_resolver ( Kentico::Kontent::Delivery::Resolvers::ContentLinkResolver )
-        #     - inline_content_item_resolver ( Kentico::Kontent::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
-
-        # Return all content types of the project
-        #
-        # * *Returns*:
-        #   - Kentico::Kontent::Delivery::DeliveryQuery
-        def types
-          DeliveryQuery.new project_id: @project_id,
-                            secure_key: @secure_key,
-                            query_type: QUERY_TYPE_TYPES,
-                            with_retry_policy: @with_retry_policy
-        end
-
-        # Return a single content type of the project
-        #
-        # * *Args*:
-        #   - *code_name* (+string+) Code name of the desired content type
-        #
-        # * *Returns*:
-        #   - Kentico::Kontent::Delivery::DeliveryQuery
-        def type(code_name)
-          DeliveryQuery.new project_id: @project_id,
-                            secure_key: @secure_key,
-                            code_name: code_name,
-                            query_type: QUERY_TYPE_TYPES,
-                            with_retry_policy: @with_retry_policy
-        end
-
-        # Return all content items of the project
-        #
-        # * *Args*:
-        #   - *query_parameters* (+Array+) _optional_ One or more Kentico::Kontent::Delivery::QueryParameters::Filter objects. A single object will automatically be converted into an Array.
-        #
-        # * *Returns*:
-        #   - Kentico::Kontent::Delivery::DeliveryQuery
-        def items(query_parameters = [])
-          q = DeliveryQuery.new project_id: @project_id,
-                                secure_key: @secure_key,
-                                qp: query_parameters,
-                                content_link_url_resolver: @content_link_url_resolver,
-                                inline_content_item_resolver: @inline_content_item_resolver,
-                                query_type: QUERY_TYPE_ITEMS,
-                                with_retry_policy: @with_retry_policy
-          q.use_preview = use_preview
-          q.preview_key = @preview_key
-          q
-        end
-
-        # Return a single content item of the project
-        #
-        # * *Args*:
-        #   - *code_name* (+string+) The code name of the desired content item
-        #   - *query_parameters* (+Array+) _optional_ One or more Kentico::Kontent::Delivery::QueryParameters::Filter objects. A single object will automatically be converted into an Array.
-        #
-        # * *Returns*:
-        #   - Kentico::Kontent::Delivery::DeliveryQuery
-        def item(code_name, query_parameters = [])
-          q = DeliveryQuery.new project_id: @project_id,
-                                secure_key: @secure_key,
-                                code_name: code_name,
-                                qp: query_parameters,
-                                content_link_url_resolver: @content_link_url_resolver,
-                                inline_content_item_resolver: @inline_content_item_resolver,
-                                query_type: QUERY_TYPE_ITEMS,
-                                with_retry_policy: @with_retry_policy
-          q.use_preview = use_preview
-          q.preview_key = @preview_key
-          q
-        end
-
-        # Return all taxonomy groups of the project
-        #
-        # * *Args*:
-        #   - *query_parameters* (+Array+) _optional_ One or more Kentico::Kontent::Delivery::QueryParameters::Filter objects. A single object will automatically be converted into an Array.
-        #
-        # * *Returns*:
-        #   - Kentico::Kontent::Delivery::DeliveryQuery
-        def taxonomies(query_parameters = [])
-          DeliveryQuery.new project_id: @project_id,
-                            secure_key: @secure_key,
-                            qp: query_parameters,
-                            query_type: QUERY_TYPE_TAXONOMIES,
-                            with_retry_policy: @with_retry_policy
-        end
-
-        # Return a single taxonomy group of the project
-        #
-        # * *Args*:
-        #   - *code_name* (+string+) The code name of the desired taxonomy group
-        #
-        # * *Returns*:
-        #   - Kentico::Kontent::Delivery::DeliveryQuery
-        def taxonomy(code_name)
-          DeliveryQuery.new project_id: @project_id,
-                            secure_key: @secure_key,
-                            code_name: code_name,
-                            query_type: QUERY_TYPE_TAXONOMIES,
-                            with_retry_policy: @with_retry_policy
-        end
-
-        # Return a single element of a content type
-        #
-        # * *Args*:
-        #   - *content_type* (+string+) The code name of the content type containing the element
-        #   - *element* (+string+) The code name of the desired element
-        #
-        # * *Returns*:
-        #   - Kentico::Kontent::Delivery::DeliveryQuery
-        def element(content_type, element)
-          DeliveryQuery.new project_id: @project_id,
-                            secure_key: @secure_key,
-                            code_name: element,
-                            content_type: content_type,
-                            query_type: QUERY_TYPE_ELEMENT,
-                            with_retry_policy: @with_retry_policy
-        end
-      end
-    end
-  end
-end
+require 'delivery/client/delivery_query'
+require 'delivery/responses/delivery_item_listing_response'
+require 'delivery/responses/delivery_item_response'
+require 'json'
+
+module Kentico
+  module Kontent
+    module Delivery
+      QUERY_TYPE_TYPES = 'QUERY_TYPE_TYPES'.freeze
+      QUERY_TYPE_ITEMS = 'QUERY_TYPE_ITEMS'.freeze
+      QUERY_TYPE_TAXONOMIES = 'QUERY_TYPE_TAXONOMIES'.freeze
+      QUERY_TYPE_ELEMENT = 'QUERY_TYPE_ELEMENT'.freeze
+      QUERY_TYPE_ITEMS_FEED = 'QUERY_TYPE_ITEMS_FEED'.freeze
+
+      # Executes requests against the Kentico Kontent Delivery API.
+      class DeliveryClient
+        attr_accessor :use_preview
+
+        # Constructor. Accepts a hash with the options for client.
+        #
+        # * *Args*:
+        #   - *config* (+Hash+) May contain the following keys:
+        #     - project_id (+string+) _required_
+        #     - preview_key (+string+)
+        #     - secure_key (+string+)
+        #     - content_link_url_resolver ( Kentico::Kontent::Delivery::Resolvers::ContentLinkResolver )
+        #     - inline_content_item_resolver ( Kentico::Kontent::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
+
+        # Return all content types of the project
+        #
+        # * *Returns*:
+        #   - Kentico::Kontent::Delivery::DeliveryQuery
+        def types
+          DeliveryQuery.new project_id: @project_id,
+                            secure_key: @secure_key,
+                            query_type: QUERY_TYPE_TYPES,
+                            with_retry_policy: @with_retry_policy
+        end
+
+        # Return a single content type of the project
+        #
+        # * *Args*:
+        #   - *code_name* (+string+) Code name of the desired content type
+        #
+        # * *Returns*:
+        #   - Kentico::Kontent::Delivery::DeliveryQuery
+        def type(code_name)
+          DeliveryQuery.new project_id: @project_id,
+                            secure_key: @secure_key,
+                            code_name: code_name,
+                            query_type: QUERY_TYPE_TYPES,
+                            with_retry_policy: @with_retry_policy
+        end
+
+        # Return a paginated feed of all content items of the project
+        #
+        # * *Args*:
+        #   - *query_parameters* (+Array+) _optional_ One or more Kentico::Kontent::Delivery::QueryParameters::Filter objects. A single object will automatically be converted into an Array.
+        #
+        # * *Returns*:
+        #   - Kentico::Kontent::Delivery::DeliveryQuery
+        def items_feed(query_parameters = [])
+          q = DeliveryQuery.new project_id: @project_id,
+                                secure_key: @secure_key,
+                                qp: query_parameters,
+                                content_link_url_resolver: @content_link_url_resolver,
+                                inline_content_item_resolver: @inline_content_item_resolver,
+                                query_type: QUERY_TYPE_ITEMS_FEED,
+                                with_retry_policy: @with_retry_policy
+          q.use_preview = use_preview
+          q.preview_key = @preview_key
+          q
+        end
+
+        # Return all content items of the project
+        #
+        # * *Args*:
+        #   - *query_parameters* (+Array+) _optional_ One or more Kentico::Kontent::Delivery::QueryParameters::Filter objects. A single object will automatically be converted into an Array.
+        #
+        # * *Returns*:
+        #   - Kentico::Kontent::Delivery::DeliveryQuery
+        def items(query_parameters = [])
+          q = DeliveryQuery.new project_id: @project_id,
+                                secure_key: @secure_key,
+                                qp: query_parameters,
+                                content_link_url_resolver: @content_link_url_resolver,
+                                inline_content_item_resolver: @inline_content_item_resolver,
+                                query_type: QUERY_TYPE_ITEMS,
+                                with_retry_policy: @with_retry_policy
+          q.use_preview = use_preview
+          q.preview_key = @preview_key
+          q
+        end
+
+        # Return a single content item of the project
+        #
+        # * *Args*:
+        #   - *code_name* (+string+) The code name of the desired content item
+        #   - *query_parameters* (+Array+) _optional_ One or more Kentico::Kontent::Delivery::QueryParameters::Filter objects. A single object will automatically be converted into an Array.
+        #
+        # * *Returns*:
+        #   - Kentico::Kontent::Delivery::DeliveryQuery
+        def item(code_name, query_parameters = [])
+          q = DeliveryQuery.new project_id: @project_id,
+                                secure_key: @secure_key,
+                                code_name: code_name,
+                                qp: query_parameters,
+                                content_link_url_resolver: @content_link_url_resolver,
+                                inline_content_item_resolver: @inline_content_item_resolver,
+                                query_type: QUERY_TYPE_ITEMS,
+                                with_retry_policy: @with_retry_policy
+          q.use_preview = use_preview
+          q.preview_key = @preview_key
+          q
+        end
+
+        # Return all taxonomy groups of the project
+        #
+        # * *Args*:
+        #   - *query_parameters* (+Array+) _optional_ One or more Kentico::Kontent::Delivery::QueryParameters::Filter objects. A single object will automatically be converted into an Array.
+        #
+        # * *Returns*:
+        #   - Kentico::Kontent::Delivery::DeliveryQuery
+        def taxonomies(query_parameters = [])
+          DeliveryQuery.new project_id: @project_id,
+                            secure_key: @secure_key,
+                            qp: query_parameters,
+                            query_type: QUERY_TYPE_TAXONOMIES,
+                            with_retry_policy: @with_retry_policy
+        end
+
+        # Return a single taxonomy group of the project
+        #
+        # * *Args*:
+        #   - *code_name* (+string+) The code name of the desired taxonomy group
+        #
+        # * *Returns*:
+        #   - Kentico::Kontent::Delivery::DeliveryQuery
+        def taxonomy(code_name)
+          DeliveryQuery.new project_id: @project_id,
+                            secure_key: @secure_key,
+                            code_name: code_name,
+                            query_type: QUERY_TYPE_TAXONOMIES,
+                            with_retry_policy: @with_retry_policy
+        end
+
+        # Return a single element of a content type
+        #
+        # * *Args*:
+        #   - *content_type* (+string+) The code name of the content type containing the element
+        #   - *element* (+string+) The code name of the desired element
+        #
+        # * *Returns*:
+        #   - Kentico::Kontent::Delivery::DeliveryQuery
+        def element(content_type, element)
+          DeliveryQuery.new project_id: @project_id,
+                            secure_key: @secure_key,
+                            code_name: element,
+                            content_type: content_type,
+                            query_type: QUERY_TYPE_ELEMENT,
+                            with_retry_policy: @with_retry_policy
+        end
+      end
+    end
+  end
+end