ofx 0.2.9 → 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f010daf75c910a87b19c737c27a0970a4a410f5e5b6ba5916f4546e2bb5f9abb
+  data.tar.gz: abf6b0090855e5c063ce2d627e8f2b4907be64a71289cb520d4ae4bf7687371e
+SHA512:
+  metadata.gz: f3ccb6719848c32e3047243715a3ec2aabbc80b2f241bfd2ff7dcbda819bf1baeb3086ee751459a28643345d4272bf4b4481dd56ba727f9ebf94ea6a680d4cf0
+  data.tar.gz: 48076b4428d20fa368544099691ebe1bf877b724b49cfce83265545a84b62b07e45759e00ae0febaf254090d53c157a1f9b7b6340f5c9d59237aa1847e590ca5

data/README.rdoc

@@ -1,8 +1,11 @@
 = OFX
 
-A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports OFX 1.0.2.
+{<img src="https://badge.fury.io/rb/ofx.png" alt="Gem Version" />}[http://badge.fury.io/rb/ofx]
+{<img src="https://travis-ci.org/annacruz/ofx.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/annacruz/ofx]
 
-Works on both Ruby 1.8 and 1.9.
+A simple OFX (Open Financial Exchange) parser built on top of Nokogiri. Currently supports both OFX 1.0.2 and 2.1.1.
+
+Works on both ruby 1.9 and 2.0.
 
 == Usage
 
@@ -14,10 +17,16 @@ Works on both Ruby 1.8 and 1.9.
     p account.transactions
   end
 
-== Maintainer
+Invalid files will raise an OFX::UnsupportedFileError.
+
+== Creator
 
 * Nando Vieira - http://simplesideias.com.br
 
+== Maintainer
+
+* Anna Cruz - http://anna-cruz.com
+
 == License
 
 (The MIT License)

data/Rakefile

@@ -3,3 +3,5 @@ Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/ofx/account.rb

@@ -6,5 +6,6 @@ module OFX
     attr_accessor :id
     attr_accessor :transactions
     attr_accessor :type
+    attr_accessor :available_balance
   end
 end

data/lib/ofx/parser/ofx102.rb

@@ -1,27 +1,31 @@
-require "bigdecimal"
+# frozen_string_literal: true
 
 module OFX
   module Parser
     class OFX102
-      VERSION = "1.0.2"
+      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
+        'CHECKING' => :checking,
+        'SAVINGS' => :savings,
+        'CREDITLINE' => :creditline,
+        'MONEYMRKT' => :moneymrkt
+      }.freeze
+
+      TRANSACTION_TYPES = %w[
+        ATM CASH CHECK CREDIT DEBIT DEP DIRECTDEBIT DIRECTDEP DIV
+        FEE INT OTHER PAYMENT POS REPEATPMT SRVCHG XFER
+      ].each_with_object({}) do |tran_type, hash|
+        hash[tran_type] = tran_type.downcase.to_sym
+      end
+
+      SEVERITY = {
+        'INFO' => :info,
+        'WARN' => :warn,
+        'ERROR' => :error
+      }.freeza
+
+      attr_reader :headers, :body, :html
 
       def initialize(options = {})
         @headers = options[:headers]
@@ -29,67 +33,171 @@ module OFX
         @html = Nokogiri::HTML.parse(body)
       end
 
+      def statements
+        @statements ||= html.search('stmttrnrs, ccstmttrnrs').collect { |node| build_statement(node) }
+      end
+
+      def accounts
+        @accounts ||= html.search('stmttrnrs, ccstmttrnrs').collect { |node| build_account(node) }
+      end
+
+      # DEPRECATED: kept for legacy support
       def account
-        @account ||= build_account
+        @account ||= build_account(html.search('stmttrnrs, ccstmttrnrs').first)
+      end
+
+      def sign_on
+        @sign_on ||= build_sign_on
+      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).each_with_object({}) do |line, memo|
+          _, key, value = *line.match(/^(.*?):(.*?)\s*(\r?\n)*$/)
+
+          unless key.nil?
+            memo[key] = value == 'NONE' ? nil : value
+          end
+        end
+
+        return headers unless headers.empty?
       end
 
       private
-      def build_account
+
+      def build_statement(node)
+        stmrs_node = node.search('stmtrs, ccstmtrs')
+        account = build_account(node)
+        OFX::Statement.new(
+          currency: stmrs_node.search('curdef').inner_text,
+          start_date: build_date(stmrs_node.search('banktranlist > dtstart').inner_text),
+          end_date: build_date(stmrs_node.search('banktranlist > dtend').inner_text),
+          account: account,
+          transactions: account.transactions,
+          balance: account.balance,
+          available_balance: account.available_balance
+        )
+      end
+
+      def build_account(node)
         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
