kontent-delivery-sdk-ruby 2.0.6 → 2.0.7

data/lib/delivery/models/taxonomy_group.rb

@@ -1,39 +1,39 @@
-module Kentico
-  module Kontent
-    module Delivery
-      class TaxonomyGroup
-        # Parses the 'terms' JSON node as a dynamic OpenStruct object.
-        #
-        # * *Returns*:
-        #   - +OpenStruct+ The terms of the taxonomy group as a dynamic object
-        def terms
-          @terms unless @terms.nil?
-          @terms = JSON.parse(
-            JSON.generate(@source['terms']),
-            object_class: OpenStruct
-          )
-        end
-
-        # Parses the 'system' JSON node as a dynamic OpenStruct object.
-        #
-        # * *Returns*:
-        #   - +OpenStruct+ The system properties of the taxonomy group
-        def system
-          @system unless @system.nil?
-          @system = JSON.parse(
-            JSON.generate(@source['system']),
-            object_class: OpenStruct
-          )
-        end
-
-        # Constructor.
-        #
-        # * *Args*:
-        #   - *json* (+JSON+) A JSON node representing a taxonomy group
-        def initialize(source)
-          @source = source
-        end
-      end
-    end
-  end
-end
+module Kentico
+  module Kontent
+    module Delivery
+      class TaxonomyGroup
+        # Parses the 'terms' JSON node as a dynamic OpenStruct object.
+        #
+        # * *Returns*:
+        #   - +OpenStruct+ The terms of the taxonomy group as a dynamic object
+        def terms
+          @terms unless @terms.nil?
+          @terms = JSON.parse(
+            JSON.generate(@source['terms']),
+            object_class: OpenStruct
+          )
+        end
+
+        # Parses the 'system' JSON node as a dynamic OpenStruct object.
+        #
+        # * *Returns*:
+        #   - +OpenStruct+ The system properties of the taxonomy group
+        def system
+          @system unless @system.nil?
+          @system = JSON.parse(
+            JSON.generate(@source['system']),
+            object_class: OpenStruct
+          )
+        end
+
+        # Constructor.
+        #
+        # * *Args*:
+        #   - *json* (+JSON+) A JSON node representing a taxonomy group
+        def initialize(source)
+          @source = source
+        end
+      end
+    end
+  end
+end

data/lib/delivery/query_parameters/filters.rb

