pay-asaas

Asaas payment processor for Pay gem (Payments engine for Ruby on Rails);

This gem is not affiliated with Asaas.

The goal for the first implementation is to support the following features:

• Customer creation
• Make a payment with PIX
• Support basic webhooks needed for the payment process
• Pix QRCode sync

Following features will be implemented in the future and I will be happy to receive contributions:

• Credit Cards
• Subscriptions

Install the gem and add to the application's Gemfile by executing:

bundle add pay-asaas;

Install pay gem if you haven't already: https://github.com/pay-rails/pay/blob/main/docs/1_installation.md

rails credentials:edit --environment=development

asaas:
  api_key: xxxx
  api_url: https://api-sandbox.asaas.com/v3 # or 	https://api.asaas.com/v3
  webhook_access_key: xxxx

Pay will also check environment variables for API keys:

• ASAAS_API_KEY
• ASAAS_API_URL
• ASAAS_WEBHOOK_ACCESS_KEY

Se other configuration options at: https://github.com/pay-rails/pay/blob/main/docs/2_configuration.md

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

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.

This first version of the gem will only support PIX payments.

@user.payment_processor.charge(15_00)

@user.payment_processor.charge(15_00, { attrs: { order_id: @order.id } })

The gem provides a built-in controller to handle webhooks from Asaas. These webhooks are essential for keeping your payment records in sync with Asaas's systems.

To configure webhooks in your Asaas dashboard, use the following URL (replace example.org with your domain):

• Asaas Webhook URL: https://example.org/pay/webhooks/asaas

The main goal of the webhooks right now is to sync payment statuses.

For now we listen to the events that are important for pix transactions. For more configuration options see: https://github.com/pay-rails/pay/blob/main/docs/7_webhooks.md

All incoming webhooks from Asaas will be verified using the webhook_access_key provided in the gem configuration.

To debug HTTP requests made by our gem, which uses the httparty library, you can enable logging of all outgoing HTTP calls. Just add the following line to one of your initializers:

HTTParty::Basement.debug_output($stdout)

This will print the full request and response details to the console, making it easier to troubleshoot issues during development.

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pay-asaas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

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.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Pay::Asaas project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.