storyblok 3.0.1 → 3.2.0

data/examples/management_api.rb

@@ -14,14 +14,14 @@ spaces = client.get('spaces')['data']['spaces']
 space = spaces.first
 
 p client.get("spaces/#{space['id']}")['data']['space']
-story_res = client.post("spaces/#{space['id']}/stories", {story: {name: 'new', slug: "new"}})['data']
+story_res = client.post("spaces/#{space['id']}/stories", { story: { name: 'new', slug: "new" } })['data']
 
 10.times do |index|
   client.get("spaces/#{space['id']}/stories/#{story_res['story']['id']}")
   puts index
 end
 
-p client.put("spaces/#{space['id']}/stories/#{story_res['story']['id']}", {story: {name: 'new123'}})['data']
+p client.put("spaces/#{space['id']}/stories/#{story_res['story']['id']}", { story: { name: 'new123' } })['data']
 
 10.times do |index|
   client.story('new')
@@ -29,5 +29,3 @@ p client.put("spaces/#{space['id']}/stories/#{story_res['story']['id']}", {story
 end
 
 p client.delete("spaces/#{space['id']}/stories/#{story_res['story']['id']}")
-
-

data/examples/renderer.rb

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

data/examples/tree.rb

@@ -1,30 +1,30 @@
 # bundle exec ruby examples/tree.rb
 
-require 'storyblok'
+require "storyblok"
 
 logger = Logger.new(STDOUT)
 
 client = Storyblok::Client.new(
-  token: 't618GfLe1YHICBioAHnMrwtt',
-  api_url: 'localhost:3001',
+  token: "t618GfLe1YHICBioAHnMrwtt",
+  api_url: "localhost:3001",
   secure: false,
   logger: logger
 )
 
 tree = client.tree
 
-puts '<ul>'
+puts "<ul>"
 tree.each do |key, item|
-  puts '<li>' + item['item']['name']
+  puts "<li>" + item["item"]["name"]
 
-  if !item['children'].empty?
-    puts '<ul>'
-    item['children'].each do |key, inner_item|
-      puts '<li>' + inner_item['item']['name'] + '</li>'
+  if !item["children"].empty?
+    puts "<ul>"
+    item["children"].each do |key, inner_item|
+      puts "<li>" + inner_item["item"]["name"] + "</li>"
     end
-    puts '</ul>'
+    puts "</ul>"
   end
 
-  puts '</li>'
+  puts "</li>"
 end
-puts '</ul>'
+puts "</ul>"

data/lib/storyblok/cache/redis.rb

@@ -47,7 +47,6 @@ module Storyblok
           @redis.set(key, value)
         end
       end
-
     end
   end
 end

data/lib/storyblok/client.rb

@@ -11,7 +11,6 @@ module Storyblok
   class Client
     DEFAULT_CONFIGURATION = {
       secure: true,
-      api_url: 'api.storyblok.com',
       api_version: 2,
       logger: false,
       log_level: Logger::INFO,
@@ -32,6 +31,7 @@ module Storyblok
     # @option given_configuration [String] :api_url
     # @option given_configuration [Proc] :component_resolver
     # @option given_configuration [Number] :api_version
+    # @option given_configuration [String] :api_region
     # @option given_configuration [false, ::Logger] :logger
     # @option given_configuration [::Logger::DEBUG, ::Logger::INFO, ::Logger::WARN, ::Logger::ERROR] :log_level
     def initialize(given_configuration = {})
@@ -40,9 +40,15 @@ module Storyblok
       validate_configuration!
 
       if configuration[:oauth_token]
-        @rest_client = RestClient::Resource.new(base_url, :headers => {
-          :authorization => configuration[:oauth_token]
-        })
+        @configuration[:api_version] = 1
+        @rest_client = RestClient::Resource.new(
+          base_url,
+          headers: {
+            authorization: configuration[:oauth_token],
+            'SB-Agent-Version': Storyblok::VERSION,
+            'SB-Agent': 'SB-RB'
+          }
+        )
       end
 
       @renderer = Richtext::HtmlRenderer.new
@@ -197,7 +203,6 @@ module Storyblok
       result
     end
 
-
     def flush
       unless cache.nil?
         cache.set('storyblok:' + configuration[:token] + ':version', space['data']['space']['version'])
@@ -223,175 +228,188 @@ module Storyblok
     end
 
     private
+      def parse_result(res)
+        { 'headers' => res.headers, 'data' => JSON.parse(res.body) }
+      end
 
-    def parse_result(res)
-      {'headers' => res.headers, 'data' => JSON.parse(res.body)}
-    end
-
-    def run_request(endpoint, query_string)
-      logger.info(request: { endpoint: endpoint, query: query_string }) if logger
-
-      retries_left = 3
+      def run_request(endpoint, query_string)
+        logger.info(request: { endpoint: endpoint, query: query_string }) if logger
+
+        retries_left = 3
+
+        begin
+          # rubocop:disable Lint/UselessAssignment
+          res = RestClient.get(
+            "#{endpoint}?#{query_string}",
+            headers={
+              'SB-Agent-Version': Storyblok::VERSION,
+              'SB-Agent': 'SB-RB'
+            }
+          )
+          # rubocop:enable Lint/UselessAssignment
+        rescue RestClient::TooManyRequests
+          if retries_left != 0
+            retries_left -= 1
+            logger.info("Too many requests. Retry nr. #{(3 - retries_left).to_s} of max. 3 times.") if logger
+            sleep(0.5)
+            retry
+          end
 
-      begin
-        res = RestClient.get "#{endpoint}?#{query_string}"
-      rescue RestClient::TooManyRequests
-        if retries_left != 0
-          retries_left -= 1
-          logger.info("Too many requests. Retry nr. #{(3 - retries_left).to_s} of max. 3 times.") if logger
-          sleep(0.5)
-          retry
+          raise
         end
 
-        raise
-      end
+        body = JSON.parse(res.body)
+        self.cache_version = body['cv'] if body['cv']
 
-      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
 
-      unless cache.nil?
-        cache.set('storyblok:' + configuration[:token] + ':version', cache_version)
+        { 'headers' => res.headers, 'data' => body }.to_json
       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?
 
-    # 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?
+        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
 
-      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?
+        query
       end
 
-      query
-    end
+      # Returns the base url for all of the client's requests
+      def base_url
+        if !configuration[:api_url]
+          region = configuration[:api_region] ? "-#{configuration[:api_region]}" : ""
+          "http#{configuration[:secure] ? 's' : ''}://api#{region}.storyblok.com/v#{configuration[:api_version]}"
+        else
+          "http#{configuration[:secure] ? 's' : ''}://#{configuration[:api_url]}/v#{configuration[:api_version]}"
+        end
+      end
 
-    # Returns the base url for all of the client's requests
-    def base_url
-      "http#{configuration[:secure] ? 's' : ''}://#{configuration[:api_url]}/v#{configuration[:api_version]}"
-    end
+      def default_configuration
+        DEFAULT_CONFIGURATION.dup
+      end
 
-    def default_configuration
-      DEFAULT_CONFIGURATION.dup
-    end
+      def cache
+        configuration[:cache]
+      end
 
-    def cache
-      configuration[:cache]
-    end
+      def setup_logger
+        @logger = configuration[:logger]
+        logger.level = configuration[:log_level] if logger
+      end
 
-    def setup_logger
-      @logger = configuration[:logger]
-      logger.level = configuration[:log_level] if logger
-    end
+      def validate_configuration!
+        fail ArgumentError, 'You will need to initialize a client with an :token or :oauth_token' if !configuration[:token] and !configuration[:oauth_token]
+        fail ArgumentError, 'The :api_version must be a positive number' unless configuration[:api_version].to_i >= 0
+      end
 
-    def validate_configuration!
-      fail ArgumentError, 'You will need to initialize a client with an :token or :oauth_token' if !configuration[:token] and !configuration[:oauth_token]
-      fail ArgumentError, 'The client configuration needs to contain an :api_url' if configuration[:api_url].empty?
-      fail ArgumentError, 'The :api_version must be a positive number' unless configuration[:api_version].to_i >= 0
-    end
+      def build_nested_query(value, prefix = nil)
+        case value
+        when Array
+          value.map { |v|
+            build_nested_query(v, "#{prefix}[]")
+          }.join("&")
+        when Hash
+          value.map { |k, v|
+            build_nested_query(v,
+                               prefix ? "#{prefix}[#{URI.encode_www_form_component(k)}]" : URI.encode_www_form_component(k))
+          }.reject(&:empty?).join('&')
+        when nil
+          prefix
+        else
+          raise ArgumentError, "value must be a Hash" if prefix.nil?
 
-    def build_nested_query(value, prefix = nil)
-      case value
-      when Array
-        value.map { |v|
-          build_nested_query(v, "#{prefix}[]")
-        }.join("&")
-      when Hash
-        value.map { |k, v|
-          build_nested_query(v, prefix ? "#{prefix}[#{URI.encode_www_form_component(k)}]" : URI.encode_www_form_component(k))
-        }.reject(&:empty?).join('&')
-      when nil
-        prefix
-      else
-        raise ArgumentError, "value must be a Hash" if prefix.nil?
-        "#{prefix}=#{URI.encode_www_form_component(value)}"
+          "#{prefix}=#{URI.encode_www_form_component(value)}"
+        end
       end
-    end
 
-    def resolve_stories(result, params)
-      data = result['data']
-      rels = data['rels']
-      links = data['links']
-      resolve_relations = params[:resolve_relations] || params["resolve_relations"]
+      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)
+        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
-      end
 
-      result
-    end
+        result
+      end
 
-    def find_and_fill_links(content, links)
-      return if content.nil? || links.nil? || links.size.zero?
+      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
+        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
+                links.each do |link|
+                  if link['uuid'] == id
+                    content['story'] = link
+                    break
+                  end
                 end
               end
             end
-          end
 
-          find_and_fill_links(value, links)
+            find_and_fill_links(value, links)
+          end
+          content.delete('story') if content['story'].nil?
         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?
+      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
+        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
-          end
 
-          find_and_fill_relations(value, relation_params, rels)
+            find_and_fill_relations(value, relation_params, rels)
+          end
         end
       end
-    end
   end
 end

data/lib/storyblok/links.rb

@@ -1,42 +1,41 @@
 module Storyblok
   class Links
     def initialize(response_obj)
-      @links = response_obj['data']['links']
+      @links = response_obj["data"]["links"]
     end
 
     def as_tree
       tree = {}
 
       @links.each do |key, item|
-        if tree[item['parent_id']].nil?
-          tree[item['parent_id']] = []
+        if tree[item["parent_id"]].nil?
+          tree[item["parent_id"]] = []
         end
 
-        tree[item['parent_id']] << item
+        tree[item["parent_id"]] << item
       end
 
       generate_tree(0, tree)
     end
 
     private
+      def generate_tree(parent_id = 0, items)
+        tree = {}
 
-    def generate_tree(parent_id = 0, items)
-      tree = {}
+        if !items[parent_id].nil?
+          result = items[parent_id]
 
-      if !items[parent_id].nil?
-        result = items[parent_id]
+          result.each do |item|
+            if tree[item["id"]].nil?
+              tree[item["id"]] = {}
+            end
 
-        result.each do |item|
-          if tree[item['id']].nil?
-            tree[item['id']] = {}
+            tree[item["id"]]["item"] = item
+            tree[item["id"]]["children"] = generate_tree(item["id"], items)
           end
-
-          tree[item['id']]['item'] = item
-          tree[item['id']]['children'] = generate_tree(item['id'], items)
         end
-      end
 
-      tree
-    end
+        tree
+      end
   end
 end

data/lib/storyblok/version.rb

@@ -1,4 +1,4 @@
 module Storyblok
   # Gem Version
-  VERSION = '3.0.1'
+  VERSION = "3.2.0"
 end

data/lib/storyblok.rb

@@ -1,3 +1,3 @@
-require 'storyblok/version'
-require 'storyblok/cache/redis'
-require 'storyblok/client'
+require "storyblok/version"
+require "storyblok/cache/redis"
+require "storyblok/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storyblok
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Storyblok (Alexander Feiglstorfer)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -141,31 +141,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".editorconfig"
 - ".gitignore"
-- ".ruby-version"
+- ".rubocop.yml"
+- ".rubocop_strict.yml"
+- ".rubocop_todo.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - 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
 homepage: https://github.com/storyblok/storyblok-ruby
-licenses:
-- MIT
+licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,9 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: storyblok
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.5.1