kontent-delivery-sdk-ruby 2.0.19 → 2.0.20

data/lib/delivery/models/content_type.rb

@@ -1,41 +1,41 @@
-require 'ostruct'
-
-module Kentico
-  module Kontent
-    module Delivery
-      class ContentType
-        # Parses the 'elements' JSON object as a dynamic OpenStruct object.
-        #
-        # * *Returns*:
-        #   - +OpenStruct+ The elements of the content type
-        def elements
-          @elements unless @elements.nil?
-          @elements = JSON.parse(
-            JSON.generate(@source['elements']),
-            object_class: OpenStruct
-          )
-        end
-
-        # Parses the 'system' JSON object as a dynamic OpenStruct object.
-        #
-        # * *Returns*:
-        #   - +OpenStruct+ The system properties of the content type
-        def system
-          @system unless @system.nil?
-          @system = JSON.parse(
-            JSON.generate(@source['system']),
-            object_class: OpenStruct
-          )
-        end
-
-        # Constructor.
-        #
-        # * *Args*:
-        #   - *source* (+JSON+) The response from a REST request for content types
-        def initialize(source)
-          @source = source
-        end
-      end
-    end
-  end
-end
+require 'ostruct'
+
+module Kentico
+  module Kontent
+    module Delivery
+      class ContentType
+        # Parses the 'elements' JSON object as a dynamic OpenStruct object.
+        #
+        # * *Returns*:
+        #   - +OpenStruct+ The elements of the content type
+        def elements
+          @elements unless @elements.nil?
+          @elements = JSON.parse(
+            JSON.generate(@source['elements']),
+            object_class: OpenStruct
+          )
+        end
+
+        # Parses the 'system' JSON object as a dynamic OpenStruct object.
+        #
+        # * *Returns*:
+        #   - +OpenStruct+ The system properties of the content type
+        def system
+          @system unless @system.nil?
+          @system = JSON.parse(
+            JSON.generate(@source['system']),
+            object_class: OpenStruct
+          )
+        end
+
+        # Constructor.
+        #
+        # * *Args*:
+        #   - *source* (+JSON+) The response from a REST request for content types
+        def initialize(source)
+          @source = source
+        end
+      end
+    end
+  end
+end

data/lib/delivery/models/pagination.rb

@@ -1,22 +1,22 @@
-module Kentico
-  module Kontent
-    module Delivery
-      # Holds pagination data from listing responses
-      class Pagination
-        attr_accessor :skip, :limit, :count, :next_page, :total_count
-
-        # Constructor.
-        #
-        # * *Args*:
-        #   - *json* (+JSON+) The 'pagination' node of a listing reponse's JSON object 
-        def initialize(json)
-          self.skip = json['skip']
-          self.limit = json['limit']
-          self.count = json['count']
-          self.next_page = json['next_page']
-          self.total_count = json['total_count']
-        end
-      end
-    end
-  end
-end
+module Kentico
+  module Kontent
+    module Delivery
+      # Holds pagination data from listing responses
+      class Pagination
+        attr_accessor :skip, :limit, :count, :next_page, :total_count
+
+        # Constructor.
+        #
+        # * *Args*:
+        #   - *json* (+JSON+) The 'pagination' node of a listing reponse's JSON object 
+        def initialize(json)
+          self.skip = json['skip']
+          self.limit = json['limit']
+          self.count = json['count']
+          self.next_page = json['next_page']
+          self.total_count = json['total_count']
+        end
+      end
+    end
+  end
+end

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,201 @@
-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
+          #   - *eq_sign* (+boolean+) If false, the equals sign is not generated in the parameter
+          def initialize(key, operator, values, eq_sign = true)
+            super(key, operator, values, eq_sign)
+          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 does not have the specified value.
+  #
+  # * *Args*:
+  #   - +Object+ An object representing the value that cannot exist in the element
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def not_eq(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[neq]', *args)
+  end
+
+  # Represents a filter that matches a content item if the specified
+  # content element or system attribute does not have any value.
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def empty
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[empty]', nil, false)
+  end
+
+  # Represents a filter that matches a content item if the specified
+  # content element or system attribute has any value.
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def not_empty
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[nempty]', nil, false)
+  end
+
+  # Represents a filter that matches a content item if the specified
+  # content element or system attribute does not have the specified value.
+  #
+  # * *Args*:
+  #   - +Object+ An object representing the value that cannot exist in the element
+  #
+  # * *Returns*:
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
+  def not_in(*args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[nin]', *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