delivery-sdk-ruby 0.14.13 → 0.15.0

data/lib/delivery/query_parameters/parameter_base.rb

@@ -1,30 +1,30 @@
-module Delivery
-  # Contains static methods for adding parameters to a DeliveryQuery
-  # as well as the Filter class.
-  module QueryParameters
-    # Base class for all parameters added to a DeliveryQuery using the
-    # .parameters method. All parameters appear in the query string.
-    class ParameterBase
-      attr_accessor :key
-      SEPARATOR = CGI.escape(',')
-
-      def initialize(key, operator, values)
-        self.key = key
-        values = [values] unless values.respond_to? :each
-        @values = values
-        @operator = operator
-      end
-
-      def provide_query_string_parameter
-        escaped_values = []
-        @values.each { |n| escaped_values << CGI.escape(n.to_s) }
-        format(
-          '%<k>s%<o>s=%<v>s',
-          k: CGI.escape(key),
-          o: CGI.escape(@operator),
-          v: escaped_values.join(SEPARATOR)
-        )
-      end
-    end
-  end
-end
+module Delivery
+  # Contains static methods for adding parameters to a DeliveryQuery
+  # as well as the Filter class.
+  module QueryParameters
+    # Base class for all parameters added to a DeliveryQuery using the
+    # .parameters method. All parameters appear in the query string.
+    class ParameterBase
+      attr_accessor :key
+      SEPARATOR = CGI.escape(',')
+
+      def initialize(key, operator, values)
+        self.key = key
+        values = [values] unless values.respond_to? :each
+        @values = values
+        @operator = operator
+      end
+
+      def provide_query_string_parameter
+        escaped_values = []
+        @values.each { |n| escaped_values << CGI.escape(n.to_s) }
+        format(
+          '%<k>s%<o>s=%<v>s',
+          k: CGI.escape(key),
+          o: CGI.escape(@operator),
+          v: escaped_values.join(SEPARATOR)
+        )
+      end
+    end
+  end
+end

data/lib/delivery/query_parameters/query_string.rb

@@ -1,49 +1,49 @@
-require 'delivery/query_parameters/parameter_base'
-
-module Delivery
-  module QueryParameters
-    class QueryString
-      def initialize
-        @params = []
-      end
-
-      # Adds a parameter to the query string
-      # @param [String] param Either a string representing the key for the parameter, or a complete ParameterBase object
-      # @param [String] values A string or array of strings representing the values for the parameter
-      # @param [String] operator Kentico Cloud filtering parameter, placed after the key, before the equal sign
-      def set_param(param, values = '', operator = '')
-        parameter_base =
-          if param.is_a? String
-            Delivery::QueryParameters::ParameterBase.new(
-              param,
-              operator,
-              values
-            )
-          else
-            param
-          end
-        # Ensure we have a ParameterBase object
-        return unless parameter_base.respond_to? 'provide_query_string_parameter'
-
-        remove_param parameter_base.key
-        @params << parameter_base
-      end
-
-      def remove_param(key)
-        @params.delete_if { |i| i.key.eql? key }
-      end
-
-      def param(key)
-        @params.select { |p| p.key.eql? key }
-      end
-
-      def empty?
-        @params.empty?
-      end
-
-      def to_s
-        '?' + @params.map(&:provide_query_string_parameter).join('&')
-      end
-    end
-  end
-end
+require 'delivery/query_parameters/parameter_base'
+
+module Delivery
+  module QueryParameters
+    class QueryString
+      def initialize
+        @params = []
+      end
+
+      # Adds a parameter to the query string
+      # @param [String] param Either a string representing the key for the parameter, or a complete ParameterBase object
+      # @param [String] values A string or array of strings representing the values for the parameter
+      # @param [String] operator Kentico Cloud filtering parameter, placed after the key, before the equal sign
+      def set_param(param, values = '', operator = '')
+        parameter_base =
+          if param.is_a? String
+            Delivery::QueryParameters::ParameterBase.new(
+              param,
+              operator,
+              values
+            )
+          else
+            param
+          end
+        # Ensure we have a ParameterBase object
+        return unless parameter_base.respond_to? 'provide_query_string_parameter'
+
+        remove_param parameter_base.key
+        @params << parameter_base
+      end
+
+      def remove_param(key)
+        @params.delete_if { |i| i.key.eql? key }
+      end
+
+      def param(key)
+        @params.select { |p| p.key.eql? key }
+      end
+
+      def empty?
+        @params.empty?
+      end
+
+      def to_s
+        '?' + @params.map(&:provide_query_string_parameter).join('&')
+      end
+    end
+  end
+end

