ofxparser 1.0.0

data/lib/ofx.rb

@@ -0,0 +1,189 @@
+module OfxParser
+  module MonetarySupport
+ # 	@@monies = []
+ #   @@monies ||= []
+
+ #   class_extension do
+ #     def monetary_vars(*methods) #:nodoc:
+ #       @@monies += methods
+ #     end
+ #   end
+
+    # Returns pennies for a given string amount, i.e:
+    #  '-123.45' => -12345
+    #  '123' => 12300
+    def pennies_for(amount)
+      return nil if amount == ""
+      int, fraction = amount.scan(/\d+/)
+      i = (fraction.to_s.strip =~ /[1-9]/) ? "#{int}#{fraction[0,2]}".to_i : int.to_i * 100
+      amount =~ /^\s*-\s*\d+/ ? -i : i
+    end
+
+    def original_method(meth) #:nodoc:
+      meth.to_s.sub('_in_pennies','').to_sym rescue nil
+    end
+
+    def monetary_method_call?(meth) #:nodoc:
+      orig = original_method(meth)
+      @@monies.include?(orig) && meth.to_s == "#{orig}_in_pennies"
+    end
+
+    def method_missing(meth, *args) #:nodoc:
+      if (monetary_method_call?(meth))
+        pennies_for(send(original_method(meth)))
+      else
+        super
+      end
+    end
+
+    def respond_to?(meth) #:nodoc:
+      monetary_method_call?(meth) ? true : super
+    end
+
+  end
+
+  # 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
+  end
+
+  class BankAccount < Account
+    TYPE = [:CHECKING, :SAVINGS, :MONEYMRKT, :CREDITLINE]
+    attr_accessor :routing_number, :type, :balance, :balance_date
+
+    include MonetarySupport
+    #monetary_vars :balance
+
+    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
+
+    include MonetarySupport
+#    monetary_vars :remaining_credit, :balance
+  end
+
+  class InvestmentAccount < Account
+    attr_accessor :broker_id, :positions, :margin_balance, :short_balance, :cash_balance
+
+   # include MonetarySupport
+#    monetary_vars :margin_balance, :short_balance, :cash_balance
+  end
+
+
+  class Statement
+    attr_accessor :currency, :transactions, :start_date, :end_date, :stock_positions, :opt_positions
+  end
+
+  class Transaction
+    attr_accessor :type, :date, :amount, :fit_id, :check_number, :sic, :memo, :payee
+
+    include MonetarySupport
+ #   monetary_vars :amount
+
+    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 Stock_Position
+  	attr_accessor :uniqueid, :uniqueid_type, :heldinacct, :type, :units, :unitprice, :pricedate, :memo	
+  end
+  
+   class Opt_Position
+  	attr_accessor :uniqueid, :uniqueid_type, :heldinacct, :type, :units, :unitprice, :pricedate, :memo, :mktval	
+  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/ofxparser.rb

@@ -0,0 +1,236 @@
+require 'hpricot'
+require 'time'
+require 'date'
+
+%w(class-extension ofx mcc).each do |fn|
+  require File.dirname(__FILE__) + "/#{fn}"
+end
+
+module OfxParser
+  VERSION = '1.0.0'
+
+  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?
+      ofx.investment=build_investment((doc/"INVSTMTMSGSRSV1/INVSTMTTRNRS"))
+      
+      
+      #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)
+	  acct = InvestmentAccount.new
+	  acct.broker_id=(doc/"INVSTMTRS/INVACCTFROM/BROKERID").inner_text
+	  acct.cash_balance=(doc/"INVSTMTRS/INVBAL/AVAILCASH").inner_text
+	  
+	  statement = Statement.new
+	  acct.statement=statement
+	    
+	  statement.stock_positions = (doc/"INVSTMTRS/INVPOSLIST/POSSTOCK").collect do |p|
+	  	build_stock_position(p)
+  	  end
+  	  
+	  statement.opt_positions = (doc/"INVSTMTRS/INVPOSLIST/POSOPT").collect do |p|
+	  	build_opt_position(p)
+  	  end  	  
+
+	  acct
+    end
+
+	def self.build_stock_position(p)
+	  stock_position = Stock_Position.new
+	  stock_position.uniqueid = (p/"INVPOS/SECID/UNIQUEID").inner_text
+	  stock_position.uniqueid_type = (p/"INVPOS/SECID/UNIQUEIDTYPE").inner_text
+	  stock_position.heldinacct = (p/"INVPOS/HELDINACCT").inner_text
+	  stock_position.type = (p/"INVPOS/POSTYPE").inner_text
+	  stock_position.units = (p/"INVPOS/UNITS").inner_text
+      stock_position.unitprice = (p/"INVPOS/UNITPRICE").inner_text	  
+	  stock_position.pricedate = parse_datetime((p/"INVPOS/DTPRICEASOF").inner_text)
+	  stock_position.memo = (p/"INVPOS/MEMO").inner_text
+	  stock_position
+	end
+
+	def self.build_opt_position(p)
+	  opt_position = Opt_Position.new
+	  opt_position.uniqueid = (p/"INVPOS/SECID/UNIQUEID").inner_text
+	  opt_position.uniqueid_type = (p/"INVPOS/SECID/UNIQUEIDTYPE").inner_text
+	  opt_position.heldinacct = (p/"INVPOS/HELDINACCT").inner_text
+	  opt_position.type = (p/"INVPOS/POSTYPE").inner_text
+	  opt_position.units = (p/"INVPOS/UNITS").inner_text
+      opt_position.unitprice = (p/"INVPOS/UNITPRICE").inner_text	  
+      opt_position.mktval = (p/"INVPOS/MKTVAL").inner_text
+	  opt_position.pricedate = parse_datetime((p/"INVPOS/DTPRICEASOF").inner_text)
+	  opt_position.memo = (p/"INVPOS/MEMO").inner_text
+	  opt_position
+	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/test/test_ofxparser.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "ofxparser"
+
+class TestOfxparser < Test::Unit::TestCase
+  def test_sanity
+    flunk "write tests or I will kneecap you"
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: ofxparser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Pavit Masson (forked from Andrew A. Smith)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-27 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: &9298020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9298020
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &9297684 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *9297684
+description: ! '== DESCRIPTION:  My fork of aasmith''s ofx-parser v1.0.2 and attempt
+  at building the investment acct methods. OfxParser 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.'
+email: pavitm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/class-extension.rb
+- lib/mcc.rb
+- lib/ofxparser.rb
+- lib/ofx.rb
+- test/test_ofxparser.rb
+has_rdoc: true
+homepage: http://ofxparser.rubyforge.org/
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ofxparser
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 2
+summary: ofx-parser is a ruby library for parsing OFX 1.x data.
+test_files:
+- test/test_ofxparser.rb