-        })
+                           bank_id: node.search('bankacctfrom > bankid').inner_text,
+                           id: node.search('bankacctfrom > acctid, ccacctfrom > acctid').inner_text,
+                           type: ACCOUNT_TYPES[node.search('bankacctfrom > accttype').inner_text.to_s.upcase],
+                           transactions: build_transactions(node),
+                           balance: build_balance(node),
+                           available_balance: build_available_balance(node),
+                           currency: node.search('stmtrs > curdef, ccstmtrs > curdef').inner_text
+                         })
+      end
+
+      def build_status(node)
+        OFX::Status.new({
+                          code: node.search('code').inner_text.to_i,
+                          severity: SEVERITY[node.search('severity').inner_text],
+                          message: node.search('message').inner_text
+                        })
       end
 
-      def build_transactions
-        html.search("banktranlist > stmttrn").collect do |element|
+      def build_sign_on
+        OFX::SignOn.new({
+                          language: html.search('signonmsgsrsv1 > sonrs > language').inner_text,
+                          fi_id: html.search('signonmsgsrsv1 > sonrs > fi > fid').inner_text,
+                          fi_name: html.search('signonmsgsrsv1 > sonrs > fi > org').inner_text,
+                          status: build_status(html.search('signonmsgsrsv1 > sonrs > status'))
+                        })
+      end
+
+      def build_transactions(node)
+        node.search('banktranlist > stmttrn').collect do |element|
           build_transaction(element)
         end
       end
 
       def build_transaction(element)
+        occurred_at = begin
+          build_date(element.search('dtuser').inner_text)
+        rescue StandardError
+          nil
+        end
+
         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,
-          :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)
-        })
+                               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),
+                               occurred_at:,
+                               type: build_type(element),
+                               sic: element.search('sic').inner_text
+                             })
       end
 
       def build_type(element)
-        TRANSACTION_TYPES[element.search("trntype").inner_text]
+        TRANSACTION_TYPES[element.search('trntype').inner_text.to_s.upcase]
       end
 
       def build_amount(element)
-        BigDecimal.new(element.search("trnamt").inner_text)
+        to_decimal(element.search('trnamt').inner_text)
       end
 
+      # Input format is `YYYYMMDDHHMMSS.XXX[gmt offset[:tz name]]`
       def build_date(date)
-        _, year, month, day, hour, minutes, seconds = *date.match(/(\d{4})(\d{2})(\d{2})(?:(\d{2})(\d{2})(\d{2}))?/)
+        tz_pattern = /(?:\[([+-]?\d{1,4}):\S{3}\])?\z/
+
+        # Timezone offset handling
+        date.sub!(tz_pattern, '')
+        offset = Regexp.last_match(1)
+
+        if offset
+          # Offset padding
+          _, hours, mins = *offset.match(/\A([+-]?\d{1,2})(\d{0,2})?\z/)
+          offset = format('%+03d%02d', hours.to_i, mins.to_i)
+        else
+          offset = '+0000'
+        end
 
-        date = "#{year}-#{month}-#{day} "
-        date << "#{hour}:#{minutes}:#{seconds}" if hour && minutes && seconds
+        date << ' #{offset}'
 
         Time.parse(date)
       end
 
-      def build_balance
-        amount = html.search("ledgerbal > balamt").inner_text.to_f
+      def build_balance(node)
+        amount = to_decimal(node.search('ledgerbal > balamt').inner_text)
+        posted_at = begin
+          build_date(node.search('ledgerbal > dtasof').inner_text)
+        rescue StandardError
+          nil
+        end
 
         OFX::Balance.new({
-          :amount => amount,
-          :amount_in_pennies => (amount * 100).to_i,
-          :posted_at => build_date(html.search("ledgerbal > dtasof").inner_text)
-        })
+                           amount:,
+                           amount_in_pennies: (amount * 100).to_i,
+                           posted_at:
+                         })
+      end
+
+      def build_available_balance(node)
+        if node.search('availbal').size > 0
+          amount = to_decimal(node.search('availbal > balamt').inner_text)
+
+          OFX::Balance.new({
+                             amount:,
+                             amount_in_pennies: (amount * 100).to_i,
+                             posted_at: build_date(node.search('availbal > dtasof').inner_text)
+                           })
+        end
+      end
+
+      def to_decimal(amount)
+        BigDecimal(amount.to_s.gsub(',', '.'))
       end
     end
   end

data/lib/ofx/parser/ofx103.rb

@@ -0,0 +1,7 @@
+module OFX
+  module Parser
+    class OFX103 < OFX102
+      VERSION = '1.0.3'
+    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

@@ -7,20 +7,22 @@ module OFX
       attr_reader :parser
 
       def initialize(resource)
-          resource = open_resource(resource)
-          resource.rewind
-          @content = convert_to_utf8(resource.read)
-
+        resource = open_resource(resource)
+        resource.rewind
         begin
+          @content = convert_to_utf8(resource.read)
           @headers, @body = prepare(content)
-        rescue Exception
+        rescue
           raise OFX::UnsupportedFileError
         end
 