data/lib/delivery/resolvers/content_link_resolver.rb

@@ -1,62 +1,62 @@
-require 'nokogiri'
-
-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
-    class ContentLinkResolver
-      def initialize(callback = nil)
-        @callback = callback
-      end
-
-      # Resolves all links in the content
-      # @param [String] content The string value stored in the element
-      # @param [Array] links The collection of source links from the JSON response
-      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.inner_html
-      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
-      def resolve_tag(tag, links)
-        matches = links.select { |link| link.id == tag['data-item-id'].to_s }
-        url = provide_url matches
-        tag['href'] = url
-        tag
-      end
-
-      # Returns a url if a link was found in source links, otherwise returns 404
-      def provide_url(matches)
-        if !matches.empty?
-          if @callback.nil?
-            resolve_link matches[0]
-          else
-            @callback.call matches[0]
-          end
-        else
-          '/404'
-        end
-      end
-    end
-
-    # Model for links from the JSON response
-    class ContentLink
-      attr_accessor :code_name, :type, :url_slug, :id
-
-      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
+require 'nokogiri'
+
+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
+    class ContentLinkResolver
+      def initialize(callback = nil)
+        @callback = callback
+      end
+
+      # Resolves all links in the content
+      # @param [String] content The string value stored in the element
+      # @param [Array] links The collection of source links from the JSON response
+      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.inner_html
+      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
+      def resolve_tag(tag, links)
+        matches = links.select { |link| link.id == tag['data-item-id'].to_s }
+        url = provide_url matches
+        tag['href'] = url
+        tag
+      end
+
+      # Returns a url if a link was found in source links, otherwise returns 404
+      def provide_url(matches)
+        if !matches.empty?
+          if @callback.nil?
+            resolve_link matches[0]
+          else
+            @callback.call matches[0]
+          end
+        else
+          '/404'
+        end
+      end
+    end
+
+    # Model for links from the JSON response
+    class ContentLink
+      attr_accessor :code_name, :type, :url_slug, :id
+
+      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

data/lib/delivery/resolvers/inline_content_item_resolver.rb

@@ -1,50 +1,50 @@
-require 'nokogiri'
-
-module Delivery
-  module Resolvers
-    # Locates <object data-type="item"> tags in content and calls a user-defined method
-    # to supply the HTML output for the content item
-    class InlineContentItemResolver
-      def initialize(callback = nil)
-        @callback = callback
-      end
-
-      # Resolves all inline content items in the content
-      # @param [String] content The string value stored in the element
-      # @param [Array] inline_items ContentItems referenced by the content
-      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.
-      def resolve_tag(tag, inline_items)
-        matches = inline_items.select { |item| item.system.codename == tag['data-codename'].to_s }
-        provide_output matches
-      end
-
-      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
+require 'nokogiri'
+
+module Delivery
+  module Resolvers
+    # Locates <object data-type="item"> tags in content and calls a user-defined method
+    # to supply the HTML output for the content item
+    class InlineContentItemResolver
+      def initialize(callback = nil)
+        @callback = callback
+      end
+
+      # Resolves all inline content items in the content
+      # @param [String] content The string value stored in the element
+      # @param [Array] inline_items ContentItems referenced by the content
+      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.
+      def resolve_tag(tag, inline_items)
+        matches = inline_items.select { |item| item.system.codename == tag['data-codename'].to_s }
+        provide_output matches
+      end
+
+      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

data/lib/delivery/resolvers/linked_item_resolver.rb

@@ -1,28 +1,28 @@
-module Delivery
-  # 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 Content Item
-    # @param [String] codename Codename of the content item
-    # @return [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
+module Delivery
+  # 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 Content Item
+    # @param [String] codename Codename of the content item
+    # @return [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

data/lib/delivery/responses/delivery_element_response.rb

@@ -1,23 +1,23 @@
-require 'delivery/responses/response_base'
-
-module Delivery
-  module Responses
-    # Returned by DeliveryClient.element containing a single element
-    class DeliveryElementResponse < ResponseBase
-      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
+require 'delivery/responses/response_base'
+
+module Delivery
+  module Responses
+    # Returned by DeliveryClient.element containing a single element
+    class DeliveryElementResponse < ResponseBase
+      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