ofx_parser 1.0.6

data/lib/ofx_parser/ofx.rb

@@ -0,0 +1,128 @@
+module OfxParser
+  # This class is returned when a parse is successful.
+  # == General Notes
+  # * currency symbols are an iso4217 3-letter code
+  # * language is defined by iso639 3-letter code
+  class Ofx
+    attr_accessor :header, :sign_on, :signup_account_info,
+                  :bank_account, :credit_card, :investment
+
+    def accounts
+      accounts = []
+      [:bank_account, :credit_card, :investment].each do |method|
+        val = send(method)
+        accounts << val if val
+      end
+      accounts
+    end
+  end
+
+  class SignOn
+    attr_accessor :status, :date, :language, :institute
+  end
+
+  class AccountInfo
+    attr_accessor :desc, :number
+  end
+
+  class Account
+    attr_accessor :number, :statement, :transaction_uid, :routing_number
+  end
+
+  class BankAccount < Account
+    TYPE = [:CHECKING, :SAVINGS, :MONEYMRKT, :CREDITLINE]
+    attr_accessor :type, :balance, :balance_date
+
+    undef type
+    def type
+      @type.to_s.upcase.to_sym
+    end
+  end
+
+  class CreditAccount < Account
+    attr_accessor :remaining_credit, :remaining_credit_date, :balance, :balance_date
+  end
+
+  class InvestmentAccount < Account
+    attr_accessor :broker_id, :positions, :margin_balance, :short_balance, :cash_balance
+  end
+
+
+  class Statement
+    attr_accessor :currency, :transactions, :start_date, :end_date
+  end
+
+  class Transaction
+    attr_accessor :type, :date, :amount, :fit_id, :check_number, :sic, :memo, :payee
+
+    TYPE = {
+      :CREDIT      => "Generic credit",
+      :DEBIT       => "Generic debit",
+      :INT         => "Interest earned or paid ",
+      :DIV         => "Dividend",
+      :FEE         => "FI fee",
+      :SRVCHG      => "Service charge",
+      :DEP         => "Deposit",
+      :ATM         => "ATM debit or credit",
+      :POS         => "Point of sale debit or credit ",
+      :XFER        => "Transfer",
+      :CHECK       => "Check",
+      :PAYMENT     => "Electronic payment",
+      :CASH        => "Cash withdrawal",
+      :DIRECTDEP   => "Direct deposit",
+      :DIRECTDEBIT => "Merchant initiated debit",
+      :REPEATPMT   => "Repeating payment/standing order",
+      :OTHER       => "Other"
+    }
+
+    def type_desc
+      TYPE[type]
+    end
+
+    undef type
+    def type
+      @type.to_s.strip.upcase.to_sym
+    end
+
+    undef sic
+    def sic
+      @sic == "" ? nil : @sic
+    end
+
+    def sic_desc
+      Mcc::CODES[sic]
+    end
+  end
+
+  class Position
+  end
+
+  # Status of a sign on
+  class Status
+    attr_accessor :code, :severity, :message
+
+    CODES = {
+      '0'	    => 'Success',
+      '2000'	=> 'General error',
+      '15000'	=> 'Must change USERPASS',
+      '15500'	=> 'Signon invalid',
+      '15501'	=> 'Customer account already in use',
+      '15502'	=> 'USERPASS Lockout'
+    }
+
+    def code_desc
+      CODES[code]
+    end
+
+    undef code
+    def code
+      @code.to_s.strip
+    end
+
+  end
+
+  class Institute
+    attr_accessor :name, :id
+  end
+
+end

data/lib/ofx_parser/ofx_parser.rb

