abacatepay-ruby 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65f1214bed1683aa366b68ef9055d85a318ca11901f90c36669fb3202c0b9be5
-  data.tar.gz: 0f1374d3702f53204228345237a8072a23918151cb3e2b9d13bd374b558cb04a
+  metadata.gz: 6049a0d508a75825d5bd94835dd27ec3241a0040129299165cb122de1af4636c
+  data.tar.gz: 8d2e2a858ac296de096f69ebf9acbab31c220d127631bd7a9534f30aa5caf5a7
 SHA512:
-  metadata.gz: de8e7e809c16a249b698f02ed6d7f5eb0d1df24e6e2cab086f32a49fe90c818665a31c1cd642fae49f9a57174482470d64ec681ee99a55cb35e400d2d9fa6188
-  data.tar.gz: 22fd62f1e9e223d5d2e956c466b1d9de1d6128930d3b8651f4c72369e5827596e3a46c4c30db5171673eee95dd1bce49ef16a1739a351c64f1c73babeb37ff8a
+  metadata.gz: 7733ebca9a9176869461cdbf726933ff32836f8953df5cd4a4a4c64c1021261c0ec6d5a75e753b382071f68b93928a928db8364c0dc280e050aed59a0b9a534e
+  data.tar.gz: f90e64c56b1681d41ee820ba3ba05e9e7fa0b9ff61afd2d9adf1daf8d6debf68d62f9865f49f5d956744843f1eb51fecc9cfbc49146a7717c7bbbf7a39a7d078

data/.rubocop.yml

@@ -134,6 +134,7 @@ RSpec/DescribeClass:
     - "spec/clients/logging_spec.rb"
     - "spec/clients/boleto_spec.rb"
     - "spec/packaging_spec.rb"
+    - "spec/api_conformance_spec.rb"
 
 # `has_more?` mirrors the API's own `hasMore` field and matches the convention
 # other payment SDKs use for cursor pagination. `more?` would read as a

data/CHANGELOG.md

@@ -7,6 +7,53 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.2] - 2026-08-06
+
+Found by exercising all 39 public calls against the live sandbox.
+
+### Fixed
+
+- **`customers.delete`, `products.delete` and `coupons.delete` always failed.**
+  Every delete endpoint reads the id from the query string; sending it only in
+  the body fails with "Expected property 'id' to be string but found:
+  undefined". Same defect as `webhook_endpoints.delete`.
+- **`pix.send_pix` and `payouts.create` always failed.** The API nests the
+  destination under `pix` as `{ key, type }`. The SDK sent `key`/`keyType` at
+  the top level, which fails with "Property 'pix' is missing". `Payouts` gained
+  `pix_key` and `pix_key_type`, without which a payout has no destination at
+  all.
+- **`subscriptions.create` always failed.** Line items take the product `id`,
+  the same shape checkouts use; the SDK sent `externalId`, which fails with
+  "Expected property 'items.0.id' to be string".
+- **Parsing a response could crash on a value the SDK did not know.**
+  `initialize_enum` validated while reading API responses, so any status
+  AbacatePay introduced turned into an `ArgumentError` inside `list` and `get`
+  for every integration at once. It happened with the coupon status `DISABLED`
+  and the payment-link status `ACTIVE`, which made `coupons.toggle` and
+  `payment_links.create` fail outright. Unknown values now pass through with a
+  warning; use the enum's `validate!` when you want a hard failure on a value
+  you are about to send.
+- **`Coupons#code` and `#current_redeems` were always nil.** The API uses the
+  coupon code as the object's `id` and sends the counter as `redeemsCount`.
+  Adds `redeems_count`, `notes` and `dev_mode?`; `code` falls back to the id
+  and `current_redeems` keeps answering.
+- **`webhook_endpoints.delete` always failed.** The API reads the id from the
+  query string on that endpoint, and answers `{"success":true,"error":null}`
+  with no `data` key, which the SDK then rejected as malformed. A successful
+  response carrying no payload is no longer an error.
+- Building a resource from an empty payload raised `NoMethodError`.
+
+### Added
+
+- `webhook_endpoints.create` refuses a secret shorter than 32 characters
+  locally, which is what the API requires.
+- `pix.list` documents that the API requires an `id`; despite the name it
+  filters rather than lists.
+
+### Changed
+
+- The coupon and checkout status enums gained `DISABLED` and `ACTIVE`.
+
 ## [1.2.1] - 2026-08-06
 
 Inclui tudo o que estava previsto para a 1.2.0, que nunca chegou a ser
@@ -239,6 +286,7 @@ versions and will not change without a major bump.
 
 - Initial release
 