-
-        case @headers["VERSION"]
-        when "102" then
-          @parser = OFX::Parser::OFX102.new(:headers => headers, :body => body)
+        case headers["VERSION"]
+        when /102/ then
+          @parser = OFX102.new(:headers => headers, :body => body)
+        when /103/ then
+          @parser = OFX103.new(:headers => headers, :body => body)
+        when /200|202|211|220/ then
+          @parser = OFX211.new(:headers => headers, :body => body)
         else
           raise OFX::UnsupportedFileError
         end
@@ -28,37 +30,34 @@ module OFX
 
       def open_resource(resource)
         if resource.respond_to?(:read)
-          return resource
+          resource
         else
-          begin
-            return open(resource)
-          rescue
-            return StringIO.new(resource)
-          end
+          open(resource)
         end
+      rescue
+        StringIO.new(resource)
       end
 
       private
       def prepare(content)
-        # Split headers & body
-        headers, body = content.dup.split(/<OFX>/, 2)
-
-        # Change single CR's to LF's to avoid issues with some banks
-        headers.gsub!(/\r(?!\n)/, "\n")
+        # split headers & body
+        header_text, body = content.dup.split(/<OFX>/, 2)
 
         raise OFX::UnsupportedFileError unless body
 
-        # Parse headers. When value is NONE, convert it to nil.
-        headers = headers.to_enum(:each_line).inject({}) do |memo, line|
-          _, key, value = *line.match(/^(.*?):(.*?)(\r?\n)*$/)
-          memo[key] = value == "NONE" ? nil : value
-          memo
+        # Header format is different between versions. Give each
+        # parser a chance to parse the headers.
+        headers = nil
+
+        OFX::Parser.constants.grep(/OFX/).each do |name|
+          headers = OFX::Parser.const_get(name).parse_headers(header_text)
+          break if headers
         end
 
         # Replace body tags to parse it with Nokogiri
-        body.gsub!(/>\s+</m, '><')
-        body.gsub!(/\s+</m, '<')
-        body.gsub!(/>\s+/m, '>')
+        body.gsub!(/>\s+</m, "><")
+        body.gsub!(/\s+</m, "<")
+        body.gsub!(/>\s+/m, ">")
         body.gsub!(/<(\w+?)>([^<]+)/m, '<\1>\2</\1>')
 
         [headers, body]
@@ -66,8 +65,8 @@ module OFX
 
       def convert_to_utf8(string)
         return string if Kconv.isutf8(string)
-        Iconv.conv('UTF-8', 'LATIN1//IGNORE', string)
+        string.encode("UTF-8", "ISO-8859-1")
       end
     end
   end
-end
+end

data/lib/ofx/sign_on.rb

@@ -0,0 +1,8 @@
+module OFX
+  class SignOn < Foundation
+    attr_accessor :language
+    attr_accessor :fi_id
+    attr_accessor :fi_name
+    attr_accessor :status
+  end
+end

data/lib/ofx/statement.rb

@@ -0,0 +1,11 @@
+module OFX
+  class Statement < Foundation
+    attr_accessor :account
+    attr_accessor :available_balance
+    attr_accessor :balance
+    attr_accessor :currency
+    attr_accessor :start_date
+    attr_accessor :end_date
+    attr_accessor :transactions
+  end
+end

data/lib/ofx/status.rb

@@ -0,0 +1,12 @@
+module OFX
+  # Error Reporting Aggregate
+  class Status < Foundation
+    attr_accessor :code     # Error code
+    attr_accessor :severity # Severity of the error
+    attr_accessor :message  # Textual explanation
+
+    def success?
+      code == 0
+    end
+  end
+end

data/lib/ofx/transaction.rb

@@ -5,9 +5,12 @@ module OFX
     attr_accessor :check_number
     attr_accessor :fit_id
     attr_accessor :memo
+    attr_accessor :name
     attr_accessor :payee
     attr_accessor :posted_at
+    attr_accessor :occurred_at
     attr_accessor :ref_number
     attr_accessor :type
+    attr_accessor :sic
   end
-end
+end

data/lib/ofx/version.rb

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

data/lib/ofx.rb

@@ -1,17 +1,24 @@
-require "open-uri"
-require "nokogiri"
+# frozen_string_literal: true
 
-require "iconv"
-require "kconv"
+require 'open-uri'
+require 'nokogiri'
+require 'bigdecimal'
 
-require "ofx/errors"
-require "ofx/parser"
-require "ofx/parser/ofx102"
-require "ofx/foundation"
-require "ofx/balance"
-require "ofx/account"
-require "ofx/transaction"
-require "ofx/version"
+require 'kconv'
+
+require 'ofx/errors'
+require 'ofx/parser'
+require 'ofx/parser/ofx102'
+require 'ofx/parser/ofx103'
+require 'ofx/parser/ofx211'
+require 'ofx/foundation'
+require 'ofx/balance'
+require 'ofx/account'
+require 'ofx/sign_on'
+require 'ofx/status'
+require 'ofx/statement'
+require 'ofx/transaction'
+require 'ofx/version'
 
 def OFX(resource, &block)
   parser = OFX::Parser::Base.new(resource).parser