storyblok 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c997a24b49f1144f4c6a4fef322cd10328627a4063bade8ac8fc8f5c73b352fa
-  data.tar.gz: 155cff879f86f38ce3181e0053ee907ccb23afa2b08064427b5d21c8ace3a08d
+  metadata.gz: a7788a31d2120b18b1048f242d05f5d9f2c984344bf36e44bc9519e244dd15a3
+  data.tar.gz: b1858aa45ffad79e7088da5ff78cbc0fd7523f8b30e7525e91da72f6e8609e41
 SHA512:
-  metadata.gz: a2820713268b897df31fc3705e5fef177f40719b7729ae3f1a2daed9f158220906834d3c875376daf1e6ddfe746dc190f3347987e6f088c7f17377fa4b5ab5e6
-  data.tar.gz: 36a26ab2e9c1ec77fbd187f1b6e05c7fadde46c21d6c2a4e8afbb99fb27b1281f31aaa876f74ce1d9f07f31f3ee722e87c4c2fc4ae55ecedf5a05b350b2a5d9e
+  metadata.gz: 2d91bbcdc949b788375f0409560c843050c8166606d73b9ed6e59d6422d33c01c5dfbde90143268cc4fe5b6605cefba1a8f1ba494c0b06e68a493c07d5d0ab39
+  data.tar.gz: 0164c14e04e352a1f51f598592a25e6c9266a4a3eeb646cfaafdb51c1ea7ae4244c7774e4ae349f49ea7afac261dee007871cb788fa36978be2b9f2a5c27aec0

data/.gitignore

@@ -6,3 +6,4 @@ Gemfile.lock
 .idea
 *.DS_Store
 .ruby-version
+*.gem

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,48 @@ 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}"
+})
+```
+
+### Contribute
+
+How to build a gem file.
+
+~~~
+gem build storyblok.gemspec
+gem push storyblok-2.0.X.gem
+~~~
+
 
 ### License
 

data/examples/example_queries.rb

@@ -5,14 +5,14 @@ require 'storyblok'
 logger = Logger.new(STDOUT)
 
 client = Storyblok::Client.new(
-  token: 'FtyUE8zLpZox3ptNYz3dgQtt',
+  token: 't618GfLe1YHICBioAHnMrwtt',
   api_url: 'localhost:3001',
   secure: false,
   logger: logger
 )
 
-p client.datasources
 p client.stories(starts_with: 'en/news')
 p client.story('demo1')
 p client.datasource_entries(datasource: 'labels', per_page: 10)
 p client.links
+p client.datasources

data/examples/renderer.rb

@@ -0,0 +1,31 @@
+# bundle exec ruby examples/renderer.rb
+
+require_relative '../lib/storyblok'
+require 'redis'
+
+logger = Logger.new(STDOUT)
+
+redis = Redis.new(url: 'redis://localhost:6379')
+cache = Storyblok::Cache::Redis.new(redis: redis)
+
+client = Storyblok::Client.new(
+  token: '6HMYdAjBoONyuS6GIf5PdAtt',
+  logger: logger,
+  component_resolver: ->(component, data) {
+    "Placeholder for #{component}: #{data['text']}"
+  },
+  api_url: 'api-testing.storyblok.com',
+  api_version: 2,
+  cache: cache
+)
+
+
+res = client.flush
+res = client.story('authors/page', {version: 'published'})
+puts client.cache_version
+res = client.story('authors/page', {version: 'published'})
+res = client.story('authors/page', {version: 'published'})
+res = client.story('authors/page', {version: 'published'})
+
+puts res['data']
+#puts client.render(res['data']['story']['content']['intro'])

data/lib/storyblok/cache/redis.rb

@@ -6,7 +6,7 @@ module Storyblok
       }
 
       def initialize(*args)
-        options = args.extract_options!
+        options = args.last.is_a?(::Hash) ? args.pop : {}
 
         @redis = options.delete(:redis) || begin
           if defined?(::Redis)
@@ -48,4 +48,4 @@ module Storyblok
 
     end
   end
-end
+end

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,21 +16,24 @@ module Storyblok
       logger: false,
       log_level: Logger::INFO,
       version: 'draft',
-      cache_version: Time.now.to_i,
-      cache: nil,
+      component_resolver: ->(component, data) { '' },
+      cache: nil
     }
 
     attr_reader :configuration, :logger
+    attr_accessor :cache_version
 
     # @param [Hash] given_configuration
     # @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
     def initialize(given_configuration = {})
       @configuration = default_configuration.merge(given_configuration)
+      @cache_version = '0'
       validate_configuration!
 
       if configuration[:oauth_token]
@@ -38,6 +42,8 @@ module Storyblok
         })
       end
 
+      @renderer = Richtext::HtmlRenderer.new
+      @renderer.set_component_resolver(@configuration[:component_resolver])
       setup_logger
     end
 
@@ -57,7 +63,7 @@ module Storyblok
     #
     # @return [Hash]
     def space(query = {})
-      Request.new(self, '/cdn/spaces/me', query).get
+      Request.new(self, '/cdn/spaces/me', query, nil, true).get
     end
 
     # Gets a collection of stories
@@ -164,16 +170,15 @@ module Storyblok
       parse_result(res)
     end
 
-    def cached_get(request)
+    def cached_get(request, bypass_cache = false)
       endpoint = base_url + request.url
       query = request_query(request.query)
       query_string = build_nested_query(query)
 
-      if cache.nil?
+      if cache.nil? || bypass_cache || query[:version] == 'draft'
         result = run_request(endpoint, query_string)
       else
-        version = cache.get('storyblok:' + configuration[:token] + ':version') || '0'
-        cache_key = 'storyblok:' + configuration[:token] + ':v:' + version + ':' + request.url + ':' + Base64.encode64(query_string)
+        cache_key = 'storyblok:' + configuration[:token] + ':v:' + query[:cv] + ':' + request.url + ':' + Base64.encode64(query_string)
 
         result = cache.cache(cache_key) do
           run_request(endpoint, query_string)
@@ -185,10 +190,28 @@ module Storyblok
 
     def flush
       unless cache.nil?
-        cache.set('storyblok:' + configuration[:token] + ':version', Time.now.to_i.to_s)
+        cache.set('storyblok:' + configuration[:token] + ':version', space['data']['space']['version'])
       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)
@@ -213,14 +236,27 @@ module Storyblok
         raise
       end
 
-      {'headers' => res.headers, 'data' => JSON.parse(res.body)}.to_json
+      body = JSON.parse(res.body)
+      self.cache_version = body['cv'] if body['cv']
+
+      unless cache.nil?
+        cache.set('storyblok:' + configuration[:token] + ':version', cache_version)
+      end
+
+      {'headers' => res.headers, 'data' => body}.to_json
     end
 
     # Patches a query hash with the client configurations for queries
     def request_query(query)
       query[:token] = configuration[:token] if query[:token].nil?
       query[:version] = configuration[:version] if query[:version].nil?
-      query[:cv] = configuration[:cache_version] if query[:cache_version].nil?
+
+      unless cache.nil?
+        query[:cv] = (cache.get('storyblok:' + configuration[:token] + ':version') or cache_version) if query[:cv].nil?
+      else
+        query[:cv] = cache_version if query[:cv].nil?
+      end
+
       query
     end
 

data/lib/storyblok/request.rb

@@ -5,14 +5,15 @@ module Storyblok
   class Request
     attr_reader :client, :type, :query, :id, :endpoint
 
-    def initialize(client, endpoint, query = {}, id = nil)
+    def initialize(client, endpoint, query = {}, id = nil, bypass_cache = false)
       @client = client
       @endpoint = endpoint
       @query = query
+      @bypass_cache = bypass_cache
 
       if id
         @type = :single
-        @id = URI.escape(id)
+        @id = URI.encode_www_form_component(id)
       else
         @type = :multi
         @id = nil
@@ -26,7 +27,7 @@ module Storyblok
 
     # Delegates the actual HTTP work to the client
     def get
-      client.cached_get(self)
+      client.cached_get(self, @bypass_cache)
     end
 
     # Returns a new Request object with the same data

data/lib/storyblok/version.rb

@@ -1,4 +1,4 @@
 module Storyblok
   # Gem Version
-  VERSION = '2.0.4'
+  VERSION = '2.1.0'
 end

data/storyblok.gemspec

@@ -10,12 +10,13 @@ Gem::Specification.new do |gem|
   gem.email         = 'it@storyblok.com'
   gem.homepage      = 'https://github.com/storyblok/storyblok-ruby'
 
-  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) && !path.start_with?('pkg') }
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) && !path.start_with?('pkg') && !path.end_with?('.gem') }
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^spec/})
   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.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Storyblok (Alexander Feiglstorfer)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-23 00:00:00.000000000 Z
+date: 2020-08-18 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,14 +95,16 @@ 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
 - lib/storyblok/request.rb
 - lib/storyblok/version.rb
-- storyblok-2.0.3.gem
 - storyblok.gemspec
 homepage: https://github.com/storyblok/storyblok-ruby
 licenses: