delivery-sdk-ruby 0.10.5 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f780f88f42bb6381043099d5e3bcca65f8e900ccbd74a2b7e763cde93d48f0f
-  data.tar.gz: d003bdca98b31de4a6dc58e001bd2dfbe22300754e11709ff24a30b289de1057
+  metadata.gz: fd73aeb9d5c21ced1f411e55d6c5580cbf4a47e4c53e079c20a6042c6e4c8a86
+  data.tar.gz: 69e4592d7a990b1bafca69909f27435e7882c25c80b8936541b83d29567fdd5a
 SHA512:
-  metadata.gz: 789f858cfe6dc8105dde244cd1a8e4573e3c1940cec4e5b68c1648029954347a5171f6ff852fa7ccc109100c8e9b398a879705db08af2ad1e914f07f1203455c
-  data.tar.gz: 3b2fb78ac028a29482973075960f55af73cb13c8f9eca5202618fbe029d4f64dff731ae56d02f332fc6d7efb63fcc287c0ef0a175ec2bf24f49c2348610bd974
+  metadata.gz: 55367ece8fc6d59d62180aab48359507335b0b87e3d38cea94a3e923dc06ddf14cda1be62dca0bf373e7714fc6723aefd90b5878893717d682d49571ad535a79
+  data.tar.gz: 6b90bb56897fcbed3bf7cc61e0d0f74a65e5d0d2c14578fd997192d5d2b1e2ef555eeccd9f56675dc9d493f5f44fcb288e738245ac9910bf5d953356e977f86e

data/README.md

@@ -243,8 +243,8 @@ If a rich text element contains links to other content items, you will need to g
 
 ```ruby
 link_resolver = Delivery::Resolvers::ContentLinkResolver.new(lambda do |link|
-  return "/coffees/#{link.url_slug}" if link.type == 'coffee'
-  return "/brewers/#{link.url_slug}" if link.type == 'brewer'
+  return "/coffees/#{link.url_slug}" if link.type.eql? 'coffee'
+  return "/brewers/#{link.url_slug}" if link.type.eql? 'brewer'
 end)
 delivery_client = Delivery::DeliveryClient.new project_id: '<your-project-id>',
                                                content_link_url_resolver: link_resolver
@@ -255,8 +255,8 @@ You can also build the logic for your resolver in a separate class and register
 ```ruby
 class MyLinkResolver < Delivery::Resolvers::ContentLinkResolver
   def resolve_link(link)
-    return "/coffees/#{link.url_slug}" if link.type == 'coffee'
-    return "/brewers/#{link.url_slug}" if link.type == 'brewer'
+    return "/coffees/#{link.url_slug}" if link.type.eql? 'coffee'
+    return "/brewers/#{link.url_slug}" if link.type.eql? 'brewer'
   end
 end
 ```
@@ -287,17 +287,50 @@ The `ContentLink` object that is passed to your resolver contains the following
 To resolve links in rich text elements, you must retrieve the text using `get_string`:
 
 ```ruby
