libofx-ffi 0.1.3

data/lib/ofx.rb

@@ -0,0 +1,36 @@
+require 'ffi'
+
+require 'ofx/ffi'
+
+require 'ofx/statement'
+require 'ofx/account'
+require 'ofx/transaction'
+
+module OFX
+  AccountCallback = Proc.new do |acct_data, junk|
+    account = Account.new(acct_data)
+    @statement[account.number] = account
+    0
+  end
+
+  TransactionCallback = Proc.new do |t, junk|
+    acct_data = FFI::AccountData.new t[:account_ptr]
+    acct_num  = acct_data.account_number
+    @statement[acct_num].transactions << Transaction.new(t)
+    0
+  end
+
+  def self.parse(file_name)
+    raise Errno::ENOENT unless File.exist? file_name
+
+    @statement = OFX::Statement.new
+
+    context = FFI.libofx_get_new_context
+    FFI.ofx_set_account_cb context, AccountCallback
+    FFI.ofx_set_transaction_cb context, TransactionCallback
+    FFI.ofx_proc_file context, file_name, 0
+    FFI.libofx_free_context context
+
+    @statement
+  end
+end

data/lib/ofx/account.rb

@@ -0,0 +1,13 @@
+module OFX
+  class Account
+    attr_reader   :number, :type
+    attr_accessor :transactions
+
+    def initialize(ffi_account)
+      @number = ffi_account.account_number.to_s
+      @type   = ffi_account.account_type
+
+      @transactions = []
+    end
+  end
+end

data/lib/ofx/ffi.rb

@@ -0,0 +1,100 @@
+require 'ofx/ffi/valid_access'
+
+module OFX
+  module FFI
+    extend ::FFI::Library
+    ffi_lib 'ofx'
+
+    # LibofxContextPtr is void*
+    attach_function :libofx_get_new_context, [], :pointer
+    attach_function :libofx_free_context, [:pointer], :int
+
+    attach_function :ofx_proc_file, [:pointer, :pointer, :int], :int
+
+    AccountType = enum :checking, :savings, :money_market, :credit_line,
+                       :cma, :credit_card, :investment
+    class AccountData < ::FFI::Struct
+      include ValidAccess
+
+      layout :account_id, [:char, 57],
+        :account_name, [:char, 255],
+        :account_id_valid, :int,
+        :account_type, AccountType,
+        :account_type_valid, :int,
+        :currency, [:char, 4],
+        :currency_valid, :int,
+        :account_number, [:char, 23],
+        :account_number_valid, :int,
+        :bank_id, [:char, 10],
+        :bank_id_valid, :int,
+        :broker_id, [:char, 23],
+        :broker_id_valid, :int,
+        :branch_id, [:char, 23],
+        :branch_id_valid, :int
+    end
+    callback :account_callback, [AccountData.by_value, :pointer], :int
+    attach_function :ofx_set_account_cb, [:pointer, :account_callback], :void
+
+
+    TransactionType = enum :credit, :debit, :interest, :dividend, :fee,
+                           :service_change, :deposit, :atm, :point_of_sale,
+                           :transfer, :check, :payment, :cash_withdrawal,
+                           :direct_deposit, :direct_debit, :repeat_payment,
+                           :other
+    class TransactionData < ::FFI::Struct
+      include ValidAccess
+
+      layout :account_id, [:char, 57],
+        :account_ptr, :pointer,
+        :account_id_valid, :int,
+        :transaction_type, TransactionType,
+        :transaction_type_valid, :int,
+        :investment_transaction_type, :int, # this is really an enum but i don't care about it right now
+        :investment_transaction_type_valid, :int,
+        :units, :double,
+        :units_valid, :int,
+        :unit_price, :double,
+        :units_price_valid, :int,
+        :amount, :double,
+        :amount_valid, :int,
+        :fi_id, [:char, 256],
+        :fi_id_valid, :int,
+        :unique_id, [:char, 33],
+        :unique_id_valid, :int,
+        :unique_id_type, [:char, 11],
+        :unique_id_type_valid, :int,
+        :security_data, :pointer,
+        :security_data_valid, :int,
+        :date_posted, :int, # really a time_t
+        :date_posted_valid, :int,
+        :date_initiated, :int, #time_t
+        :date_initiated_valid, :int,
+        :date_funds_available, :int, # time_t
+        :date_funds_available_valid, :int,
+        :fi_id_corrected, [:char, 256],
+        :fi_id_corrected_valid, :int,
+        :fi_id_corrected_action, :int, #really an enum
+        :fi_id_corrected_action_valid, :int,
+        :server_transaction_id, [:char, 37],
+        :server_transaction_id_valid, :int,
+        :check_number, [:char, 13],
+        :check_number_valid, :int,
+        :reference_number, [:char, 33],
+        :reference_number_valid, :int,
+        :standard_industrial_code, :long,
+        :standard_industrial_code_valid, :int,
+        :payee_id, [:char, 37],
+        :payee_id_valid, :int,
+        :name, [:char, 33],
+        :name_valid, :int,
+        :memo, [:char, 391],
+        :memo_valid, :int,
+        :commission, :double,
+        :commission_valid, :int,
+        :fees, :double,
+        :fees_valid, :int
+    end
+    callback :transaction_callback, [TransactionData.by_value, :pointer], :int
+    attach_function :ofx_set_transaction_cb, [:pointer, :transaction_callback], :void
+  end
+end

