A Ruby library to extract bank information
Pull request Compare This branch is 23 commits behind dontangg:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
CHANGELOG.rdoc
Gemfile
Gemfile.lock
README.rdoc
Rakefile
TODO.rdoc
syrup.gemspec

README.rdoc

Syrup

Syrup helps you to extract bank account information and transactions.

Usage

# Setup an instance of the bank
zions_bank = Syrup.setup_institution('zions_bank') do |config|
  config.username = 'user'
  config.password = 'pass'
  config.secret_questions = {'What is your secret question?' => "I don't know"}
end

# List accounts
zions_bank.accounts.each do |account|
  puts "#{account.name} (#{account.current_balance})" # => "Checking (100.0)"
end

# Get transactions
account = zions_bank.find_account_by_id 123456
transactions = account.find_transactions(Date.today - 30) # => an array of Transactions from the last 30 days
transactions = account.find_transactions(Date.parse('2011-01-01'), Date.parse('2011-02-01') - 1) # => an array of Transactions from the month of January

Installation

The latest version of Syrup can be installed with Rubygems:

[sudo] gem install "syrup"

In Rails 3, add this to your Gemfile and run the bundle command.

gem "syrup"

In Rails 2, add this to your environment.rb file.

config.gem "syrup"

Supported Institutions

Currently, only Zions Bank is supported. I will be implementing UCCU, USAA, and Wells Fargo (probably in that order). If you would like support for a different bank, you have two options:

  1. Get me the credentials to log into an account with that bank (you'd have to trust me).

  2. Implement it yourself and submit a pull request. See Adding Support For Another Institution