volcano-sdk 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36dee9d50b8138335752de5e3fdb5007ecd5dfa66547150190de691a048052d
-  data.tar.gz: 97edb400526abafd980ec19278304f80cff3ead5010d7704da7b55128390879e
+  metadata.gz: b992adf24aad6b7edea16323e1f9b21c8db08cefe1380cffaf12c99ed436baf4
+  data.tar.gz: 3770340779a1a5cf0b985b6290a185223632f85863e56ab33c4f8f443ce02f0e
 SHA512:
-  metadata.gz: 5c3e7ed134b563780e8c1d64ba26f30f7ae9563d7c2ac219a265dabbf6aa04544600ef1a963abd09f9aa3f4efc2a6e32da0adeaf9a2a45905bd793daffd4101d
-  data.tar.gz: c2abfe5361e2ccff60f6f76a77aa4e2eedc0a033d1ef7649a63c5a6fa8f1edf0996c8141cc5eede6c08e5848e24fa8159e5a550b12edc5a32d16ea6dbf4311aa
+  metadata.gz: 8bd2583130b36e6ede81cdb096cfe97cff10aa9aebe8fb086cff5dd1d13c8883f6bc196b9d528c4e437fb7533df568aab7fce759d0a79f134983b825b730f9d7
+  data.tar.gz: d5118276bfe5a10d157e637643827a07586cba53d632b5f966501f3ffa9bf5562c1d1a682d8286026f0109f77b19cf701cd3a536d0fc419badf7e34e8d9f3a89

data/README.md

@@ -2,6 +2,8 @@
 
 Official Ruby SDK for Volcano. Requires Ruby 3.2 or later.
 
+Start with the [Ruby quickstart](https://github.com/Kong/volcano-sdk-ruby/blob/main/docs/README.md).
+
 ## Install
 
 Add the gem to your Gemfile and run `bundle install`:
@@ -487,7 +489,8 @@ syntax. Both methods require an active user session.
 rows = client.database("main").from("items").select("*").eq("slug", "a").execute
 ```
 
-Database selects, inserts, updates, deletes, and log reads refresh the captured
+Database selects, inserts, updates, deletes, log reads, and authenticated storage
+requests (including upload sessions and parts) refresh the captured
 session after an HTTP 401 and retry the same request once. Concurrent requests reuse a successful
 refresh for that session.
 Replacing or signing out the session before replay, or while replay is in flight,

data/lib/volcano/auth_anonymous.rb

@@ -13,14 +13,12 @@ module Volcano
     end
 
     def convert_anonymous(email:, password:, metadata: {})
-      generation, current = @client.capture_session
-      raise Error::AuthenticationError, 'No active session' unless current
-
-      payload = Transport.body(
-        anonymous_conversion_response(current.access_token, email, password, metadata),
-        200
-      )
-      cache_current_user(payload, generation)
+      profile_request do
+        request_email = email.dup.freeze
+        request_password = password.dup.freeze
+        request_metadata = JSON.parse(JSON.generate(Hash(metadata)), freeze: true)
+        ->(token) { anonymous_conversion_response(token, request_email, request_password, request_metadata) }
+      end
     end
 
     private

data/lib/volcano/auth_email_change.rb

@@ -26,11 +26,10 @@ module Volcano
     end
 
     def confirm_email_change(token:)
-      generation, current = @client.capture_session
-      raise Error::AuthenticationError, 'No active session' unless current
-
-      payload = Transport.body(confirm_email_change_response(current.access_token, token), 200)
-      cache_current_user(payload, generation)
+      profile_request do
+        request_token = token.dup.freeze
+        ->(access_token) { confirm_email_change_response(access_token, request_token) }
+      end
     end
 
     private

data/lib/volcano/auth_get_user.rb

@@ -15,17 +15,22 @@ module Volcano
                      :USER_OPTIONAL_VALUES, :USER_STATUSES, :USER_TIMESTAMPS
 
     def user
-      generation, current = @client.capture_session
-      raise Error::AuthenticationError, 'No active session' unless current
-
-      payload = Transport.body(get_user_response(current.access_token), 200)
-      cache_current_user(payload, generation)
+      profile_request { method(:get_user_response) }
     end
 
     alias get_user user
 
     private
 
+    def profile_request
+      binding = @client.capture_session_binding
+      raise Error::AuthenticationError, 'No active session' unless binding.last
+
+      request = yield
+      payload = Transport.body(session_request(binding: binding, &request), 200)
+      cache_current_user(payload, owned_session_binding(binding).first)
+    end
+
     def cache_current_user(payload, generation)
       profile = user_payload(payload)
       user = build_user(profile)

data/lib/volcano/auth_refresh.rb

@@ -10,10 +10,10 @@ module Volcano
       refresh_captured_session(binding)
     end
 
-    def session_request
-      binding = @client.capture_session_binding
+    def session_request(binding: @client.capture_session_binding)
       raise Error::AuthenticationError, 'No active session' unless binding.last
 
+      binding = owned_session_binding(binding)
       response = yield(binding.last.access_token)
       return response unless response.status == 401
 
@@ -65,10 +65,10 @@ module Volcano
       active = @client.capture_session_binding
       raise Error::AuthenticationError, 'No active session' if rejected_refresh?(binding, active)
 
-      generation, active_lineage, current = active
+      _, active_lineage, current = active
       raise Error::SessionChangedError unless current && active_lineage == binding[1]
 
-      [generation, current]
+      active
     end
 
     def rejected_refresh?(binding, active)

data/lib/volcano/auth_update_user.rb

@@ -4,14 +4,11 @@ module Volcano
   # Current-user update behavior for the authentication facade.
   class Auth
     def update_user(password: nil, metadata: nil)
-      generation, current = @client.capture_session
-      raise Error::AuthenticationError, 'No active session' unless current
-
-      payload = Transport.body(
-        update_user_response(current.access_token, password:, metadata:),
-        200
-      )
-      cache_current_user(payload, generation)
+      profile_request do
+        request_password = password&.dup&.freeze
+        request_metadata = metadata.nil? ? nil : JSON.parse(JSON.generate(Hash(metadata)), freeze: true)
+        ->(token) { update_user_response(token, password: request_password, metadata: request_metadata) }
+      end
     end
 
     private

data/lib/volcano/client.rb

@@ -49,8 +49,8 @@ module Volcano
       session.access_token
     end
 
-    def session_request(&)
-      @auth.session_request(&)
+    def session_request(...)
+      @auth.session_request(...)
     end
 
     alias session_read session_request

data/lib/volcano/storage.rb

@@ -28,7 +28,7 @@ module Volcano
     def initialize(client, transport, name, api_url:, anon_key:)
       @client = client
       @transport = transport
-      @name = name
+      @name = name.dup.freeze
       @api_url = api_url.dup.freeze
       @anon_key = anon_key.dup.freeze
       freeze
@@ -36,12 +36,16 @@ module Volcano
 
     def upload(path, value, content_type: nil)
       mime_type = upload_content_type(content_type)
-      response = Transport.invoke do
+      path = storage_paths(path).first
+      binding = @client.capture_session_binding
+      @client.session_token
+      content = upload_bytes(value).freeze
+      response = storage_request(binding: binding) do |token|
         @transport.upload_storage_object(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           path: path,
-          data: upload_bytes(value),
+          data: content,
           content_type: mime_type
         )
       end
@@ -49,9 +53,11 @@ module Volcano
     end
 
     def download(path, range: nil)
-      response = Transport.invoke do
+      path = storage_paths(path).first
+      range = range&.dup&.freeze
+      response = storage_request do |token|
         @transport.download_storage_object(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           path: path,
           byte_range: range
@@ -63,9 +69,11 @@ module Volcano
     end
 
     def list(prefix = '', limit: nil, cursor: nil)
-      response = Transport.invoke do
+      prefix = prefix.dup.freeze
+      cursor = cursor&.dup&.freeze
+      response = storage_request do |token|
         @transport.list_storage_objects(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           prefix: prefix,
           limit: limit,
@@ -82,6 +90,10 @@ module Volcano
 
     private
 
+    def storage_request(binding: @client.capture_session_binding)
+      @client.session_request(binding: binding) { |token| Transport.invoke { yield(token) } }
+    end
+
     def upload_content_type(value)
       return if value.nil?
       return value.dup.freeze if value.is_a?(String) && value.match?(/\A[\x20-\x7e]+\z/) && !value.strip.empty?

data/lib/volcano/storage_mutations.rb

@@ -5,16 +5,16 @@ module Volcano
   class StorageBucket
     def remove(paths)
       deleted = storage_paths(paths)
-      authorization = @client.session_token
-      deleted.each { |path| delete_path(path, authorization) }
+      binding = @client.capture_session_binding
+      deleted.each { |path| delete_path(path, binding) }
       deleted
     end
 
     def move(from_path, to_path)
       source, destination = storage_paths([from_path, to_path])
-      response = Transport.invoke do
+      response = storage_request do |token|
         @transport.move_storage_object(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           from_path: source,
           to_path: destination
@@ -25,9 +25,9 @@ module Volcano
 
     def copy(from_path, to_path)
       source, destination = storage_paths([from_path, to_path])
-      response = Transport.invoke do
+      response = storage_request do |token|
         @transport.copy_storage_object(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           from_path: source,
           to_path: destination
@@ -39,9 +39,9 @@ module Volcano
     def update_visibility(path, public:)
       object_path = storage_paths(path).fetch(0)
       visibility = visibility_value(public)
-      response = Transport.invoke do
+      response = storage_request do |token|
         @transport.update_storage_object_visibility(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           path: object_path,
           is_public: visibility
@@ -61,10 +61,10 @@ module Volcano
       path_list.map { |path| path.dup.freeze }.freeze
     end
 
-    def delete_path(path, authorization)
-      response = Transport.invoke do
+    def delete_path(path, binding)
+      response = storage_request(binding: binding) do |token|
         @transport.delete_storage_object(
-          authorization: authorization,
+          authorization: token,
           bucket_name: @name,
           path: path
         )

data/lib/volcano/storage_upload_sessions.rb

@@ -15,9 +15,9 @@ module Volcano
         total_size: total_size,
         part_size: part_size
       )
-      response = Transport.invoke do
+      response = storage_request do |token|
         @transport.create_upload_session(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           request: request
         )
@@ -32,9 +32,9 @@ module Volcano
         part_number: part_number,
         data: upload_bytes(data)
       )
-      response = Transport.invoke do
+      response = storage_request do |token|
         @transport.upload_part(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           request: request
         )
@@ -44,9 +44,9 @@ module Volcano
 
     def complete_upload_session(path, session_id:)
       request = UploadSessionReference.new(path: path, session_id: session_id)
-      response = Transport.invoke do
+      response = storage_request do |token|
         @transport.complete_upload_session(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           request: request
         )
@@ -56,9 +56,9 @@ module Volcano
 
     def get_upload_session(path, session_id:)
       request = UploadSessionReference.new(path: path, session_id: session_id)
-      response = Transport.invoke do
+      response = storage_request do |token|
         @transport.get_upload_session(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           request: request
         )
@@ -68,9 +68,9 @@ module Volcano
 
     def abort_upload_session(path, session_id:)
       request = UploadSessionReference.new(path: path, session_id: session_id)
-      response = Transport.invoke do
+      response = storage_request do |token|
         @transport.abort_upload_session(
-          authorization: @client.session_token,
+          authorization: token,
           bucket_name: @name,
           request: request
         )

data/lib/volcano/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Volcano
-  VERSION = '0.7.0'
+  VERSION = '0.7.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: volcano-sdk
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Kong