@@ -1,158 +1,158 @@
-require 'delivery/query_parameters/parameter_base'
-
-module Kentico
-  module Kontent
-    module Delivery
-      module QueryParameters
-        # Provides the base class for filter implementations.
-        # See https://developer.kenticocloud.com/v1/reference#content-filtering
-        class Filter < ParameterBase
-          # 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)
-            super(key, operator, values)
-          end
-        end
-      end
-    end
-  end
-end
-
-# Extend String class to allow semantic typing of filters
-class String
-  # Represents a filter that matches a content item if the specified content
-  # element or system attribute has a value that contains all the specified
-  # values. This filter is applicable to array values only, such as sitemap
-  # location or value of Linked Items, Taxonomy and Multiple choice content elements.
-  #
-  # * *Args*:
-  #   - +Object+ One or more objects representing the values that must appear in the field
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def all(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[all]', *args)
-  end
-
-  # Represents a filter that matches a content item if the specified content
-  # element or system attribute has a value that contains any the specified
-  # values. This filter is applicable to array values only, such as sitemap
-  # location or value of Linked Items, Taxonomy and Multiple choice content elements.
-  #
-  # * *Args*:
-  #   - +Object+ One or more objects representing the values that may appear in the field
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def any(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[any]', *args)
-  end
-
-  # Represents a filter that matches a content item if the specified content element
-  # or system attribute has a value that contains the specified value.
-  # This filter is applicable to array values only, such as sitemap location or value
-  # of Linked Items, Taxonomy and Multiple choice content elements.
-  #
-  # * *Args*:
-  #   - +Object+ An object representing the value that must appear in the field
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def contains(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[contains]', *args)
-  end
-
-  # Represents a filter that matches a content item if the specified
-  # content element or system attribute has the specified value.
-  #
-  # * *Args*:
-  #   - +Object+ An object representing the value that must equal the value in the field
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def eq(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '', *args)
-  end
-
-  # Represents a filter that matches a content item if the specified content
-  # element or system attribute has a value that is greater than the
-  # specified value.
-  #
-  # * *Args*:
-  #   - +Object+ An object representing the lowest possible value of the field, non-inclusive
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def gt(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[gt]', *args)
-  end
-
-  # Represents a filter that matches a content item if the specified content
-  # element or system attribute has a value that is greater than or equal to
-  # the specified value.
-  #
-  # * *Args*:
-  #   - +Object+ An object representing the lowest possible value of the field
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def gt_or_eq(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[gte]', *args)
-  end
-
-  # Represents a filter that matches a content item if the specified
-  # content element or system attribute has a value that matches a
-  # value in the specified list.
-  #
-  # * *Args*:
-  #   - +Object+ One or more objects representing the required values of the field
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def in(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[in]', *args)
-  end
-
-  # Represents a filter that matches a content item if the specified content
-  # element or system attribute has a value that is less than the
-  # specified value.
-  #
-  # * *Args*:
-  #   - +Object+ An object representing the highest possible value of the field, non-inclusive
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def lt(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[lt]', *args)
-  end
-
-  # Represents a filter that matches a content item if the specified content
-  # element or system attribute has a value that is less than or equal to
-  # the specified value.
-  #
-  # * *Args*:
-  #   - +Object+ An object representing the highest possible value of the field
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def lt_or_eq(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[lte]', *args)
-  end
-
-  # Represents a filter that matches a content item if the specified
-  # content element or system attribute has a value that falls within
-  # the specified range of values (both inclusive).
-  #
-  # * *Args*:
-  #   - +Object+ An object representing the lowest and highest possible values of the field
-  #
-  # * *Returns*:
-  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
-  def range(*args)
-    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[range]', *args)
-  end
-end
+require 'delivery/query_parameters/parameter_base'
+
+module Kentico
+  module Kontent
+    module Delivery
+      module QueryParameters
+        # Provides the base class for filter implementations.
+        # See https://developer.kenticocloud.com/v1/reference#content-filtering
+        class Filter < ParameterBase
+          # 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)
+            super(key, operator, values)
+          end
+        end
+      end
+    end
+  end
+end
+
+# Extend String class to allow semantic typing of filters
+class String
+  # Represents a filter that matches a content item if the specified content
+  # element or system attribute has a value that contains all the specified
+  # values. This filter is applicable to array values only, such as sitemap
+  # location or value of Linked Items, Taxonomy and Multiple choice content elements.
+  #
+  # * *Args*:
+  #   - +Object+ One or more objects representing the values that must appear in the field
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def all(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[all]', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified content
+  # element or system attribute has a value that contains any the specified
+  # values. This filter is applicable to array values only, such as sitemap
+  # location or value of Linked Items, Taxonomy and Multiple choice content elements.
+  #
+  # * *Args*:
+  #   - +Object+ One or more objects representing the values that may appear in the field
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def any(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[any]', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified content element
+  # or system attribute has a value that contains the specified value.
+  # This filter is applicable to array values only, such as sitemap location or value
+  # of Linked Items, Taxonomy and Multiple choice content elements.
+  #
+  # * *Args*:
+  #   - +Object+ An object representing the value that must appear in the field
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def contains(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[contains]', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified
+  # content element or system attribute has the specified value.
+  #
+  # * *Args*:
+  #   - +Object+ An object representing the value that must equal the value in the field
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def eq(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified content
+  # element or system attribute has a value that is greater than the
+  # specified value.
+  #
+  # * *Args*:
+  #   - +Object+ An object representing the lowest possible value of the field, non-inclusive
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def gt(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[gt]', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified content
+  # element or system attribute has a value that is greater than or equal to
+  # the specified value.
+  #
+  # * *Args*:
+  #   - +Object+ An object representing the lowest possible value of the field
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def gt_or_eq(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[gte]', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified
+  # content element or system attribute has a value that matches a
+  # value in the specified list.
+  #
+  # * *Args*:
+  #   - +Object+ One or more objects representing the required values of the field
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def in(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[in]', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified content
+  # element or system attribute has a value that is less than the
+  # specified value.
+  #
+  # * *Args*:
+  #   - +Object+ An object representing the highest possible value of the field, non-inclusive
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def lt(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[lt]', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified content
+  # element or system attribute has a value that is less than or equal to
+  # the specified value.
+  #
+  # * *Args*:
+  #   - +Object+ An object representing the highest possible value of the field
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def lt_or_eq(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[lte]', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified
+  # content element or system attribute has a value that falls within
+  # the specified range of values (both inclusive).
+  #
+  # * *Args*:
+  #   - +Object+ An object representing the lowest and highest possible values of the field
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def range(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[range]', *args)
+  end
+end

data/lib/delivery/query_parameters/parameter_base.rb

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

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