+[1.2.2]: https://github.com/AbacatePay/abacatepay-ruby-sdk/releases/tag/v1.2.2
 [1.2.1]: https://github.com/AbacatePay/abacatepay-ruby-sdk/releases/tag/v1.2.1
 [1.1.0]: https://github.com/AbacatePay/abacatepay-ruby-sdk/releases/tag/v1.1.0
 [1.0.0]: https://github.com/AbacatePay/abacatepay-ruby-sdk/releases/tag/v1.0.0

data/lib/abacate_pay/clients/client.rb

@@ -83,16 +83,33 @@ module AbacatePay
         parsed = JSON.parse(response.body)
         raise ApiError, "API error: #{parsed["error"]}" if parsed["error"]
 
-        data = parsed.fetch("data")
-        # Preserve the cursor when the API sends one; dropping it made paging
-        # past the first 100 records impossible.
-        parsed["pagination"] ? Collection.new(data, parsed["pagination"]) : data
+        extract_data(parsed)
       rescue Faraday::Error => e
         handle_request_error(e)
       rescue JSON::ParserError => e
         raise ApiError, "Malformed API response: #{e.message}"
-      rescue KeyError
-        raise ApiError, "API response is missing the 'data' field"
+      end
+
+      # Pulls the payload out of the `{data, error, success}` envelope.
+      #
+      # Some endpoints answer a successful call with no `data` at all, for
+      # example `webhooks/delete` returning `{"success":true,"error":null}`.
+      # Treating that as malformed turned a working call into an ApiError.
+      #
+      # @param parsed [Hash] The decoded response body
+      # @return [Object, nil] The payload, or nil when the call carries none
+      # @raise [ApiError] if the envelope has neither data nor a success flag
+      def extract_data(parsed)
+        unless parsed.key?("data")
+          return nil if parsed["success"]
+
+          raise ApiError, "Unexpected API response: #{parsed.inspect[0, 120]}"
+        end
+
+        data = parsed["data"]
+        # Preserve the cursor when the API sends one; dropping it made paging
+        # past the first 100 records impossible.
+        parsed["pagination"] ? Collection.new(data, parsed["pagination"]) : data
       end
 
       # Issues the HTTP call.

data/lib/abacate_pay/clients/coupon_client.rb

@@ -42,7 +42,10 @@ module AbacatePay
       # @param id [String] Coupon ID
       # @return [Resources::Coupons]
       def delete(id)
-        response = request("POST", "delete", json: { id: id })
+        # The API reads the id from the query string on delete endpoints.
+        # Sending it only in the body fails with
+        # "Expected property 'id' to be string but found: undefined".
+        response = request("POST", "delete", params: { id: id }, json: {})
         Resources::Coupons.new(response)
       end
 

data/lib/abacate_pay/clients/customer_client.rb

@@ -50,7 +50,10 @@ module AbacatePay
       # @param id [String] The customer ID
       # @return [Resources::Customers] The deleted Customer object
       def delete(id)
-        response = request("POST", "delete", json: { id: id })
+        # The API reads the id from the query string on delete endpoints.
+        # Sending it only in the body fails with
+        # "Expected property 'id' to be string but found: undefined".
+        response = request("POST", "delete", params: { id: id }, json: {})
         Resources::Customers.new(response)
       end
     end

data/lib/abacate_pay/clients/payout_client.rb

@@ -32,7 +32,13 @@ module AbacatePay
         response = request("POST", "create", json: {
                              amount: data.amount,
                              externalId: data.external_id,
-                             description: data.description
+                             description: data.description,
+                             # The API nests the destination under `pix`, with
+                             # `key` and `type`. Sending pixKey/pixKeyType at the
+                             # top level fails with "Property 'pix' is missing";
+                             # nesting the wrong names fails with
+                             # "Property 'pix.type' is missing".
+                             pix: { key: data.pix_key, type: data.pix_key_type }
                            })
         Resources::Payouts.new(response)
       end

data/lib/abacate_pay/clients/pix_client.rb

@@ -13,7 +13,11 @@ module AbacatePay
         super(URI, client)
       end
 
-      # @param params [Hash] Optional pagination params (after, before, limit)
+      # The API requires an `id` on this endpoint: a bare call fails with
+      # "Expected property 'id' to be string but found: undefined". Despite the
+      # name it filters rather than lists.
+      #
+      # @param params [Hash] Params forwarded to the API; `id` is required
       # @return [Array<Resources::PixTransfers>]
       def list(**params)
         response = request("GET", "list", params: params.empty? ? nil : params)