@@ -0,0 +1,188 @@
+require 'rubygems'
+require 'hpricot'
+require 'time'
+require 'date'
+
+module OfxParser
+  VERSION = '1.0.6'
+
+  class OfxParser
+
+    # Creates and returns an Ofx instance when given a well-formed OFX document,
+    # complete with the mandatory key:pair header.
+    def self.parse(ofx)
+      ofx = ofx.respond_to?(:read) ? ofx.read.to_s : ofx.to_s
+
+      return Ofx.new if ofx == ""
+
+      header, body = pre_process(ofx)
+
+      ofx_out = parse_body(body)
+      ofx_out.header = header
+      ofx_out
+    end
+
+    # Designed to make the main OFX body parsable. This means adding closing tags
+    # to the SGML to make it parsable by hpricot.
+    #
+    # Returns an array of 2 elements:
+    # * header as a hash,
+    # * body as an evily pre-processed string ready for parsing by hpricot.
+    def self.pre_process(ofx)
+      header, body = ofx.split(/\n{2,}|:?<OFX>/, 2)
+
+      header = Hash[*header.gsub(/^\r?\n+/,'').split(/\r\n/).collect do |e| 
+        e.split(/:/,2)
+      end.flatten]
+
+      body.gsub!(/>\s+</m, '><')
+      body.gsub!(/\s+</m, '<')
+      body.gsub!(/>\s+/m, '>')
+      body.gsub!(/<(\w+?)>([^<]+)/m, '<\1>\2</\1>')
+
+      [header, body]
+    end
+
+    # Takes an OFX datetime string of the format:
+    # * YYYYMMDDHHMMSS.XXX[gmt offset:tz name]
+    # * YYYYMMDD
+    # * YYYYMMDDHHMMSS
+    # * YYYYMMDDHHMMSS.XXX
+    #
+    # Returns a DateTime object. Milliseconds (XXX) are ignored.
+    def self.parse_datetime(date)
+      if /\A\s*
+          (\d{4})(\d{2})(\d{2})           ?# YYYYMMDD            1,2,3
+          (?:(\d{2})(\d{2})(\d{2}))?      ?# HHMMSS  - optional  4,5,6
+          (?:\.(\d{3}))?                  ?# .XXX    - optional  7
+          (?:\[([-+]?[\.\d]+)\:\w{3}\])?  ?# [-n:TZ] - optional  8,9
+          \s*\z/ix =~ date
+        year = $1.to_i
+        mon = $2.to_i
+        day = $3.to_i
+        hour = $4.to_i
+        min = $5.to_i
+        sec = $6.to_i
+        # DateTime does not support usecs.
+        # usec = 0
+        # usec = $7.to_f * 1000000 if $7
+        off = Rational($8.to_i, 24) # offset as a fraction of day. :|
+        DateTime.civil(year, mon, day, hour, min, sec, off)
+      end
+    end
+
+  private
+    def self.parse_body(body)
+      doc = Hpricot.XML(body)
+
+      ofx = Ofx.new
+
+      ofx.sign_on = build_signon((doc/"SIGNONMSGSRSV1/SONRS"))
+      ofx.signup_account_info = build_info((doc/"SIGNUPMSGSRSV1/ACCTINFOTRNRS"))
+      ofx.bank_account = build_bank((doc/"BANKMSGSRSV1/STMTTRNRS")) unless (doc/"BANKMSGSRSV1").empty?
+      ofx.credit_card = build_credit((doc/"CREDITCARDMSGSRSV1/CCSTMTTRNRS")) unless (doc/"CREDITCARDMSGSRSV1").empty?
+      #build_investment((doc/"SIGNONMSGSRQV1"))
+
+      ofx
+    end
+
+    def self.build_signon(doc)
+      sign_on = SignOn.new
+      sign_on.status = build_status((doc/"STATUS"))
+      sign_on.date = parse_datetime((doc/"DTSERVER").inner_text)
+      sign_on.language = (doc/"LANGUAGE").inner_text
+
+      sign_on.institute = Institute.new
+      sign_on.institute.name = ((doc/"FI")/"ORG").inner_text
+      sign_on.institute.id = ((doc/"FI")/"FID").inner_text
+      sign_on
+    end
+
+    def self.build_info(doc)
+      account_infos = []
+
+      (doc/"ACCTINFO").each do |info_doc|
+        acc_info = AccountInfo.new
+        acc_info.desc = (info_doc/"DESC").inner_text
+        acc_info.number = (info_doc/"ACCTID").inner_text
+        account_infos << acc_info
+      end
+
+      account_infos
+    end
+
+    def self.build_bank(doc)
+      acct = BankAccount.new
+
+      acct.transaction_uid = (doc/"TRNUID").inner_text.strip
+      acct.number = (doc/"STMTRS/BANKACCTFROM/ACCTID").inner_text
+      acct.routing_number = (doc/"STMTRS/BANKACCTFROM/BANKID").inner_text
+      acct.type = (doc/"STMTRS/BANKACCTFROM/ACCTTYPE").inner_text.strip
+      acct.balance = (doc/"STMTRS/LEDGERBAL/BALAMT").inner_text
+      acct.balance_date = parse_datetime((doc/"STMTRS/LEDGERBAL/DTASOF").inner_text)
+
+      statement = Statement.new
+      statement.currency = (doc/"STMTRS/CURDEF").inner_text
+      statement.start_date = parse_datetime((doc/"STMTRS/BANKTRANLIST/DTSTART").inner_text)
+      statement.end_date = parse_datetime((doc/"STMTRS/BANKTRANLIST/DTEND").inner_text)
+      acct.statement = statement
+
+      statement.transactions = (doc/"STMTRS/BANKTRANLIST/STMTTRN").collect do |t|
+        build_transaction(t)
+      end
+
+      acct
+    end
+
+    def self.build_credit(doc)
+      acct = CreditAccount.new
+
+      acct.number = (doc/"CCSTMTRS/CCACCTFROM/ACCTID").inner_text
+      acct.transaction_uid = (doc/"TRNUID").inner_text.strip
+      acct.balance = (doc/"CCSTMTRS/LEDGERBAL/BALAMT").inner_text
+      acct.balance_date = parse_datetime((doc/"CCSTMTRS/LEDGERBAL/DTASOF").inner_text)
+      acct.remaining_credit = (doc/"CCSTMTRS/AVAILBAL/BALAMT").inner_text
+      acct.remaining_credit_date = parse_datetime((doc/"CCSTMTRS/AVAILBAL/DTASOF").inner_text)
+
+      statement = Statement.new
+      statement.currency = (doc/"CCSTMTRS/CURDEF").inner_text
+      statement.start_date = parse_datetime((doc/"CCSTMTRS/BANKTRANLIST/DTSTART").inner_text)
+      statement.end_date = parse_datetime((doc/"CCSTMTRS/BANKTRANLIST/DTEND").inner_text)
+      acct.statement = statement
+
+      statement.transactions = (doc/"CCSTMTRS/BANKTRANLIST/STMTTRN").collect do |t|
+        build_transaction(t)
+      end
+
+      acct
+    end
+
+    # for credit and bank transactions.
+    def self.build_transaction(t)
+      transaction = Transaction.new
+      transaction.type = (t/"TRNTYPE").inner_text
+      transaction.date = parse_datetime((t/"DTPOSTED").inner_text)
+      transaction.amount = (t/"TRNAMT").inner_text
+      transaction.fit_id = (t/"FITID").inner_text
+      transaction.payee = (t/"PAYEE").inner_text + (t/"NAME").inner_text
+      transaction.memo = (t/"MEMO").inner_text
+      transaction.sic = (t/"SIC").inner_text
+      transaction.check_number = (t/"CHECKNUM").inner_text if transaction.type == :CHECK
+      transaction
+    end
+
+
+    def self.build_investment(doc)
+
+    end
+
+    def self.build_status(doc)
+      status = Status.new
+      status.code = (doc/"CODE").inner_text
+      status.severity = (doc/"SEVERITY").inner_text
+      status.message = (doc/"MESSAGE").inner_text
+      status
+    end
+
+  end
+end

data/ofx-parser.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ofx_parser"
+
+Gem::Specification.new do |s|
+  s.name        = "ofx_parser"
+  s.version     = OfxParser::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrew A. Smith", "Armand du Plessis"]
+  s.email       = ["adp@bank.io"]
+  s.homepage    = "http://ofx-parser.rubyforge.org/"
+  s.summary     = %q{ofx-parser is an OFX 1.x parser written in Ruby. Forked from original ofx-parser gem to remove UK monetary support}
+  s.description = %q{ofx-parser is an OFX 1.x parser written in Ruby. Forked from original ofx-parser gem to remove UK monetary support}
+
+  s.rubyforge_project = "ofx_parser"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency 'hpricot'
+end

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:
+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>
+