delivery-sdk-ruby 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b0f167bc8a460612e4ab4b68a799ba17d16c9fb66c23d23a666302f97ae8c06
-  data.tar.gz: 9465cc7835bdf6e14fd562b2aa55d073ed6147806e718e7e31403328674b463f
+  metadata.gz: 7029e71c762bf49c74c61390da58f7b47e502211cc5a502e1c017ca8b5dbe320
+  data.tar.gz: 4bce2671a40fb2fc31e4038fd112cf722eb1bdd435b8d565eb1a5c98f22af151
 SHA512:
-  metadata.gz: 7a2e54efd94331a7fe1264064fcb44c3b5ba01b5663cf4aa4e224026b5a1ebdea4adae7a82156a325d9c4d8f68dcd578bc3ccc61598c4b932ada63c687738585
-  data.tar.gz: 4e5d2fade9a324f1b2e7b63fd887a64d09508a448a7ee83951748ef76cb3ced252165cc095dce48ec4d5ba59dfb1b2acbdfa3a66c10e10fe22c49ef8adb6cbd1
+  metadata.gz: 978d43e11b2c242ddba7113c4e2593f5ade63790fce3ed91720406954fe0391db7dd5859d4a779e1a6fc6545bdd2a9372fabd64f6e4347442f9e96d9c71781d7
+  data.tar.gz: 1d2d8938e1052b55df02f16ad324965b4c57077602e6449e17368e26751e8225d468e882ca5d2e0d15212bad506bc6ca80adcc65f5440f2f0959e46c6679750c

data/README.md

