kontent-delivery-sdk-ruby 2.0.15 → 2.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a504c6a9439735535f7373339c04ec54df37c90afc23ac90c662b6ecb3bf2e4d
-  data.tar.gz: bf8bfa8745c9c66a9f2e9fe2d4637da7d2748d2e9ed61505aabfb36dd4f55a95
+  metadata.gz: 96b761a2d404fbb7f7d4277dc11777b5518f89091243cf5a2c3a24974e554270
+  data.tar.gz: 0f5404b57090c5d827576d9e4a84a71a24e151a7fa848847509c6f7134f006c8
 SHA512:
-  metadata.gz: b8affbb16b1db59f18d6cb75fcf8ea8a0f68a51fdacc3a42a574bcd8a0fe6f611116238ea4781e3ca9ad00aa41a06f5d51e18d185441c1123c404966a70f3978
-  data.tar.gz: 9fadf919b125de5b03851a5daf0209269648ac883d6df83413976005dced4775d368ac5c57431b8f4dc052be3c438c67c8e433c8cdbf134c2a940dbbc88b6993
+  metadata.gz: 83c79acbeabffaaa8002414f5dc28d90a310e66085382922fcc9d03bc416afa0113a9a6836c2be44f92073e534ef601982e2363d647e32c75f4a04c0e2ae7e38
+  data.tar.gz: a3e94e33ab180278b446f76275e2f6e51716caca29f87fd7c7d49545807fd6d0f584133f85d646e56feeb824d4952fd6c1be35d54dfe81036619b614dc0ef757

data/README.md

