delivery-sdk-ruby 0.16.0 → 1.0.0

data/lib/delivery/responses/delivery_element_response.rb

@@ -3,8 +3,14 @@ require 'delivery/responses/response_base'
 module KenticoCloud
   module Delivery
     module Responses
-      # Returned by DeliveryClient.element containing a single element
+      # The response of a successful query of a content type's element
+      # See https://github.com/Kentico/delivery-sdk-ruby#retrieving-content-type-elements
       class DeliveryElementResponse < ResponseBase
+        # An element's definition from a
+        # KenticoCloud::Delivery::DeliveryClient.element call
+        #
+        # * *Returns*:
+        #   - +OpenStruct+ The element of a content item
         def element
           @element unless @element.nil?
           @element = JSON.parse(

data/lib/delivery/responses/delivery_item_listing_response.rb

@@ -5,16 +5,26 @@ require 'delivery/responses/response_base'
 module KenticoCloud
   module Delivery
     module Responses
-      # Returned by DeliveryClient.items with an enumerable of ContentItems
+      # The response of a successful query for content items.
+      # See https://github.com/Kentico/delivery-sdk-ruby#listing-items
       class DeliveryItemListingResponse < ResponseBase
+        # Parses the 'pagination' JSON node of the response.
+        #
+        # * *Returns*:
+        #   - KenticoCloud::Delivery::Pagination
         def pagination
           @pagination unless @pagination.nil?
           @pagination = Pagination.new @response['pagination']
         end
 
+        # A collection of KenticoCloud::Delivery::ContentItem objects from
+        # a KenticoCloud::Delivery::DeliveryClient.items call.
+        #
+        # * *Returns*:
+        #   - +Array+ One or more KenticoCloud::Delivery::ContentItem objects
         def items
           @items unless @items.nil?
-          linked_items_resolver = LinkedItemResolver.new @response['modular_content'], @content_link_url_resolver, @inline_content_item_resolver
+          linked_items_resolver = KenticoCloud::Delivery::Resolvers::LinkedItemResolver.new @response['modular_content'], @content_link_url_resolver, @inline_content_item_resolver
           items = []
           @response['items'].each do |n|
             items << KenticoCloud::Delivery::ContentItem.new(

data/lib/delivery/responses/delivery_item_response.rb

@@ -4,11 +4,17 @@ require 'delivery/responses/response_base'
 module KenticoCloud
   module Delivery
     module Responses
-      # Returned by DeliveryClient.item containing a single ContentItem
+      # The response of a successful query for a content item.
+      # See https://github.com/Kentico/delivery-sdk-ruby#listing-items
       class DeliveryItemResponse < ResponseBase
+        # A KenticoCloud::Delivery::ContentItem object from a
+        # KenticoCloud::Delivery::DeliveryClient.item call.
+        #
+        # * *Returns*:
+        #   - KenticoCloud::Delivery::ContentItem
         def item
           @item unless @item.nil?
-          linked_items_resolver = LinkedItemResolver.new @response['modular_content'], @content_link_url_resolver, @inline_content_item_resolver
+          linked_items_resolver = KenticoCloud::Delivery::Resolvers::LinkedItemResolver.new @response['modular_content'], @content_link_url_resolver, @inline_content_item_resolver
           @item = KenticoCloud::Delivery::ContentItem.new(
             @response,
             @content_link_url_resolver,
@@ -22,7 +28,7 @@ module KenticoCloud
           @content_link_url_resolver = content_link_url_resolver
           @inline_content_item_resolver = inline_content_item_resolver
           super 200,
-            "Success, '#{item.system.code_name}' returned",
+            "Success, '#{item.system.codename}' returned",
             JSON.generate(@response)
         end
       end

data/lib/delivery/responses/delivery_taxonomy_listing_response.rb

@@ -5,13 +5,23 @@ require 'delivery/responses/response_base'
 module KenticoCloud
   module Delivery
     module Responses
-      # Returned by DeliveryClient.taxonomies with an enumerable of TaxonomyGroups
+      # The response of a successful query for taxonomy groups.
+      # See https://github.com/Kentico/delivery-sdk-ruby#taxonomy
       class DeliveryTaxonomyListingResponse < ResponseBase
+        # Parses the 'pagination' JSON node of the response.
+        #
+        # * *Returns*:
+        #   - KenticoCloud::Delivery::Pagination
         def pagination
           @pagination unless @pagination.nil?
           @pagination = Pagination.new @response['pagination']
         end
 
+        # Parses the 'taxonomies' JSON node of the response from a
+        # KenticoCloud::Delivery::DeliveryClient.taxonomies call.
+        #
+        # * *Returns*:
+        #   - +Array+ The taxonomy groups as KenticoCloud::Delivery::TaxonomyGroup objects
         def taxonomies
           @taxonomies unless @taxonomies.nil?
           taxonomies = []

data/lib/delivery/responses/delivery_taxonomy_response.rb

@@ -4,8 +4,14 @@ require 'delivery/responses/response_base'
 module KenticoCloud
   module Delivery
     module Responses
-      # Returned by DeliveryClient.taxonomy containing a single TaxonomyGroup
+      # The response of a successful query for a taxonomy group.
+      # See https://github.com/Kentico/delivery-sdk-ruby#taxonomy
       class DeliveryTaxonomyResponse < ResponseBase
+        # Parses the response from a
+        # KenticoCloud::Delivery::DeliveryClient.taxonomy call.
+        #
+        # * *Returns*:
+        #   - KenticoCloud::Delivery::TaxonomyGroup
         def taxonomy
           @taxonomy unless @taxonomy.nil?
           @taxonomy = KenticoCloud::Delivery::TaxonomyGroup.new(@response)

data/lib/delivery/responses/delivery_type_listing_response.rb

@@ -5,13 +5,23 @@ require 'delivery/responses/response_base'
 module KenticoCloud
   module Delivery
     module Responses
-      # Returned by DeliveryClient.types with an enumerable of ContentTypes
+      # The response of a successful query for content types.
+      # See https://github.com/Kentico/delivery-sdk-ruby#retrieving-content-types
       class DeliveryTypeListingResponse < ResponseBase
+        # Parses the 'pagination' JSON node of the response.
+        #
+        # * *Returns*:
+        #   - KenticoCloud::Delivery::Pagination
         def pagination
           @pagination unless @pagination.nil?
           @pagination = Pagination.new @response['pagination']
         end
 
+        # Parses the 'types' JSON node of the response from a
+        # KenticoCloud::Delivery::DeliveryClient.types call.
+        #
+        # * *Returns*:
+        #   - +Array+ The content types as KenticoCloud::Delivery::ContentType objects
         def types
           @types unless @types.nil?
           types = []

data/lib/delivery/responses/delivery_type_response.rb

@@ -4,8 +4,14 @@ require 'delivery/responses/response_base'
 module KenticoCloud
   module Delivery
     module Responses
-      # Returned by DeliveryClient.types with an enumerable of ContentTypes
+      # The response of a successful query for a content type.
+      # See https://github.com/Kentico/delivery-sdk-ruby#retrieving-content-types
       class DeliveryTypeResponse < ResponseBase
+        # A KenticoCloud::Delivery::ContentType object from a
+        # KenticoCloud::Delivery::DeliveryClient.type call.
+        #
+        # * *Returns*:
+        #   - KenticoCloud::Delivery::ContentType
         def type
           @type unless @type.nil?
           @type = KenticoCloud::Delivery::ContentType.new(@response)

data/lib/delivery/responses/response_base.rb

@@ -1,18 +1,30 @@
 module KenticoCloud
   module Delivery
     module Responses
-      # Base class for all responses from DeliveryQuery.execute
+      # Base class for all responses from a
+      # KenticoCloud::Delivery::DeliveryQuery.execute call.
       class ResponseBase
         attr_accessor :http_code,
                       :message,
                       :json
 
+        # Constructor.
+        #
+        # * *Args*:
+        #   - *http_code* (+integer+) The status code returned by the REST request
+        #   - *message* (+string+) An informative message about the response, visible when calling +to_s+
+        #   - *json* (+string+) _optional_ The complete, unmodified JSON response from the server
         def initialize(http_code, message, json = '')
           self.http_code = http_code
           self.message = message
           self.json = json
         end
 
+        # Provides an informative message about the success of the request
+        # by combining the status code and message.
+        #
+        # * *Returns*:
+        #   - +string+
         def to_s
           "Response is status code #{http_code} with message:\n#{message}"
         end

data/lib/delivery/version.rb

@@ -1,5 +1,5 @@
 module KenticoCloud
   module Delivery
-    VERSION = '0.16.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric Dugre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri