banker-ofx 0.4.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage
+*.un~
+*.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use ruby-1.9.2@banker-ofx --create
+rvm use ruby-1.9.3@banker-ofx --create

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: rspec

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in banker.gemspec
+gemspec
+
+gem 'guard-rspec'

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :notification => true, :version => 2, :cli => "--colour", :run_all => {:cli => '--profile'} do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/README.md

@@ -0,0 +1,46 @@
+# Banker [![CI Build Status](https://secure.travis-ci.org/BritRuby/Banker-OFX.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/BritRuby/Banker-OFX.png?travis)][gemnasium]
+
+[travis]:http://travis-ci.org/BritRuby/Banker-OFX
+[gemnasium]:https://gemnasium.com/BritRuby/Banker-OFX
+
+A simple OFX (Open Financial Exchange) parser for Bank Accounts and Credit Cards. Supports multiple accounts.
+
+### Usage
+
+	require 'ofx'
+
+	ofx = OFX("statement.ofx")
+
+	ofx.bank_accounts.each do |bank_account|
+	  puts bank_account.id # => "492108"
+	  puts bank_account.bank_id # => "1837"
+	  puts bank_account.currency # => "GBP"
+	  puts bank_account.type # => :checking
+	  puts bank_account.balance.amount # => "100.00"
+	  puts bank_account.balance.amount_in_pennies # => "10000"
+	  puts bank_account.transactions # => [#<OFX::Transaction:0x007ff3bb8cf418>]
+	end
+
+	ofx.credit_cards.each do |credit_card|
+	  puts credit_card.id # => "81728918309730"
+	  puts credit_card.currency # => "GBP"
+	  puts bank_account.balance.amount # => "-100.00"
+	  puts bank_account.balance.amount_in_pennies # => "-10000"
+	  puts credit_card.transactions # => [#<OFX::Transaction:0x007ff3bb8cf418>]
+	end
+
+### Supports
+#### Ruby
+* 1.9.2
+* 1.9.3
+
+#### OFX
+* 1.0.2
+* 2.1.1
+
+### ToDo
+1. Support other OFX Versions
+
+### Original Fork
+
+* Nando Vieira - https://github.com/fnando/ofx

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new

data/lib/ofx/account.rb

@@ -0,0 +1,10 @@
+module OFX
+  class Account < Foundation
+    attr_accessor :balance
+    attr_accessor :bank_id
+    attr_accessor :currency
+    attr_accessor :id
+    attr_accessor :transactions
+    attr_accessor :type
+  end
+end

data/lib/ofx/balance.rb

@@ -0,0 +1,7 @@
+module OFX
+  class Balance < Foundation
+    attr_accessor :amount
+    attr_accessor :amount_in_pennies
+    attr_accessor :posted_at
+  end
+end

data/lib/ofx/errors.rb

@@ -0,0 +1,3 @@
+module OFX
+  class UnsupportedFileError < StandardError; end
+end

data/lib/ofx/foundation.rb

@@ -0,0 +1,9 @@
+module OFX
+  class Foundation
+    def initialize(attrs)
+      attrs.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/ofx/parser/ofx102.rb