@@ -2,8 +2,8 @@
 [![Join the chat at https://kentico-community.slack.com](https://img.shields.io/badge/join-slack-E6186D.svg)](https://kentico-community.slack.com)
 [![Stack Overflow](https://img.shields.io/badge/Stack%20Overflow-ASK%20NOW-FE7A16.svg?logo=stackoverflow&logoColor=white)](https://stackoverflow.com/tags/kentico-kontent)
  [![Version](https://img.shields.io/gem/v/kontent-delivery-sdk-ruby.svg?style=flat)](https://rubygems.org/gems/kontent-delivery-sdk-ruby)
- [![Maintainability](https://api.codeclimate.com/v1/badges/b2e3fae28a2b2601d815/maintainability)](https://codeclimate.com/github/Kentico/kontent-delivery-sdk-ruby/maintainability)
- [![Test coverage](https://api.codeclimate.com/v1/badges/b2e3fae28a2b2601d815/test_coverage)](https://codeclimate.com/github/Kentico/delivery-sdk-ruby/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c83f2067f9cae9bde737/maintainability)](https://codeclimate.com/github/Kentico/kontent-delivery-sdk-ruby/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c83f2067f9cae9bde737/test_coverage)](https://codeclimate.com/github/Kentico/kontent-delivery-sdk-ruby/test_coverage)
 
 # Delivery Ruby SDK
 
@@ -316,6 +316,26 @@ delivery_client.items
 
 :warning: Note that using the `include_total_count` method may increase the response time and should only be used if necessary.
 
+## Items feed
+
+Use the `items_feed` method to retrieve a dynamically paginated list of content items in your project. The result will have a `more_results?` method which indicates that more items can be retrieved from the feed, using the `next_result` method.
+
+This method accepts all [filtering](https://github.com/Kentico/kontent-delivery-sdk-ruby#filtering) and [parameters](https://github.com/Kentico/kontent-delivery-sdk-ruby#parameters) except _depth_, _skip_, and _limit_. You can read more about the /items-feed endpoint in the [Kontent documentation](https://docs.kontent.ai/reference/delivery-api#operation/enumerate-content-items)
+
+Below is an example that will load all content items of a project into a single array:
+
+```ruby
+result = delivery_client.items_feed.execute
+items = result.items
+if result.more_results?
+  loop do
+    result = result.next_result
+    items.push *result.items
+    break unless result.more_results?
+  end
+end
+```
+
 ## Retrieving content types
 
 You can use the `.type` and `.types` methods to request your content types from Kentico Kontent:

data/lib/delivery/builders/url_builder.rb

@@ -13,6 +13,7 @@ module Kentico
           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
@@ -67,6 +68,8 @@ module Kentico
                 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
 

data/lib/delivery/client/delivery_client.rb

@@ -10,6 +10,7 @@ module Kentico
       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
@@ -61,6 +62,26 @@ module Kentico
                             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*:

data/lib/delivery/client/delivery_query.rb

@@ -13,6 +13,9 @@ module Kentico
                         'https://github.com/Kentico/kontent-delivery-sdk-ruby#previewing-unpublished-content'.freeze
         ERROR_PARAMS = 'Only filters may be passed in the .item or .items methods'\
                         '. See https://github.com/Kentico/kontent-delivery-sdk-ruby#filtering'.freeze
+        HEADER_WAIT_FOR_CONTENT = 'X-KC-Wait-For-Loading-New-Content'.freeze
+        HEADER_SDK_ID = 'X-KC-SDKID'.freeze
+        HEADER_CONTINUATION = 'X-Continuation'.freeze
         attr_accessor :use_preview,
                       :preview_key,
                       :project_id,
@@ -139,7 +142,7 @@ module Kentico
         # * *Returns*:
         #   - +self+
         def skip(value)
-          query_string.set_param('skip', value)
+          query_string.set_param('skip', value) unless query_type.eql? Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS_FEED
           self
         end
 
@@ -167,7 +170,7 @@ module Kentico
         # * *Returns*:
         #   - +self+
         def limit(value)
-          query_string.set_param('limit', value)
+          query_string.set_param('limit', value) unless query_type.eql? Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS_FEED
           self
         end
 
@@ -196,7 +199,7 @@ module Kentico
         # * *Returns*:
         #   - +self+
         def depth(value)
-          query_string.set_param('depth', value)
+          query_string.set_param('depth', value) unless query_type.eql? Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS_FEED
           self
         end
 
@@ -207,7 +210,7 @@ module Kentico
         # * *Returns*:
         #   - +self+
         def request_latest_content
-          @headers['X-KC-Wait-For-Loading-New-Content'] = true
+          @headers[HEADER_WAIT_FOR_CONTENT] = true
           self
         end
 
@@ -238,6 +241,19 @@ module Kentico
           self
         end
 
+        def update_continuation(token)
+          @headers[HEADER_CONTINUATION] = token
+          self
+        end
+
+        def continuation_exists?
+          !continuation_token.nil?
+        end
+
+        def continuation_token
+          @headers[HEADER_CONTINUATION]
+        end
+
         private
 
         # Returns request headers that are extended with custom headers.
@@ -247,7 +263,7 @@ module Kentico
         #   - +Hash+
         def headers
           headers = @headers.clone
-          headers['X-KC-SDKID'] = provide_sdk_header
+          headers[HEADER_SDK_ID] = provide_sdk_header
           headers['Authorization'] = "Bearer #{preview_key}" if should_preview
           headers['Authorization'] = "Bearer #{secure_key}" if !should_preview && secure_key
 

data/lib/delivery/client/request_manager.rb

@@ -71,6 +71,12 @@ module Kentico
           #   - 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
@@ -103,15 +109,13 @@ module Kentico
               Kentico::Kontent::Delivery::Responses::DeliveryItemListingResponse.new(
                 response.headers,
                 response.body,
-                @query.content_link_url_resolver,
-                @query.inline_content_item_resolver
+                @query
               )
             else
               Kentico::Kontent::Delivery::Responses::DeliveryItemResponse.new(
                 response.headers,
                 response.body,
-                @query.content_link_url_resolver,
-                @query.inline_content_item_resolver
+                @query
               )
             end
           end

data/lib/delivery/responses/delivery_item_listing_response.rb

@@ -38,10 +38,10 @@ module Kentico
             @items = items
           end
 
-          def initialize(headers, body, content_link_url_resolver, inline_content_item_resolver)
+          def initialize(headers, body, query)
             @response = JSON.parse(body)
-            @content_link_url_resolver = content_link_url_resolver
-            @inline_content_item_resolver = inline_content_item_resolver
+            @content_link_url_resolver = query.content_link_url_resolver
+            @inline_content_item_resolver = query.inline_content_item_resolver
             super 200,
               "Success, #{items.length} items returned",
               headers,

data/lib/delivery/responses/delivery_item_response.rb

@@ -24,10 +24,10 @@ module Kentico
             )
           end
 
-          def initialize(headers, body, content_link_url_resolver, inline_content_item_resolver)
+          def initialize(headers, body, query)
             @response = JSON.parse(body)
-            @content_link_url_resolver = content_link_url_resolver
-            @inline_content_item_resolver = inline_content_item_resolver
+            @content_link_url_resolver = query.content_link_url_resolver
+            @inline_content_item_resolver = query.inline_content_item_resolver
             super 200,
               "Success, '#{item.system.codename}' returned",
               headers,

data/lib/delivery/responses/delivery_items_feed_response.rb

@@ -0,0 +1,58 @@
+require 'delivery/models/content_item'
+require 'delivery/models/pagination'
+require 'delivery/responses/response_base'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module Responses
+        # The response of a successful query for content items.
+        class DeliveryItemsFeedResponse < ResponseBase
+          # A collection of Kentico::Kontent::Delivery::ContentItem objects from
+          # a Kentico::Kontent::Delivery::DeliveryClient.items_feed call.
+          #
+          # * *Returns*:
+          #   - +Array+ One or more Kentico::Kontent::Delivery::ContentItem objects
+          def items
+            @items unless @items.nil?
+            linked_items_resolver = Kentico::Kontent::Delivery::Resolvers::LinkedItemResolver.new @response['modular_content'], @content_link_url_resolver, @inline_content_item_resolver
+            items = []
+            @response['items'].each do |n|
+              items << Kentico::Kontent::Delivery::ContentItem.new(
+                n,
+                @content_link_url_resolver,
+                @inline_content_item_resolver,
+                linked_items_resolver
+              )
+            end
+            @items = items
+          end
+
+          def initialize(headers, body, query)
+            @query = query
+            @response = JSON.parse(body)
+            @content_link_url_resolver = query.content_link_url_resolver
+            @inline_content_item_resolver = query.inline_content_item_resolver
+            super 200,
+              "Success, #{items.length} items returned",
+              headers,
+              JSON.generate(@response)
+          end
+
+          def next_result
+            @query.update_continuation continuation_token
+            @query.execute
+          end
+
+          def more_results?
+            !continuation_token.nil?
+          end
+
+          def continuation_token
+            headers[Kentico::Kontent::Delivery::DeliveryQuery::HEADER_CONTINUATION]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/tests/fake_responder.rb

@@ -14,6 +14,9 @@ module Kentico
           PREVIEW_KEY = ENV['PREVIEW_KEY']
           BASE_URL = "https://deliver.kontent.ai/#{PROJECT_ID}".freeze
           PREVIEW_URL = "https://preview-deliver.kontent.ai/#{PROJECT_ID}".freeze
+          CONTINUATION_HEADER_1 = '+RID:~lmJ4ALSekwpBTQAAAAAADA==#RT:1#TRC:100#RTD:NrCNpn14PWTcji51F4ccBWJlYm5geGZqaHBtZWBgYHVmdHVqbnBvamJtAA==#ISV:2#IEO:65551#QCF:1#FPC:AggAAAAAADAAAAMAAAAAMAAAAAAAAAAwAAD2AgPA4N8A+A8+EYAkABBCCEEQgBAAK4BRABCSFoAhAACgQgBg4AMAMgAAqAEAM4BPgAXAICSSgAAAoBIEAFEAgANTAP7/AwAACC6AAcADACyAVABSRWIUIoqAAH2ABMCAQpFEEQAEAEIAGDAMABuAI4AyAACQCwAzACJBJBJIQhgAUYJIBFGiAhAERSKKSCkQADIAAP4fACIAqQAQABEAAAURAABgL4AEwA+APwDAjwYAMgAQqEIAEgCgqgIAUgDwAYAHIQA6ABEAADBSAAD/AQAhAMP/EUAfABKAgQD4/2JAAQD4/zFAHwARAPgAEQCABBIAPAAs/iFAfwAxAADgGIBxAH7/JgABSKRd22trW1KpUpkmACQIogAAUElJkpUCAYQA+P//A+z/AwdRAAD4coFBAAD8IEASAAD/BwBWgC+AAcACAYEAwAESAAD/BwAmgKEAMA0SAAL/HwBGgBmAYgDgh3EAUoCdgAHAcAAxgCIA4AcgABEAgD9RAAAPj4ADwAUAAAAAI9aAIQAgFTKAEQAAHm+A0QDwA7+AQgAMAABAJIAfgAiADoACwHVVAwBvgATAqgAAAFWrCgByAKkAEAAhAAwAIgAEwAMAEgB/ABgAAQHgDxEAHgA8gIuAUQClKmeAAQEDABEAkAAxACQAYQAAJCQA3wAAQAMBABBRAAAMNYABwAJ8P4ACwFRtAwBhAEABUQC1BTeAcgDgAP8PIQAAMBEAqgJRAICAIQAcABOA4gEA0AoAQQAAwNGAkQAAMEEAAAMhAAAYMQCAAyIAAGAhAD6AowAAtgUAoUhSAIABAEAfgHIAgGqTAZIAAOABACEAeABggBEAAChCAJA1ggMxAARwUIAngAHAAAyFgEiAEgAA/wEAEgAD4AIAQQA4ABMAGABQNQACcQBIAGIACAZAAFSAAsBgAYABPIAHgDEAAAxBgJEAgAriAAD4AwBxAADwUQEgQEuAAcBcBm6BQ4AvgAHAbARTgFeAnYAKgA+AoQAQAsmAAQAAAAAwAACAAVIAQGo1AKEBIKx0gGEAAH7JgH6A/IAIgIIAAGhVDcqAXIBEgLWAggAAYAGVhIBhAGAAd4DSAABwADBSABABAAo2gB2AAIAhADAAEgCrBWg1YgCA/w8AEgDg8f8AIQB+ABMAQBQgAEoAUQAABzKAIgACWAAELoAFwG21DhUJUqmmqgBvggCAH4IBwOMAcQDAARmAQ4ABwABQz4AEwP8AAMD//w8AsQGAATIAIoABAoEAMAATAACQqto2Ir+ADYC4gCIAAAMIAGiAmIBhAAD4EUAPAEQAASTAA1wFAwAfgAOADYAVgZIAAKASACGAMQC/AZIAsCAEAJIAEAQCAMGABcAA8P7/////wwEAwIABAQCgIQAA+D2AT4ACwPD/hwDRAmAAooARAAwAggIg+B4AoQAAYCuAK4ARgBOAQgAA4AMAroBcgW2BmII8gA2AUwCA//9PhwBsgAbAEAQAgACAvx8D+AcAKICigALABgAIAHuAE4BggI6AGYChAAMAmIBWhAIAAAAAMAAADgFyAqCAAgA2gBmALoCxAAAD4wAACRAgAAJjAMAA9+8DAGSAKoAggDIBXAEQAG6AAIAogDCAPYAGgJEAACh/gFEAAAejAGB/8///B5GAIQBgAOEAyB6SAECAMQAZgBGAuoAqgIGAAIAOgA+A7oBMgCiAD4AJgAHAPAARgAHAMABDAAB+AYHz/xFA3/9TQP/fGwAQIBEAgANiAPgAAAgRAMAAEQGVAL6AA8AAIgMAAQCxAABIIYKBAOARQQPkATEAQARwgZOBCYIhAYABARcGAFaAUAAiQP8PAGBRARgAMgAA0P8AIIBBAAyANUBP4Pf+AQDw/0kCMgAAwOcBIQAAMDWAWIAvgKEAwAAugBEAwAIDAAAAADAAAHQAn4EAgBQEABz/D0EA8AFiABgcBACzBQDAj/8DAGqAQQAA4BIAADwCEBEAjAESADAOCAAhAGAQNwBEjt8/wOAHAO8DEiA4ABEB4AEiAA8A4A9xCQc4QgCDAABAMwDA/zf//wc0AAAHEFCAgf8AMwAAPIAB+OM='.freeze
+          CONTINUATION_HEADER_2 = '+RID:~lmJ4ALSekwrtbwAAAAAADA==#RT:2#TRC:200#RTD:NrCNpn14PWTcji51F4ccBWJ2dXBuYnVqZGBxdmNtanRpam9oYGJvZWB2b3F2Y21qdGlqb2hgNDU0ZTJmNgA=#ISV:2#IEO:65551#QCF:1#FPC:AggAAAAAADAAAAMAAAAAMAAAAAAAAAAwAAD2AgPA4N8A+A8+EYAkABBCCEEQgBAAK4BRABCSFoAhAACgQgBg4AMAMgAAqAEAM4BPgAXAICSSgAAAoBIEAFEAgANTAP7/AwAACC6AAcADACyAVABSRWIUIoqAAH2ABMCAQpFEEQAEAEIAGDAMABuAI4AyAACQCwAzACJBJBJIQhgAUYJIBFGiAhAERSKKSCkQADIAAP4fACIAqQAQABEAAAURAABgL4AEwA+APwDAjwYAMgAQqEIAEgCgqgIAUgDwAYAHIQA6ABEAADBSAAD/AQAhAMP/EUAfABKAgQD4/2JAAQD4/zFAHwARAPgAEQCABBIAPAAs/iFAfwAxAADgGIBxAH7/JgABSKRd22trW1KpUpkmACQIogAAUElJkpUCAYQA+P//A+z/AwdRAAD4coFBAAD8IEASAAD/BwBWgC+AAcACAYEAwAESAAD/BwAmgKEAMA0SAAL/HwBGgBmAYgDgh3EAUoCdgAHAcAAxgCIA4AcgABEAgD9RAAAPj4ADwAUAAAAAI9aAIQAgFTKAEQAAHm+A0QDwA7+AQgAMAABAJIAfgAiADoACwHVVAwBvgATAqgAAAFWrCgByAKkAEAAhAAwAIgAEwAMAEgB/ABgAAQHgDxEAHgA8gIuAUQClKmeAAQEDABEAkAAxACQAYQAAJCQA3wAAQAMBABBRAAAMNYABwAJ8P4ACwFRtAwBhAEABUQC1BTeAcgDgAP8PIQAAMBEAqgJRAICAIQAcABOA4gEA0AoAQQAAwNGAkQAAMEEAAAMhAAAYMQCAAyIAAGAhAD6AowAAtgUAoUhSAIABAEAfgHIAgGqTAZIAAOABACEAeABggBEAAChCAJA1ggMxAARwUIAngAHAAAyFgEiAEgAA/wEAEgAD4AIAQQA4ABMAGABQNQACcQBIAGIACAZAAFSAAsBgAYABPIAHgDEAAAxBgJEAgAriAAD4AwBxAADwUQEgQEuAAcBcBm6BQ4AvgAHAbARTgFeAnYAKgA+AoQAQAsmAAQAAAAAwAACAAVIAQGo1AKEBIKx0gGEAAH7JgH6A/IAIgIIAAGhVDcqAXIBEgLWAggAAYAGVhIBhAGAAd4DSAABwADBSABABAAo2gB2AAIAhADAAEgCrBWg1YgCA/w8AEgDg8f8AIQB+ABMAQBQgAEoAUQAABzKAIgACWAAELoAFwG21DhUJUqmmqgBvggCAH4IBwOMAcQDAARmAQ4ABwABQz4AEwP8AAMD//w8AsQGAATIAIoABAoEAMAATAACQqto2Ir+ADYC4gCIAAAMIAGiAmIBhAAD4EUAPAEQAASTAA1wFAwAfgAOADYAVgZIAAKASACGAMQC/AZIAsCAEAJIAEAQCAMGABcAA8P7/////wwEAwIABAQCgIQAA+D2AT4ACwPD/hwDRAmAAooARAAwAggIg+B4AoQAAYCuAK4ARgBOAQgAA4AMAroBcgW2BmII8gA2AUwCA//9PhwBsgAbAEAQAgACAvx8D+AcAKICigALABgAIAHuAE4BggI6AGYChAAMAmIBWhAIAAAAAMAAADgFyAqCAAgA2gBmALoCxAAAD4wAACRAgAAJjAMAA9+8DAGSAKoAggDIBXAEQAG6AAIAogDCAPYAGgJEAACh/gFEAAAejAGB/8///B5GAIQBgAOEAyB6SAECAMQAZgBGAuoAqgIGAAIAOgA+A7oBMgCiAD4AJgAHAPAARgAHAMABDAAB+AYHz/xFA3/9TQP/fGwAQIBEAgANiAPgAAAgRAMAAEQGVAL6AA8AAIgMAAQCxAABIIYKBAOARQQPkATEAQARwgZOBCYIhAYABARcGAFaAUAAiQP8PAGBRARgAMgAA0P8AIIBBAAyANUBP4Pf+AQDw/0kCMgAAwOcBIQAAMDWAWIAvgKEAwAAugBEAwAIDAAAAADAAAHQAn4EAgBQEABz/D0EA8AFiABgcBACzBQDAj/8DAGqAQQAA4BIAADwCEBEAjAESADAOCAAhAGAQNwBEjt8/wOAHAO8DEiA4ABEB4AEiAA8A4A9xCQc4QgCDAABAMwDA/zf//wc0AAAHEFCAgf8AMwAAPIAB+OM='.freeze
+          CONTINUATION_HEADER_3 = '+RID:~lmJ4ALSekwpBxQAAAAAADA==#RT:3#TRC:300#RTD:NrCNpn14PWTcji51F4ccBWJlYm5geGZqaHBtZWBgYHVmdHVqbnBvamJtAA==#ISV:2#IEO:65551#QCF:1#FPC:AggAAAAAADAAAAMAAAAAMAAAAAAAAAAwAAD2AgPA4N8A+A8+EYAkABBCCEEQgBAAK4BRABCSFoAhAACgQgBg4AMAMgAAqAEAM4BPgAXAICSSgAAAoBIEAFEAgANTAP7/AwAACC6AAcADACyAVABSRWIUIoqAAH2ABMCAQpFEEQAEAEIAGDAMABuAI4AyAACQCwAzACJBJBJIQhgAUYJIBFGiAhAERSKKSCkQADIAAP4fACIAqQAQABEAAAURAABgL4AEwA+APwDAjwYAMgAQqEIAEgCgqgIAUgDwAYAHIQA6ABEAADBSAAD/AQAhAMP/EUAfABKAgQD4/2JAAQD4/zFAHwARAPgAEQCABBIAPAAs/iFAfwAxAADgGIBxAH7/JgABSKRd22trW1KpUpkmACQIogAAUElJkpUCAYQA+P//A+z/AwdRAAD4coFBAAD8IEASAAD/BwBWgC+AAcACAYEAwAESAAD/BwAmgKEAMA0SAAL/HwBGgBmAYgDgh3EAUoCdgAHAcAAxgCIA4AcgABEAgD9RAAAPj4ADwAUAAAAAI9aAIQAgFTKAEQAAHm+A0QDwA7+AQgAMAABAJIAfgAiADoACwHVVAwBvgATAqgAAAFWrCgByAKkAEAAhAAwAIgAEwAMAEgB/ABgAAQHgDxEAHgA8gIuAUQClKmeAAQEDABEAkAAxACQAYQAAJCQA3wAAQAMBABBRAAAMNYABwAJ8P4ACwFRtAwBhAEABUQC1BTeAcgDgAP8PIQAAMBEAqgJRAICAIQAcABOA4gEA0AoAQQAAwNGAkQAAMEEAAAMhAAAYMQCAAyIAAGAhAD6AowAAtgUAoUhSAIABAEAfgHIAgGqTAZIAAOABACEAeABggBEAAChCAJA1ggMxAARwUIAngAHAAAyFgEiAEgAA/wEAEgAD4AIAQQA4ABMAGABQNQACcQBIAGIACAZAAFSAAsBgAYABPIAHgDEAAAxBgJEAgAriAAD4AwBxAADwUQEgQEuAAcBcBm6BQ4AvgAHAbARTgFeAnYAKgA+AoQAQAsmAAQAAAAAwAACAAVIAQGo1AKEBIKx0gGEAAH7JgH6A/IAIgIIAAGhVDcqAXIBEgLWAggAAYAGVhIBhAGAAd4DSAABwADBSABABAAo2gB2AAIAhADAAEgCrBWg1YgCA/w8AEgDg8f8AIQB+ABMAQBQgAEoAUQAABzKAIgACWAAELoAFwG21DhUJUqmmqgBvggCAH4IBwOMAcQDAARmAQ4ABwABQz4AEwP8AAMD//w8AsQGAATIAIoABAoEAMAATAACQqto2Ir+ADYC4gCIAAAMIAGiAmIBhAAD4EUAPAEQAASTAA1wFAwAfgAOADYAVgZIAAKASACGAMQC/AZIAsCAEAJIAEAQCAMGABcAA8P7/////wwEAwIABAQCgIQAA+D2AT4ACwPD/hwDRAmAAooARAAwAggIg+B4AoQAAYCuAK4ARgBOAQgAA4AMAroBcgW2BmII8gA2AUwCA//9PhwBsgAbAEAQAgACAvx8D+AcAKICigALABgAIAHuAE4BggI6AGYChAAMAmIBWhAIAAAAAMAAADgFyAqCAAgA2gBmALoCxAAAD4wAACRAgAAJjAMAA9+8DAGSAKoAggDIBXAEQAG6AAIAogDCAPYAGgJEAACh/gFEAAAejAGB/8///B5GAIQBgAOEAyB6SAECAMQAZgBGAuoAqgIGAAIAOgA+A7oBMgCiAD4AJgAHAPAARgAHAMABDAAB+AYHz/xFA3/9TQP/fGwAQIBEAgANiAPgAAAgRAMAAEQGVAL6AA8AAIgMAAQCxAABIIYKBAOARQQPkATEAQARwgZOBCYIhAYABARcGAFaAUAAiQP8PAGBRARgAMgAA0P8AIIBBAAyANUBP4Pf+AQDw/0kCMgAAwOcBIQAAMDWAWIAvgKEAwAAugBEAwAIDAAAAADAAAHQAn4EAgBQEABz/D0EA8AFiABgcBACzBQDAj/8DAGqAQQAA4BIAADwCEBEAjAESADAOCAAhAGAQNwBEjt8/wOAHAO8DEiA4ABEB4AEiAA8A4A9xCQc4QgCDAABAMwDA/zf//wc0AAAHEFCAgf8AMwAAPIAB+OM='.freeze
 
           class << self
             def get_response(query, url, headers)
@@ -35,6 +38,9 @@ module Kentico
               return respond_429 if @query.code_name == '429'
 
               qs = url.contains('?') ? url.split('?')[1] : nil
+
+              return respond_feed if query.query_type.eql? Kentico::Kontent::Delivery::QUERY_TYPE_ITEMS_FEED
+
               return respond_filtering qs unless qs.nil? # e.g. /items/about_us?skip=0&limit=5
 
               respond_generic url # Didn't match other clauses, so response should be located in corresponding filepath
@@ -48,6 +54,26 @@ module Kentico
               )
             end
 
+            def respond_feed
+              if @query.continuation_exists?
+                if @query.continuation_token.include? '#RT:1#'
+                  headers = {Kentico::Kontent::Delivery::DeliveryQuery::HEADER_CONTINUATION => CONTINUATION_HEADER_2}
+                  path = Pathname.new(File.dirname(__FILE__) + '/items_feed/articles_feed_2.json')
+                else
+                  headers = ''
+                  path = Pathname.new(File.dirname(__FILE__) + '/items_feed/articles_feed_3.json')
+                end
+              else
+                headers = {Kentico::Kontent::Delivery::DeliveryQuery::HEADER_CONTINUATION => CONTINUATION_HEADER_1}
+                path = Pathname.new(File.dirname(__FILE__) + '/items_feed/articles_feed_1.json')
+              end
+
+              OpenStruct.new(
+                headers: headers,
+                body: path.read
+              )
+            end
+
             def respond_filtering(query)
               path =
                 case CGI.unescape query

data/lib/delivery/tests/items_feed/articles_feed_1.json

@@ -0,0 +1,39 @@
+{
+	"items": [{
+			"system": {
+				"id": "b2fea94c-73fd-42ec-a22f-f409878de187",
+				"name": "Origins of Arabica Bourbon",
+				"codename": "origins_of_arabica_bourbon",
+				"language": "en-US",
+				"type": "article",
+				"sitemap_locations": [],
+				"last_modified": "2019-03-27T13:21:49.151Z"
+			},
+			"elements": {
+				"title": {
+					"type": "text",
+					"name": "Title",
+					"value": "Origins of Arabica Bourbon"
+				},
+				"summary": {
+					"type": "text",
+					"name": "Summary",
+					"value": "This one particular type of coffee, the Arabica Bourbon, is now sold only in Japan. It has been brought back to life by enthusiasts after being almost forgotten for nearly sixty years."
+				},
+				"personas": {
+					"type": "taxonomy",
+					"name": "Personas",
+					"taxonomy_group": "personas",
+					"value": [{
+							"name": "Barista",
+							"codename": "barista"
+						}, {
+							"name": "Coffee blogger",
+							"codename": "coffee_blogger"
+						}
+					]
+				}
+			}
+		}
+	]
+}

data/lib/delivery/tests/items_feed/articles_feed_2.json

@@ -0,0 +1,78 @@
+{
+	"items": [{
+			"system": {
+				"id": "3120ec15-a4a2-47ec-8ccd-c85ac8ac5ba5",
+				"name": "Which brewing fits you?",
+				"codename": "which_brewing_fits_you_",
+				"language": "en-US",
+				"type": "article",
+				"sitemap_locations": [],
+				"last_modified": "2019-03-27T13:24:54.042Z"
+			},
+			"elements": {
+				"title": {
+					"type": "text",
+					"name": "Title",
+					"value": "Which brewing fits you?"
+				},
+				"summary": {
+					"type": "text",
+					"name": "Summary",
+					"value": "We have put down three procedures with clearly written steps describing the process of making coffee. Read this article to convince yourself that brewing coffee is no science"
+				},
+				"personas": {
+					"type": "taxonomy",
+					"name": "Personas",
+					"taxonomy_group": "personas",
+					"value": [{
+							"name": "Coffee lover",
+							"codename": "coffee_lover"
+						}, {
+							"name": "Coffee blogger",
+							"codename": "coffee_blogger"
+						}, {
+							"name": "Barista",
+							"codename": "barista"
+						}
+					]
+				}
+			}
+		}, {
+			"system": {
+				"id": "f4b3fc05-e988-4dae-9ac1-a94aba566474",
+				"name": "On Roasts",
+				"codename": "on_roasts",
+				"language": "en-US",
+				"type": "article",
+				"sitemap_locations": [],
+				"last_modified": "2019-03-27T13:21:11.38Z"
+			},
+			"elements": {
+				"title": {
+					"type": "text",
+					"name": "Title",
+					"value": "On Roasts"
+				},
+				"summary": {
+					"type": "text",
+					"name": "Summary",
+					"value": "Roasting coffee beans can take from 6 to 13 minutes. Different roasting times produce different types of coffee, with varying concentration of caffeine and intensity of the original flavor."
+				},
+				"personas": {
+					"type": "taxonomy",
+					"name": "Personas",
+					"taxonomy_group": "personas",
+					"value": [{
+							"name": "Barista",
+							"codename": "barista"
+						}, {
+							"name": "Coffee blogger",
+							"codename": "coffee_blogger"
+						}
+					]
+				}
+			}
+		}
+	],
+	"modular_content": {}
+}

data/lib/delivery/tests/items_feed/articles_feed_3.json

@@ -0,0 +1,104 @@
+{
+	"items": [{
+			"system": {
+				"id": "cf106f4e-30a4-42ef-b313-b8ea3fd3e5c5",
+				"name": "Coffee Beverages Explained",
+				"codename": "coffee_beverages_explained",
+				"language": "en-US",
+				"type": "article",
+				"sitemap_locations": [],
+				"last_modified": "2019-03-27T13:12:58.578Z"
+			},
+			"elements": {
+				"title": {
+					"type": "text",
+					"name": "Title",
+					"value": "Coffee Beverages Explained"
+				},
+				"summary": {
+					"type": "text",
+					"name": "Summary",
+					"value": "Espresso and filtered coffee are the two main categories of coffee, based on the method of preparation. Learn about individual types of coffee that fall under these categories."
+				},
+				"personas": {
+					"type": "taxonomy",
+					"name": "Personas",
+					"taxonomy_group": "personas",
+					"value": [{
+							"name": "Coffee lover",
+							"codename": "coffee_lover"
+						}
+					]
+				}
+			}
+		}, {
+			"system": {
+				"id": "117cdfae-52cf-4885-b271-66aef6825612",
+				"name": "Coffee processing techniques",
+				"codename": "coffee_processing_techniques",
+				"language": "en-US",
+				"type": "article",
+				"sitemap_locations": [],
+				"last_modified": "2019-03-27T13:13:35.312Z"
+			},
+			"elements": {
+				"title": {
+					"type": "text",
+					"name": "Title",
+					"value": "Coffee processing techniques"
+				},
+				"summary": {
+					"type": "text",
+					"name": "Summary",
+					"value": "Learn about the techniques of processing the products of coffee plants. Different methods are used in different parts of the world depending mainly on their weather conditions."
+				},
+				"personas": {
+					"type": "taxonomy",
+					"name": "Personas",
+					"taxonomy_group": "personas",
+					"value": [{
+							"name": "Coffee blogger",
+							"codename": "coffee_blogger"
+						}, {
+							"name": "Coffee lover",
+							"codename": "coffee_lover"
+						}
+					]
+				}
+			}
+		}, {
+			"system": {
+				"id": "23f71096-fa89-4f59-a3f9-970e970944ec",
+				"name": "Donate with us",
+				"codename": "donate_with_us",
+				"language": "en-US",
+				"type": "article",
+				"sitemap_locations": [],
+				"last_modified": "2019-03-27T13:14:07.384Z"
+			},
+			"elements": {
+				"title": {
+					"type": "text",
+					"name": "Title",
+					"value": "Donate with us"
+				},
+				"summary": {
+					"type": "text",
+					"name": "Summary",
+					"value": "Dancing Goat regularly donates money to Children in Africa, a foundation helping children with food, accommodation, education, and other essentials. Donate with us and create a better world."
+				},
+				"personas": {
+					"type": "taxonomy",
+					"name": "Personas",
+					"taxonomy_group": "personas",
+					"value": [{
+							"name": "Cafe owner",
+							"codename": "cafe_owner"
+						}
+					]
+				}
+			}
+		}
+	],
+	"modular_content": {}
+}

data/lib/delivery/version.rb

@@ -1,7 +1,7 @@
 module Kentico
   module Kontent
     module Delivery
-      VERSION = '2.0.15'.freeze
+      VERSION = '2.0.16'.freeze
     end
   end
 end

data/lib/kontent-delivery-sdk-ruby.rb

@@ -12,6 +12,7 @@ require File.dirname(__FILE__) + '/delivery/responses/delivery_type_response'
 require File.dirname(__FILE__) + '/delivery/responses/delivery_taxonomy_listing_response'
 require File.dirname(__FILE__) + '/delivery/responses/delivery_taxonomy_response'
 require File.dirname(__FILE__) + '/delivery/responses/delivery_element_response'
+require File.dirname(__FILE__) + '/delivery/responses/delivery_items_feed_response'
 require File.dirname(__FILE__) + '/delivery/resolvers/content_link_resolver'
 require File.dirname(__FILE__) + '/delivery/resolvers/inline_content_item_resolver'
 require File.dirname(__FILE__) + '/delivery/resolvers/linked_item_resolver'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kontent-delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.15
+  version: 2.0.16
 platform: ruby
 authors:
 - Eric Dugre
@@ -112,14 +112,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.18.5
 description: Kentico Kontent Delivery SDK for Ruby
 email:
 - EricD@kentico.com
@@ -149,6 +149,7 @@ files:
 - lib/delivery/responses/delivery_element_response.rb
 - lib/delivery/responses/delivery_item_listing_response.rb
 - lib/delivery/responses/delivery_item_response.rb
+- lib/delivery/responses/delivery_items_feed_response.rb
 - lib/delivery/responses/delivery_taxonomy_listing_response.rb
 - lib/delivery/responses/delivery_taxonomy_response.rb
 - lib/delivery/responses/delivery_type_listing_response.rb
@@ -169,6 +170,9 @@ files:
 - lib/delivery/tests/generic/taxonomies.json
 - lib/delivery/tests/generic/types.json
 - lib/delivery/tests/generic/types/brewer/elements/product_status.json
+- lib/delivery/tests/items_feed/articles_feed_1.json
+- lib/delivery/tests/items_feed/articles_feed_2.json
+- lib/delivery/tests/items_feed/articles_feed_3.json
 - lib/delivery/version.rb
 - lib/kontent-delivery-sdk-ruby.rb
 homepage: https://github.com/Kentico/kontent-delivery-sdk-ruby