asaas-sdk 0.1.0

data/lib/asaas/resources/invoice.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Invoice < Base
+      def self.resource_path = "/invoices"
+    end
+  end
+end

data/lib/asaas/resources/my_account.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    # The authenticated (sub)account itself: /myAccount.
+    # Acts on the account that owns the api_key, so pass the subaccount's own
+    # key per call: MyAccount.status(api_key: "aact_sub_key").
+    class MyAccount
+      extend HasClient
+
+      # Authoritative KYC registration status. Returns an AsaasObject exposing
+      # commercialInfo, documentation, bankAccountInfo and general statuses.
+      def self.status(opts = {})
+        response = client(opts).request(:get, "/myAccount/status")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.commercial_info(opts = {})
+        response = client(opts).request(:get, "/myAccount/commercialInfo/")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.update_commercial_info(profile, opts = {})
+        response = client(opts).request(
+          :post,
+          "/myAccount/commercialInfo/",
+          params: profile,
+          retryable: opts.fetch(:retryable, true)
+        )
+        AsaasObject.construct_from(response)
+      end
+    end
+  end
+end

data/lib/asaas/resources/notification.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Notification
+      extend HasClient
+
+      def self.update(id, params = {}, opts = {})
+        response = client(opts).request(:put, "/notifications/#{id}", params: params)
+        AsaasObject.construct_from(response)
+      end
+
+      def self.update_batch(params = {}, opts = {})
+        response = client(opts).request(:put, "/notifications", params: params)
+        AsaasObject.construct_from(response)
+      end
+    end
+  end
+end

data/lib/asaas/resources/payment.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Payment < Base
+      def self.resource_path = "/payments"
+
+      def self.restore(id, opts = {})
+        response = client(opts).request(:post, "#{resource_path}/#{id}/restore")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.refund(id, params = {}, opts = {})
+        response = client(opts).request(
+          :post,
+          "#{resource_path}/#{id}/refund",
+          params: params,
+          retryable: opts.fetch(:retryable, true),
+          timeout: opts[:timeout],
+          idempotency_key: opts[:idempotency_key]
+        )
+        AsaasObject.construct_from(response)
+      end
+
+      def self.capture(id, opts = {})
+        response = client(opts).request(:post, "#{resource_path}/#{id}/capture")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.confirm_cash_receipt(id, params = {}, opts = {})
+        response = client(opts).request(:post, "#{resource_path}/#{id}/confirmCashReceipt", params: params)
+        AsaasObject.construct_from(response)
+      end
+
+      def self.payment_info(id, opts = {})
+        response = client(opts).request(:get, "#{resource_path}/#{id}/paymentInfo")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.pix_qr_code(id, opts = {})
+        response = client(opts).request(:get, "#{resource_path}/#{id}/pixQrCode")
+        AsaasObject.construct_from(response)
+      end
+    end
+  end
+end

data/lib/asaas/resources/payment_link.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class PaymentLink < Base
+      def self.resource_path = "/paymentLinks"
+
+      def self.add_image(id, params = {}, opts = {})
+        response = client(opts).request(:post, "#{resource_path}/#{id}/images", params: params)
+        AsaasObject.construct_from(response)
+      end
+    end
+  end
+end

data/lib/asaas/resources/pix.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Pix
+      extend HasClient
+
+      def self.create_key(params = {}, opts = {})
+        response = client(opts).request(:post, "/pix/addressKeys", params: params)
+        AsaasObject.construct_from(response)
+      end
+
+      def self.list_keys(params = {}, opts = {})
+        path = "/pix/addressKeys"
+        response = client(opts).request(:get, path, params: params)
+        ListObject.construct_from(response, client: client(opts), path: path, params: params)
+      end
+
+      def self.delete_key(id, opts = {})
+        response = client(opts).request(:delete, "/pix/addressKeys/#{id}")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.create_qr_code(params = {}, opts = {})
+        response = client(opts).request(:post, "/pix/qrCodes/static", params: params)
+        AsaasObject.construct_from(response)
+      end
+
+      def self.transactions(params = {}, opts = {})
+        path = "/pix/transactions"
+        response = client(opts).request(:get, path, params: params)
+        ListObject.construct_from(response, client: client(opts), path: path, params: params)
+      end
+
+      def self.retrieve_transaction(id, opts = {})
+        uuid = /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i
+        unless id.is_a?(String) && id.ascii_only? && id.match?(uuid)
+          raise ArgumentError, "Pix transaction ID must be a UUID"
+        end
+
+        response = client(opts).request(
+          :get,
+          "/pix/transactions/#{id}",
+          retryable: opts.fetch(:retryable, true),
+          timeout: opts[:timeout]
+        )
+        AsaasObject.construct_from(response)
+      end
+
+      def self.decode_qr_code(params = {}, opts = {})
+        response = client(opts).request(:post, "/pix/qrCodes/decode", params: params)
+        AsaasObject.construct_from(response)
+      end
+    end
+  end
+end

data/lib/asaas/resources/pix_automatic.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class PixAutomatic < Base
+      def self.resource_path = "/pix/automatic/authorizations"
+    end
+  end
+end

data/lib/asaas/resources/sandbox.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Sandbox < Base
+      def self.resource_path = "/sandbox"
+
+      def self.approve_account(opts = {})
+        response = client(opts).request(:post, "#{resource_path}/myAccount/approve")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.confirm_payment(id, opts = {})
+        response = client(opts).request(:post, "#{resource_path}/payment/#{id}/confirm")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.overdue_payment(id, opts = {})
+        response = client(opts).request(:post, "#{resource_path}/payment/#{id}/overdue")
+        AsaasObject.construct_from(response)
+      end
+    end
+  end
+end

data/lib/asaas/resources/split.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Split
+      extend HasClient
+
+      SPLITS_PAID = "/payments/splits/paid"
+      SPLITS_RECEIVED = "/payments/splits/received"
+
+      def self.paid(params = {}, opts = {})
+        response = client(opts).request(:get, SPLITS_PAID, params: params)
+        ListObject.construct_from(response, client: client(opts), path: SPLITS_PAID, params: params)
+      end
+
+      def self.received(params = {}, opts = {})
+        response = client(opts).request(:get, SPLITS_RECEIVED, params: params)
+        ListObject.construct_from(response, client: client(opts), path: SPLITS_RECEIVED, params: params)
+      end
+
+      def self.retrieve_paid(id, opts = {})
+        response = client(opts).request(:get, "#{SPLITS_PAID}/#{id}")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.retrieve_received(id, opts = {})
+        response = client(opts).request(:get, "#{SPLITS_RECEIVED}/#{id}")
+        AsaasObject.construct_from(response)
+      end
+    end
+  end
+end

data/lib/asaas/resources/subaccount.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Subaccount < Base
+      def self.resource_path = "/accounts"
+
+      def self.create_api_key(id, opts = {})
+        response = client(opts).request(:post, "#{resource_path}/#{id}/apiKeys")
+        AsaasObject.construct_from(response)
+      end
+
+      def self.api_keys(id, params = {}, opts = {})
+        path = "#{resource_path}/#{id}/apiKeys"
+        response = client(opts).request(:get, path, params: params)
+        ListObject.construct_from(response, client: client(opts), path: path, params: params)
+      end
+    end
+  end
+end

data/lib/asaas/resources/subscription.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Subscription < Base
+      def self.resource_path = "/subscriptions"
+
+      def self.payments(id, params = {}, opts = {})
+        path = "#{resource_path}/#{id}/payments"
+        response = client(opts).request(:get, path, params: params)
+        ListObject.construct_from(response, client: client(opts), path: path, params: params)
+      end
+    end
+  end
+end

data/lib/asaas/resources/transfer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Transfer < Base
+      def self.resource_path = "/transfers"
+    end
+  end
+end

data/lib/asaas/resources/webhook.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Asaas
+  module Resources
+    class Webhook < Base
+      def self.resource_path = "/webhooks"
+
+      def self.remove_penalty(id, opts = {})
+        response = client(opts).request(:post, "#{resource_path}/#{id}/removePenalty")
+        AsaasObject.construct_from(response)
+      end
+    end
+  end
+end

data/lib/asaas/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Asaas
+  VERSION = "0.1.0"
+end

data/lib/asaas/webhook_event.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "json"
+require "openssl"
+
+module Asaas
+  module WebhookEvent
+    TOKEN_HEADER = "asaas-access-token"
+
+    def self.construct_event(payload, token_header, expected_token)
+      verify_token!(token_header, expected_token)
+      AsaasObject.construct_from(JSON.parse(payload))
+    rescue JSON::ParserError => e
+      raise InvalidPayloadError, "Invalid JSON payload: #{e.message}"
+    end
+
+    def self.verify_token!(token_header, expected_token)
+      raise ArgumentError, "expected_token cannot be nil or empty" if expected_token.nil? || expected_token.empty?
+      raise WebhookVerificationError, "Missing #{TOKEN_HEADER} header" if token_header.nil? || token_header.empty?
+      raise WebhookVerificationError, "Token mismatch" unless secure_compare(token_header.to_s, expected_token.to_s)
+    end
+    private_class_method :verify_token!
+
+    def self.secure_compare(lhs, rhs)
+      return false unless lhs.bytesize == rhs.bytesize
+
+      OpenSSL.fixed_length_secure_compare(lhs, rhs)
+    end
+    private_class_method :secure_compare
+  end
+end

data/lib/asaas-sdk.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Entry point matching the gem name, so `Bundler.require` and
+# `require "asaas-sdk"` load the SDK without an explicit `require: "asaas"`.
+require_relative "asaas"

data/lib/asaas.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "asaas/version"
+require_relative "asaas/configuration"
+require_relative "asaas/errors"
+require_relative "asaas/webhook_event"
+require_relative "asaas/asaas_object"
+require_relative "asaas/list_object"
+require_relative "asaas/client"
+require_relative "asaas/resources/has_client"
+require_relative "asaas/resources/base"
+require_relative "asaas/resources/customer"
+require_relative "asaas/resources/credit_card"
+require_relative "asaas/resources/payment"
+require_relative "asaas/resources/subscription"
+require_relative "asaas/resources/webhook"
+require_relative "asaas/resources/finance"
+require_relative "asaas/resources/pix"
+require_relative "asaas/resources/payment_link"
+require_relative "asaas/resources/transfer"
+require_relative "asaas/resources/installment"
+require_relative "asaas/resources/checkout"
+require_relative "asaas/resources/invoice"
+require_relative "asaas/resources/split"
+require_relative "asaas/resources/anticipation"
+require_relative "asaas/resources/notification"
+require_relative "asaas/resources/dunning"
+require_relative "asaas/resources/chargeback"
+require_relative "asaas/resources/subaccount"
+require_relative "asaas/resources/bill_payment"
+require_relative "asaas/resources/pix_automatic"
+require_relative "asaas/resources/sandbox"
+require_relative "asaas/resources/document"
+require_relative "asaas/resources/my_account"
+
+module Asaas
+  @config = Configuration.new
+
+  class << self
+    attr_reader :config
+
+    def configure
+      yield @config
+    end
+
+    def api_key=(key)
+      @config.api_key = key
+    end
+
+    def api_key
+      @config.api_key
+    end
+
+    def sandbox=(val)
+      @config.sandbox = val
+    end
+
+    def sandbox?
+      @config.sandbox
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: asaas-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JoaoPierre
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.65'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.65'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+description: A Ruby SDK for Asaas — Brazil's payment platform. Supports Customers,
+  Payments (Boleto, Pix, Credit Card), Subscriptions, Webhooks and more.
+email:
+- jppierre90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/asaas-sdk.rb
+- lib/asaas.rb
+- lib/asaas/asaas_object.rb
+- lib/asaas/client.rb
+- lib/asaas/configuration.rb
+- lib/asaas/errors.rb
+- lib/asaas/list_object.rb
+- lib/asaas/resources/anticipation.rb
+- lib/asaas/resources/base.rb
+- lib/asaas/resources/bill_payment.rb
+- lib/asaas/resources/chargeback.rb
+- lib/asaas/resources/checkout.rb
+- lib/asaas/resources/credit_card.rb
+- lib/asaas/resources/customer.rb
+- lib/asaas/resources/document.rb
+- lib/asaas/resources/dunning.rb
+- lib/asaas/resources/finance.rb
+- lib/asaas/resources/has_client.rb
+- lib/asaas/resources/installment.rb
+- lib/asaas/resources/invoice.rb
+- lib/asaas/resources/my_account.rb
+- lib/asaas/resources/notification.rb
+- lib/asaas/resources/payment.rb
+- lib/asaas/resources/payment_link.rb
+- lib/asaas/resources/pix.rb
+- lib/asaas/resources/pix_automatic.rb
+- lib/asaas/resources/sandbox.rb
+- lib/asaas/resources/split.rb
+- lib/asaas/resources/subaccount.rb
+- lib/asaas/resources/subscription.rb
+- lib/asaas/resources/transfer.rb
+- lib/asaas/resources/webhook.rb
+- lib/asaas/version.rb
+- lib/asaas/webhook_event.rb
+homepage: https://github.com/JoaoPierre/asaas-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/JoaoPierre/asaas-ruby
+  changelog_uri: https://github.com/JoaoPierre/asaas-ruby/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/JoaoPierre/asaas-ruby/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby SDK for the Asaas payment gateway API
+test_files: []