univapay-client-sdk 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79defc22034350900b06cf5d1c4a3c63cdee6bed5ea4e43595685f443da6c3ca
-  data.tar.gz: 12730cd792e21693771ca200748b298096b28c659ccb49633c7e88c2ff9f15d2
+  metadata.gz: 3dad9df2de9a66d2b1dd4fba909ae6bda94459bef6d270803e1411b0a98c71ab
+  data.tar.gz: eaf97de06378b70bb1f6a9f1a1e2748688350222a5f7c8566ca064b451492b42
 SHA512:
-  metadata.gz: 8411eb3d7b92fde1d317379086a0ec13f4312508ec8b644120e65710fb654783ba43a75b4e2186f9ab20fd95f2e37908c88bd5cc38415a71e259388ba6006f0f
-  data.tar.gz: 5f23c4ac26fab020c1cf29f9f1557119460f91162b71fa50e61ed8811552d7da8f411f5bdc0c1af425e69d792bde07bc2f394b65e158f635fceaf14b63bae7d2
+  metadata.gz: 06062d75f1be86e35e936c5a9745809ecb50e215fb2beeb5bfa5973885a577e12f113545f07399a52276d006c53a53cf124794c0dde000444b2cec20822632af
+  data.tar.gz: 19d93fc64e65334d9917cb2449a96c26d0e8be08d8b132cb90a309cf5aa096ecb51a49dbf1f36b8456f61033cf0165235096125e3793d778d0447461f8b6cbb2

data/README.md

@@ -36,16 +36,16 @@ We will assume that all requests are going to originate from a backend server th
 Install the gem from the command line:
 
 ```bash
-gem install univapay-client-sdk -v 1.2.0
+gem install univapay-client-sdk -v 1.2.2
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'univapay-client-sdk', '1.2.0'
+gem 'univapay-client-sdk', '1.2.2'
 ```
 
-For additional gem details, see the [RubyGems page for the univapay-client-sdk gem](https://rubygems.org/gems/univapay-client-sdk/versions/1.2.0).
+For additional gem details, see the [RubyGems page for the univapay-client-sdk gem](https://rubygems.org/gems/univapay-client-sdk/versions/1.2.2).
 
 ## IRB Console Usage
 

data/lib/univapay_client_sdk/apis/base_api.rb

@@ -10,7 +10,7 @@ module UnivapayClientSdk
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Ruby-SDK/1.2.0 (OS: {os-info}, Engine: {engine}/{engine-version})'
+      'Ruby-SDK/1.2.2 (OS: {os-info}, Engine: {engine}/{engine-version})'
     end
 
     def self.user_agent_parameters

data/lib/univapay_client_sdk/apis/webhooks_api.rb

@@ -391,73 +391,5 @@ module UnivapayClientSdk
                                           APIException))
         .execute
     end
-
-    # Re-sends the webhook payload for a previously delivered (or failed) event.
-    # Returns 202 Accepted immediately; delivery is asynchronous.
-    # @param [UUID | String] store_id Required parameter: The unique identifier
-    # of the store.
-    # @param [UUID | String] id Required parameter: The unique identifier of the
-    # resource.
-    # @param [UUID | String] event_id Required parameter: The unique identifier
-    # of the webhook event.
-    # @param [String] idempotency_key Optional parameter: An optional
-    # idempotency key to prevent double charges and duplicate operations. We
-    # recommend a randomly generated UUID (v4).
-    # @return [ApiResponse] Complete http response with raw body and status code.
-    def redeliver_webhook_event(store_id,
-                                id,
-                                event_id,
-                                idempotency_key: nil)
-      @api_call
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/stores/{storeId}/webhooks/{id}/events/{eventId}/redeliver',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(store_id, key: 'storeId')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .template_param(new_parameter(id, key: 'id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .template_param(new_parameter(event_id, key: 'eventId')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('JWT_TOKEN')))
-        .response(new_response_handler
-                    .deserializer(APIHelper.method(:json_deserialize))
-                    .is_api_response(true)
-                    .local_error_template('401',
-                                          'HTTP 401 Unauthorized: {$response.body#/code}',
-                                          ApiErrorException)
-                    .local_error_template('403',
-                                          'HTTP 403 Forbidden: {$response.body#/code}',
-                                          ApiErrorException)
-                    .local_error_template('404',
-                                          'HTTP 404 Not Found: {$response.body#/code}',
-                                          ApiErrorException)
-                    .local_error_template('400',
-                                          'HTTP 400 Bad Request: {$response.body#/code}',
-                                          APIException)
-                    .local_error_template('409',
-                                          'HTTP 409 Conflict: {$response.body#/code}',
-                                          APIException)
-                    .local_error_template('429',
-                                          'HTTP 429 Rate Limited: {$response.body#/code}',
-                                          APIException)
-                    .local_error_template('500',
-                                          'HTTP 500 Server Error: {$response.body#/code}',
-                                          APIException)
-                    .local_error_template('503',
-                                          'HTTP 503 Unavailable: {$response.body#/code}',
-                                          APIException)
-                    .local_error_template('504',
-                                          'HTTP 504 Timeout: {$response.body#/code}',
-                                          APIException)
-                    .local_error_template('default',
-                                          'HTTP {$statusCode}: {$response.body#/code}',
-                                          APIException))
-        .execute
-    end
   end
 end

