storyblok 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33a4596358cf0ba305669f743c068507e4101df1ef108489220aea87ab080a10
-  data.tar.gz: 39d281b937424cc102f5aed916e5b49ec139fa57991d0bdf033d2dcd3a7e6cce
+  metadata.gz: 5b52ba5dae9347e6869eff8ae51d53d3b569eef875132b569bcfd8c88c648650
+  data.tar.gz: b15b55e78b254420e70016a9258e4c31f9fcd855a97050ae64972b9ce16aeeeb
 SHA512:
-  metadata.gz: 15b2d39171573e27f50353dfb643930b7c8cf2b8c57ed00576c5b58ffad967376b199635aacabfb37363580bcce5df9dc7e878f56a79182cfe4017ee7f606545
-  data.tar.gz: 99271032e787a4d40270692800c95e8b7b2d2419ced123ea022d4e67436d0937d11477beac638449421cf1dbdde624cf771dd785a535b8c6c22d4709eab8337e
+  metadata.gz: 5265d40c02b920d73d783306810c0dffd1498574b607dd2af7ac658895efbf428f2812b04abdf56ca0e5107a050483f55f98e6c48a371da037bfcfa1fba9c01d
+  data.tar.gz: c7df3f398a7cffe56773d1c286b68ab9be0edcc3791fff45abdc504249b2ba70a0096aa43e6798e38b4b56f374008fc8007fdf9157835ba5a756c9e28a9d7c87

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

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/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,11 +12,14 @@ 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
     }
 
@@ -185,9 +188,16 @@ module Storyblok
         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', space['data']['space']['version'])
@@ -301,5 +311,86 @@ 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']
+
+      if data['stories'].nil?
+        find_and_fill_relations(data.dig('story', 'content'), params[:resolve_relations], rels)
+        find_and_fill_links(data.dig('story', 'content'), links)
+      else
+        data['stories'].each do |story|
+          find_and_fill_relations(story['content'], params[: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/version.rb

@@ -1,4 +1,4 @@
 module Storyblok
   # Gem Version
-  VERSION = '2.1.1'
+  VERSION = '3.0.0'
 end

data/spec/lib/storyblok_cache_redis_spec.rb

@@ -0,0 +1,91 @@
+require 'redis'
+require_relative '../../lib/storyblok/cache/redis'
+require 'spec_helper'
+
+describe Storyblok::Cache::Redis, redis_cache: true do
+  let(:redis_client) {
+    raise StandardError, "Environment variable 'REDIS_URL' is not defined" if ENV['REDIS_URL'].nil?
+    Redis.new(url: ENV['REDIS_URL'])
+  }
+
+  context "When '::Redis' from redis-rb gem is not available" do
+    let!(:redis_constant_copy) { ::Redis }
+    before { Object.send(:remove_const, :Redis) }
+    after  { ::Redis = redis_constant_copy }
+    it "raises Redis.current could not be found" do
+      expect{ subject }.to raise_error(RuntimeError, 'Redis.current could not be found. Supply :redis option or make sure Redis.current is available.')
+    end
+  end
+
+  context "When Storyblok::Cache::Redis is initialized without 'redis' arg" do
+    it "asks the redis to '::Redis.current'" do
+      redis_current = nil
+      expect{ redis_current = subject.redis }.not_to raise_error
+      expect(redis_current.object_id).to eq(::Redis.current.object_id)
+    end
+  end
+
+  describe "#cache" do
+    before { redis_client.keys("storyblok:*").each { |e| redis_client.del(e) } }
+
+    let(:key) { "storyblok:my_cache_key" }
+    context "When is passed an block" do
+      context "When the result it's not cached" do
+        it "caches the block result and returns the block call result" do
+          expect{
+            subject.cache(key){ "my_value" }
+          }.to change { redis_client.keys("#{key}*").size }.from(0).to(1)
+
+          expect(redis_client.get(key)).to eq("my_value")
+        end
+      end
+
+      context "When the arg expire as '0' is passed" do
+        let(:expire) { 0 }
+        it "returns the result of the block" do
+          expect(subject.cache(key, expire){ "my_value" } ).to eq("my_value")
+        end
+
+        it "doesn't cache anything" do
+          expect{ subject.cache(key, expire){ "my_value" } }.not_to change { redis_client.keys.size }
+        end
+      end
+
+      context "When the key has value on cache" do
+        before { subject.cache(key){ "my_value_cached" } }
+        it "the block it's no called and the cache stays untouched and the cached value is returned" do
+          expect{
+            subject.cache(key){ "my_new_value" }
+          }.not_to change { redis_client.keys("#{key}*").size }
+
+          expect(redis_client.get(key)).to eq("my_value_cached")
+        end
+      end
+    end
+  end
+
+  describe "#set" do
+    subject { super().set(key, value, expire) }
+    before { redis_client.keys("storyblok:*").each { |e| redis_client.del(e) } }
+    let(:key) {'storyblok:my_key'}
+    let(:value) {'my_value'}
+
+    context "When arg 'expire' is false" do
+      let(:expire) { false }
+      it "store the key value at Redis database WITHOUT expiration" do
+        expect{ subject }.to change { redis_client.keys("#{key}*").size }.from(0).to(1)
+        expect(redis_client.get(key)).to eq(value)
+        expect(redis_client.ttl(key)).to eq(-1) # -1 means no expiration for redis key
+      end
+    end
+
+    context "When args 'expire' is valid integer" do
+      let(:expire) { 60 * 60 }
+      it "store the key value at Redis database WITH expiration" do
+        expect{ subject }.to change { redis_client.keys("#{key}*").size }.from(0).to(1)
+        expect(redis_client.get(key)).to eq(value)
+        expect(redis_client.ttl(key)).to be > 1
+      end
+    end
+  end
+end