data/lib/ofx/ffi/valid_access.rb

@@ -0,0 +1,13 @@
+module OFX
+  module FFI
+    module ValidAccess
+      def self.included(c)
+        class_eval do
+          def method_missing(attribute, *args)
+            self[:"#{attribute}_valid"] == 1 ? self[attribute] : nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ofx/statement.rb

@@ -0,0 +1,23 @@
+module OFX
+  class Statement
+    def initialize
+      @accounts = {}
+    end
+
+    def [](key)
+      # have to call to_s because the original key from ffi is a CharArray
+      # (equality doesn't do what i want)
+      @accounts[key.to_s]
+    end
+
+    def []=(key, val)
+      @accounts[key.to_s] = val
+    end
+
+    def each
+      @accounts.each do |number, account|
+        yield account
+      end
+    end
+  end
+end

data/lib/ofx/transaction.rb

@@ -0,0 +1,16 @@
+require 'time'
+
+module OFX
+  class Transaction
+    attr_reader :number, :date, :type, :name, :memo, :amount
+
+    def initialize(ffi_transaction)
+      @number = ffi_transaction.fi_id.to_s
+      @date = Time.at ffi_transaction.date_posted
+      @memo = ffi_transaction.memo.to_s
+      @name = ffi_transaction.name.to_s
+      @type = ffi_transaction.transaction_type
+      @amount = ffi_transaction.amount
+    end
+  end
+end

data/test/ofx_test.rb

@@ -0,0 +1,41 @@
+require 'ofx'
+require 'test/unit'
+
+class OfxTest < Test::Unit::TestCase
+  def setup
+    @statement = OFX.parse 'test/test.ofx'
+  end
+
+  def test_ofx_file_must_exist
+    assert_raise Errno::ENOENT do
+      OFX.parse 'test/blah.ofx'
+    end
+  end
+
+  def test_account_must_exist
+    refute_nil @statement["987654321"]
+  end
+
+  def test_transactions_are_correct
+    transactions = @statement["987654321"].transactions
+
+    expected = [
+      { :type => :debit, :amount => -100, :number => "0000009",
+        :name => /AUTOMATIC WITHDRAWAL/, :memo => /AUTOMATIC WITHDRAWAL/,
+        :date => Time.new(2011, 1, 3, 11, 0, 0, "-07:00") },
+      { :type => :check, :amount => -146.64, :number => "0000008",
+        :name => "CHECK # 515",
+        :date => Time.new(2011, 1, 10, 11, 0, 0, "-07:00") },
+      { :type => :credit, :amount => 1600.01, :number => "0000007",
+        :name => /AUTOMATIC DEPOSIT/, :memo => /AUTOMATIC DEPOSIT/,
+        :date => Time.new(2011, 1, 13, 11, 0, 0, "-07:00") }
+    ]
+
+    transactions.each do |transaction|
+      expected.shift.each do |attribute, expected_value|
+        got = transaction.send(attribute)
+        assert expected_value === got, "expected #{expected_value}, but got #{got}"
+      end
+    end
+  end
+end

data/test/statement_test.rb

@@ -0,0 +1,27 @@
+require 'ofx/statement'
+require 'test/unit'
+
+class StatementTest < Test::Unit::TestCase
+  def setup
+    @s = OFX::Statement.new
+    @s[:foo] = 1
+    @s[:bar] = 2
+  end
+
+  def test_account_setting_and_getting
+    assert_equal 1, @s[:foo]
+    assert_equal 2, @s[:bar]
+    assert_nil @s[:baz]
+  end
+
+  def test_each
+    expected = ["foo", 1, "bar", 2]
+
+    @s.each do |k,v|
+      assert_equal expected.shift, k
+      assert_equal expected.shift, v
+    end
+
+    assert_equal [], expected
+  end
+end

data/test/test.ofx

@@ -0,0 +1,81 @@
+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
+			</STATUS>
+			<DTSERVER>20110301225905.944
+			<LANGUAGE>ENG
+			<DTPROFUP>20050531060000.000
+			<FI>
+				<ORG>BLAH
+				<FID>1000
+			</FI>
+			<INTU.BID>99999
+			<INTU.USERID>12345678
+		</SONRS>
+	</SIGNONMSGSRSV1>
+	<BANKMSGSRSV1>
+		<STMTTRNRS>
+			<TRNUID>0
+			<STATUS>
+				<CODE>0
+				<SEVERITY>INFO
+			</STATUS>
+			<STMTRS>
+				<CURDEF>USD
+				<BANKACCTFROM>
+					<BANKID>345678910
+					<ACCTID>987654321
+					<ACCTTYPE>CHECKING
+				</BANKACCTFROM>
+				<BANKTRANLIST>
+					<DTSTART>20110101070000.000
+					<DTEND>20110301070000.000
+					<STMTTRN>
+						<TRNTYPE>DEBIT
+						<DTPOSTED>20110103120000.000
+						<TRNAMT>-100
+						<FITID>0000009
+						<NAME>AUTOMATIC WITHDRAWAL, BLAH BLAH 
+						<MEMO>AUTOMATIC WITHDRAWAL, BLAH BLAH BLAH BLAH BLAH BLAH B
+					</STMTTRN>
+					<STMTTRN>
+						<TRNTYPE>CHECK
+						<DTPOSTED>20110110120000.000
+						<TRNAMT>-146.64
+						<FITID>0000008
+						<CHECKNUM>515
+						<NAME>CHECK # 515
+					</STMTTRN>
+					<STMTTRN>
+						<TRNTYPE>CREDIT
+						<DTPOSTED>20110113120000.000
+						<TRNAMT>1600.01
+						<FITID>0000007
+						<NAME>AUTOMATIC DEPOSIT, SOME EMPLOYER
+						<MEMO>AUTOMATIC DEPOSIT, SOME EMPLOYER
+					</STMTTRN>
+				</BANKTRANLIST>
+				<LEDGERBAL>
+					<BALAMT>9999.99
+					<DTASOF>20110301225905.944
+				</LEDGERBAL>
+				<AVAILBAL> <BALAMT>9999.99
+					<DTASOF>20110301225905.944
+				</AVAILBAL>
+			</STMTRS>
+		</STMTTRNRS>
+	</BANKMSGSRSV1>
+</OFX>

data/test/valid_access_test.rb

@@ -0,0 +1,21 @@
+require 'ofx/ffi/valid_access'
+require 'test/unit'
+
+class ValidAccessTest < Test::Unit::TestCase
+  def test_valid_access
+    h = {
+      :foo => 'blah',
+      :foo_valid => 1,
+      :bar => 'glah',
+      :bar_valid => 0,
+      :baz => 'zoing'
+    }
+    class << h
+      include OFX::FFI::ValidAccess
+    end
+
+    assert_equal 'blah', h.foo
+    assert_nil h.bar
+    assert_nil h.baz
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: libofx-ffi
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- Cameron Matheson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-26 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 6
+        version: 1.0.6
+  type: :runtime
+  version_requirements: *id001
+description: Ruby/FFI wrapper for libofx
+email: cameron.matheson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ofx/ffi/valid_access.rb
+- lib/ofx/statement.rb
+- lib/ofx/transaction.rb
+- lib/ofx/ffi.rb
+- lib/ofx/account.rb
+- lib/ofx.rb
+- test/valid_access_test.rb
+- test/statement_test.rb
+- test/test.ofx
+- test/ofx_test.rb
+has_rdoc: true
+homepage: http://github.com/cmatheson/libofx-ffi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: libofx-ffi parses financial documents supported by libofx
+test_files: []
+