ofx-parser 1.0.0

data/test/fixtures/banking.ofx.sgml

@@ -0,0 +1,87 @@
+OFXHEADER:100
+DATA:OFXSGML
+VERSION:102
+SECURITY:NONE
+ENCODING:USASCII
+CHARSET:1252
+COMPRESSION:NONE
+OLDFILEUID:NONE
+NEWFILEUID:NONE
+
+<OFX>
+  <SIGNONMSGSRSV1>
+    <SONRS>
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY>
+        <MESSAGE>The user is authentic; operation succeeded.</MESSAGE>
+      </STATUS>
+      <DTSERVER>20070623142635.169[-5:CDT]</DTSERVER>
+      <LANGUAGE>ENG</LANGUAGE>
+      <FI>
+        <ORG>U.S. Bank</ORG>
+        <FID>1402</FID>
+      </FI>
+      <INTU.BID>1402</INTU.BID>
+    </SONRS>
+  </SIGNONMSGSRSV1>
+  <BANKMSGSRSV1>
+    <STMTTRNRS>
+      <TRNUID>9C24229A0077EAA50000011353C9E00743FC</TRNUID>
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY>
+      </STATUS>
+      <STMTRS>
+        <CURDEF>USD</CURDEF>
+        <BANKACCTFROM>
+          <BANKID>033000033</BANKID>
+          <ACCTID>103333333333</ACCTID>
+          <ACCTTYPE>CHECKING</ACCTTYPE>
+        </BANKACCTFROM>
+        <BANKTRANLIST>
+          <DTSTART>20070604190000.000[-5:CDT]</DTSTART>
+          <DTEND>20070622190000.000[-5:CDT]</DTEND>
+          <STMTTRN>
+            <TRNTYPE>PAYMENT</TRNTYPE>
+            <DTPOSTED>20070606120000.000</DTPOSTED>
+            <TRNAMT>-11.11</TRNAMT>
+            <FITID>11111111 22</FITID>
+            <NAME>WEB AUTHORIZED PMT FOO INC</NAME>
+            <MEMO>Download from usbank.com. FOO INC</MEMO>
+          </STMTTRN>
+          <STMTTRN>
+            <TRNTYPE>CHECK</TRNTYPE>
+            <DTPOSTED>20070607120000.000</DTPOSTED>
+            <TRNAMT>-111.11</TRNAMT>
+            <FITID>22222A</FITID>
+            <CHECKNUM>0000009611</CHECKNUM>
+            <NAME>CHECK</NAME>
+            <MEMO>Download from usbank.com.</MEMO>
+          </STMTTRN>
+          <STMTTRN>
+            <TRNTYPE>DIRECTDEP</TRNTYPE>
+            <DTPOSTED>20070614120000.000</DTPOSTED>
+            <TRNAMT>1111.11</TRNAMT>
+            <FITID>X34AE33</FITID>
+            <NAME>ELECTRONIC DEPOSIT BAR INC</NAME>
+            <MEMO>Download from usbank.com. BAR INC</MEMO>
+          </STMTTRN>
+          <STMTTRN>
+            <TRNTYPE>CREDIT</TRNTYPE>
+            <DTPOSTED>20070619120000.000</DTPOSTED>
+            <TRNAMT>11.11</TRNAMT>
+            <FITID>8 8 9089743</FITID>
+            <NAME>ATM DEPOSIT US BANK ANYTOWNAS</NAME>
+            <MEMO>Download from usbank.com. US BANK ANYTOWN ASUS1</MEMO>
+          </STMTTRN>
+        </BANKTRANLIST>
+        <LEDGERBAL>
+          <BALAMT>1234.09</BALAMT>
+          <DTASOF>20070623142635.369[-5:CDT]</DTASOF>
+        </LEDGERBAL>
+      </STMTRS>
+    </STMTTRNRS>
+  </BANKMSGSRSV1>
+</OFX>
+

data/test/fixtures/creditcard.ofx.sgml

