kontent-delivery-sdk-ruby 2.0.6 → 2.0.7

data/lib/delivery/resolvers/content_link_resolver.rb

@@ -1,102 +1,102 @@
-require 'nokogiri'
-
-module Kentico
-  module Kontent
-    module Delivery
-      module Resolvers
-        # Locates <a data-item-id=""> tags in content and calls a user-defined method
-        # to supply the href for content item links.
-        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#resolving-links
-        class ContentLinkResolver
-          # Constructor.
-          #
-          # * *Args*:
-          #   - *found_handler* (+lambda+) _optional_ Method to be called when resolving a content link and the content item is present in the response
-          #   - *not_found_handler* (+lambda+) _optional_ Method to be called when resolving a content link and the content item isn't present in the response
-          def initialize(found_handler = nil, not_found_handler = nil)
-            @found_handler = found_handler
-            @not_found = not_found_handler
-          end
-
-          # Resolves all links in the content.
-          #
-          # * *Args*:
-          #   - *content* (+string+) The string value stored in the element
-          #   - *links* (+Array+) The collection of links from an element's 'links' JSON node
-          #
-          # * *Returns*:
-          #   - +string+ The original content passed, with all links resolved
-          def resolve(content, links)
-            doc = Nokogiri::HTML.parse(content).xpath('//body')
-            links = links.map { |link| ContentLink.new link }
-            tags = doc.xpath('//a[@data-item-id]')
-            # This line performs the link resolving and replaces the tags in doc
-            tags.map { |tag| resolve_tag tag, links }
-            doc.to_xhtml
-          end
-
-          private
-
-          # Accepts a tag found in the content and tries to locate matching
-          # source link from JSON response. If found, resolves URL and returns
-          # the tag with generated HREF.
-          #
-          # * *Args*:
-          #   - *tag* (+string+) A <a data-item-id=""> tag found in the content
-          #   - *links* (+Array+) The collection of links from an element's 'links' JSON node, converted to Kentico::Kontent::Delivery::Resolvers::ContentLink objects
-          #
-          # * *Returns*:
-          #   - +string+ The <a data-item-id=""> tag with an HREF generated by the +provide_url+ method
-          def resolve_tag(tag, links)
-            matches = links.select { |link| link.id == tag['data-item-id'].to_s }
-            url = provide_url matches, tag['data-item-id']
-            tag['href'] = url
-            tag
-          end
-
-          # Uses the +resolve_link+ method to generate a URL for a ContentLink
-          # object, or +resolve_404+ if the content item was not present in the
-          # response.
-          #
-          # * *Args*:
-          #   - *matches* (+Array+) The ContentLink objects with an ID matching a particular <a data-item-id=""> tag
-          #   - *id* (+string+) The ID of the <a data-item-id=""> tag being resolved
-          #
-          # * *Returns*:
-          #   - +string+ A url to the item or 404 page
-          def provide_url(matches, id)
-            if matches.empty?
-              if @not_found_handler.nil?
-                resolve_404 id
-              else
-                @not_found_handler.call id
-              end
-            else
-              if @found_handler.nil?
-                resolve_link matches[0]
-              else
-                @found_handler.call matches[0]
-              end
-            end
-          end
-        end
-
-        # Model for links from the JSON response
-        class ContentLink
-          attr_accessor :code_name, :type, :url_slug, :id
-
-          # Constructor.
-          #
-          # * *Args*:
-          #   - *link* (+JSON+) One link from an element's 'links' JSON node
-          def initialize(link)
-            self.id = link[0]
-            self.code_name = link[1]['codename']
-            self.type = link[1]['type']
-            self.url_slug = link[1]['url_slug']
-          end
-        end
-      end
-    end
-  end
-end
+require 'nokogiri'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module Resolvers
+        # Locates <a data-item-id=""> tags in content and calls a user-defined method
+        # to supply the href for content item links.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#resolving-links
+        class ContentLinkResolver
+          # Constructor.
+          #
+          # * *Args*:
+          #   - *found_handler* (+lambda+) _optional_ Method to be called when resolving a content link and the content item is present in the response
+          #   - *not_found_handler* (+lambda+) _optional_ Method to be called when resolving a content link and the content item isn't present in the response
+          def initialize(found_handler = nil, not_found_handler = nil)
+            @found_handler = found_handler
+            @not_found = not_found_handler
+          end
+
+          # Resolves all links in the content.
+          #
+          # * *Args*:
+          #   - *content* (+string+) The string value stored in the element
+          #   - *links* (+Array+) The collection of links from an element's 'links' JSON node
+          #
+          # * *Returns*:
+          #   - +string+ The original content passed, with all links resolved
+          def resolve(content, links)
+            doc = Nokogiri::HTML.parse(content).xpath('//body')
+            links = links.map { |link| ContentLink.new link }
+            tags = doc.xpath('//a[@data-item-id]')
+            # This line performs the link resolving and replaces the tags in doc
+            tags.map { |tag| resolve_tag tag, links }
+            doc.to_xhtml
+          end
+
+          private
+
+          # Accepts a tag found in the content and tries to locate matching
+          # source link from JSON response. If found, resolves URL and returns
+          # the tag with generated HREF.
+          #
+          # * *Args*:
+          #   - *tag* (+string+) A <a data-item-id=""> tag found in the content
+          #   - *links* (+Array+) The collection of links from an element's 'links' JSON node, converted to Kentico::Kontent::Delivery::Resolvers::ContentLink objects
+          #
+          # * *Returns*:
+          #   - +string+ The <a data-item-id=""> tag with an HREF generated by the +provide_url+ method
+          def resolve_tag(tag, links)
+            matches = links.select { |link| link.id == tag['data-item-id'].to_s }
+            url = provide_url matches, tag['data-item-id']
+            tag['href'] = url
+            tag
+          end
+
+          # Uses the +resolve_link+ method to generate a URL for a ContentLink
+          # object, or +resolve_404+ if the content item was not present in the
+          # response.
+          #
+          # * *Args*:
+          #   - *matches* (+Array+) The ContentLink objects with an ID matching a particular <a data-item-id=""> tag
+          #   - *id* (+string+) The ID of the <a data-item-id=""> tag being resolved
+          #
+          # * *Returns*:
+          #   - +string+ A url to the item or 404 page
+          def provide_url(matches, id)
+            if matches.empty?
+              if @not_found_handler.nil?
+                resolve_404 id
+              else
+                @not_found_handler.call id
+              end
+            else
+              if @found_handler.nil?
+                resolve_link matches[0]
+              else
+                @found_handler.call matches[0]
+              end
+            end
+          end
+        end
+
+        # Model for links from the JSON response
+        class ContentLink
+          attr_accessor :code_name, :type, :url_slug, :id
+
+          # Constructor.
+          #
+          # * *Args*:
+          #   - *link* (+JSON+) One link from an element's 'links' JSON node
+          def initialize(link)
+            self.id = link[0]
+            self.code_name = link[1]['codename']
+            self.type = link[1]['type']
+            self.url_slug = link[1]['url_slug']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/resolvers/inline_content_item_resolver.rb

@@ -1,75 +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
+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

@@ -1,37 +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
+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

@@ -1,33 +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
+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

@@ -1,53 +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
+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