@@ -0,0 +1,134 @@
+module OFX
+  module Parser
+    class OFX102
+      VERSION = "1.0.2"
+
+      ACCOUNT_TYPES = {
+        "CHECKING" => :checking
+      }
+
+      TRANSACTION_TYPES = [
+        'ATM', 'CASH', 'CHECK', 'CREDIT', 'DEBIT', 'DEP', 'DIRECTDEBIT', 'DIRECTDEP', 'DIV',
+        'FEE', 'INT', 'OTHER', 'PAYMENT', 'POS', 'REPEATPMT', 'SRVCHG', 'XFER'
+      ].inject({}) { |hash, tran_type| hash[tran_type] = tran_type.downcase.to_sym; hash }
+
+      attr_reader :headers
+      attr_reader :body
+      attr_reader :html
+
+      def initialize(options = {})
+        @headers = options[:headers]
+        @body = options[:body]
+        @html = Nokogiri::HTML.parse(body)
+      end
+
+      def bank_accounts
+        @bank_accounts ||= build_bank_account
+      end
+
+      def credit_cards
+        @credit_cards ||= build_credit_card
+      end
+
+      def self.parse_headers(header_text)
+        # Change single CR's to LF's to avoid issues with some banks
+        header_text.gsub!(/\r(?!\n)/, "\n")
+
+        # Parse headers. When value is NONE, convert it to nil.
+        headers = header_text.to_enum(:each_line).inject({}) do |memo, line|
+          _, key, value = *line.match(/^(.*?):(.*?)\s*(\r?\n)*$/)
+
+          unless key.nil?
+            memo[key] = value == "NONE" ? nil : value
+          end
+
+          memo
+        end
+
+        return headers unless headers.empty?
+      end
+
+      private
+
+      def build_bank_account
+        html.search("stmttrnrs").each_with_object([]) do |account, accounts|
+          args = {
+            :bank_id      => account.search("bankacctfrom > bankid").inner_text,
+            :id           => account.search("bankacctfrom > acctid").inner_text,
+            :type         => ACCOUNT_TYPES[account.search("bankacctfrom > accttype").inner_text.to_s.upcase],
+            :transactions => build_transactions(account.search("banktranlist > stmttrn")),
+            :balance      => build_balance(account),
+            :currency     => account.search("stmtrs > curdef").inner_text
+          }
+
+          accounts << OFX::Account.new(args)
+        end
+      end
+
+      def build_credit_card
+        html.search("ccstmttrnrs").each_with_object([]) do |account, accounts|
+          args = {
+            :id           => account.search("ccstmtrs > ccacctfrom > acctid").inner_text,
+            :transactions => build_transactions(account.search("banktranlist > stmttrn")),
+            :balance      => build_balance(account),
+            :currency     => account.search("ccstmtrs > curdef").inner_text
+          }
+
+          accounts << OFX::Account.new(args)
+        end
+      end
+
+      def build_transactions(transactions)
+        transactions.each_with_object([]) do |transaction, transactions|
+          transactions << build_transaction(transaction)
+        end
+      end
+
+      def build_transaction(transaction)
+        args = {
+          :amount            => build_amount(transaction),
+          :amount_in_pennies => (build_amount(transaction) * 100).to_i,
+          :fit_id            => transaction.search("fitid").inner_text,
+          :memo              => transaction.search("memo").inner_text,
+          :name              => transaction.search("name").inner_text,
+          :payee             => transaction.search("payee").inner_text,
+          :check_number      => transaction.search("checknum").inner_text,
+          :ref_number        => transaction.search("refnum").inner_text,
+          :posted_at         => build_date(transaction.search("dtposted").inner_text),
+          :type              => build_type(transaction)
+        }
+
+        OFX::Transaction.new(args)
+      end
+
+      def build_type(transaction)
+        TRANSACTION_TYPES[transaction.search("trntype").inner_text.to_s.upcase]
+      end
+
+      def build_amount(transaction)
+        BigDecimal.new(transaction.search("trnamt").inner_text)
+      end
+
+      def build_date(date)
+        _, year, month, day, hour, minutes, seconds = *date.match(/(\d{4})(\d{2})(\d{2})(?:(\d{2})(\d{2})(\d{2}))?/)
+
+        date = "#{year}-#{month}-#{day} "
+        date << "#{hour}:#{minutes}:#{seconds}" if hour && minutes && seconds
+
+        Time.parse(date)
+      end
+
+      def build_balance(account)
+        amount = account.search("ledgerbal > balamt").inner_text.to_f
+
+        args = {
+          :amount => amount,
+          :amount_in_pennies => (amount * 100).to_i,
+          :posted_at => build_date(account.search("ledgerbal > dtasof").inner_text)
+        }
+
+        OFX::Balance.new(args)
+      end
+    end
+  end
+end

data/lib/ofx/parser/ofx211.rb

@@ -0,0 +1,40 @@
+module OFX
+  module Parser
+    class OFX211 < OFX102
+      VERSION = "2.1.1"
+
+      def self.parse_headers(header_text)
+        doc = Nokogiri::XML(header_text)
+
+        # Nokogiri can't search for processing instructions, so we
+        # need to do this manually.
+        doc.children.each do |e|
+          if e.type == Nokogiri::XML::Node::PI_NODE && e.name == "OFX"
+            # Getting the attributes from the element doesn't seem to
+            # work either.
+            return extract_headers(e.text)
+          end
+        end
+
+        nil
+      end
+
+      private
+      def self.extract_headers(text)
+        headers = {}
+        text.split(/\s+/).each do |attr_text|
+          match = /(.+)="(.+)"/.match(attr_text)
+          next unless match
+          k, v = match[1], match[2]
+          headers[k] = v
+        end
+        headers
+      end
+
+      def self.strip_quotes(s)
+        return unless s
+        s.sub(/^"(.*)"$/, '\1')
+      end
+    end
+  end
+end

