Cobrato Client

This is the official Ruby client for the Cobrato API.

The Cobrato Ruby Client is compatible with Ruby 2.4.3 or higher.

Add this line to your application's Gemfile:

gem 'cobrato-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cobrato-client

Use Cobrato.configure to setup your environment:

require "cobrato"

Cobrato.configure do |config|
  config.url = "https://sandbox.cobrato.com/api/v1" # defaults to "https://app.cobrato.com.br/api/v1"
  config.user_agent = 'My App v1.0' # optional, but you should pass a custom user-agent identifying your app
end

Given your token, create an instance of Cobrato::Client, as below:

client = Cobrato.client("YOUR_TOKEN_HERE")

Now you have acess to every API endpoint:

• Payees API
• Bank Accounts API
• People API
• Payers API (DEPRECATED)
• Charge Configs API
• Charges API
• Regress Cnab
• Remittance Cnab
• CreditCards API
• Webhooks API
• Payment Config (BETA)
• Payment (BETA)

You can check the Cobrato signature on the payload request:

sgnature = Cobrato.signature('secret')
signature.check?(request.headers['X-Cobrato-RequestId'], request.headers['X-Cobrato-Signature'], request.body)
# => true

All actions that change data triggers an event that you can subscribe to. This event allow you to extend the logic executed when you call a client method.

All you have to do is create a class that responds to a method #call with two arguments:

class MyListener
  def call(result, args)
  end
end

Where:

• result is the return of a client method
• args is an array of arguments passed to the client method you called

Now you have a listener, you can subscribe to an event:

Cobrato.subscribe("cobrato.payees.destroy", MyListener.new)

Example:

When you call client.payees.destroy(1), an event cobrato.payees.destroy will be triggered. Your listener method #call will receive:

• result would be true or false - depending on what client.payees.destroy(1) returned
• args would be [1] - an array with the arguments passed to the client method

• payees
  • cobrato.payees.create
  • cobrato.payees.destroy
• bank_accounts
  • cobrato.bank_accounts.create
  • cobrato.bank_accounts.destroy
• charge_configs
  • cobrato.charge_configs.create
  • cobrato.charge_configs.destroy
• charges
  • cobrato.charges.create
  • cobrato.charges.destroy
  • cobrato.charges.receive
  • cobrato.charges.undo_receive
  • cobrato.charges.cancel
• webhooks
  • cobrato.webhooks.create
  • cobrato.webhooks.destroy
• charge_templates
  • cobrato.charge_templates.create
  • cobrato.charge_templates.destroy

To release a new version, update the version number in lib/cobrato/version.rb, add the version in CHANGELOG.md, run bundle install and commit & push the changes to the repository.

If this is your first time publishing a RubyGem in your local device, you will have to download your credentials. To do this, follow the instructions in your profile page in RubyGems or just type the following in your command line, replacing $username with your RubyGems username.

$ curl -u $username https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials

Then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org. Make sure you have publishing rights for the gem on RubyGems beforehand, though.

After publishing the new version, add a released label to each pull request included in the release.

1. Fork it ( https://github.com/[my-github-username]/cobrato-client-ruby/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request