storyblok 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63796aff8477f2b79ef4324fba6b7f8047afc427d40fdb94bc654da62104b233
-  data.tar.gz: 59a2d5e72ab9f5ed341517e6699f1f91724b6e1195a91fcb1624e2781961493e
+  metadata.gz: ff2b96538cd2959b1a5f3e75a8fe05698875a8daea71fe5ddcf703206fc1efa2
+  data.tar.gz: c2c68e5926b227fb615311fe27da54f710b607cd9ab1282808219522ccbb4777
 SHA512:
-  metadata.gz: 36835f923209b8ee31ad737899676f3e380dfdad681b1cdb748dc096df910b14dcdf0a344ef2bca4bb41cc9eb5d3949e4adfac33e4c8dbf8d7ab5f4b437af7cb
-  data.tar.gz: 36fcccbf5de2048faf484c30c3157463c229cf1f03d5a847816611e43267ea1aeb3e4c8bd5898584562091a288acfb70b2ea088d015fa81848ddd0187d240cdf
+  metadata.gz: 54f690a2d6e335334dbaf384576023b5d8571100ad9ba6df9f4187adb9ff87bc5b2fc2f4268314e7f8348ae956727c94c95af5fc1ddebadf70f87d1a5f3a399c
+  data.tar.gz: 319006f9bd1f30487135838e120815d85350e06b49cdbae82190736aeba130a6c2fb35186b27149a24d72f6265695b8ba250842fc3db9fbb9bbf55b7fa143626

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,7 +34,8 @@ 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'
@@ -238,13 +240,17 @@ module Storyblok
         retries_left = 3
 
         begin
+          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={
-              'SB-Agent-Version': Storyblok::VERSION,
-              'SB-Agent': 'SB-RB'
-            }
+            headers = headers
           )
           # rubocop:enable Lint/UselessAssignment
         rescue RestClient::TooManyRequests

data/lib/storyblok/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storyblok
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Storyblok (Alexander Feiglstorfer)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -147,6 +147,7 @@ files:
 - ".rubocop_strict.yml"
 - ".rubocop_todo.yml"
 - Gemfile
+- LICENSE
 - README.md
 - examples/cache.rb
 - examples/example_queries.rb
@@ -177,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