storyblok 2.0.8 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15b954d3cf0dc7ca6346d490dfe34ed0b676cbd3eef222d7091860d31c7103b4
-  data.tar.gz: f5aaa23eac80dba3e1129c729c96aa3f57a4fcda746a6bdd14a6e914a25523fb
+  metadata.gz: a0a390c17a7c90bad28b7a799a7f151486d55d38977a98257cf67a1cd539e9dd
+  data.tar.gz: 54f9aaad47ad4d435cd40292fc969e9250c5f934c278475880f83a077e49b7cc
 SHA512:
-  metadata.gz: 69cdd57edaab0f030cd3018a0e27caa4d28dde70ca6e4b75d00bd773d71838d3e8de9346e05b53c1b8885f273037787c09a08937de6564193bde954831e91941
-  data.tar.gz: 4680ba3b6697ad2e25bd50cb0039dc3b3a4c3652df680045e862a80a8d9625d057a388d3d0b448bf5c17c042c2cea158672f2144fde359311b8ece9eb68dc58e
+  metadata.gz: 179c3cc2405a6370ab2cc924fa925df5df0a2737b18cd76ac6c6183e3c980889dd1782a4b3cb6f3f0e963124e138639864b6ed04fd293286c647fcf03a092424
+  data.tar.gz: aff00d8502c0816aac6078e68d4060db5a8041249c695f5e55c2c2ea8825ebf63efd788fd408acb9f9408ad57ce9f375eb098a5cb05253f8c820b1b3cd8c25aa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    storyblok (2.0.6)
+    storyblok (2.0.8)
       rest-client (>= 1.8.0, < 3)
       storyblok-richtext-renderer (>= 0.0.4, < 1)
 
@@ -16,7 +16,7 @@ GEM
       domain_name (~> 0.5)
     mime-types (3.3)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0904)
+    mime-types-data (3.2019.1009)
     netrc (0.11.0)
     redis (4.1.0)
     rest-client (2.1.0)

data/README.md

