delivery-sdk-ruby 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7029e71c762bf49c74c61390da58f7b47e502211cc5a502e1c017ca8b5dbe320
-  data.tar.gz: 4bce2671a40fb2fc31e4038fd112cf722eb1bdd435b8d565eb1a5c98f22af151
+  metadata.gz: 699ce3c4f3fbb0ede944795f2062ca3f475959465a0da0768fb82f397af9e867
+  data.tar.gz: e1ae507b2a597758ee8902728305e101c255784bc46d8283c441bd613ea43ea6
 SHA512:
-  metadata.gz: 978d43e11b2c242ddba7113c4e2593f5ade63790fce3ed91720406954fe0391db7dd5859d4a779e1a6fc6545bdd2a9372fabd64f6e4347442f9e96d9c71781d7
-  data.tar.gz: 1d2d8938e1052b55df02f16ad324965b4c57077602e6449e17368e26751e8225d468e882ca5d2e0d15212bad506bc6ca80adcc65f5440f2f0959e46c6679750c
+  metadata.gz: b10106369fb1ec0eaa6a816d0f37961dba342e6b5450bf65e72fd8a7b2254444d63fbda027234685989b881d2179939349de3d7c2a076b8427dd9a3764b2b7eb
+  data.tar.gz: 543364d151630c4c0ffaedfbe493c72e7c6491b858127a2e75aae966ebbb83d00f449e3941ffc1cd07c5c6558257de0bbcd35f1498c95f32506a0cee8bc5459c

data/README.md

@@ -304,6 +304,20 @@ delivery_client.taxonomy('personas').execute do |response|
 end
 ```
 
+## Retreiveing content type elements
+
+Kentico Cloud provides an [endpoint](https://developer.kenticocloud.com/v1/reference#view-a-content-type-element) for obtaining details about a specific element of a content type. In the Ruby SDK, you can use the `.element` method:
+
+```ruby
+delivery_client.element('brewer', 'product_status').execute do |response|
+  puts response.element.type # taxonomy
+end
+```
+
+This returns a `Delivery::Responses::DeliveryElementResponse` where the `element` attribute is a dynamic OStruct representation of the JSON response. This means that you can access any property of the element by simply typing the name as in the above example.
+
+The element will always contain __codename__, __type__, and __name__, but multiple choice elements will also contain __options__ and taxonomy elements will contain __taxonomy_group__.
+
 ## Resolving links
 
 If a rich text element contains links to other content items, you will need to generate the URLs to those items. You can do this by registering a `Delivery::Resolvers::ContentLinkResolver` when you instantiate the DeliveryClient. When you create a ContentLinkResolver, you must pass a method that will return the URL:

data/lib/delivery-sdk-ruby.rb

@@ -10,6 +10,7 @@ require File.dirname(__FILE__) + '/delivery/responses/delivery_type_listing_resp
 require File.dirname(__FILE__) + '/delivery/responses/delivery_type_response'
 require File.dirname(__FILE__) + '/delivery/responses/delivery_taxonomy_listing_response'
 require File.dirname(__FILE__) + '/delivery/responses/delivery_taxonomy_response'
+require File.dirname(__FILE__) + '/delivery/responses/delivery_element_response'
 require File.dirname(__FILE__) + '/delivery/resolvers/content_link_resolver'
 require File.dirname(__FILE__) + '/delivery/resolvers/inline_content_item_resolver'
 require File.dirname(__FILE__) + '/delivery/builders/image_transformation_builder'

data/lib/delivery/builders/url_builder.rb

@@ -54,6 +54,8 @@ module Delivery
             else
               format(URL_TEMPLATE_TAXONOMY, query.code_name)
             end
+          when Delivery::QUERY_TYPE_ELEMENT
+            format(URL_TEMPLATE_ELEMENTS, query.content_type, query.code_name)
           end
         end
 

data/lib/delivery/client/delivery_client.rb

@@ -7,6 +7,7 @@ module Delivery
   QUERY_TYPE_TYPES = 'QUERY_TYPE_TYPES'.freeze
   QUERY_TYPE_ITEMS = 'QUERY_TYPE_ITEMS'.freeze
   QUERY_TYPE_TAXONOMIES = 'QUERY_TYPE_TAXONOMIES'.freeze
+  QUERY_TYPE_ELEMENT = 'QUERY_TYPE_ELEMENT'.freeze
 
   # Executes requests against the Kentico Cloud Delivery API.
   class DeliveryClient
@@ -72,5 +73,13 @@ module Delivery
                         code_name: code_name,
                         query_type: QUERY_TYPE_TAXONOMIES
     end
+
+    def element(content_type, element)
+      DeliveryQuery.new project_id: @project_id,
+                        secure_key: @secure_key,
+                        code_name: element,
+                        content_type: content_type,
+                        query_type: QUERY_TYPE_ELEMENT
+    end
   end
 end

data/lib/delivery/client/delivery_query.rb

@@ -20,7 +20,8 @@ module Delivery
                   :content_link_url_resolver,
                   :inline_content_item_resolver,
                   :query_type,
-                  :query_string
+                  :query_string,
+                  :content_type
 
     # Setter for url, returns self for chaining
     # .url represents *manually* configured urls, otherwise final url is
@@ -169,6 +170,8 @@ module Delivery
         else
           Delivery::Responses::DeliveryTaxonomyResponse.new JSON.parse(response)
         end
+      when Delivery::QUERY_TYPE_ELEMENT
+        Delivery::Responses::DeliveryElementResponse.new JSON.parse(response)
       end
     end
   end

data/lib/delivery/responses/delivery_element_response.rb

@@ -0,0 +1,23 @@
+require 'delivery/responses/response_base'
+
+module Delivery
+  module Responses
+    # Returned by DeliveryClient.element containing a single element
+    class DeliveryElementResponse < ResponseBase
+      def element
+        @element unless @element.nil?
+        @element = JSON.parse(
+          JSON.generate(@response),
+          object_class: OpenStruct
+        )
+      end
+
+      def initialize(response)
+        @response = response
+        super 200,
+          "Success, '#{element.codename}' returned",
+          JSON.generate(@response)
+      end
+    end
+  end
+end

data/lib/delivery/version.rb

@@ -1,3 +1,3 @@
 module Delivery
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.14.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Eric Dugre
@@ -117,6 +117,7 @@ files:
 - lib/delivery/query_parameters/query_string.rb
 - lib/delivery/resolvers/content_link_resolver.rb
 - lib/delivery/resolvers/inline_content_item_resolver.rb
+- lib/delivery/responses/delivery_element_response.rb
 - lib/delivery/responses/delivery_item_listing_response.rb
 - lib/delivery/responses/delivery_item_response.rb
 - lib/delivery/responses/delivery_taxonomy_listing_response.rb