kontent-delivery-sdk-ruby 2.0.6

data/lib/delivery/resolvers/inline_content_item_resolver.rb

@@ -0,0 +1,75 @@
+require 'nokogiri'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module Resolvers
+        # Locates <object data-type="item"> tags in content and calls a user-defined
+        # method to supply the output for the content item.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#resolving-inline-content
+        class InlineContentItemResolver
+          def initialize(callback = nil)
+            @callback = callback
+          end
+
+          # Resolves all inline content items in the content.
+          #
+          # * *Args*:
+          #   - *content* (+string+) The string value stored in the element
+          #   - *inline_items* (+Array+) ContentItems referenced by the content from the 'modular_content' JSON node
+          #
+          # * *Returns*:
+          #   - +string+ The original content passed, with all <object data-type="item"> replaced with custom output
+          def resolve(content, inline_items)
+            doc = Nokogiri::HTML.parse(content).xpath('//body')
+            tags = doc.xpath('//object[@type="application/kenticocloud"][@data-type="item"]')
+            tags.each do |tag|
+              output = resolve_tag tag, inline_items
+              el = doc.at_xpath(
+                '//object[@type="application/kenticocloud"][@data-type="item"][@data-codename=$value]',
+                nil,
+                value: tag['data-codename']
+              )
+              el.swap(output) unless output.nil?
+            end
+            doc.inner_html
+          end
+
+          private
+
+          # Accepts a tag found in the content and tries to locate matching
+          # ContentItem from JSON response.
+          #
+          # * *Args*:
+          #   - *tag* (+string+) A <object data-type="item"> tag found in the content
+          #   - *inline_items* (+Array+) ContentItems referenced by the content from the 'modular_content' JSON node
+          #
+          # * *Returns*:
+          #   - +string+ The custom output generated by the +provide_output+ method
+          def resolve_tag(tag, inline_items)
+            matches = inline_items.select { |item| item.system.codename == tag['data-codename'].to_s }
+            provide_output matches
+          end
+
+          # Generates custom output for a content item using the +resolve_item+
+          # method.
+          #
+          # * *Args*:
+          #   - *matches* (+Array+) The ContentItems from the 'modular_content' JSON node which match the code name of a particular <object data-type="item"> tag
+          #
+          # * *Returns*:
+          #   - +string+ The custom output generated by the +resolve_item+ method
+          def provide_output(matches)
+            if !matches.empty?
+              if @callback.nil?
+                resolve_item matches[0]
+              else
+                @callback.call matches[0]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/resolvers/linked_item_resolver.rb

@@ -0,0 +1,37 @@
+module Kentico
+  module Kontent
+    module Delivery
+      module Resolvers
+        # Resolves a content item by its codename. It contains the modular content
+        # of item/items response.
+        class LinkedItemResolver
+          def initialize(modular_content, content_link_url_resolver, inline_content_item_resolver)
+            @modular_content = modular_content
+            @content_link_url_resolver = content_link_url_resolver
+            @inline_content_item_resolver = inline_content_item_resolver
+            @resolved_items = {}
+          end
+
+          # Resolves a content item. If the link for a codename was resolved
+          # before, it returns the same instance of ContentItem.
+          #
+          # * *Args*:
+          #   - *codename* (+string+) Codename of the content item
+          #
+          # * *Return*:
+          #   - Kentico::Kontent::Delivery::ContentItem
+          def resolve(codename)
+            @resolved_items[codename] ||= resolve_item(codename)
+          end
+
+          private
+
+          def resolve_item(codename)
+            item = @modular_content.values.find { |i| i['system']['codename'] == codename }
+            ContentItem.new JSON.parse(JSON.generate(item)), @content_link_url_resolver, @inline_content_item_resolver, self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_element_response.rb

@@ -0,0 +1,33 @@
+require 'delivery/responses/response_base'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module Responses
+        # The response of a successful query of a content type's element
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#retrieving-content-type-elements
+        class DeliveryElementResponse < ResponseBase
+          # An element's definition from a
+          # Kentico::Kontent::Delivery::DeliveryClient.element call
+          #
+          # * *Returns*:
+          #   - +OpenStruct+ The element of a content item
+          def element
+            @element unless @element.nil?
+            @element = JSON.parse(
+              JSON.generate(@response),
+              object_class: OpenStruct
+            )
+          end
+
+          def initialize(response)
+            @response = response
+            super 200,
+              "Success, '#{element.codename}' returned",
+              JSON.generate(@response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_item_listing_response.rb

@@ -0,0 +1,53 @@
+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.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#listing-items
+        class DeliveryItemListingResponse < ResponseBase
+          # Parses the 'pagination' JSON node of the response.
+          #
+          # * *Returns*:
+          #   - Kentico::Kontent::Delivery::Pagination
+          def pagination
+            @pagination unless @pagination.nil?
+            @pagination = Pagination.new @response['pagination']
+          end
+
+          # A collection of Kentico::Kontent::Delivery::ContentItem objects from
+          # a Kentico::Kontent::Delivery::DeliveryClient.items 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(response, content_link_url_resolver, inline_content_item_resolver)
+            @response = response
+            @content_link_url_resolver = content_link_url_resolver
+            @inline_content_item_resolver = inline_content_item_resolver
+            super 200,
+              "Success, #{items.length} items returned",
+              JSON.generate(@response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_item_response.rb

@@ -0,0 +1,39 @@
+require 'delivery/models/content_item'
+require 'delivery/responses/response_base'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module Responses
+        # The response of a successful query for a content item.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#listing-items
+        class DeliveryItemResponse < ResponseBase
+          # A Kentico::Kontent::Delivery::ContentItem object from a
+          # Kentico::Kontent::Delivery::DeliveryClient.item call.
+          #
+          # * *Returns*:
+          #   - Kentico::Kontent::Delivery::ContentItem
+          def item
+            @item unless @item.nil?
+            linked_items_resolver = Kentico::Kontent::Delivery::Resolvers::LinkedItemResolver.new @response['modular_content'], @content_link_url_resolver, @inline_content_item_resolver
+            @item = Kentico::Kontent::Delivery::ContentItem.new(
+              @response,
+              @content_link_url_resolver,
+              @inline_content_item_resolver,
+              linked_items_resolver
+            )
+          end
+
+          def initialize(response, content_link_url_resolver, inline_content_item_resolver)
+            @response = response
+            @content_link_url_resolver = content_link_url_resolver
+            @inline_content_item_resolver = inline_content_item_resolver
+            super 200,
+              "Success, '#{item.system.codename}' returned",
+              JSON.generate(@response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_taxonomy_listing_response.rb

@@ -0,0 +1,46 @@
+require 'delivery/models/taxonomy_group'
+require 'delivery/models/pagination'
+require 'delivery/responses/response_base'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module Responses
+        # The response of a successful query for taxonomy groups.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#taxonomy
+        class DeliveryTaxonomyListingResponse < ResponseBase
+          # Parses the 'pagination' JSON node of the response.
+          #
+          # * *Returns*:
+          #   - Kentico::Kontent::Delivery::Pagination
+          def pagination
+            @pagination unless @pagination.nil?
+            @pagination = Pagination.new @response['pagination']
+          end
+
+          # Parses the 'taxonomies' JSON node of the response from a
+          # Kentico::Kontent::Delivery::DeliveryClient.taxonomies call.
+          #
+          # * *Returns*:
+          #   - +Array+ The taxonomy groups as Kentico::Kontent::Delivery::TaxonomyGroup objects
+          def taxonomies
+            @taxonomies unless @taxonomies.nil?
+            taxonomies = []
+            @response['taxonomies'].each do |n|
+              taxonomies << Kentico::Kontent::Delivery::TaxonomyGroup.new(n)
+            end
+            @taxonomies = taxonomies
+          end
+
+          def initialize(response)
+            @response = response
+
+            super 200,
+                  "Success, #{taxonomies.length} taxonomies returned",
+                  JSON.generate(@response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_taxonomy_response.rb

@@ -0,0 +1,32 @@
+require 'delivery/models/taxonomy_group'
+require 'delivery/responses/response_base'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module Responses
+        # The response of a successful query for a taxonomy group.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#taxonomy
+        class DeliveryTaxonomyResponse < ResponseBase
+          # Parses the response from a
+          # Kentico::Kontent::Delivery::DeliveryClient.taxonomy call.
+          #
+          # * *Returns*:
+          #   - Kentico::Kontent::Delivery::TaxonomyGroup
+          def taxonomy
+            @taxonomy unless @taxonomy.nil?
+            @taxonomy = Kentico::Kontent::Delivery::TaxonomyGroup.new(@response)
+          end
+
+          def initialize(response)
+            @response = response
+
+            super 200,
+                  "Success, '#{taxonomy.system.codename}' returned",
+                  JSON.generate(@response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_type_listing_response.rb

@@ -0,0 +1,45 @@
+require 'delivery/models/content_type'
+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 types.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#retrieving-content-types
+        class DeliveryTypeListingResponse < ResponseBase
+          # Parses the 'pagination' JSON node of the response.
+          #
+          # * *Returns*:
+          #   - Kentico::Kontent::Delivery::Pagination
+          def pagination
+            @pagination unless @pagination.nil?
+            @pagination = Pagination.new @response['pagination']
+          end
+
+          # Parses the 'types' JSON node of the response from a
+          # Kentico::Kontent::Delivery::DeliveryClient.types call.
+          #
+          # * *Returns*:
+          #   - +Array+ The content types as Kentico::Kontent::Delivery::ContentType objects
+          def types
+            @types unless @types.nil?
+            types = []
+            @response['types'].each do |n|
+              types << Kentico::Kontent::Delivery::ContentType.new(n)
+            end
+            @types = types
+          end
+
+          def initialize(response)
+            @response = response
+            super 200,
+                  "Success, #{types.length} types returned",
+                  JSON.generate(@response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_type_response.rb

@@ -0,0 +1,31 @@
+require 'delivery/models/content_type'
+require 'delivery/responses/response_base'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module Responses
+        # The response of a successful query for a content type.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#retrieving-content-types
+        class DeliveryTypeResponse < ResponseBase
+          # A Kentico::Kontent::Delivery::ContentType object from a
+          # Kentico::Kontent::Delivery::DeliveryClient.type call.
+          #
+          # * *Returns*:
+          #   - Kentico::Kontent::Delivery::ContentType
+          def type
+            @type unless @type.nil?
+            @type = Kentico::Kontent::Delivery::ContentType.new(@response)
+          end
+
+          def initialize(response)
+            @response = response
+            super 200,
+                  "Success, type '#{type.system.codename}' returned",
+                  JSON.generate(@response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/responses/response_base.rb

@@ -0,0 +1,36 @@
+module Kentico
+  module Kontent
+    module Delivery
+      module Responses
+        # Base class for all responses from a
+        # Kentico::Kontent::Delivery::DeliveryQuery.execute call.
+        class ResponseBase
+          attr_accessor :http_code,
+                        :message,
+                        :json
+
+          # Constructor.
+          #
+          # * *Args*:
+          #   - *http_code* (+integer+) The status code returned by the REST request
+          #   - *message* (+string+) An informative message about the response, visible when calling +to_s+
+          #   - *json* (+string+) _optional_ The complete, unmodified JSON response from the server
+          def initialize(http_code, message, json = '')
+            self.http_code = http_code
+            self.message = message
+            self.json = json
+          end
+
+          # Provides an informative message about the success of the request
+          # by combining the status code and message.
+          #
+          # * *Returns*:
+          #   - +string+
+          def to_s
+            "Response is status code #{http_code} with message:\n#{message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/tests/401.json

@@ -0,0 +1,6 @@
+{
+    "message": "Missing or invalid access token. Please include the valid access token value in the Authorization header field as an HTTP bearer authorization scheme.",
+    "request_id": "|89bb1503b14c254a91bd57c135329822.d31c99c5_",
+    "error_code": 3,
+    "specific_code": 0
+}