data/lib/univapay_client_sdk/extensions.rb

@@ -230,6 +230,30 @@ module UnivapayClientSdk
       value = payload[claim]
       value.is_a?(String) && UUID_PATTERN.match?(value) ? value : nil
     end
+
+    # Asserts that a store id was resolvable from the configured app token.
+    #
+    # Named and shaped to match `AppJwt.requireStoreId` in the Java and PHP
+    # SDKs, `RequireStoreId` in the C# one and `requireStoreId` in the
+    # TypeScript and Python ones, so the guard reads the same in every language.
+    # Returning the id (rather than fetching on the caller's behalf) keeps the
+    # check ahead of every side effect.
+    #
+    # @param store_id [String, nil] The store id read from the token, or nil.
+    # @return [String] store_id, when it is present.
+    # @raise [RuntimeError] When it is not -- before any request is built, so a
+    #   missing id can never reach the request path.
+    def self.require_store_id(store_id)
+      return store_id unless store_id.nil?
+
+      # Says nothing about the token itself: the credential and its claims must
+      # never reach an error message or a log. A merchant-level token reaching
+      # here is not a broken token -- it is simply not scoped to a store.
+      raise 'get_charge(charge_id) requires a store-level App Token: the ' \
+            'configured token carries no usable "store_id" claim. Use a ' \
+            'store-level App Token, or call get_charge(store_id, charge_id) ' \
+            'on charges with an explicit store id.'
+    end
   end
 
   # Reopened onto the generated client class to expose the app token's context.
@@ -259,6 +283,30 @@ module UnivapayClientSdk
       AppJwt.read_uuid_claim(jwt_token_or_nil, 'store_id')
     end
 
+    # Retrieves a charge without being given a store id.
+    #
+    # `/stores/{storeId}/charges/{id}` needs a store, which callers would
+    # otherwise have to persist alongside every charge id -- but a store-level
+    # app token already carries one, so this reads it from the configured token
+    # and then behaves exactly like `charges.get_charge`.
+    #
+    # Raises before any request is built when the configured token carries no
+    # `store_id` claim -- a merchant-level token, or none at all. With a
+    # merchant-level token, resolve the store yourself (see `stores`) and call
+    # `charges.get_charge` with it.
+    #
+    # @param charge_id [String] The unique identifier of the charge.
+    # @param polling [Boolean, nil] If true, instructs the API to internally
+    #   poll the charge status until it leaves 'pending'.
+    # @return The controller's response, untouched.
+    # @raise [RuntimeError] When the token carries no usable `store_id` claim.
+    def get_charge(charge_id, polling: nil)
+      # Guard first, controller second: nothing is built and no request is made
+      # until a store id is known to exist.
+      store_id = AppJwt.require_store_id(get_current_store_id)
+      charges.get_charge(store_id, charge_id, polling: polling)
+    end
+
     private
 
     # The configured JWT, or nil when no credentials are set.

data/lib/univapay_client_sdk/models/merchant.rb

@@ -39,7 +39,7 @@ module UnivapayClientSdk
     # @return [TrueClass | FalseClass]
     attr_accessor :verified
 