@@ -0,0 +1,79 @@
+OFXHEADER:100
+DATA:OFXSGML
+VERSION:102
+SECURITY:NONE
+ENCODING:USASCII
+CHARSET:1252
+COMPRESSION:NONE
+OLDFILEUID:NONE
+NEWFILEUID:NONE
+
+<OFX>
+  <SIGNONMSGSRSV1>
+    <SONRS>
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY>
+      </STATUS>
+      <DTSERVER>20070623192010</DTSERVER>
+      <LANGUAGE>ENG</LANGUAGE>
+      <FI>
+        <ORG>Citigroup</ORG>
+        <FID>24909</FID>
+      </FI>
+      <INTU.BID>24909</INTU.BID>
+    </SONRS>
+  </SIGNONMSGSRSV1>
+  <CREDITCARDMSGSRSV1>
+    <CCSTMTTRNRS>
+      <TRNUID>0</TRNUID>
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY>
+      </STATUS>
+      <CCSTMTRS>
+        <CURDEF>USD</CURDEF>
+        <CCACCTFROM>
+          <ACCTID>XXXXXXXXXXXX1111</ACCTID>
+        </CCACCTFROM>
+        <BANKTRANLIST>
+          <DTSTART>20070509120000</DTSTART>
+          <DTEND>20070608120000</DTEND>
+          <STMTTRN>
+            <TRNTYPE>DEBIT</TRNTYPE>
+            <DTPOSTED>20070510170000</DTPOSTED>
+            <TRNAMT>-19.17</TRNAMT>
+            <FITID>xx</FITID>
+            <SIC>5912</SIC>
+            <NAME>WALGREEN      34638675 ANYTOWN</NAME>
+          </STMTTRN>
+          <STMTTRN>
+            <TRNTYPE>DEBIT</TRNTYPE>
+            <DTPOSTED>20070512170000</DTPOSTED>
+            <TRNAMT>-12.0</TRNAMT>
+            <FITID>yy-56</FITID>
+            <SIC>7933</SIC>
+            <NAME>SUNSET BOWL            ANYTOWN</NAME>
+          </STMTTRN>
+          <STMTTRN>
+            <TRNTYPE>CREDIT</TRNTYPE>
+            <DTPOSTED>20070526170000</DTPOSTED>
+            <TRNAMT>11.01</TRNAMT>
+            <FITID>78-9</FITID>
+            <SIC>0000</SIC>
+            <NAME>ELECTRONIC PAYMENT-THANK YOU</NAME>
+          </STMTTRN>
+        </BANKTRANLIST>
+        <LEDGERBAL>
+          <BALAMT>-1111.01</BALAMT>
+          <DTASOF>20070623192013</DTASOF>
+        </LEDGERBAL>
+        <AVAILBAL>
+          <BALAMT>19000.99</BALAMT>
+          <DTASOF>20070623192013</DTASOF>
+        </AVAILBAL>
+      </CCSTMTRS>
+    </CCSTMTTRNRS>
+  </CREDITCARDMSGSRSV1>
+</OFX>
+

data/test/fixtures/with_spaces.ofx.sgml

@@ -0,0 +1,28 @@
+OFXHEADER:100
+DATA:OFXSGML
+VERSION:102
+SECURITY:NONE
+ENCODING:USASCII
+CHARSET:1252
+COMPRESSION:NONE
+OLDFILEUID:NONE
+NEWFILEUID:NONE
+
+<OFX>
+  <SIGNONMSGSRSV1>
+    <SONRS>
+      <STATUS>
+        <CODE>   0
+        <SEVERITY>   INFO
+        <MESSAGE>   The user is authentic; operation succeeded.
+      </STATUS>
+      <DTSERVER>   20070623142635.169[-5:CDT]
+      <LANGUAGE>ENG
+      <FI>
+        <ORG>   U.S. Bank
+        <FID>   1402
+      </FI>
+      <INTU.BID>1402
+    </SONRS>
+  </SIGNONMSGSRSV1>
+</OFX>

data/test/test_ofx_parser.rb

