Project

ofx_reader

0.0
No commit activity in last 3 years
No release in over 3 years
A simple ofx reader
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
~> 0.11
~> 10.0
~> 3.0

Runtime

 Project Readme

OFXReader

Simple OFX Reader

Installation

Add this line to your application's Gemfile:

gem 'ofx_reader'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ofx_reader

Usage

ofx = OFXReader.(ofx_text)
=> #<OFXReader::Parser::Base:...

Headers

ofx.headers
=> {
  'OFXHEADER' => '100'
  'DATA' => 'OFXSGML'
  'VERSION' => '102'
  'SECURITY' => 'TYPE1'
  'ENCODING' => 'USASCII'
  'CHARSET' => '1252'
  'COMPRESSION' => 'NONE'
  'OLDFILEUID' => 'NONE'
  'NEWFILEUID' => 'NONE'
}

Account

ofx.account
=> { bank_id: '1', account_id: '1' }

Transactions

Will return a hash with all fields on .OFX file, using original names, as symbols:

ofx.transactions
=> [{
  trntype: "DEBIT",
  dtposted: '20171214000000[-3:EST]'),
  trnamt: -99.99,
  fitid: "00000000000000000000000000",
  name: "TRANSACTION DESCRIPTION"
}, ... ]

You can also read a .OFX file in console using the ofx_reader executable:

$ ofx_reader path/to/file.ofx

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 tags, and push the .gem file to rubygems.org.

Credits

This gem is based on ofx.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/franciscomxs/ofx_reader.