chopmo-ofx 0.3.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.gem
+pkg

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in /tmp/sample.gemspec
+gemspec
+
+gem 'ruby-debug'

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    chopmo-ofx (0.2.9)
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    linecache (0.43)
+    nokogiri (1.4.4)
+    rspec (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+      rspec-mocks (= 2.0.0)
+    rspec-core (2.0.0)
+    rspec-expectations (2.0.0)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chopmo-ofx!
+  rspec (>= 2.0.0)
+  ruby-debug

data/README.rdoc

@@ -0,0 +1,42 @@
+= OFX
+
+A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports OFX 1.0.2.
+
+Works on both Ruby 1.8 and 1.9.
+
+== Usage
+
+  require "ofx"
+
+  OFX("file.ofx") do
+    p account
+    p account.balance
+    p account.transactions
+  end
+
+== Maintainer
+
+* Nando Vieira - http://simplesideias.com.br
+
+== License
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

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

data/lib/ofx.rb

@@ -0,0 +1,29 @@
+require "open-uri"
+require "nokogiri"
+
+require "iconv"
+require "kconv"
+
+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/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.rb

@@ -0,0 +1,69 @@
+module OFX
+  module Parser
+    class Base
+      attr_reader :headers
+      attr_reader :body
+      attr_reader :content
+      attr_reader :parser
+
+      def initialize(resource)
+        resource = open_resource(resource)
+        resource.rewind
+        @content = convert_to_utf8(resource.read)
+
+        begin
+          @headers, @body = prepare(content)
+        rescue Exception
+          raise OFX::UnsupportedFileError
+        end
+
+        case @headers["VERSION"]
+        when /102/ then
+          @parser = OFX::Parser::OFX102.new(:headers => headers, :body => body)
+        when /200|211/ then
+          @parser = OFX::Parser::OFX211.new(:headers => headers, :body => body)
+        else
+          raise OFX::UnsupportedFileError
+        end
+      end
+
+      def open_resource(resource)
+        if resource.respond_to?(:read)
+          return resource
+        else
+          begin
+            return open(resource)
+          rescue
+            return StringIO.new(resource)
+          end
+        end
+      end
+
+      private
+      def prepare(content)
+        # split headers & body
+        header_text, body = content.dup.split(/<OFX>/, 2)
+
+        raise OFX::UnsupportedFileError unless body
+
+        # Header format is different between versions. Give each
+        # parser a chance to parse the headers.
+        headers = OFX::Parser::OFX102.parse_headers(header_text)
+        headers ||= OFX::Parser::OFX211.parse_headers(header_text)
+
+        # Replace body tags to parse it with Nokogiri
+        body.gsub!(/>\s+</m, '><')
+        body.gsub!(/\s+</m, '<')
+        body.gsub!(/>\s+/m, '>')
+        body.gsub!(/<(\w+?)>([^<]+)/m, '<\1>\2</\1>')
+
+        [headers, body]
+      end
+
+      def convert_to_utf8(string)
+        return string if Kconv.isutf8(string)
+        Iconv.conv('UTF-8', 'LATIN1//IGNORE', string)
+      end
+    end
+  end
+end

data/lib/ofx/parser/ofx102.rb

@@ -0,0 +1,113 @@
+require "bigdecimal"
+
+module OFX
+  module Parser
+    class OFX102
+      VERSION = "1.0.2"
+
+      ACCOUNT_TYPES = {
+        "CHECKING" => :checking
+      }
+
+      TRANSACTION_TYPES = {
+        "CREDIT" => :credit,
+        "DEBIT" => :debit,
+        "OTHER" => :other,
+        "DEP" => :dep,
+        "XFER" => :xfer,
+        "CASH" => :cash,
+        "CHECK" => :check
+      }
+
+      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 account
+        @account ||= build_account
+      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_account
+        OFX::Account.new({
+          :bank_id      => html.search("bankacctfrom > bankid").inner_text,
+          :id           => html.search("bankacctfrom > acctid").inner_text,
+          :type         => ACCOUNT_TYPES[html.search("bankacctfrom > accttype").inner_text],
+          :transactions => build_transactions,
+          :balance      => build_balance,
+          :currency     => html.search("bankmsgsrsv1 > stmttrnrs > stmtrs > curdef").inner_text
+        })
+      end
+
+      def build_transactions
+        html.search("banktranlist > stmttrn").collect do |element|
+          build_transaction(element)
+        end
+      end
+
+      def build_transaction(element)
+        OFX::Transaction.new({
+          :amount            => build_amount(element),
+          :amount_in_pennies => (build_amount(element) * 100).to_i,
+          :fit_id            => element.search("fitid").inner_text,
+          :memo              => element.search("memo").inner_text,
+          :name              => element.search("name").inner_text,
+          :payee             => element.search("payee").inner_text,
+          :check_number      => element.search("checknum").inner_text,
+          :ref_number        => element.search("refnum").inner_text,
+          :posted_at         => build_date(element.search("dtposted").inner_text),
+          :type              => build_type(element)
+        })
+      end
+
+      def build_type(element)
+        TRANSACTION_TYPES[element.search("trntype").inner_text]
+      end
+
+      def build_amount(element)
+        BigDecimal.new(element.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
+        amount = html.search("ledgerbal > balamt").inner_text.to_f
+
+        OFX::Balance.new({
+          :amount => amount,
+          :amount_in_pennies => (amount * 100).to_i,
+          :posted_at => build_date(html.search("ledgerbal > dtasof").inner_text)
+        })
+      end
+    end
+  end
+end

data/lib/ofx/parser/ofx211.rb

@@ -0,0 +1,42 @@
+require "bigdecimal"
+
+module OFX
+  module Parser
+    # I think inheritance is appropriate here. Very little has changed. 
+    class OFX211 < OFX102
+      VERSION = "2.1.1"
+
+      def self.parse_headers(header_text)
+        doc = Nokogiri(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
+      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 nil if s.nil?
+        s.sub(/^"(.*)"$/,'\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 = 3
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/ofx.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ofx/version"
+
+Gem::Specification.new do |s|
+  s.name        = "chopmo-ofx"
+  s.version     = OFX::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nando Vieira"]
+  s.email       = ["fnando.vieira@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/ofx"
+  s.summary     = "A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports OFX 1.0.2."
+  s.description = <<-TXT
+A simple OFX (Open Financial Exchange) parser built on top of Nokogiri.
+Currently supports OFX 1.0.2.
+
+Usage:
+
+  OFX("sample.ofx") do |ofx|
+    p ofx
+  end
+TXT
+
+  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_dependency "nokogiri"
+  s.add_development_dependency "rspec", ">= 2.0.0"
+end