data/lib/ofx/parser.rb

@@ -0,0 +1,67 @@
+module OFX
+  module Parser
+    class Base
+      attr_reader :headers
+      attr_reader :body
+      attr_reader :content
+      attr_reader :parser
+
+      def initialize(resource)
+        @content = open_resource(resource).read
+        prepare(content)
+      end
+
+    private
+
+      def open_resource(document)
+        return document if document.respond_to?(:read)
+        open(document, "r:iso-8859-1:utf-8")
+      rescue
+        StringIO.new(document.encode('utf-8'))
+      end
+
+      def prepare(content)
+        header, body = content.dup.split(/<OFX>/, 2)
+        raise OFX::UnsupportedFileError unless body
+
+        begin
+          @headers = condition_headers(header)
+          @body = condition_body(body)
+        rescue Exception
+          raise OFX::UnsupportedFileError
+        end
+
+        instantiate_parser
+      end
+
+      def instantiate_parser
+        case headers["VERSION"]
+        when /102/ then
+          @parser = OFX102.new(:headers => headers, :body => body)
+        when /200|211/ then
+          @parser = OFX211.new(:headers => headers, :body => body)
+        else
+          raise OFX::UnsupportedFileError
+        end
+      end
+
+      def condition_headers(header)
+        headers = nil
+
+        OFX::Parser.constants.grep(/OFX/).each do |name|
+          headers = OFX::Parser.const_get(name).parse_headers(header)
+          break if headers
+        end
+
+        headers
+      end
+
+      def condition_body(body)
+        body.gsub!(/>\s+</m, "><").
+             gsub!(/\s+</m, "<").
+             gsub!(/>\s+/m, ">").
+             gsub!(/<(\w+?)>([^<]+)/m, '<\1>\2</\1>')
+      end
+    end
+  end
+end

data/lib/ofx/transaction.rb

@@ -0,0 +1,14 @@
+module OFX
+  class Transaction < Foundation
+    attr_accessor :amount
+    attr_accessor :amount_in_pennies
+    attr_accessor :check_number
+    attr_accessor :fit_id
+    attr_accessor :memo
+    attr_accessor :name
+    attr_accessor :payee
+    attr_accessor :posted_at
+    attr_accessor :ref_number
+    attr_accessor :type
+  end
+end

data/lib/ofx/version.rb

@@ -0,0 +1,8 @@
+module OFX
+  module Version
+    MAJOR = 0
+    MINOR = 4
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/lib/ofx.rb

@@ -0,0 +1,27 @@
+require "open-uri"
+require "nokogiri"
+require "bigdecimal"
+
+require "ofx/errors"
+require "ofx/parser"
+require "ofx/parser/ofx102"
+require "ofx/parser/ofx211"
+require "ofx/foundation"
+require "ofx/balance"
+require "ofx/account"
+require "ofx/transaction"
+require "ofx/version"
+
+def OFX(resource, &block)
+  parser = OFX::Parser::Base.new(resource).parser
+
+  if block_given?
+    if block.arity == 1
+      yield parser
+    else
+      parser.instance_eval(&block)
+    end
+  end
+
+  parser
+end

data/ofx.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ofx/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors     = ['Kyle Welsby', 'Chuck Hardy', "Nando Vieira"]
+  gem.email       = ['app@britishruby.com', "fnando.vieira@gmail.com"]
+  gem.homepage    = 'https://github.com/BritRuby/Banker-OFX'
+  gem.description = %q{A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports OFX 102, 200 and 211.}
+  gem.summary     = gem.description
+
+  gem.add_runtime_dependency 'nokogiri'
+
+  gem.add_development_dependency "gem-release"
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.name          = "banker-ofx"
+  gem.require_paths = ['lib']
+  gem.platform    = Gem::Platform::RUBY
+  gem.version       = OFX::Version::STRING
+end