@@ -1,5 +1,11 @@
+[![Test Coverage](https://api.codeclimate.com/v1/badges/76e7fcc8524d4fadeeee/test_coverage)](https://codeclimate.com/github/storyblok/storyblok-ruby/test_coverage)
+![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/storyblok/storyblok-ruby/RSpec%20Tests/master)
+[![Ruby Gems Downloads](https://img.shields.io/gem/dt/storyblok)](https://rubygems.org/gems/storyblok)
+[![Inline docs](https://inch-ci.org/github/storyblok/storyblok-ruby.svg?branch=master)](https://www.rubydoc.info/gems/storyblok)
+[![Maintainability](https://api.codeclimate.com/v1/badges/76e7fcc8524d4fadeeee/maintainability)](https://codeclimate.com/github/storyblok/storyblok-ruby/maintainability)
+
 # About
-This is the Storyblok ruby client for easy access of the management and content delivery api.
+This is the official [Storyblok](https://www.storyblok.com/) ruby client for easy access of the management and content delivery api.
 
 ## Install
 
@@ -120,7 +126,7 @@ client.flush
 client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')
 
 # Get your spaces
-client.get('spaces')
+client.get('spaces/')
 ```
 
 ### Create a story
@@ -158,12 +164,12 @@ Storyblok's richtext field also let's you insert content blocks. To render these
 ```ruby
 # Option 1: Define the resolver when initializing
 client = Storyblok::Client.new(
-  component_resolver: ->(component, data) => {
+  component_resolver: ->(component, data) {
     case component
     when 'button'
       "<button>#{data['text']}</button>"
     when 'your_custom_component'
-      "<div class="welcome">#{data['welcome_text']}</div>"
+      "<div class='welcome'>#{data['welcome_text']}</div>"
     end
   }
 )
@@ -183,6 +189,32 @@ gem build storyblok.gemspec
 gem push storyblok-2.0.X.gem
 ~~~
 
+### Running Tests
+We use [RSpec](http://rspec.info/) for testing.
+
+#### To run the whole test suite you will need export the environment variables, ATTENTION when running the test suit with the variable `REDIS_URL` exported, the test suite will remove the keys with this pattern `storyblok:*` from the redis database defined by `REDIS_URL`
+
+```bash
+export REDIS_URL="redis://localhost:6379"
+```
+
+Optionally you can generate the test report coverage by setting the environment variable
+
+```bash
+export COVERAGE=true
+```
+
+To run the whole test suite use the following command:
+
+```bash
+rspec
+```
+
+To run tests without redis cache tests (for when you don't have redis, or to avoid the test suite to remove the keys with this pattern `storyblok:*` ):
+
+```bash
+rspec --tag ~redis_cache:true
+```
 
 ### License
 

data/examples/renderer.rb

@@ -1,23 +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
 )
 
-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')
+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']['story']['content']['intro']
-puts client.render(res['data']['story']['content']['intro'])
+puts res['data']
+#puts client.render(res['data']['story']['content']['intro'])

data/lib/storyblok/cache/redis.rb

@@ -3,7 +3,9 @@ module Storyblok
     class Redis
       DEFAULT_CONFIGURATION = {
         ttl: 60 * 60 * 24
-      }
+      }.freeze
+
+      attr_reader :redis
 
       def initialize(*args)
         options = args.last.is_a?(::Hash) ? args.pop : {}

data/lib/storyblok/client.rb

@@ -12,16 +12,19 @@ module Storyblok
     DEFAULT_CONFIGURATION = {
       secure: true,
       api_url: 'api.storyblok.com',
-      api_version: 1,
+      api_version: 2,
       logger: false,
       log_level: Logger::INFO,
       version: 'draft',
+      # :nocov:
       component_resolver: ->(component, data) { '' },
+      # :nocov:
       cache_version: Time.now.to_i,
       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
@@ -33,6 +36,7 @@ module Storyblok
     # @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]
@@ -62,7 +66,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
@@ -169,32 +173,34 @@ 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?
-        query = request_query(request.query)
-        query_string = build_nested_query(query)
+      if cache.nil? || bypass_cache || query[:version] == 'draft'
         result = run_request(endpoint, query_string)
       else
-        version = cache.get('storyblok:' + configuration[:token] + ':version') || '0'
-
-        query = query = request_query({ cache_version: version }.merge(request.query))
-        query_string = build_nested_query(query)
-
-        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)
         end
       end
 
-      JSON.parse(result)
+      result = JSON.parse(result)
+
+      if !result.dig('data', 'story').nil? || !result.dig('data', 'stories').nil?
+        result = resolve_stories(result, query)
+      end
+
+      result
     end
 
+
     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
 
@@ -240,14 +246,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
 
@@ -292,5 +311,87 @@ module Storyblok
         "#{prefix}=#{URI.encode_www_form_component(value)}"
       end
     end
+
+    def resolve_stories(result, params)
+      data = result['data']
+      rels = data['rels']
+      links = data['links']
+      resolve_relations = params[:resolve_relations] || params["resolve_relations"]
+
+      if data['stories'].nil?
+        find_and_fill_relations(data.dig('story', 'content'), resolve_relations, rels)
+        find_and_fill_links(data.dig('story', 'content'), links)
+      else
+        data['stories'].each do |story|
+          find_and_fill_relations(story['content'], resolve_relations, rels)
+          find_and_fill_links(story['content'], links)
+        end
+      end
+
+      result
+    end
+
+    def find_and_fill_links(content, links)
+      return if content.nil? || links.nil? || links.size.zero?
+
+      if content.is_a? Array
+        content.each do |item|
+          find_and_fill_links(item, links)
+        end
+      elsif content.is_a? Hash
+        content['story'] = nil
+        content.each do |_k, value|
+          if !content['fieldtype'].nil?
+            if content['fieldtype'] == 'multilink' && content['linktype'] == 'story'
+              id =
+                if content['id'].is_a? String
+                  content['id']
+                elsif content['uuid'].is_a? String
+                  content['uuid']
+                end
+
+              links.each do |link|
+                if link['uuid'] == id
+                  content['story'] = link
+                  break
+                end
+              end
+            end
+          end
+
+          find_and_fill_links(value, links)
+        end
+        content.delete('story') if content['story'].nil?
+      end
+    end
+
+    def find_and_fill_relations(content, relation_params, rels)
+      return if content.nil? || rels.nil? || rels.size.zero?
+
+      if content.is_a? Array
+        content.each do |item|
+          find_and_fill_relations(item, relation_params, rels)
+        end
+      elsif content.is_a? Hash
+        content.each do |_k, value|
+          if !content['component'].nil? && !content['_uid'].nil?
+            relation_params.split(',').each do |relation|
+              component, field_name = relation.split('.')
+
+              if (content['component'] == component) && !content[field_name].nil?
+                rels.each do |rel|
+                  index = content[field_name].index(rel['uuid'])
+                  if !index.nil?
+                    content[field_name][index] = rel
+                  end
+                end
+              end
+            end
+          end
+
+          find_and_fill_relations(value, relation_params, rels)
+        end
+      end
+    end
   end
 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 = 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.8'
+  VERSION = '3.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storyblok
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 3.0.1
 platform: ruby
 authors:
 - Storyblok (Alexander Feiglstorfer)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -64,6 +64,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +92,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 description: Ruby client for the https://www.storyblok.com management and content
   delivery API
 email: it@storyblok.com
@@ -105,7 +161,6 @@ files:
 - lib/storyblok/links.rb
 - lib/storyblok/request.rb
 - lib/storyblok/version.rb
-- storyblok.gemspec
 homepage: https://github.com/storyblok/storyblok-ruby
 licenses:
 - MIT

data/storyblok.gemspec

@@ -1,23 +0,0 @@
-require File.expand_path('../lib/storyblok/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.name          = 'storyblok'
-  gem.version       = Storyblok::VERSION
-  gem.summary       = 'storyblok'
-  gem.description   = 'Ruby client for the https://www.storyblok.com management and content delivery API'
-  gem.license       = 'MIT'
-  gem.authors       = ['Storyblok (Alexander Feiglstorfer)']
-  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') && !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'
-end