This Ruby gem provides a convenient method to interact with the Kobana APP, simplifying operations with charges and bank billets.
This is BETA and can change anytimes. Use with caution.
- Ruby version >= 3.2
- Access to the Kobana API and a valid API key
Add this line to your application's Gemfile:
gem 'kobana'Then execute:
$ bundle installOr install it yourself as:
$ gem install kobanaConfigure your API key by creating an initializer in your Rails project:
config/initializers/kobana.rb
Kobana.configure do |config|
config.api_token = 'YOUR_API_TOKEN'
config.environment = :sandbox # you can specify the environment as :development, :sandbox, or :production
endReplace 'YOUR_API_TOKEN' with your actual API key from the corresponding environment.
For applications that need to work with multiple Kobana accounts simultaneously (e.g., multi-tenant applications), you can create multiple client instances:
# Create separate clients for different accounts
client1 = Kobana::Client.new(
api_token: 'CLIENT1_API_TOKEN',
environment: :production
)
client2 = Kobana::Client.new(
api_token: 'CLIENT2_API_TOKEN',
environment: :sandbox
)
# Use client-specific resources
pix1 = client1.charge.pix.create(attributes)
pix2 = client2.charge.pix.create(attributes)
# Each client maintains its own configuration
account1 = client1.financial.account.find(account_id)
account2 = client2.financial.account.find(account_id)You can also configure clients after initialization:
client = Kobana::Client.new
client.configure do |config|
config.api_token = 'YOUR_API_TOKEN'
config.environment = :production
config.custom_headers = { 'X-Custom-Header' => 'Value' }
config.debug = true
endThe gem supports both global configuration (backward compatible) and multi-client usage patterns.
Using global configuration:
attributes = {
'amount' => 100.50,
'payer' => {
'document_number' => '1234567890',
'name' => 'John Doe'
},
'pix_account_id' => 1,
'expire_at' => '2023-12-31',
'message' => 'Thanks for your purchase!',
'additional_info' => {
'Chave' => 'Value'
},
'custom_data' => '{"order_id": "12345"}'
}
# Global configuration approach (backward compatible)
pix = Kobana::Resources::Charge::Pix.create(attributes)Using client-specific configuration:
# Client-specific approach
client = Kobana::Client.new(api_token: 'YOUR_TOKEN')
pix = client.charge.pix.create(attributes)
pix.id # 1
pix.new_record? false
pix.created? # true
pix.attributes # {}
pix = Kobana::Resources::Charge::Pix.new(attributes)
pix.id nil
pix.new_record? # true
pix.created? # false
pix.attributes # {}
pix.savecharge_id = 1 # Replace with your charge ID
pix = Kobana::Resources::Charge::Pix.find(charge_id)
puts pixparams = { status: ["opened", "overdue"], page: 2 }
results = Kobana::Resources::Charge::Pix.all(params)
puts resultattributes = { ... }
bank_billet = Kobana::Resources::Charge::BankBillet.create(attributes)
puts bank_billetbank_billet_id = 1 # Replace with your charge ID
bank_billet = Kobana::Resources::Charge::BankBillet.find(bank_billet_id)
puts bank_billetbank_billets = Kobana::Resources::Charge::BankBillet.all
puts bank_billets