-    # Merchant configuration snapshot serialized by gyron-payments-api.
+    # Merchant configuration snapshot as serialized by the backend.
     # @return [MerchantWebhookConfiguration]
     attr_accessor :configuration
 

data/lib/univapay_client_sdk/models/merchant_webhook_configuration.rb

@@ -4,7 +4,7 @@
 # by APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module UnivapayClientSdk
-  # Merchant configuration object serialized by gyron-payments-api.
+  # Merchant configuration object as serialized by the backend.
   class MerchantWebhookConfiguration < BaseModel
     SKIP = Object.new
     private_constant :SKIP

data/lib/univapay_client_sdk/models/store.rb

@@ -24,8 +24,8 @@ module UnivapayClientSdk
     # @return [DateTime]
     attr_accessor :created_on
 
-    # Store-scoped configuration snapshot serialized by gyron-payments-api. It
-    # uses the same flattened serializer as merchant configuration, but omits
+    # Store-scoped configuration snapshot as serialized by the backend. It uses
+    # the same flattened serializer as merchant configuration, but omits
     # `transfer_schedule`.
     # @return [MerchantWebhookConfiguration]
     attr_accessor :configuration

data/test/apis/test_webhooks_api.rb

@@ -212,34 +212,4 @@ class WebhooksApiTest < ApiTestBase
     assert(ComparisonHelper.match_body(expected_body, received_body))
   end
 
-  # Re-sends the webhook payload for a previously delivered (or failed) event. Returns 202 Accepted immediately; delivery is asynchronous.
-  def test_redeliver_webhook_event
-    # Parameters for the API call
-    store_id = '0cab399b-5621-425b-993b-f8507eba1e78'
-    id = 'c4e87129-cad4-47fb-8ded-b4c0a4ae0dd4'
-    event_id = 'e1f2a3b4-c5d6-7890-efab-123456789cde'
-    idempotency_key = 'f64be872-353d-4c3c-84cb-3dc617fe89f7'
-
-    # Perform the API call through the SDK function
-    result = @controller.redeliver_webhook_event(
-      store_id, id, event_id, idempotency_key: idempotency_key
-    )
-
-    # Test response code
-    assert_equal(202, @response_catcher.response.status_code)
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = 'application/json; charset=utf-8'
-
-    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
-
-    # Test whether the captured response is as we expected
-    refute_nil(result)
-    expected_body = JSON.parse(
-      '{}'
-    )
-    received_body = JSON.parse(@response_catcher.response.raw_body)
-    assert(ComparisonHelper.match_body(expected_body, received_body))
-  end
-
 end

data/test/test_client_get_charge.rb

