Skip to content

Home

Jump to bottom
Justin Crites edited this page Jan 22, 2015 · 17 revisions

Plaid

The official Ruby bindings for the Plaid API.

Introduction

This library makes it simple to integrate Plaid into your application with the Ruby language. Please see the full documentation at Plaid.com for more details.

Version

Current stable version: 1.0.0

Notes:

  • Complete rewrite from 0.1.6
  • Object oriented returns
  • More in depth test coverage
  • Removal of all 3'rd party libraries except rSpec +Wiki Addition +Read me re-write

Last stable version: 0.1.6

Usage Flow

  1. Install

  2. Configure

  3. Authenticate

After Authentication

After the user has been authenticated you'll receive a user object with access to various methods and variables. Learn more about the user object at Plaid::User.

Depending on the API level requested you may also receive an array of Accounts and Transactions. Learn more at: Plaid::User::Account & Plaid::User:Transaction.

Informational Objects

Plaid also provides access to their Categories and Institutions via API calls. Using this library you can access them without authenticating a user.

Learn more about categories at Plaid::Category and institutions at Plaid::Institution

Contribution

We highly encourage helping out with the gem. Either adding more tests, building new helper classes, fixing bugs, or anything to increase overall quality.

The rules for contributing are simple:

  1. No outside runtime libraries are allowed unless approved by the maintainer.
  2. Follow the workflow set up below. Bug fixes should be labeled as a hot-fix, features labeled as features
  3. Semantic versioning is strictly adhered to.
  4. If you build a new feature you must release an update to the readme with information about the feature before it is accepted and commited.
  5. New rubygems versions will be based on test coverage and passing tests, or time span for smaller combined bug fixes.

Contribution rules:

  1. Fork it ( https://github.com/plaid/plaid-ruby/fork ) 2a) Create your feature branch (git checkout -b feature/my-new-feature) 2b) Create your new hot-fix branch (git checkout -b hot-fix/my-new-hotfix)
  2. Commit your changes
  3. Push to the branch (git push origin feature/my-new-feature)
  4. Create a new Pull Request
  5. Wait for review and merge or notes to get merge accepted
Clone this wiki locally