@@ -1,5 +1,4 @@
-
-[![Forums](https://img.shields.io/badge/chat-on%20forums-orange.svg)](https://forums.kenticocloud.com) [![Join the chat at https://kentico-community.slack.com](https://img.shields.io/badge/join-slack-E6186D.svg)](https://kentico-community.slack.com) [![Version](https://img.shields.io/gem/v/delivery-sdk-ruby.svg?style=flat)](https://rubygems.org/gems/delivery-sdk-ruby)
+ [![Join the chat at https://kentico-community.slack.com](https://img.shields.io/badge/join-slack-E6186D.svg)](https://kentico-community.slack.com) [![Version](https://img.shields.io/gem/v/delivery-sdk-ruby.svg?style=flat)](https://rubygems.org/gems/delivery-sdk-ruby)
 
 # Delivery Ruby SDK
 
@@ -260,8 +259,50 @@ delivery_client.type('coffee').execute do |response|
   field_type = response.type.elements.product_status.type # taxonomy
 end
 ```
+The DeliveryTypeListingResponse also contains pagination data, similar to DeliveryItemListingResponse.
+
+## Taxonomy
+
+Use the `.taxonomies` and `.taxonomy(code_name)` endpoints to get information about the taxonomy in your project:
+
+```ruby
+# Get all taxonomies
+delivery_client.taxonomies.execute do |response|
+  response.taxonomies.each do |tax|
+    puts "#{tax.system.name} (#{tax.terms.length})"
+  end
+end
+
+# Get terms of specific taxonomy
+delivery_client.taxonomy('personas').execute do |response|
+  puts response.taxonomy.terms.length
+end
+```
+
+Each response will return either a single `Delivery::TaxonomyGroup` or an array of groups. The taxonomy group(s) are accessible at `.taxonomy` and `.taxonomies` for single and multiple queries, respectively.
 
- The DeliveryTypeListingResponse also contains pagination data, similar to DeliveryItemListingResponse.
+The `TaxonomyGroup` object contains two attributes `.system` and `.terms` which are dynamic OStruct objects containing the same elements as a standard JSON reponse. For example, given a successful query you could access information about the first term of a group using:
+
+```ruby
+taxonomy_group.terms[0].codename
+```
+
+Note that the terms of a taxonomy group may also contain terms, for example in Dancing Goat's __Personas__ taxonomy group, which looks like this:
+
+- Coffee expert
+  - Barista
+  - Cafe owner
+- Coffee enthusiast
+  - Coffee lover
+  - Coffee blogger
+
+To get the code name of the first term under the "Coffee expert" term, you could do this:
+
+```ruby
+delivery_client.taxonomy('personas').execute do |response|
+  puts response.taxonomy.terms[0].terms[0].codename
+end
+```
 
 ## Resolving links
 

data/lib/delivery-sdk-ruby.rb

@@ -2,11 +2,14 @@ require File.dirname(__FILE__) + '/delivery/client/delivery_client'
 require File.dirname(__FILE__) + '/delivery/client/delivery_query'
 require File.dirname(__FILE__) + '/delivery/models/content_item'
 require File.dirname(__FILE__) + '/delivery/models/content_type'
+require File.dirname(__FILE__) + '/delivery/models/taxonomy_group'
 require File.dirname(__FILE__) + '/delivery/query_parameters/filters'
 require File.dirname(__FILE__) + '/delivery/responses/delivery_item_listing_response'
 require File.dirname(__FILE__) + '/delivery/responses/delivery_item_response'
 require File.dirname(__FILE__) + '/delivery/responses/delivery_type_listing_response'
 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/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

@@ -48,6 +48,12 @@ module Delivery
             else
               format(URL_TEMPLATE_TYPE, query.code_name)
             end
+          when Delivery::QUERY_TYPE_TAXONOMIES
+            if query.code_name.nil?
+              URL_TEMPLATE_TAXONOMIES
+            else
+              format(URL_TEMPLATE_TAXONOMY, query.code_name)
+            end
           end
         end
 

data/lib/delivery/client/delivery_client.rb

@@ -6,7 +6,8 @@ require 'json'
 module Delivery
   QUERY_TYPE_TYPES = 'QUERY_TYPE_TYPES'.freeze
   QUERY_TYPE_ITEMS = 'QUERY_TYPE_ITEMS'.freeze
-  
+  QUERY_TYPE_TAXONOMIES = 'QUERY_TYPE_TAXONOMIES'.freeze
+
   # Executes requests against the Kentico Cloud Delivery API.
   class DeliveryClient
     attr_accessor :use_preview
@@ -57,5 +58,19 @@ module Delivery
       q.preview_key = @preview_key
       q
     end
+
+    def taxonomies(query_parameters = [])
+      DeliveryQuery.new project_id: @project_id,
+                        secure_key: @secure_key,
+                        qp: query_parameters,
+                        query_type: QUERY_TYPE_TAXONOMIES
+    end
+
+    def taxonomy(code_name)
+      DeliveryQuery.new project_id: @project_id,
+                        secure_key: @secure_key,
+                        code_name: code_name,
+                        query_type: QUERY_TYPE_TAXONOMIES
+    end
   end
 end

data/lib/delivery/client/delivery_query.rb

@@ -163,6 +163,12 @@ module Delivery
         else
           Delivery::Responses::DeliveryTypeResponse.new JSON.parse(response)
         end
+      when Delivery::QUERY_TYPE_TAXONOMIES
+        if code_name.nil?
+          Delivery::Responses::DeliveryTaxonomyListingResponse.new JSON.parse(response)
+        else
+          Delivery::Responses::DeliveryTaxonomyResponse.new JSON.parse(response)
+        end
       end
     end
   end

data/lib/delivery/models/taxonomy_group.rb

@@ -0,0 +1,24 @@
+module Delivery
+  # JSON data of a taxonomy group parsed as OpenStruct objects for dynamic use
+  class TaxonomyGroup
+    def terms
+      @terms unless @terms.nil?
+      @terms = JSON.parse(
+        JSON.generate(@source['terms']),
+        object_class: OpenStruct
+      )
+    end
+
+    def system
+      @system unless @system.nil?
+      @system = JSON.parse(
+        JSON.generate(@source['system']),
+        object_class: OpenStruct
+      )
+    end
+
+    def initialize(source)
+      @source = source
+    end
+  end
+end

data/lib/delivery/responses/delivery_item_listing_response.rb

@@ -30,8 +30,7 @@ module Delivery
         @content_link_url_resolver = content_link_url_resolver
         @inline_content_item_resolver = inline_content_item_resolver
         super 200,
-          "Success,
-          #{items.length} items returned",
+          "Success, #{items.length} items returned",
           JSON.generate(@response)
       end
     end

data/lib/delivery/responses/delivery_item_response.rb

@@ -19,8 +19,7 @@ module Delivery
         @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.code_name}' returned",
           JSON.generate(@response)
       end
     end

data/lib/delivery/responses/delivery_taxonomy_listing_response.rb

@@ -0,0 +1,32 @@
+require 'delivery/models/taxonomy_group'
+require 'delivery/models/pagination'
+require 'delivery/responses/response_base'
+
+module Delivery
+  module Responses
+    # Returned by DeliveryClient.taxonomies with an enumerable of TaxonomyGroups
+    class DeliveryTaxonomyListingResponse < ResponseBase
+      def pagination
+        @pagination unless @pagination.nil?
+        @pagination = Pagination.new @response['pagination']
+      end
+
+      def taxonomies
+        @taxonomies unless @taxonomies.nil?
+        taxonomies = []
+        @response['taxonomies'].each do |n|
+          taxonomies << Delivery::TaxonomyGroup.new(n)
+        end
+        @taxonomies = taxonomies
+      end
+
+      def initialize(response)
+        @response = response
+
+        super 200,
+              "Success, #{taxonomies.length} taxonomies returned",
+              JSON.generate(@response)
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_taxonomy_response.rb

@@ -0,0 +1,22 @@
+require 'delivery/models/taxonomy_group'
+require 'delivery/responses/response_base'
+
+module Delivery
+  module Responses
+    # Returned by DeliveryClient.taxonomy containing a single TaxonomyGroup
+    class DeliveryTaxonomyResponse < ResponseBase
+      def taxonomy
+        @taxonomy unless @taxonomy.nil?
+        @taxonomy = Delivery::TaxonomyGroup.new(@response)
+      end
+
+      def initialize(response)
+        @response = response
+
+        super 200,
+              "Success, '#{taxonomy.system.codename}' returned",
+              JSON.generate(@response)
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_type_listing_response.rb

@@ -22,7 +22,9 @@ module Delivery
 
       def initialize(response)
         @response = response
-        super 200, "Success, #{types.length} types returned"
+        super 200,
+              "Success, #{types.length} types returned",
+              JSON.generate(@response)
       end
     end
   end

data/lib/delivery/responses/delivery_type_response.rb

@@ -12,7 +12,9 @@ module Delivery
 
       def initialize(response)
         @response = response
-        super 200, "Success, type '#{type.system.codename}' returned"
+        super 200,
+              "Success, type '#{type.system.codename}' returned",
+              JSON.generate(@response)
       end
     end
   end

data/lib/delivery/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Eric Dugre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-20 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -111,6 +111,7 @@ files:
 - lib/delivery/models/content_item.rb
 - lib/delivery/models/content_type.rb
 - lib/delivery/models/pagination.rb
+- lib/delivery/models/taxonomy_group.rb
 - lib/delivery/query_parameters/filters.rb
 - lib/delivery/query_parameters/parameter_base.rb
 - lib/delivery/query_parameters/query_string.rb
@@ -118,6 +119,8 @@ files:
 - lib/delivery/resolvers/inline_content_item_resolver.rb
 - lib/delivery/responses/delivery_item_listing_response.rb
 - lib/delivery/responses/delivery_item_response.rb
+- lib/delivery/responses/delivery_taxonomy_listing_response.rb
+- lib/delivery/responses/delivery_taxonomy_response.rb
 - lib/delivery/responses/delivery_type_listing_response.rb
 - lib/delivery/responses/delivery_type_response.rb
 - lib/delivery/responses/response_base.rb