pay-asaas 0.1.0.pre.alpha → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b569b26d2eacd591aad245cd92687459f6c419d5182a5514caeee1558f1b32e
-  data.tar.gz: 0c91f916c6b7d83e633c1a5aa1a9caaec037dbfa00b52097384b1733a1dd2cfa
+  metadata.gz: e8740ebeaaae97eef969cf19ad4330ee537c3830cb851b7797a77d34b2681523
+  data.tar.gz: a8f0ff7411dcb34025fe21c6d85737fb4eff504e095a5feb264056633fe7af5f
 SHA512:
-  metadata.gz: 160e4949149cdd12370128a59bdca7e4f02e9188bb61bd593053238a69a43c3186e4353863d962a90f78b462d78bb0ae6e11a2974d1fafe4d296d8b940b357a6
-  data.tar.gz: 33baf9d3695fdd9627fa890a0a2d7ddfc530cfd95798352debd4ab103f9a033207e2cc58569982d1f4571456da7a8b96e8ed9b4744363fc225f937f57f2fca68
+  metadata.gz: a9c796a31134dc0cd08a28adfa0a01c827e7156a0740f6b10035bc53375be0f78b6164bd4e5625d8bd16e0098fb9cdde6e0b47c7809c115e0203452815fae9ce
+  data.tar.gz: 6fd4b710b4cc89cbd7e078f294aeea43a8109ed4f8e2bf905a5ea82235b0831624317b95063343526b7f61aefaa86f403cb708a0bdc274f89db638b0c4c48a53

data/README.md

@@ -2,6 +2,7 @@
 
 Asaas payment processor for Pay gem (Payments engine for Ruby on Rails);
 
+> [!WARNING]
 > This gem is a work in progress and is not ready for production use.
 
 > This gem is not affiliated with Asaas.
@@ -11,10 +12,9 @@ The goal for the first implementation is to support the following features:
 - [x] Customer creation
 - [x] Make a payment with PIX
 - [x] Support basic webhooks needed for the payment process
+- [x] Pix QRCode sync
 
 Following features will be implemented in the future and I will be happy to receive contributions:
-
-- [ ] Pix QRCode sync
 - [ ] Credit Cards
 - [ ] Subscriptions
 
@@ -23,7 +23,7 @@ Following features will be implemented in the future and I will be happy to rece
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG;
+bundle add pay-asaas;
 ```
 
 > Install pay gem if you haven't already: https://github.com/pay-rails/pay/blob/main/docs/1_installation.md
@@ -53,12 +53,12 @@ Pay will also check environment variables for API keys:
 
 ## Customer
 
-**IMPORTANT**: For this add the document column to users table.
-
-The customer works the same as the other processors, but with the document additional field.
+**IMPORTANT**: In order to create a customer with pay-asaas, you need to provide a document (cpf or cnpj) to the user. This can be in the form of the following columns, in order of preference:
+  - `document`
+  - `cpf`
+  - `cnpj`
 
-The document is not required to create the customer but is required to process payments. The document can be cpf ou cnpj
-without mask.
+In asaas, the document is not required to create the customer but is required to process payments, as such, we choose to make the field mandatory in this gem.
 
 ## Charge
 
@@ -66,6 +66,8 @@ This first version of the gem will only support PIX payments.
 
 ```ruby
 @user.payment_processor.charge(15_00)
+
+@user.payment_processor.charge(15_00, { attrs: { order_id: @order.id } })
 ```
 
 ## Webhooks
@@ -95,6 +97,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
 the [code of conduct](https://github.com/[USERNAME]/pay-asaas/blob/master/CODE_OF_CONDUCT.md).
 
+### Running tests
+
+In order to run the test, first add a .env with fake credentials at the root of the project, and create a database in the `spec/dummy` folder.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/pay/asaas/api/credit_card.rb

@@ -0,0 +1,12 @@
+require "pay/asaas/client"
+require "pay/asaas/api"
+
+class Pay::Asaas::Api::CreditCard < Pay::Asaas::ApiClient
+  def self.resource_key
+    "creditCard"
+  end
+
+  def self.tokenize(params:)
+    request(:post, "creditCards/tokenize", body: params.to_json)
+  end
+end

data/lib/pay/asaas/api/payment.rb

@@ -5,4 +5,8 @@ class Pay::Asaas::Api::Payment < Pay::Asaas::ApiClient
   def self.resource_key
     "payments"
   end
+
+  def self.fetch_qr_code(processor_id)
+    request(:get, "#{resource_key}/#{processor_id}/pixQrCode")
+  end
 end

data/lib/pay/asaas/charge.rb

@@ -4,7 +4,8 @@ module Pay
   module Asaas
     class Charge < Pay::Charge
       store_accessor :data, :status
-      store_accessor :data, :qr_code
+      store_accessor :data, :pix_code
+      after_create :sync_pix_qr_code
 
       def self.sync(charge_id, object: nil, try: 0, retries: 1)
         object ||= Pay::Asaas::Api::Payment.find(id: charge_id)
@@ -57,6 +58,16 @@ module Pay
       def refund!(amount_to_refund)
         raise NotImplementedError, "Refunding charges is not supported yet by the Asaas fake processor"
       end
+
+      def sync_pix_qr_code
+        return unless payment_method_type == "pix"
+
+        response = Pay::Asaas::Api::Payment.fetch_qr_code(processor_id)
+
+        update!(
+          pix_code: response["payload"],
+        )
+      end
     end
   end
 end

data/lib/pay/asaas/client.rb

@@ -28,7 +28,6 @@ module Pay::Asaas
 
       def configure
         yield(configuration)
-        configuration.validate!
       end
 
       def headers
@@ -44,6 +43,7 @@ module Pay::Asaas
       end
 
       def request(method, path, options = {})
+        configuration.validate!
         response = HTTParty.send(
           method,
           "#{configuration.base_url}/#{path}",

data/lib/pay/asaas/customer.rb

@@ -9,7 +9,21 @@ module Pay
       has_one :default_payment_method, -> { where(default: true) }, class_name: "Pay::Asaas::PaymentMethod"
 
       def api_record_attributes
-        { email: email, name: customer_name, cpfCnpj: owner.document, externalReference: owner.id }
+        document = if owner.respond_to?(:document)
+          owner.document
+        elsif owner.respond_to?(:cpf)
+          owner.cpf
+        elsif owner.respond_to?(:cnpj)
+          owner.cnpj
+        else
+          raise StandardError, "The document attribute, and it's alternatives are not implemented for #{owner.class}"
+        end
+
+        raise StandardError, "The document attribute is required" if document.nil?
+
+        document = document.gsub(/[^\d]/, "")
+
+        { email: email, name: customer_name, cpfCnpj: document, externalReference: owner.id }
       end
 
       def api_record
@@ -47,6 +61,8 @@ module Pay
           payment_method_type: "pix",
         }
 
+        attrs = attrs.merge(options[:attrs]) if options[:attrs]
+
         charge = charges.find_or_initialize_by(processor_id: transaction["id"])
         charge.update(attrs)
         charge

data/lib/pay/asaas/version.rb

@@ -1,5 +1,5 @@
 module Pay
   module Asaas
-    VERSION = "0.1.0-alpha"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pay-asaas
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha
+  version: 0.1.0
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 bindir: exe
 cert_chain: []
-date: 2024-12-29 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -51,34 +51,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '8'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner-active_record
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
 email:
 - pedroaugustorduarte@gmail.com
 executables: []
@@ -97,6 +69,7 @@ files:
 - config/routes.rb
 - lib/pay/asaas.rb
 - lib/pay/asaas/api.rb
+- lib/pay/asaas/api/credit_card.rb
 - lib/pay/asaas/api/customer.rb
 - lib/pay/asaas/api/payment.rb
 - lib/pay/asaas/charge.rb