volcano-sdk 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 661418937049846fdcdec6332b897bc1b88e7359ed0b70f71e29cdd342302302
-  data.tar.gz: 6284d21cb08cdf77ea42829fe3fcefd48b3f741b9c49ad71665249a63c941e17
+  metadata.gz: e1c358710803cb0542775a53699fda168e00aa0292d6fe0861287d4175373ecb
+  data.tar.gz: a1e9f5146e6fd06d956ff7a505f391a72eef8b65cc3a4cf39ae4599a9e1346a5
 SHA512:
-  metadata.gz: 6acc1b7db432a0e7a33bffe77a8a7463e0c9b063049f0807327bcafd9e1e7f44bd2f5a973bb905705598254a2c51b5cc86abd403a357516eda3659c0a885fb6c
-  data.tar.gz: f582e4a361354e3e41a1988a423260638770543dc1c268dbb99f37d42ee7b13e2a373ae4872af7fa994a729cc33e8aaad9a1cfd3ecde8aa6b2cdf57f1f3569e9
+  metadata.gz: e5a1dd2cf0df583e5b02d954aeaaa9c63f4d122658605dbf78dac8a4d6f9fade33422742fc54c6f8dae6d22b4019d91aac73519beb2de83913bc4a27cfe160a9
+  data.tar.gz: 6939426bd9514b8fe97c8e413c61c04acb1559efbcc33afbcf8e6102ac6b09aa96ecc7369859465b1b8f897ce4fe47d8d329ea4ea6fcdaf5aeaa7f52915e444e

data/README.md

@@ -1,9 +1,23 @@
 # Volcano Ruby SDK
 
-Official Ruby SDK for Volcano. This repository is a private proof of concept;
-the gem is not published yet.
+Official Ruby SDK for Volcano. Requires Ruby 3.2 or later.
 
-## Proof-of-concept API
+## Install
+
+Add the gem to your Gemfile and run `bundle install`:
+
+```ruby
+gem "volcano-sdk"
+```
+
+Require it with `require "volcano"`. New versions publish to RubyGems
+automatically after a Release Please release PR merges and the release checks
+pass.
+
+Maintainers: see [Publishing releases](https://github.com/Kong/volcano-sdk-ruby/blob/main/PUBLISHING.md) for trusted publisher setup
+and the release procedure.
+
+## Create a client
 
 Create a client with the project URL and anonymous key from Volcano:
 
@@ -55,6 +69,17 @@ raise "session changed" unless current_session == session
 `current_session` reads immutable local state. It does not refresh or validate
 the token.
 
+Sessions returned by authentication retain the user payload in `session.user`,
+including metadata. The snapshot is deeply immutable and available without a
+request. It is cached data, not proof of authentication; use `auth.user` to fetch
+the server-validated profile. Existing three-field `Session` construction still
+works, with `user: nil`. An adopted snapshot must have the same user ID.
+Snapshots contain deeply frozen JSON data. Plain `Time` timestamps become UTC
+ISO8601 strings with nanosecond precision; symbols become strings. Custom objects,
+container/string/time subclasses, non-finite numbers, duplicate JSON keys, and
+structures deeper than 100 levels raise `TypeError`. Use the typed `auth.user`
+profile when you need Ruby `Time` values.
+
 ### Get the current user
 
 ```ruby
@@ -414,7 +439,11 @@ result = client.functions.invoke(
 puts [result.status, result.version, result.data]
 ```
 
-`invoke` resolves a DNS-safe function name and sends a JSON object. It uses the
+`invoke` resolves a DNS-safe function name and sends a JSON object. The request
+goes to the function's own domain rather than to `api_url`, so an egress rule
+that allows only the API host will block it; the resolved endpoint is cached for
+the lifetime the platform gives it. Deployments with no public function domain
+invoke through the API host instead. It uses the
 active user session when present, then a configured service key, then the
 anonymous key. An anonymous key can invoke a public function without a user
 session; the function receives no user identity. The immutable result includes

data/lib/volcano/auth.rb

@@ -86,14 +86,21 @@ module Volcano
       owned_session(
         access_token: payload.fetch('access_token'),
         refresh_token: payload.fetch('refresh_token'),
-        user_id: payload.fetch('user').fetch('id')
+        user_id: payload.fetch('user').fetch('id'),
+        user: payload.fetch('user')
       )
     end
 
     def complete_session?(session)
       return false unless session.is_a?(Session)
 
-      session.to_h.values.all? { |value| value.is_a?(String) && !value.strip.empty? }
+      values = [session.access_token, session.refresh_token, session.user_id]
+      values.all? { |value| value.is_a?(String) && !value.strip.empty? } &&
+        matching_session_user?(session)
+    end
+
+    def matching_session_user?(session)
+      session.user.nil? || (session.user.is_a?(Hash) && session.user['id'] == session.user_id)
     end
 
     def owned_complete_session(session)
@@ -102,11 +109,12 @@ module Volcano
       owned_session(**session.to_h)
     end
 
-    def owned_session(access_token:, refresh_token:, user_id:)
+    def owned_session(access_token:, refresh_token:, user_id:, user: nil)
       Session.new(
         access_token: access_token.dup.freeze,
         refresh_token: refresh_token.dup.freeze,
-        user_id: user_id.dup.freeze
+        user_id: user_id.dup.freeze,
+        user: user
       )
     end
   end

data/lib/volcano/models.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Volcano
-  Session = Data.define(:access_token, :refresh_token, :user_id)
   AUTH_SESSION_ATTRIBUTES = %i[
     id user_id provider expires_at is_active is_current user_agent ip_address last_ip_address
     last_activity_at session_started_at created_at updated_at

data/lib/volcano/session.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'time'
+
+module Volcano
+  SESSION_USER_CODER = JSON::Coder.new(freeze: true, allow_duplicate_key: false) do |value|
+    value.instance_of?(Time) ? Time.at(value.to_r).utc.iso8601(9) : value
+  end
+  private_constant :SESSION_USER_CODER
+
+  # In-memory credentials with an optional, unverified local user snapshot.
+  Session = Data.define(:access_token, :refresh_token, :user_id, :user) do
+    def initialize(access_token:, refresh_token:, user_id:, user: nil)
+      super(access_token:, refresh_token:, user_id:, user: immutable_user(user))
+    end
+
+    private
+
+    def immutable_user(value)
+      SESSION_USER_CODER.load(SESSION_USER_CODER.dump(value))
+    rescue JSON::GeneratorError, JSON::NestingError
+      raise TypeError, 'Session user snapshot must contain JSON values or timestamps', cause: nil
+    end
+  end
+end

data/lib/volcano/version.rb

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

data/lib/volcano.rb

@@ -3,6 +3,7 @@
 require_relative 'volcano/version'
 require_relative 'volcano/connection_string'
 require_relative 'volcano/models'
+require_relative 'volcano/session'
 require_relative 'volcano/function_response'
 require_relative 'volcano/log_responses'
 require_relative 'volcano/storage_models'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: volcano-sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Kong
@@ -51,6 +51,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.30.0
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -546,6 +574,7 @@ files:
 - lib/volcano/realtime/protocol_recovery_position.rb
 - lib/volcano/realtime/reconnect.rb
 - lib/volcano/redaction.rb
+- lib/volcano/session.rb
 - lib/volcano/sign_up_result.rb
 - lib/volcano/storage.rb
 - lib/volcano/storage_models.rb