kontent-delivery-sdk-ruby 2.0.18 → 2.0.24

data/lib/delivery/query_parameters/parameter_base.rb

@@ -1,46 +1,56 @@
-require 'cgi'
-
-module Kentico
-  module Kontent
-    module Delivery
-      module QueryParameters
-        # Base class for all parameters added to a DeliveryQuery. All
-        # QueryParameters will appear in the query string.
-        class ParameterBase
-          attr_accessor :key
-          SEPARATOR = CGI::escape(',')
-
-          # Constructor.
-          #
-          # * *Args*:
-          #   - *key* (+string+) The field to filter upon
-          #   - *operator* (+string+) The Kentico Kontent filter being applied to the field, in brackets
-          #   - *values* (+Object+) One or more values which will appear as the value of the query string parameter
-          def initialize(key, operator, values)
-            self.key = key
-            values = [values] unless values.respond_to? :each
-            @values = values
-            @operator = operator
-          end
-
-          # Converts the object into a valid query string parameter for use in
-          # a request to Delivery. The key, operator, and values are all escaped
-          # and if there are multiple values, they are joined with commas.
-          #
-          # * *Returns*:
-          #   - +string+ A query string parameter without any additional characters (e.g. '&')
-          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
-  end
-end
+require 'cgi'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module QueryParameters
+        # Base class for all parameters added to a DeliveryQuery. All
+        # QueryParameters will appear in the query string.
+        class ParameterBase
+          attr_accessor :key
+          SEPARATOR = CGI::escape(',')
+
+          # Constructor.
+          #
+          # * *Args*:
+          #   - *key* (+string+) The field to filter upon
+          #   - *operator* (+string+) The Kentico Kontent filter being applied to the field, in brackets
+          #   - *values* (+Object+) One or more values which will appear as the value of the query string parameter
+          #   - *eq_sign* (+boolean+) If false, the equals sign is not generated in the parameter
+          def initialize(key, operator, values, eq_sign = true)
+            self.key = key
+            values = [values] unless values.respond_to? :each
+            @values = values
+            @operator = operator
+            @eq_sign = eq_sign
+          end
+
+          # Converts the object into a valid query string parameter for use in
+          # a request to Delivery. The key, operator, and values are all escaped
+          # and if there are multiple values, they are joined with commas.
+          #
+          # * *Returns*:
+          #   - +string+ A query string parameter without any additional characters (e.g. '&')
+          def provide_query_string_parameter
+            escaped_values = []
+            @values.each { |n| escaped_values << CGI.escape(n.to_s) }
+            if @eq_sign 
+              format(
+                '%<k>s%<o>s=%<v>s',
+                k: CGI.escape(key),
+                o: CGI.escape(@operator),
+                v: escaped_values.join(SEPARATOR)
+              )
+            else
+              format(
+                '%<k>s%<o>s',
+                k: CGI.escape(key),
+                o: CGI.escape(@operator)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/delivery/query_parameters/query_string.rb

@@ -1,78 +1,78 @@
-require 'delivery/query_parameters/parameter_base'
-
-module Kentico
-  module Kontent
-    module Delivery
-      module QueryParameters
-        # Represents the entire query string for a request to Delivery.
-        class QueryString
-          def initialize
-            @params = []
-          end
-
-          # Adds a parameter to the query string
-          #
-          # * *Args*:
-          #   - *param* (+Object+) Either a string representing the key for the parameter, or a complete Kentico::Kontent::Delivery::QueryParameters::ParameterBase object
-          #   - *values* (+string+) A string or array of strings representing the values for the parameter
-          #   - *operator* (+string+) Kentico Kontent filtering parameter, placed after the key, before the equal sign
-          def set_param(param, values = '', operator = '')
-            parameter_base =
-              if param.is_a? String
-                Kentico::Kontent::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
-
-          # Removes all parameters from the query string with a matching key.
-          #
-          # * *Args*:
-          #   - *key* (+string+) Parameter key
-          def remove_param(key)
-            @params.delete_if { |i| i.key.eql? key }
-          end
-
-          # Returns all parameters from the query string with a matching key.
-          #
-          # * *Args*:
-          #   - *key* (+string+) Parameter key
-          #
-          # * *Returns*:
-          #   - +Object+ One or more Kentico::Kontent::Delivery::QueryParameters::ParameterBase objects
-          def param(key)
-            @params.select { |p| p.key.eql? key }
-          end
-
-          # Checks whether there are any parameters defined.
-          #
-          # * *Returns*:
-          #   - +bool+ True if there are no parameters set.
-          def empty?
-            @params.empty?
-          end
-
-          # Generates a full query string based on the set parameters, with the
-          # required '?' character at the start. Accomplished by calling the
-          # Kentico::Kontent::Delivery::QueryParameters::ParameterBase.provide_query_string_parameter
-          # method for each parameter.
-          #
-          # * *Returns*:
-          #   - +string+ A complete query string
-          def to_s
-            '?' + @params.map(&:provide_query_string_parameter).join('&')
-          end
-        end
-      end
-    end
-  end
-end
+require 'delivery/query_parameters/parameter_base'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module QueryParameters
+        # Represents the entire query string for a request to Delivery.
+        class QueryString
+          def initialize
+            @params = []
+          end
+
+          # Adds a parameter to the query string
+          #
+          # * *Args*:
+          #   - *param* (+Object+) Either a string representing the key for the parameter, or a complete Kentico::Kontent::Delivery::QueryParameters::ParameterBase object
+          #   - *values* (+string+) A string or array of strings representing the values for the parameter
+          #   - *operator* (+string+) Kentico Kontent filtering parameter, placed after the key, before the equal sign
+          def set_param(param, values = '', operator = '')
+            parameter_base =
+              if param.is_a? String
+                Kentico::Kontent::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
+
+          # Removes all parameters from the query string with a matching key.
+          #
+          # * *Args*:
+          #   - *key* (+string+) Parameter key
+          def remove_param(key)
+            @params.delete_if { |i| i.key.eql? key }
+          end
+
+          # Returns all parameters from the query string with a matching key.
+          #
+          # * *Args*:
+          #   - *key* (+string+) Parameter key
+          #
+          # * *Returns*:
+          #   - +Object+ One or more Kentico::Kontent::Delivery::QueryParameters::ParameterBase objects
+          def param(key)
+            @params.select { |p| p.key.eql? key }
+          end
+
+          # Checks whether there are any parameters defined.
+          #
+          # * *Returns*:
+          #   - +bool+ True if there are no parameters set.
+          def empty?
+            @params.empty?
+          end
+
+          # Generates a full query string based on the set parameters, with the
+          # required '?' character at the start. Accomplished by calling the
+          # Kentico::Kontent::Delivery::QueryParameters::ParameterBase.provide_query_string_parameter
+          # method for each parameter.
+          #
+          # * *Returns*:
+          #   - +string+ A complete query string
+          def to_s
+            '?' + @params.map(&:provide_query_string_parameter).join('&')
+          end
+        end
+      end
+    end
+  end
+end

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