storyblok 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd63f68ec8b4a15eb75df4240e3ab65117e44bf4f149d81814fd019f919d2b3f
-  data.tar.gz: 5de614478e045a878c41755fd342798860d8980d492687fd904dae34a94d5f34
+  metadata.gz: ff2b96538cd2959b1a5f3e75a8fe05698875a8daea71fe5ddcf703206fc1efa2
+  data.tar.gz: c2c68e5926b227fb615311fe27da54f710b607cd9ab1282808219522ccbb4777
 SHA512:
-  metadata.gz: c6ba6fa2345e29b5a9fc8d23bdbac78a89a60322dca1e7a578c7e74e3ea487d94ffd3f5f5218ed3efd708d918a07f2db54a20d509a39977012fc068528542b6c
-  data.tar.gz: e9774ef478fa2429a50e2c41fc4193c54404f18ed65b1bdb4863a42ede67b38193bf400670bd8e49c8d8bc4ff51f68979ef0cca5f4c66af46e9fe5f2bf322c53
+  metadata.gz: 54f690a2d6e335334dbaf384576023b5d8571100ad9ba6df9f4187adb9ff87bc5b2fc2f4268314e7f8348ae956727c94c95af5fc1ddebadf70f87d1a5f3a399c
+  data.tar.gz: 319006f9bd1f30487135838e120815d85350e06b49cdbae82190736aeba130a6c2fb35186b27149a24d72f6265695b8ba250842fc3db9fbb9bbf55b7fa143626

data/.gitignore

@@ -1,3 +1,6 @@
+# Ignore bundler config.
+/.bundle
+
 pkg
 doc/
 .yardoc/

data/Gemfile

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "redis"
+gem "redis", "~> 4.4.0"
 gem "storyblok-richtext-renderer"
 
 gem "rubocop", require: false

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Storyblok GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -43,7 +43,11 @@ Storyblok::Client.new(version: 'published')
 
 #### Using the APIs on other regions
 
-You should use the space access token AND `api_region: 'us'` whenever your space was created under `US` Server Location.
+You should use the space access token with the `api_region` parameter whenever your space belongs to other server locations.
+
+Available regions: `eu`, `us`, `ca` and `ap`.
+
+Example on US region:
 
 ```ruby
 client = Storyblok::Client.new(token: 'YOUR_TOKEN', api_region: 'us')

data/lib/storyblok/client.rb

@@ -19,7 +19,8 @@ module Storyblok
       component_resolver: ->(component, data) { '' },
       # :nocov:
       cache_version: Time.now.to_i,
-      cache: nil
+      cache: nil,
+      request_type: nil
     }
 
     attr_reader :configuration, :logger
@@ -33,16 +34,23 @@ module Storyblok
     # @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
+    # @option given_configuration [String] :token Required if oauth_token is not set
+    # @option given_configuration [String] :request_type
     def initialize(given_configuration = {})
       @configuration = default_configuration.merge(given_configuration)
       @cache_version = '0'
       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
@@ -232,7 +240,19 @@ module Storyblok
         retries_left = 3
 
         begin
-          res = RestClient.get "#{endpoint}?#{query_string}"
+          headers = {
+            'SB-Agent-Version': Storyblok::VERSION,
+            'SB-Agent': 'SB-RB'
+          }
+
+          headers['X-Request-Type'] = @configuration[:request_type] unless @configuration[:request_type].to_s.empty?
+
+          # rubocop:disable Lint/UselessAssignment
+          res = RestClient.get(
+            "#{endpoint}?#{query_string}",
+            headers = headers
+          )
+          # rubocop:enable Lint/UselessAssignment
         rescue RestClient::TooManyRequests
           if retries_left != 0
             retries_left -= 1

data/lib/storyblok/version.rb

@@ -1,4 +1,4 @@
 module Storyblok
   # Gem Version
-  VERSION = "3.1.0"
+  VERSION = "3.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storyblok
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Storyblok (Alexander Feiglstorfer)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -147,36 +147,8 @@ files:
 - ".rubocop_strict.yml"
 - ".rubocop_todo.yml"
 - Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
-- coverage/.last_run.json
-- coverage/.resultset.json
-- coverage/.resultset.json.lock
-- coverage/assets/0.10.2/application.css
-- coverage/assets/0.10.2/application.js
-- coverage/assets/0.10.2/colorbox/border.png
-- coverage/assets/0.10.2/colorbox/controls.png
-- coverage/assets/0.10.2/colorbox/loading.gif
-- coverage/assets/0.10.2/colorbox/loading_background.png
-- coverage/assets/0.10.2/favicon_green.png
-- coverage/assets/0.10.2/favicon_red.png
-- coverage/assets/0.10.2/favicon_yellow.png
-- coverage/assets/0.10.2/loading.gif
-- coverage/assets/0.10.2/magnify.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
-- coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png
-- coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png
-- coverage/index.html
 - examples/cache.rb
 - examples/example_queries.rb
 - examples/management_api.rb
@@ -206,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: storyblok

data/Gemfile.lock

@@ -1,128 +0,0 @@
-PATH
-  remote: .
-  specs:
-    storyblok (3.0.1)
-      rest-client (>= 1.8.0, < 3)
-      storyblok-richtext-renderer (>= 0.0.4, < 1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.4.7)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.9)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.4.4)
-    docile (1.4.0)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    hashdiff (1.0.1)
-    http-accept (1.7.0)
-    http-cookie (1.0.4)
-      domain_name (~> 0.5)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    json (2.6.1)
-    method_source (1.0.0)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
-    minitest (5.15.0)
-    netrc (0.11.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
-      ast (~> 2.4.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    redis (4.5.1)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (0.81.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rails (2.5.2)
-      activesupport
-      rack (>= 1.1)
-      rubocop (>= 0.72.0)
-    rubocop-rspec (1.38.1)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    storyblok-richtext-renderer (0.0.6)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.1)
-    unicode-display_width (1.7.0)
-    vcr (6.0.0)
-    webmock (3.14.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.5.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.5)
-  hashdiff (~> 1.0.1)
-  pry
-  redis
-  rspec (~> 3)
-  rubocop
-  rubocop-performance
-  rubocop-rails
-  rubocop-rspec
-  simplecov (< 0.18.0)
-  storyblok!
-  storyblok-richtext-renderer
-  vcr (= 6.0.0)
-  webmock (= 3.14.0)
-
-BUNDLED WITH
-   1.17.3

data/coverage/.last_run.json

@@ -1,5 +0,0 @@
-{
-  "result": {
-    "covered_percent": 53.06
-  }
-}