delivery-sdk-ruby 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5935e3de30556622cdc1d6c9ba309ea22120e0c17e79d0b0f72f22d75ba85619
-  data.tar.gz: 78c3a84a4c97a324b1cee12065f6a0b441b44d200054a0cd2df3d1f1d992f2cf
+  metadata.gz: bcfd75f3bee26c46149ed8faef71642ead7dfc5948f583d87056e0cdf2556f0a
+  data.tar.gz: 0b18049d740dd31e8abf162bcd26b6b9a06ed35b155a446dd891fe33e8969e9b
 SHA512:
-  metadata.gz: bbb47f64b96aacb9b892833288972e108377b991c9fcf14faf1b1a48f529ac737ad8c73130abc5e9391cec67a53f332e0f82c2bc5827b276196433f014194653
-  data.tar.gz: abe85df664b4f113b60cf84727953cf99db8d14ee7aa88557b372a1f78f4fa875fb148278b3969a9d27960f3ab108d741da14451604e1da4d97b97bcf49dee08
+  metadata.gz: 2a68250979aa4433a51288ea4e0df5a32d92c4cf42bebc4c97fa4ba140f7ea29f1675fdefb15ee2278af37cb34a1c896a22e393e4916246ca2f90903ed4251c9
+  data.tar.gz: 276eef68b913365d19e49db57eace88f0325caeb534fd0928fe237521bca34b0c3395610bbd58011017162f5703504fb85b1c739c0cc9411c4557a9ee1cecce4

data/README.md

@@ -346,18 +346,22 @@ The element will always contain __codename__, __type__, and __name__, but multip
 
 ## 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 `KenticoCloud::Delivery::Resolvers::ContentLinkResolver` when you instantiate the DeliveryClient. When you create a ContentLinkResolver, you must pass a method that will return the URL:
+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 `KenticoCloud::Delivery::Resolvers::ContentLinkResolver` when you instantiate the DeliveryClient. When you create a ContentLinkResolver, you must pass a method that will return the URL, and you may pass another method that will be called if the content contains a link, but the content item is not present in the response:
 
 ```ruby
 link_resolver = KenticoCloud::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)
+        # Link valid
+        return "/coffees/#{link.url_slug}" if link.type.eql? 'coffee'
+        return "/brewers/#{link.url_slug}" if link.type.eql? 'brewer'
+      end, lambda do |id|
+        # link broken
+        return "/notfound?id=#{id}"
+      end)
 delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
                                                              content_link_url_resolver: link_resolver
 ```
 
-You can also build the logic for your resolver in a separate class and register an instance of that class in the DeliveryClient. The class must extend `KenticoCloud::Delivery::Resolvers::ContentLinkResolver` and contain a `resolve_link(link)` method. For example, you can create `MyLinkResolver.rb`:
+You can also build the logic for your resolver in a separate class and register an instance of that class in the DeliveryClient. The class must extend `KenticoCloud::Delivery::Resolvers::ContentLinkResolver` and contain a `resolve_link(link)` method, as well as the `resolve_404(id)` method for broken links. For example, you can create `MyLinkResolver.rb`:
 
 ```ruby
 class MyLinkResolver < KenticoCloud::Delivery::Resolvers::ContentLinkResolver
@@ -365,6 +369,10 @@ class MyLinkResolver < KenticoCloud::Delivery::Resolvers::ContentLinkResolver
     return "/coffees/#{link.url_slug}" if link.type.eql? 'coffee'
     return "/brewers/#{link.url_slug}" if link.type.eql? 'brewer'
   end
+
+  def resolve_404(id)
+    "/notfound?id=#{id}"
+  end
 end
 ```
 

data/lib/delivery/resolvers/content_link_resolver.rb

@@ -7,8 +7,14 @@ module KenticoCloud
       # to supply the href for content item links.
       # See https://github.com/Kentico/delivery-sdk-ruby#resolving-links
       class ContentLinkResolver
-        def initialize(callback = nil)
-          @callback = callback
+        # Constructor.
+        #
+        # * *Args*:
+        #   - *found_handler* (+lambda+) _optional_ Method to be called when resolving a content link and the content item is present in the response
+        #   - *not_found_handler* (+lambda+) _optional_ Method to be called when resolving a content link and the content item isn't present in the response
+        def initialize(found_handler = nil, not_found_handler = nil)
+          @found_handler = found_handler
+          @not_found = not_found_handler
         end
 
         # Resolves all links in the content.
@@ -42,28 +48,34 @@ module KenticoCloud
         #   - +string+ The <a data-item-id=""> tag with an HREF generated by the +provide_url+ method
         def resolve_tag(tag, links)
           matches = links.select { |link| link.id == tag['data-item-id'].to_s }
-          url = provide_url matches
+          url = provide_url matches, tag['data-item-id']
           tag['href'] = url
           tag
         end
 
         # Uses the +resolve_link+ method to generate a URL for a ContentLink
-        # object.
+        # object, or +resolve_404+ if the content item was not present in the
+        # response.
         #
         # * *Args*:
         #   - *matches* (+Array+) The ContentLink objects with an ID matching a particular <a data-item-id=""> tag
+        #   - *id* (+string+) The ID of the <a data-item-id=""> tag being resolved
         #
         # * *Returns*:
-        #   - +string+ A url if a link was found in source links, otherwise '/404'
-        def provide_url(matches)
-          if !matches.empty?
-            if @callback.nil?
-              resolve_link matches[0]
+        #   - +string+ A url to the item or 404 page
+        def provide_url(matches, id)
+          if matches.empty?
+            if @not_found_handler.nil?
+              resolve_404 id
             else
-              @callback.call matches[0]
+              @not_found_handler.call id
             end
           else
-            '/404'
+            if @found_handler.nil?
+              resolve_link matches[0]
+            else
+              @found_handler.call matches[0]
+            end
           end
         end
       end

data/lib/delivery/version.rb

@@ -1,5 +1,5 @@
 module KenticoCloud
   module Delivery
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.0.2'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Eric Dugre