storyblok 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4f7ee7dc39a1457adae80294bbe0606e0ee99ea38f5e1c7608ef2f1ef13b8fb
-  data.tar.gz: 1177742ae270a639988a06cbaca3612d2c7b298a521b7614469f17bbb716e787
+  metadata.gz: 0d65c76047177a312640e32e21d9126454177bb974f9808d8a82e944b032e1e0
+  data.tar.gz: b8daf749b9072a284153d92e38155c9b202418b684deb7bb708124dca0e168eb
 SHA512:
-  metadata.gz: 0a373ba20c6107ee1b2b1a767bcaef8f387c1b734566710d38304bb2585e4860224eeeca6c39d9bd16f2ae2706241236e168d757fabb1d298bd601029cff66f9
-  data.tar.gz: d6f1bbfe69648f4dd3130caa7fde6542ecfcc27021f118d65c5af3c9a1a8a61111729255c8b2a23c740881efb402b303ffdb77b69351af74c1a7b1c212da0dc3
+  metadata.gz: 6255f6a2507ce909b0f8836bc0a7368f981f4264d2e60d602908e4fa4019fee0dc5a57506019519d998d0085c4a4028478ef41b88a15cb710ff2ee88638aabb0
+  data.tar.gz: b7f6dfb8c8f070c7b5cd89880d971dadc9cbfb4550db2b48420439c88d90f440f9050b9ad5d6c23ef42fde77354689ef8688ee6f904ae860a97348f6db4cc8de

data/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'redis'
+gem 'storyblok-richtext-renderer'

data/README.md

@@ -27,7 +27,7 @@ client = Storyblok::Client.new(token: 'YOUR_TOKEN')
 
 # Optionally set a cache client
 redis = Redis.new(url: 'redis://localhost:6379')
-cache = Storyblok::Cache::Redis.new(redis: Redis.current)
+cache = Storyblok::Cache::Redis.new(redis: redis)
 client = Storyblok::Client.new(cache: cache, token: 'YOUR_TOKEN')
 
 # Get a story
@@ -141,6 +141,39 @@ client.put("spaces/{space_id}/stories/{story_id}", {story: {name: 'new', slug: "
 client.delete("spaces/{space_id}/stories/{story_id}")
 ```
 
+## Rendering of richtext fields
+
+This SDK comes with a rendering service for richtext fields of Storyblok to get html output.
+
+### Rendering a richtext field
+
+```ruby
+client.render(data.richtext_field)
+```
+
+### Define a component renderer
+
+Storyblok's richtext field also let's you insert content blocks. To render these blocks you can define a Lambda.
+
+```ruby
+# Option 1: Define the resolver when initializing
+client = Storyblok::Client.new(
+  component_resolver: ->(component, data) => {
+    case component
+    when 'button'
+      "<button>#{data['text']}</button>"
+    when 'your_custom_component'
+      "<div class="welcome">#{data['welcome_text']}</div>"
+    end
+  }
+)
+
+# Option 2: Define the resolver afterwards
+client.set_component_resolver(->(component, data) {
+  "#{component}"
+})
+```
+
 
 ### License
 

data/examples/renderer.rb

@@ -0,0 +1,23 @@
+# bundle exec ruby examples/renderer.rb
+
+require_relative '../lib/storyblok'
+
+logger = Logger.new(STDOUT)
+
+client = Storyblok::Client.new(
+  token: '6HMYdAjBoONyuS6GIf5PdAtt',
+  logger: logger,
+  component_resolver: ->(component, data) {
+    "Placeholder for #{component}: #{data['text']}"
+  }
+)
+
+puts client.render({'type' => 'doc', 'content' => [
+  {'type' => 'paragraph', 'content' => [{'text' => 'Good', 'type' => 'text'}]},
+  {'type' => 'blok', 'attrs' => {'body' => [{'component' => 'button', 'text' => 'Click me'}]}}
+]})
+
+res = client.story('article/article-1')
+
+puts res['data']['story']['content']['intro']
+puts client.render(res['data']['story']['content']['intro'])

data/lib/storyblok/client.rb

@@ -1,6 +1,7 @@
 require_relative 'request'
 require_relative 'links'
 
+require 'storyblok/richtext'
 require 'rest-client'
 require 'logger'
 require 'base64'
@@ -15,8 +16,9 @@ module Storyblok
       logger: false,
       log_level: Logger::INFO,
       version: 'draft',
+      component_resolver: ->(component, data) { '' },
       cache_version: Time.now.to_i,
-      cache: nil,
+      cache: nil
     }
 
     attr_reader :configuration, :logger
@@ -25,6 +27,7 @@ module Storyblok
     # @option given_configuration [String] :token Required if oauth_token is not set
     # @option given_configuration [String] :oauth_token Required if token is not set
     # @option given_configuration [String] :api_url
+    # @option given_configuration [Proc] :component_resolver
     # @option given_configuration [Number] :api_version
     # @option given_configuration [false, ::Logger] :logger
     # @option given_configuration [::Logger::DEBUG, ::Logger::INFO, ::Logger::WARN, ::Logger::ERROR] :log_level
@@ -38,6 +41,8 @@ module Storyblok
         })
       end
 
+      @renderer = Richtext::HtmlRenderer.new
+      @renderer.set_component_resolver(@configuration[:component_resolver])
       setup_logger
     end
 
@@ -189,6 +194,24 @@ module Storyblok
       end
     end
 
+    # Returns html from richtext field data
+    #
+    # @param [Hash] :data
+    #
+    # @return [String]
+    def render data
+      @renderer.render(data)
+    end
+
+    # Sets component resolver
+    #
+    # @param [Proc] :component_resolver
+    #
+    # @return [nil]
+    def set_component_resolver component_resolver
+      @renderer.set_component_resolver(component_resolver)
+    end
+
     private
 
     def parse_result(res)

data/lib/storyblok/version.rb

@@ -1,4 +1,4 @@
 module Storyblok
   # Gem Version
-  VERSION = '2.0.5'
+  VERSION = '2.0.6'
 end

data/storyblok.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'rest-client', '>= 1.8.0', '< 3'
+  gem.add_dependency 'storyblok-richtext-renderer', '>= 0.0.4', '< 1'
 
   gem.add_development_dependency 'bundler', '~> 1.5'
   gem.add_development_dependency 'rspec', '~> 3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storyblok
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Storyblok (Alexander Feiglstorfer)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: storyblok-richtext-renderer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,8 +95,11 @@ files:
 - examples/cache.rb
 - examples/example_queries.rb
 - examples/management_api.rb
+- examples/renderer.rb
 - examples/tree.rb
+- lib/.DS_Store
 - lib/storyblok.rb
+- lib/storyblok/.DS_Store
 - lib/storyblok/cache/redis.rb
 - lib/storyblok/client.rb
 - lib/storyblok/links.rb