delivery-sdk-ruby 1.0.9 → 2.0.2

data/lib/delivery/models/content_type.rb

@@ -1,38 +1,40 @@
 require 'ostruct'
 
-module KenticoCloud
-  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
+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
+        # 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
+        # Constructor.
+        #
+        # * *Args*:
+        #   - *source* (+JSON+) The response from a REST request for content types
+        def initialize(source)
+          @source = source
+        end
       end
     end
   end

data/lib/delivery/models/pagination.rb

@@ -1,18 +1,20 @@
-module KenticoCloud
-  module Delivery
-    # Holds pagination data from listing responses
-    class Pagination
-      attr_accessor :skip, :limit, :count, :next_page
+module Kentico
+  module Kontent
+    module Delivery
+      # Holds pagination data from listing responses
+      class Pagination
+        attr_accessor :skip, :limit, :count, :next_page
 
-      # 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']
+        # 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']
+        end
       end
     end
   end

data/lib/delivery/models/taxonomy_group.rb

@@ -1,36 +1,38 @@
-module KenticoCloud
-  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
+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
+        # 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
+        # Constructor.
+        #
+        # * *Args*:
+        #   - *json* (+JSON+) A JSON node representing a taxonomy group
+        def initialize(source)
+          @source = source
+        end
       end
     end
   end

data/lib/delivery/query_parameters/filters.rb

@@ -1,19 +1,21 @@
 require 'delivery/query_parameters/parameter_base'
 
-module KenticoCloud
-  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 Cloud 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)
+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 Cloud 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
@@ -31,9 +33,9 @@ class String
   #   - +Object+ One or more objects representing the values that must appear in the field
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def all(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '[all]', *args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[all]', *args)
   end
 
   # Represents a filter that matches a content item if the specified content
@@ -45,9 +47,9 @@ class String
   #   - +Object+ One or more objects representing the values that may appear in the field
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def any(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '[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
@@ -59,9 +61,9 @@ class String
   #   - +Object+ An object representing the value that must appear in the field
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def contains(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '[contains]', *args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[contains]', *args)
   end
 
   # Represents a filter that matches a content item if the specified
@@ -71,9 +73,9 @@ class String
   #   - +Object+ An object representing the value that must equal the value in the field
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def eq(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '', *args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '', *args)
   end
 
   # Represents a filter that matches a content item if the specified content
@@ -84,9 +86,9 @@ class String
   #   - +Object+ An object representing the lowest possible value of the field, non-inclusive
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def gt(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '[gt]', *args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[gt]', *args)
   end
 
   # Represents a filter that matches a content item if the specified content
@@ -97,9 +99,9 @@ class String
   #   - +Object+ An object representing the lowest possible value of the field
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def gt_or_eq(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '[gte]', *args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[gte]', *args)
   end
 
   # Represents a filter that matches a content item if the specified
@@ -110,9 +112,9 @@ class String
   #   - +Object+ One or more objects representing the required values of the field
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def in(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '[in]', *args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[in]', *args)
   end
 
   # Represents a filter that matches a content item if the specified content
@@ -123,9 +125,9 @@ class String
   #   - +Object+ An object representing the highest possible value of the field, non-inclusive
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def lt(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '[lt]', *args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[lt]', *args)
   end
 
   # Represents a filter that matches a content item if the specified content
@@ -136,9 +138,9 @@ class String
   #   - +Object+ An object representing the highest possible value of the field
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def lt_or_eq(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '[lte]', *args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[lte]', *args)
   end
 
   # Represents a filter that matches a content item if the specified
@@ -149,8 +151,8 @@ class String
   #   - +Object+ An object representing the lowest and highest possible values of the field
   #
   # * *Returns*:
-  #   - KenticoCloud::Delivery::QueryParameters::Filter
+  #   - Kentico::Kontent::Delivery::QueryParameters::Filter
   def range(*args)
-    KenticoCloud::Delivery::QueryParameters::Filter.new(self, '[range]', *args)
+    Kentico::Kontent::Delivery::QueryParameters::Filter.new(self, '[range]', *args)
   end
 end

data/lib/delivery/query_parameters/parameter_base.rb

@@ -1,40 +1,42 @@
-module KenticoCloud
-  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(',')
+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 Cloud 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
+          # Constructor.
+          #
+          # * *Args*:
+          #   - *key* (+string+) The field to filter upon
+          #   - *operator* (+string+) The Kentico Cloud 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)
-          )
+          # 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

data/lib/delivery/query_parameters/query_string.rb

@@ -1,74 +1,76 @@
 require 'delivery/query_parameters/parameter_base'
 
-module KenticoCloud
-  module Delivery
-    module QueryParameters
-      # Represents the entire query string for a request to Delivery.
-      class QueryString
-        def initialize
-          @params = []
-        end
+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 KenticoCloud::Delivery::QueryParameters::ParameterBase object
-        #   - *values* (+string+) A string or array of strings representing the values for the parameter
-        #   - *operator* (+string+) 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
-              KenticoCloud::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'
+          # 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 Cloud 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
+            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
+          # 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 KenticoCloud::Delivery::QueryParameters::ParameterBase objects
-        def param(key)
-          @params.select { |p| p.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
+          # 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
-        # KenticoCloud::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('&')
+          # 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