@@ -37,8 +41,12 @@ module AbacatePay
                              amount: data.amount,
                              externalId: data.external_id,
                              description: data.description,
-                             key: data.key,
-                             keyType: data.key_type
+                             # The API nests the destination under `pix`, with
+                             # `key` and `type`. Sending pixKey/pixKeyType at the
+                             # top level fails with "Property 'pix' is missing";
+                             # nesting the wrong names fails with
+                             # "Property 'pix.type' is missing".
+                             pix: { key: data.key, type: data.key_type }
                            })
         Resources::PixTransfers.new(response)
       end

data/lib/abacate_pay/clients/product_client.rb

@@ -46,7 +46,10 @@ module AbacatePay
       # @param id [String] Product ID
       # @return [Resources::Products]
       def delete(id)
-        response = request("POST", "delete", json: { id: id })
+        # The API reads the id from the query string on delete endpoints.
+        # Sending it only in the body fails with
+        # "Expected property 'id' to be string but found: undefined".
+        response = request("POST", "delete", params: { id: id }, json: {})
         Resources::Products.new(response)
       end
     end

data/lib/abacate_pay/clients/subscription_client.rb

@@ -26,15 +26,10 @@ module AbacatePay
           methods: data.methods,
           externalId: data.external_id,
           customerId: data.customer&.id,
-          items: data.products&.map do |product|
-            {
-              externalId: product.external_id,
-              name: product.name,
-              description: product.description,
-              quantity: product.quantity,
-              price: product.price
-            }
-          end
+          # The API expects the product id here, the same shape checkouts use.
+          # Sending externalId fails with
+          # "Expected property 'items.0.id' to be string".
+          items: data.products&.map { |product| { id: product.external_id, quantity: product.quantity } }
         }
 
         response = request("POST", "create", json: request_data)

data/lib/abacate_pay/clients/webhook_client.rb

@@ -11,6 +11,9 @@ module AbacatePay
     class WebhookClient < Client
       URI = "webhooks"
 
+      # Shortest signing secret the API accepts.
+      MINIMUM_SECRET_LENGTH = 32
+
       # @param client [Faraday::Connection, nil] Optional Faraday client
       def initialize(client = nil)
         super(URI, client)
@@ -40,11 +43,19 @@ module AbacatePay
       # @param secret [String] Signing secret
       # @param events [Array<String>] Event types to subscribe to
       # @return [Resources::WebhookEndpoints] The created webhook
-      # @raise [ArgumentError] if the endpoint is not an HTTPS URL
+      # @raise [ArgumentError] if the endpoint is not HTTPS, the event list is
+      #   empty, or the secret is shorter than the API accepts
       def create(name:, endpoint:, secret:, events:)
         raise ArgumentError, "endpoint must be an HTTPS URL, got #{endpoint.inspect}" unless https_url?(endpoint)
         raise ArgumentError, "events must not be empty" if Array(events).empty?
 