@@ -0,0 +1,244 @@
+require 'test/unit'
+require 'ofx-parser'
+
+class OfxParserTest < Test::Unit::TestCase
+
+  OFX_FILES = {}
+
+  fixtures_dir = File.dirname(__FILE__) + '/fixtures'
+
+  # Load up the xml files
+  Dir.open(fixtures_dir).each do |fn|
+    next unless fn =~ /\.ofx\.sgml$/
+    OFX_FILES[fn.scan(/^[^.]*/).to_s.to_sym] = File.read(fixtures_dir + "/#{fn}")
+  end
+
+  def setup
+    # empty ofx parser - useful for testing other methods independently
+    @parser = OfxParser::OfxParser
+  end
+
+  def test_pre_process_strips_spaces
+    header, body = @parser.pre_process(OFX_FILES[:with_spaces])
+
+    assert_no_match(/>\s+.*?</, body, "should be no spaces after a tag close")
+    assert_no_match(/>.*?\s+</, body, "should be no spaces before a tag close")
+    assert_no_match(/>\s+</, body, "should be no spaces between two tags")
+    assert_match("The user is authentic; operation succeeded.", body, "content in tags should not be altered")
+  end
+
+  def test_pre_process_header
+    header, body = @parser.pre_process(OFX_FILES[:with_spaces])
+
+    assert_equal 9, header.keys.size
+  end
+
+  def test_parse_datetime
+    assert_equal DateTime.civil(2007, 6, 22, 19, 0, 0, Rational(-5,24)), @parser.parse_datetime('20070622190000.200[-5:CDT]')
+    assert_equal DateTime.civil(2007, 6, 22), @parser.parse_datetime('20070622')
+    assert_equal DateTime.civil(2007, 6, 22, 19, 0, 0), @parser.parse_datetime('20070622190000')
+    assert_equal DateTime.civil(2007, 6, 22, 19, 0, 0), @parser.parse_datetime('20070622190000.200')
+  end
+
+  def test_sign_on
+    ofx = OfxParser::OfxParser.parse(OFX_FILES[:with_spaces])
+
+    assert_equal '0', ofx.sign_on.status.code
+    assert_equal 'INFO', ofx.sign_on.status.severity
+    assert_equal 'The user is authentic; operation succeeded.', ofx.sign_on.status.message
+    assert_equal 'Success', ofx.sign_on.status.code_desc
+
+    assert_equal DateTime.civil(2007,6,23,14,26,35,Rational(-5, 24)), ofx.sign_on.date
+    assert_equal 'ENG', ofx.sign_on.language
+    assert_equal 'U.S. Bank', ofx.sign_on.institute.name
+    assert_equal '1402', ofx.sign_on.institute.id
+  end
+
+  def test_no_accounts
+    ofx = OfxParser::OfxParser.parse(OFX_FILES[:with_spaces])
+
+    assert_equal 0, ofx.accounts.size
+  end
+
+  def test_banking
+    ofx = OfxParser::OfxParser.parse(OFX_FILES[:banking])
+
+    acct = ofx.bank_account
+
+    assert_equal '103333333333', acct.number
+    assert_equal '033000033', acct.routing_number
+    assert_equal :CHECKING, acct.type
+    assert_equal '1234.09', acct.balance
+    assert_equal 123409, acct.balance_in_pennies
+    assert_equal DateTime.civil(2007,6,23,14,26,35,Rational(-5, 24)), acct.balance_date
+    assert_equal '9C24229A0077EAA50000011353C9E00743FC', acct.transaction_uid
+
+    statement = acct.statement
+
+    assert_equal 'USD', statement.currency
+    assert_equal DateTime.civil(2007,6,4,19,0,0,Rational(-5, 24)), statement.start_date
+    assert_equal DateTime.civil(2007,6,22,19,0,0,Rational(-5, 24)), statement.end_date
+
+    transactions = statement.transactions
+    assert_equal 4, transactions.size
+
+    assert_equal :PAYMENT, transactions[0].type
+    assert_equal OfxParser::Transaction::TYPE[:PAYMENT], transactions[0].type_desc
+    assert_equal DateTime.civil(2007,6,6,12,0,0), transactions[0].date
+    assert_equal '-11.11', transactions[0].amount
+    assert_equal -1111, transactions[0].amount_in_pennies
+    assert_equal '11111111 22', transactions[0].fit_id
+    assert_equal nil, transactions[0].check_number
+    assert_equal nil, transactions[0].sic
+    assert_equal nil, transactions[0].sic_desc
+    assert_equal 'WEB AUTHORIZED PMT FOO INC', transactions[0].payee
+    assert_equal 'Download from usbank.com. FOO INC', transactions[0].memo
+
+    assert_equal :CHECK, transactions[1].type
+    assert_equal OfxParser::Transaction::TYPE[:CHECK], transactions[1].type_desc
+    assert_equal DateTime.civil(2007,6,7,12,0,0), transactions[1].date
+    assert_equal '-111.11', transactions[1].amount
+    assert_equal -11111, transactions[1].amount_in_pennies
+    assert_equal '22222A', transactions[1].fit_id
+    assert_equal '0000009611', transactions[1].check_number
+    assert_equal nil, transactions[1].sic
+    assert_equal nil, transactions[1].sic_desc
+    assert_equal 'CHECK', transactions[1].payee
+    assert_equal 'Download from usbank.com.', transactions[1].memo
+
+    assert_equal :DIRECTDEP, transactions[2].type
+    assert_equal OfxParser::Transaction::TYPE[:DIRECTDEP], transactions[2].type_desc
+    assert_equal DateTime.civil(2007,6,14,12,0,0), transactions[2].date
+    assert_equal '1111.11', transactions[2].amount
+    assert_equal 111111, transactions[2].amount_in_pennies
+    assert_equal 'X34AE33', transactions[2].fit_id
+    assert_equal nil, transactions[2].check_number
+    assert_equal nil, transactions[2].sic
+    assert_equal nil, transactions[2].sic_desc
+    assert_equal 'ELECTRONIC DEPOSIT BAR INC', transactions[2].payee
+    assert_equal 'Download from usbank.com. BAR INC', transactions[2].memo
+
+    assert_equal :CREDIT, transactions[3].type
+    assert_equal OfxParser::Transaction::TYPE[:CREDIT], transactions[3].type_desc
+    assert_equal DateTime.civil(2007,6,19,12,0,0), transactions[3].date
+    assert_equal '11.11', transactions[3].amount
+    assert_equal 1111, transactions[3].amount_in_pennies
+    assert_equal '8 8 9089743', transactions[3].fit_id
+    assert_equal nil, transactions[3].check_number
+    assert_equal nil, transactions[3].sic
+    assert_equal nil, transactions[3].sic_desc
+    assert_equal 'ATM DEPOSIT US BANK ANYTOWNAS', transactions[3].payee
+    assert_equal 'Download from usbank.com. US BANK ANYTOWN ASUS1', transactions[3].memo
+
+    assert_equal 1, ofx.accounts.size
+  end
+
+  def test_creditcard
+    ofx = OfxParser::OfxParser.parse(OFX_FILES[:creditcard])
+
+    acct = ofx.credit_card
+
+    assert_equal 'XXXXXXXXXXXX1111', acct.number
+    assert_equal '19000.99', acct.remaining_credit
+    assert_equal 1900099, acct.remaining_credit_in_pennies
+    assert_equal DateTime.civil(2007,6,23,19,20,13), acct.remaining_credit_date
+    assert_equal '-1111.01', acct.balance
+    assert_equal -111101, acct.balance_in_pennies
+    assert_equal DateTime.civil(2007,6,23,19,20,13), acct.balance_date
+    assert_equal '0', acct.transaction_uid
+
+    statement = acct.statement
+
+    assert_equal 'USD', statement.currency
+    assert_equal DateTime.civil(2007,5,9,12,0,0), statement.start_date
+    assert_equal DateTime.civil(2007,6,8,12,0,0), statement.end_date
+
+    transactions = statement.transactions
+    assert_equal 3, transactions.size
+
+    assert_equal :DEBIT, transactions[0].type
+    assert_equal OfxParser::Transaction::TYPE[:DEBIT], transactions[0].type_desc
+    assert_equal DateTime.civil(2007,5,10,17,0,0), transactions[0].date
+    assert_equal '-19.17', transactions[0].amount
+    assert_equal -1917, transactions[0].amount_in_pennies
+    assert_equal 'xx', transactions[0].fit_id
+    assert_equal nil, transactions[0].check_number
+    assert_equal '5912', transactions[0].sic
+    assert_equal OfxParser::Sic::CODES['5912'], transactions[0].sic_desc
+    assert_equal 'WALGREEN      34638675 ANYTOWN', transactions[0].payee
+    assert_equal '', transactions[0].memo
+
+    assert_equal :DEBIT, transactions[1].type
+    assert_equal OfxParser::Transaction::TYPE[:DEBIT], transactions[1].type_desc
+    assert_equal DateTime.civil(2007,5,12,17,0,0), transactions[1].date
+    assert_equal '-12.0', transactions[1].amount
+    assert_equal -1200, transactions[1].amount_in_pennies
+    assert_equal 'yy-56', transactions[1].fit_id
+    assert_equal nil, transactions[1].check_number
+    assert_equal '7933', transactions[1].sic
+    assert_equal OfxParser::Sic::CODES['7933'], transactions[1].sic_desc
+    assert_equal 'SUNSET BOWL            ANYTOWN', transactions[1].payee
+    assert_equal '', transactions[1].memo
+
+    assert_equal :CREDIT, transactions[2].type
+    assert_equal OfxParser::Transaction::TYPE[:CREDIT], transactions[2].type_desc
+    assert_equal DateTime.civil(2007,5,26,17,0,0), transactions[2].date
+    assert_equal '11.01', transactions[2].amount
+    assert_equal 1101, transactions[2].amount_in_pennies
+    assert_equal '78-9', transactions[2].fit_id
+    assert_equal nil, transactions[2].check_number
+    assert_equal '0000', transactions[2].sic
+    assert_equal nil, transactions[2].sic_desc
+    assert_equal 'ELECTRONIC PAYMENT-THANK YOU', transactions[2].payee
+    assert_equal '', transactions[2].memo
+
+    assert_equal 1, ofx.accounts.size
+  end
+
+  def test_monetary_support_call
+    t = OfxParser::Transaction.new
+    t.amount = '-11.1'
+
+    assert_nothing_raised { t.amount_in_pennies }
+    assert_raise(NoMethodError) { t.amount_in_whatever }
+
+    assert t.respond_to?(:amount_in_pennies)
+    assert !t.respond_to?(:amount_in_whatever)
+
+
+  end
+
+  class X
+    include OfxParser::MonetarySupport
+    attr_accessor :amount
+    monetary_vars :amount
+  end
+
+  def test_original_method
+    x = X.new
+    assert_equal :a_b, x.original_method('a_b_in_pennies')
+    assert_equal :a, x.original_method('a_in_pennies')
+  end
+
+  def test_for_pennies
+    amounts = {
+      '-11.1' => -111,
+      '-11.110' => -1111,
+      '-11.11101' => -1111,
+      '11.11' => 1111,
+      '11,11' => 1111,
+      '1' => 100,
+      '1.0' => 100,
+      '-1.0' => -100,
+      '' => nil
+    }
+
+    x =  X.new
+
+    amounts.each do |actual, expected|
+      x.amount = actual
+      assert_equal expected, x.amount_in_pennies, "#{actual.inspect} should give #{expected.inspect}"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: ofx-parser
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-06-26 00:00:00 -07:00
+summary: ofx-parser is a ruby library for parsing OFX 1.x data.
+require_paths: 
+- lib
+email: andy@tinnedfruit.org
+homepage: http://ofx-parser.rubyforge.org/
+rubyforge_project: ofx-parser
+description: "== DESCRIPTION:  ofx-parser is a ruby library to parse a realistic subset of the lengthy OFX 1.x specification.  == FEATURES/PROBLEMS:  * Reads OFX responses - i.e. those downloaded from financial institutions and puts it into a usable object graph. * Supports the 3 main message sets: banking, credit card and investment accounts, as well as the required 'sign on' set. * Knows about SIC codes - if your institution provides them. See http://www.eeoc.gov/stats/jobpat/siccodes.html * Monetary amounts can be retrieved either as a raw string, or in pennies. * Supports OFX timestamps."
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Andrew A. Smith
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/class-extension.rb
+- lib/ofx-parser.rb
+- lib/ofx.rb
+- lib/sic.rb
+- test/fixtures/banking.ofx.sgml
+- test/fixtures/creditcard.ofx.sgml
+- test/fixtures/with_spaces.ofx.sgml
+- test/test_ofx_parser.rb
+test_files: 
+- test/test_ofx_parser.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: