volcano-sdk 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47568709329b06a2dd8a84c4ab0058accc47d749d6cc773de6a87c0fc08a6ce1
-  data.tar.gz: d9685709f29037f6db0c5598bae32a84537500f2025337dbf6497a729a315774
+  metadata.gz: e946d4476603cf2c234194f51e63aadd8ca1327719bcae02bf098de61049b65b
+  data.tar.gz: 38d3aa7dbbc508796620f75285b2a483b70a9e2d49a255aded0dba3fa023334b
 SHA512:
-  metadata.gz: 776a324b0d6330c0152e4ef6f46f87d4145f5605c8ed9c4f1fbe648418b8d806e67c668af5f1d41e75ecd5825aa58b4b8d894cb6941c75413f3991153e021f84
-  data.tar.gz: 2b3a2bc60a3cd4e77c32c08f44fc2c8529cc886688381eec5abcdb8ca6bd4f2160fa8bddbfba75544fd865b99b44160a055fece6b65f78c4c6ca1fd79a8bddaf
+  metadata.gz: 014b16629b5d06e89d39f010b1c8cb550582f3f7f224b6c6911324c6b2b07196eed9729305c2edd623d6fbedb2ba12a9460d4d128bda61202c9c88874823fada
+  data.tar.gz: d98691e237fd5cdb277f701701e3549aa6e533179d36c0039e188a66143fe5992a1ac9565f210304704838d2e855a9512e9e2e60de7ec0b2abfa9a8a30ae4cb2

data/lib/volcano/generated_transport.rb

@@ -52,7 +52,9 @@ module Volcano
       invoke do
         apis = @api_factory.call(authorization)
         body = Generated::ProjectLockLeaseRequest.new(ttl_seconds: ttl)
-        result = apis.locks.acquire_project_lock_with_http_info(key, token, request_id, body)
+        result = apis.locks.acquire_project_lock_with_http_info(
+          key, token, request_id, body, debug_return_type: 'Object'
+        )
         data, status, headers = result
         response(data, status, headers)
       end
@@ -63,7 +65,8 @@ module Volcano
         apis = @api_factory.call(authorization)
         data, status, headers = apis.locks.get_project_lock_with_http_info(
           key,
-          request_id
+          request_id,
+          debug_return_type: 'Object'
         )
         response(data, status, headers)
       end
@@ -85,7 +88,7 @@ module Volcano
         apis = @api_factory.call(authorization)
         body = Generated::ProjectLockLeaseRequest.new(ttl_seconds: ttl)
         result = apis.locks.renew_project_lock_with_http_info(
-          key, token, request_id, body
+          key, token, request_id, body, debug_return_type: 'Object'
         )
         data, status, headers = result
         response(data, status, headers)

data/lib/volcano/lock_response.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Volcano
+  # Validates lock response fields before creating public records.
+  module LockResponse
+    private
+
+    def parse_time(value)
+      return Time.iso8601(value) if value.is_a?(String)
+      return value if value.nil? || value.is_a?(Time)
+
+      raise Error::TransportError, 'invalid lock expiry'
+    rescue ArgumentError => e
+      raise Error::TransportError, 'invalid lock expiry', cause: e
+    end
+
+    def required_time(value)
+      parse_time(value) || raise(Error::TransportError, 'invalid lock expiry')
+    end
+
+    def lock_payload(body)
+      raise Error::TransportError, 'invalid lock response' unless body.is_a?(Hash)
+
+      body
+    end
+
+    def lock_held(value)
+      return true if value == true
+      return false if value == false
+
+      raise Error::TransportError, 'invalid lock held flag'
+    end
+
+    def required_fencing_token(value)
+      raise Error::TransportError, 'invalid lock fencing token' unless value.is_a?(Integer)
+
+      value
+    end
+
+    def optional_fencing_token(value)
+      return if value.nil?
+
+      required_fencing_token(value)
+    end
+  end
+end

data/lib/volcano/locks.rb

@@ -7,6 +7,7 @@ module Volcano
   # Acquires and releases project-scoped distributed locks.
   class Locks
     include LockAutoRenewal
+    include LockResponse
 
     def initialize(client, transport)
       @client = client
@@ -14,80 +15,103 @@ module Volcano
     end
 
     def get(key, request_id: nil)
-      payload = lock_request(:get_project_lock, 200, key: key, request_id: request_id)
-      LockState.new(
-        held: payload.fetch('held'),
-        expires_at: parse_time(payload['expires_at']),
-        fencing_token: payload['fencing_token']
-      )
+      payload = lock_payload(perform_request(200) do
+        @transport.get_project_lock(
+          authorization: @client.service_token, key: key, request_id: request_uuid(request_id, 'request_id')
+        )
+      end)
+      build_state(payload)
     end
 
     def acquire(key, ttl:, token: nil, request_id: nil)
       validate_ttl(ttl)
-      parameters = {
-        authorization: @client.service_token.dup.freeze, key: key.dup.freeze,
-        ttl: ttl, token: request_uuid(token, 'token'), request_id: request_uuid(request_id, 'request_id')
-      }.freeze
-      payload = acquire_payload(parameters)
-      build_lease(parameters[:key], parameters[:token], payload)
+      authorization = @client.service_token.dup.freeze
+      owned_key = key.dup.freeze
+      owned_token = request_uuid(token, 'token')
+      owned_request_id = request_uuid(request_id, 'request_id')
+      payload = acquire_payload(
+        authorization: authorization, key: owned_key, ttl: ttl, token: owned_token, request_id: owned_request_id
+      )
+      build_lease(owned_key, owned_token, payload)
     end
 
     def renew(key, lease, ttl:, request_id: nil)
       validate_ttl(ttl)
-      payload = lock_request(:renew_project_lock, 200, key: key, ttl: ttl,
-                                                       token: lease.token, request_id: request_id)
+      payload = lock_payload(perform_request(200) do
+        @transport.renew_project_lock(
+          authorization: @client.service_token, key: key, ttl: ttl,
+          token: lease.token, request_id: request_uuid(request_id, 'request_id')
+        )
+      end)
       build_lease(key, lease.token, payload)
     end
 
     def release(key, lease, request_id: nil)
-      lock_request(:release_project_lock, 204, key: key, token: lease.token, request_id: request_id)
+      perform_request(204) do
+        @transport.release_project_lock(
+          authorization: @client.service_token, key: key, token: lease.token,
+          request_id: request_uuid(request_id, 'request_id')
+        )
+      end
       nil
     end
 
     def force_release(key, request_id: nil)
-      lock_request(:force_release_project_lock, 204, key: key, request_id: request_id)
+      perform_request(204) do
+        @transport.force_release_project_lock(
+          authorization: @client.service_token, key: key, request_id: request_uuid(request_id, 'request_id')
+        )
+      end
       nil
     end
 
     private
 
-    def acquire_payload(parameters)
-      perform_request(:acquire_project_lock, 201, parameters)
+    def acquire_payload(authorization:, key:, ttl:, token:, request_id:)
+      lock_payload(perform_request(201) do
+        @transport.acquire_project_lock(authorization: authorization, key: key, ttl: ttl,
+                                        token: token, request_id: request_id)
+      end)
     rescue Error::TransportError, Error::ServerError => e
       raise unless e.status.nil? || e.status == 503
 
-      perform_request(:acquire_project_lock, 201, parameters)
-    end
-
-    def lock_request(operation, status, **parameters)
-      parameters[:authorization] = @client.service_token
-      parameters[:request_id] = request_uuid(parameters[:request_id], 'request_id')
-      perform_request(operation, status, parameters)
+      lock_payload(perform_request(201) do
+        @transport.acquire_project_lock(authorization: authorization, key: key, ttl: ttl,
+                                        token: token, request_id: request_id)
+      end)
     end
 
-    def perform_request(operation, status, parameters)
-      response = Transport.invoke { @transport.public_send(operation, **parameters) }
+    def perform_request(status, &)
+      response = Transport.invoke(&)
       Transport.body(response, status)
     end
 
     def request_uuid(value, name)
       return SecureRandom.uuid.freeze if value.nil?
 
-      valid = value.is_a?(String) && value.match?(/\A[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}\z/i)
-      raise ArgumentError, "#{name} must be a UUID string" unless valid
+      unless value.is_a?(String) && value.match?(/\A[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}\z/i)
+        raise ArgumentError, "#{name} must be a UUID string"
+      end
 
       value.dup.freeze
     end
 
     def build_lease(key, token, payload)
       LockLease.new(
-        key: key, token: token, expires_at: parse_time(payload['expires_at']),
-        fencing_token: payload['fencing_token']
+        key: key, token: token, expires_at: required_time(payload['expires_at']),
+        fencing_token: required_fencing_token(payload['fencing_token'])
       )
     end
 
-    def parse_time(value)
-      value.is_a?(String) ? Time.iso8601(value) : value
+    def build_state(payload)
+      held = lock_held(payload['held'])
+      expiry = held ? required_time(payload['expires_at']) : parse_time(payload['expires_at'])
+      fencing = if held
+                  required_fencing_token(payload['fencing_token'])
+                else
+                  optional_fencing_token(payload['fencing_token'])
+                end
+      LockState.new(held: held, expires_at: expiry, fencing_token: fencing)
     end
   end
 end

data/lib/volcano/version.rb

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

data/lib/volcano.rb

@@ -50,6 +50,7 @@ require_relative 'volcano/lock_guard'
 require_relative 'volcano/lock_renewer'
 require_relative 'volcano/lock_session'
 require_relative 'volcano/lock_auto_renewal'
+require_relative 'volcano/lock_response'
 require_relative 'volcano/locks'
 require_relative 'volcano/realtime/protocol'
 require_relative 'volcano/realtime'
@@ -57,7 +58,7 @@ require_relative 'volcano/client'
 
 # Public namespace for the Volcano Ruby SDK.
 module Volcano
-  private_constant :GeneratedTransport, :LockAutoRenewal, :LockLeaseClock, :LockRenewer, :LockSession,
+  private_constant :GeneratedTransport, :LockAutoRenewal, :LockLeaseClock, :LockRenewer, :LockSession, :LockResponse,
                    :Redaction, :SessionOperations
 
   Realtime.private_constant :Protocol, :ProtocolDispatch, :ProtocolPublicationDispatch, :ProtocolRecovery,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: volcano-sdk
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Kong
@@ -560,6 +560,7 @@ files:
 - lib/volcano/lock_guard.rb
 - lib/volcano/lock_lease_clock.rb
 - lib/volcano/lock_renewer.rb
+- lib/volcano/lock_response.rb
 - lib/volcano/lock_session.rb
 - lib/volcano/locks.rb
 - lib/volcano/log_responses.rb