+        # The API rejects anything shorter with
+        # "Expected string length greater or equal to 32".
+        if secret.to_s.length < MINIMUM_SECRET_LENGTH
+          raise ArgumentError,
+                "secret must be at least #{MINIMUM_SECRET_LENGTH} characters, got #{secret.to_s.length}"
+        end
+
         response = request("POST", "create", json: {
                              name: name,
                              endpoint: endpoint,
@@ -55,9 +66,15 @@ module AbacatePay
       end
 
       # @param id [String] The webhook ID
-      # @return [Resources::WebhookEndpoints] The deleted webhook
+      # @return [Resources::WebhookEndpoints, nil] The deleted webhook, or nil
+      #   when the API confirms the deletion without echoing the object
       def delete(id)
-        response = request("POST", "delete", json: { id: id })
+        # The API reads the id from the query string here, like
+        # transparents/simulate-payment. Sending it in the body fails with
+        # "Expected property 'id' to be string but found: undefined".
+        response = request("POST", "delete", params: { id: id }, json: {})
+        return nil if response.nil?
+
         Resources::WebhookEndpoints.new(response)
       end
 

data/lib/abacate_pay/enums/checkouts/statuses.rb

@@ -10,8 +10,11 @@ module AbacatePay
         PAID = "PAID"
         REFUNDED = "REFUNDED"
 
+        # Reusable payment links are created ACTIVE rather than PENDING.
+        ACTIVE = "ACTIVE"
+
         def self.values
-          [PENDING, EXPIRED, CANCELLED, PAID, REFUNDED]
+          [PENDING, EXPIRED, CANCELLED, PAID, REFUNDED, ACTIVE]
         end
 
         def self.valid?(value)

data/lib/abacate_pay/enums/coupons/statuses.rb

@@ -8,8 +8,11 @@ module AbacatePay
         INACTIVE = "INACTIVE"
         EXPIRED = "EXPIRED"
 
+        # What the API returns for a coupon turned off through `toggle`.
+        DISABLED = "DISABLED"
+
         def self.values
-          [ACTIVE, INACTIVE, EXPIRED]
+          [ACTIVE, INACTIVE, EXPIRED, DISABLED]
         end
 
         def self.valid?(value)

data/lib/abacate_pay/resources/coupons.rb

@@ -11,13 +11,38 @@ module AbacatePay
 
       DATETIME_PROPERTIES = %w[created_at updated_at].freeze
 
-      attr_reader :id, :code, :discount, :discount_kind, :max_redeems,
-                  :current_redeems, :status, :created_at, :updated_at
+      attr_reader :id, :discount, :discount_kind, :max_redeems,
+                  :status, :notes, :dev_mode, :created_at, :updated_at
+
+      # @return [Integer, nil] Times the coupon has been redeemed
+      attr_reader :redeems_count
 
       def initialize(data)
         fill(data)
       end
 
+      # The coupon code.
+      #
+      # The API uses the code as the object's `id` and sends no separate
+      # `code` field, so this reader was always nil for API data.
+      #
+      # @return [String, nil]
+      def code
+        @code || @id
+      end
+
+      # @return [Integer, nil] Times the coupon has been redeemed
+      #
+      # @deprecated The API calls this `redeemsCount`; use {#redeems_count}.
+      def current_redeems
+        @current_redeems || @redeems_count
+      end
+
+      # @return [Boolean, nil] Whether the coupon belongs to Dev mode
+      def dev_mode?
+        @dev_mode
+      end
+
       private
 
       def process_value(property, value)
@@ -35,7 +60,8 @@ module AbacatePay
       protected
 
       attr_writer :id, :code, :discount, :discount_kind, :max_redeems,
-                  :current_redeems, :status, :created_at, :updated_at
+                  :current_redeems, :redeems_count, :status, :notes,
+                  :dev_mode, :created_at, :updated_at
     end
   end
 end

data/lib/abacate_pay/resources/payouts.rb

@@ -10,6 +10,12 @@ module AbacatePay
 
       DATETIME_PROPERTIES = %w[created_at updated_at].freeze
 
+      # @return [String, nil] Destination PIX key
+      attr_accessor :pix_key
+
+      # @return [String, nil] Destination PIX key type
+      attr_accessor :pix_key_type
+
       attr_reader :id, :amount, :external_id, :description,
                   :status, :created_at, :updated_at
 

data/lib/abacate_pay/resources/resource.rb

@@ -21,16 +21,28 @@ module AbacatePay
         raise ArgumentError, "Invalid datetime value: #{value}"
       end
 
-      # Initialize an enum from a string or enum object
+      # Initialize an enum from a string or enum object.
+      #
+      # Unknown values pass through with a warning rather than raising. This
+      # method runs while parsing API responses, and AbacatePay adds statuses
+      # over time: rejecting an unrecognised one would turn every new value
+      # into a crash inside `list` and `get` for every integration at once.
+      # That happened with the coupon status `DISABLED` and the payment-link
+      # status `ACTIVE`, neither of which the SDK knew about.
+      #
+      # Use {AbacatePay::Enums} `validate!` directly when you want a hard
+      # failure on a value you are about to send.
       #
       # @param enum_class [Class] The enum class to initialize
       # @param value [String, Object] The value to initialize
-      # @return [Object, nil] The initialized enum or nil
-      # @raise [ArgumentError] If the value is invalid
+      # @return [Object, nil] The value, validated when known
       def initialize_enum(enum_class, value)
         return nil if value.nil? || value.empty?
+        return value if enum_class.valid?(value)
 
-        enum_class.validate!(value)
+        warn "[AbacatePay] unknown #{enum_class.name.split("::").last} value #{value.inspect}. " \
+             "Passing it through; upgrade the gem if this is a new API value."
+        value
       end
 
       # Initialize a resource from a hash or resource object
@@ -66,6 +78,10 @@ module AbacatePay
       # @param data [Hash] The data to fill with
       # @return [void]
       def fill(data)
+        # Some endpoints answer a successful call with no payload, so the
+        # resource is built from nil. An empty object beats a NoMethodError.
+        return if data.nil?
+
         data.each do |key, value|
           property = camel_to_snake(key)
           next unless respond_to?("#{property}=", true)

data/lib/abacate_pay/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbacatePay
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abacatepay-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Matheus Cardoso