-lambda_resolver = Delivery::Resolvers::ContentLinkResolver.new(lambda do |link|
-  return "/coffees/#{link.url_slug}" if link.type == 'coffee'
-  return "/brewers/#{link.url_slug}" if link.type == 'brewer'
+item_resolver = Delivery::Resolvers::ContentLinkResolver.new(lambda do |link|
+  return "/coffees/#{link.url_slug}" if link.type.eql? 'coffee'
+  return "/brewers/#{link.url_slug}" if link.type.eql? 'brewer'
 end)
 delivery_client = Delivery::DeliveryClient.new project_id: '<your-project-id>',
-                                               content_link_url_resolver: lambda_resolver
+                                               content_link_url_resolver: item_resolver
 delivery_client.item('coffee_processing_techniques').execute do |response|
   text = response.item.get_string 'body_copy'
 end
 ```
 
+## Resolving inline content
+
+Existing content items can be inserted into a rich text element, or you can create new content items as components. You need to resolve these in your application just as with content links. You can register a resolver when you instantiate the client by passing it with the hash key `inline_content_item_resolver`:
+
+```ruby
+item_resolver = Delivery::Resolvers::InlineContentItemResolver.new(lambda do |item|
+      return "<h1>#{item.elements.zip_code.value}</h1>" if item.system.type.eql? 'cafe'
+      return "<div>$#{item.elements.price.value}</div>" if item.system.type.eql? 'brewer'
+    end)
+delivery_client = Delivery::DeliveryClient.new project_id: '<your-project-id>',
+                                               inline_content_item_resolver: item_resolver
+```
+
+The object passed to the resolving method is a complete ContentItem. Similar to content link resolvers, you can create your own class which extends `Delivery::Resolvers::InlineContentItemResolver` and implements the `resolve_item` method:
+
+```ruby
+class MyItemResolver < Delivery::Resolvers::InlineContentItemResolver
+  def resolve_item(item)
+    return "<h1>#{item.elements.zip_code.value}</h1>" if item.system.type.eql? 'cafe'
+    return "<div>$#{item.elements.price.value}</div>" if item.system.type.eql? 'brewer'
+  end
+end
+```
+
+You can also set the inline content resolver per-query:
+
+```ruby
+delivery_client = Delivery::DeliveryClient.new project_id: '<your-project-id>'
+# Client doesn't use InlineContentItemResolver, but query below will
+delivery_client.items
+               .with_inline_content_item_resolver MyItemResolver.new
+```
+
 ## Feedback & Contributing
 
 Check out the [contributing](https://github.com/Kentico/delivery-sdk-ruby/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions, and begin contributing.

data/lib/delivery-sdk-ruby.rb

@@ -8,3 +8,4 @@ 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/resolvers/content_link_resolver'
+require File.dirname(__FILE__) + '/delivery/resolvers/inline_content_item_resolver'

data/lib/delivery/client/delivery_client.rb

@@ -16,6 +16,7 @@ module Delivery
       @preview_key = config.fetch(:preview_key, nil)
       @secure_key = config.fetch(:secure_key, nil)
       @content_link_url_resolver = config.fetch(:content_link_url_resolver, nil)
+      @inline_content_item_resolver = config.fetch(:inline_content_item_resolver, nil)
       self.use_preview = !@preview_key.nil?
     end
 
@@ -37,6 +38,7 @@ module Delivery
                             secure_key: @secure_key,
                             qp: query_parameters,
                             content_link_url_resolver: @content_link_url_resolver,
+                            inline_content_item_resolver: @inline_content_item_resolver,
                             query_type: QUERY_TYPE_ITEMS
       q.use_preview = use_preview
       q.preview_key = @preview_key
@@ -49,6 +51,7 @@ module Delivery
                             code_name: code_name,
                             qp: query_parameters,
                             content_link_url_resolver: @content_link_url_resolver,
+                            inline_content_item_resolver: @inline_content_item_resolver,
                             query_type: QUERY_TYPE_ITEMS
       q.use_preview = use_preview
       q.preview_key = @preview_key

data/lib/delivery/client/delivery_query.rb

@@ -18,6 +18,7 @@ module Delivery
                   :params,
                   :secure_key,
                   :content_link_url_resolver,
+                  :inline_content_item_resolver,
                   :query_type
 
     # Setter for url, returns self for chaining
@@ -60,6 +61,11 @@ module Delivery
       self
     end
 
+    def with_inline_content_item_resolver(resolver)
+      self.inline_content_item_resolver = resolver
+      self
+    end
+
     def order_by(value, sort = '[asc]')
       set_param('order', value + sort)
       self
@@ -141,12 +147,14 @@ module Delivery
         if code_name.nil?
           Delivery::Responses::DeliveryItemListingResponse.new(
             JSON.parse(response),
-            content_link_url_resolver
+            content_link_url_resolver,
+            inline_content_item_resolver
           )
         else
           Delivery::Responses::DeliveryItemResponse.new(
             JSON.parse(response),
-            content_link_url_resolver
+            content_link_url_resolver,
+            inline_content_item_resolver
           )
         end
       when Delivery::QUERY_TYPE_TYPES

data/lib/delivery/models/content_item.rb

@@ -4,7 +4,8 @@ require 'nokogiri'
 module Delivery
   # JSON data of a content item parsed as OpenStruct objects for dynamic use
   class ContentItem
-    attr_accessor :content_link_url_resolver
+    attr_accessor :content_link_url_resolver,
+                  :inline_content_item_resolver
 
     def elements
       @elements unless @elements.nil?
@@ -22,24 +23,28 @@ module Delivery
       )
     end
 
-    def initialize(source, content_link_url_resolver)
+    def initialize(source, content_link_url_resolver, inline_content_item_resolver)
       @source =
         if source['item'].nil?
           source
         else
           source['item']
         end
-      @link_source = source['modular_content']
+      @modular_content = source['modular_content']
       self.content_link_url_resolver = content_link_url_resolver
+      self.inline_content_item_resolver = inline_content_item_resolver
     end
 
     def get_string(code_name)
       element = get_element code_name
-      
-      # Resolve content links if there are any and we have a resolver
-      return content_link_url_resolver.resolve element['value'], element['links'] if should_resolve element
+      content = element['value']
 
-      element['value'].to_s
+      if element['type'] == 'rich_text'
+        content = content_link_url_resolver.resolve content, element['links'] if should_resolve_links element
+        inline_items = get_inline_items code_name
+        content = inline_content_item_resolver.resolve content, inline_items if should_resolve_inline_content element
+      end
+      content.to_s
     end
 
     # Returns an array of assets inserted into the specified element
@@ -49,17 +54,29 @@ module Delivery
     end
 
     # Returns an array of ContentItems by comparing code names stored in the
-    # element with items from request's link_source
+    # element with items from request's modular_content
     def get_links(code_name)
       element = get_element code_name
-      filtered = @link_source.values.select { |item| element['value'].include?(item['system']['codename']) }
-      filtered.map { |n| ContentItem.new JSON.parse(JSON.generate(n)), content_link_url_resolver }
+      filtered = @modular_content.values.select { |item| element['value'].include?(item['system']['codename']) }
+      filtered.map { |n| ContentItem.new JSON.parse(JSON.generate(n)), content_link_url_resolver, inline_content_item_resolver }
+    end
+
+    # Returns an array of ContentItems by comparing code names stored in the
+    # modular_content object with items from request's modular_content
+    def get_inline_items(code_name)
+      element = get_element code_name
+      filtered = @modular_content.values.select { |item| element['modular_content'].include?(item['system']['codename']) }
+      filtered.map { |n| ContentItem.new JSON.parse(JSON.generate(n)), content_link_url_resolver, inline_content_item_resolver }
     end
 
     private
 
-    def should_resolve(element)
-      element['type'] == 'rich_text' && !element['links'].nil? && !content_link_url_resolver.nil?
+    def should_resolve_links(element)
+      !element['links'].nil? && !content_link_url_resolver.nil?
+    end
+
+    def should_resolve_inline_content(element)
+      !element['modular_content'].nil? && !inline_content_item_resolver.nil?
     end
 
     def get_element(code_name)

data/lib/delivery/resolvers/inline_content_item_resolver.rb

@@ -0,0 +1,51 @@
+require 'nokogiri'
+
+module Delivery
+  module Resolvers
+    # Locates <object data-type="item"> tags in content and calls a user-defined method
+    # to supply the HTML output for the content item
+    class InlineContentItemResolver
+      def initialize(callback = nil)
+        @callback = callback
+      end
+
+      # Resolves all inline content items in the content
+      # @param [String] content The string value stored in the element
+      # @param [Array] inline_items ContentItems referenced by the content
+      def resolve(content, inline_items)
+        doc = Nokogiri::HTML.parse(content).xpath('//body')
+        tags = doc.xpath('//object[@type="application/kenticocloud"][@data-type="item"]')
+        tags.each do |tag|
+          output = resolve_tag tag, inline_items
+          doc.at_xpath('//object[@type="application/kenticocloud"][@data-type="item"][@data-codename=$value]',
+                        nil,
+                        :value => tag['data-codename']
+                      )
+             .swap(output)
+        end
+        doc.inner_html
+      end
+
+      private
+
+      # Accepts a tag found in the content and tries to locate matching
+      # ContentItem from JSON response.
+      def resolve_tag(tag, inline_items)
+        matches = inline_items.select { |item| item.system.codename == tag['data-codename'].to_s }
+        provide_output matches
+      end
+
+      def provide_output(matches)
+        if !matches.empty?
+          if @callback.nil?
+            resolve_item matches[0]
+          else
+            @callback.call matches[0]
+          end
+        else
+          '/404'
+        end
+      end
+    end
+  end
+end

data/lib/delivery/responses/delivery_item_listing_response.rb

@@ -17,15 +17,17 @@ module Delivery
         @response['items'].each do |n|
           items << Delivery::ContentItem.new(
             n,
-            @content_link_url_resolver
+            @content_link_url_resolver,
+            @inline_content_item_resolver
           )
         end
         @items = items
       end
 
-      def initialize(response, content_link_url_resolver)
+      def initialize(response, content_link_url_resolver, inline_content_item_resolver)
         @response = response
         @content_link_url_resolver = content_link_url_resolver
+        @inline_content_item_resolver = inline_content_item_resolver
         super 200, "Success, #{items.length} items returned"
       end
     end

data/lib/delivery/responses/delivery_item_response.rb

@@ -7,12 +7,13 @@ module Delivery
     class DeliveryItemResponse < ResponseBase
       def item
         @item unless @item.nil?
-        @item = Delivery::ContentItem.new(@response, @content_link_url_resolver)
+        @item = Delivery::ContentItem.new(@response, @content_link_url_resolver, @inline_content_item_resolver)
       end
 
-      def initialize(response, content_link_url_resolver)
+      def initialize(response, content_link_url_resolver, inline_content_item_resolver)
         @response = response
         @content_link_url_resolver = content_link_url_resolver
+        @inline_content_item_resolver = inline_content_item_resolver
         super 200, "Success, '#{item.system.code_name}' returned"
       end
     end

data/lib/delivery/version.rb

@@ -1,3 +1,3 @@
 module Delivery
-  VERSION = '0.10.5'.freeze
+  VERSION = '0.11.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.10.5
+  version: 0.11.0
 platform: ruby
 authors:
 - Eric Dugre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -113,6 +113,7 @@ files:
 - lib/delivery/query_parameters/filters.rb
 - lib/delivery/query_parameters/parameter_base.rb
 - lib/delivery/resolvers/content_link_resolver.rb
+- 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_type_listing_response.rb