@@ -0,0 +1,154 @@
+# Custom test (not auto-generated): pins get_charge(charge_id) -- the
+# store-scoped convenience call that reads the store id from the configured App
+# Token instead of making the caller pass (and persist) one.
+#
+# Two things are guarded here.
+#
+# First the *guard*: when the configured token carries no usable store_id, the
+# call must fail before a request is built. Interpolating a missing id would
+# send GET /stores//charges/{id} -- a confusing 4xx instead of a clear
+# client-side failure -- so the failure cases assert not just the raise but that
+# the controller was never reached.
+#
+# Second the *delegation*: on the happy path this must behave exactly like
+# charges.get_charge(store_id, charge_id, polling:), forwarding every argument
+# and returning the response untouched. Anything else and the shortcut would be
+# a second, subtly different way to fetch a charge.
+#
+# Everything here is synthetic and offline -- no network, no environment, no
+# real credential. Note the SDK test harness injects JWT_TOKEN=test-jwt, which
+# is not a JWT at all, so a test resting on an env-built client would silently
+# exercise only the failure path. Hence the locally built clients.
+#
+# Seven SDKs are expected to share this contract; keep the case table aligned
+# when porting.
+
+require 'base64'
+require 'json'
+require 'minitest/autorun'
+require 'univapay_client_sdk'
+
+class ClientGetChargeTest < Minitest::Test
+  include UnivapayClientSdk
+
+  MERCHANT_ID = '11ec8e24-0ecf-2c5a-923c-331b915dc311'.freeze
+  STORE_ID = '11ec8e24-b133-6c68-b54d-971717202e9b'.freeze
+  CHARGE_ID = '11ec8e24-c5f5-6f2e-b9b0-1f4d3c6a9e10'.freeze
+  RESPONSE = Object.new
+
+  # Builds a JWT carrying claims. Header and signature are inert -- nothing
+  # verifies them.
+  def jwt(claims)
+    segment = lambda do |payload|
+      Base64.urlsafe_encode64(JSON.generate(payload), padding: false)
+    end
+    "#{segment.call({ 'alg' => 'HS256', 'typ' => 'JWT' })}.#{segment.call(claims)}.c2ln"
+  end
+
+  def store_token
+    jwt('merchant_id' => MERCHANT_ID, 'store_id' => STORE_ID)
+  end
+
+  def merchant_token
+    jwt('merchant_id' => MERCHANT_ID)
+  end
+
+  def client_with(jwt_token)
+    credentials =
+      if jwt_token.nil?
+        nil
+      else
+        BearerAuthCredentials.new(secret_key: 'not-a-real-secret', jwt_token: jwt_token)
+      end
+    Client.new(bearer_auth_credentials: credentials)
+  end
+
+  # Replaces the controller call with a recorder, so no HTTP is issued.
+  def watching(client)
+    calls = []
+    controller = client.charges
+    controller.define_singleton_method(:get_charge) do |store_id, id, polling: nil|
+      calls << { store_id: store_id, id: id, polling: polling, receiver: self }
+      RESPONSE
+    end
+    calls
+  end
+
+  # ── The guard: no usable store_id ─────────────────────────────────────────
+
+  def assert_guard_trips(jwt_token)
+    client = client_with(jwt_token)
+    calls = watching(client)
+
+    assert_nil client.get_current_store_id, 'precondition: no store id in this token'
+
+    error = assert_raises(RuntimeError) { client.get_charge(CHARGE_ID) }
+    assert_includes error.message, 'store-level App Token'
+    assert_empty calls, 'no request may be built when the store id is missing'
+  end
+
+  def test_merchant_level_token_raises
+    assert_guard_trips(merchant_token)
+  end
+
+  def test_no_credentials_raises
+    assert_guard_trips(nil)
+  end
+
+  def test_malformed_token_raises
+    assert_guard_trips('not.a-jwt')
+  end
+
+  def test_non_uuid_store_id_raises
+    assert_guard_trips(jwt('merchant_id' => MERCHANT_ID, 'store_id' => 'store-1'))
+  end
+
+  def test_never_puts_the_credential_in_the_message
+    error = assert_raises(RuntimeError) { client_with(merchant_token).get_charge(CHARGE_ID) }
+
+    assert_includes error.message, 'get_charge(store_id, charge_id)'
+    refute_includes error.message, merchant_token
+    refute_includes error.message, MERCHANT_ID
+    refute_includes error.message, STORE_ID
+  end
+
+  # ── The delegation: store id taken from the token ─────────────────────────
+
+  def test_delegates_with_the_store_id_from_the_token
+    client = client_with(store_token)
+    calls = watching(client)
+
+    client.get_charge(CHARGE_ID)
+
+    assert_equal 1, calls.length
+    assert_equal STORE_ID, calls[0][:store_id]
+    assert_equal CHARGE_ID, calls[0][:id]
+    assert_nil calls[0][:polling]
+  end
+
+  def test_forwards_the_polling_flag
+    client = client_with(store_token)
+    calls = watching(client)
+
+    client.get_charge(CHARGE_ID, polling: true)
+
+    assert_equal true, calls[0][:polling]
+  end
+
+  def test_returns_the_controller_response_untouched
+    client = client_with(store_token)
+    watching(client)
+
+    assert_same RESPONSE, client.get_charge(CHARGE_ID)
+  end
+
+  def test_reuses_one_controller_across_calls
+    client = client_with(store_token)
+    calls = watching(client)
+
+    client.get_charge(CHARGE_ID)
+    client.get_charge(CHARGE_ID)
+
+    assert_same calls[0][:receiver], calls[1][:receiver]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: univapay-client-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Univapay Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-19 00:00:00.000000000 Z
+date: 2026-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -433,6 +433,7 @@ files:
 - test/framework_integrations/webhooks/test/test_sinatra_charge_app.rb
 - test/http_response_catcher.rb
 - test/test_app_jwt.rb
+- test/test_client_get_charge.rb
 homepage: https://univapay.com
 licenses:
 - MIT