ofx 0.3.1 → 0.3.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1f7e1315a8e1fe59c9e97b5bb1bd470f5ba977463f3311e3eb76ecdc707afd7
+  data.tar.gz: f8463316d6ef710908701765feabbd884e7f5ee87b0ceb2188cef1284705ed23
+SHA512:
+  metadata.gz: 4883a274bcb8fcbd35b363183f9ddf896994278ade919f038d698ccd1164dd78b947ee500d3b66b27dc6c22ba719ba6144317a1fbacf66a724d35e3bc14845bd
+  data.tar.gz: 7f40b8abdde571151fe54015a243e8f569116178dc7ed0113639900bbfe4e976ca4f62ccb32dbdaa72e2ce5ddd5794fd85f50bf1dc455ac20a61c893c0e5dd49

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

@@ -1,10 +1,7 @@
+# frozen_string_literal: true
+
 module OFX
   class Account < Foundation
-    attr_accessor :balance
-    attr_accessor :bank_id
-    attr_accessor :currency
-    attr_accessor :id
-    attr_accessor :transactions
-    attr_accessor :type
+    attr_accessor :balance, :bank_id, :currency, :id, :transactions, :type, :available_balance
   end
 end

data/lib/ofx/balance.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module OFX
   class Balance < Foundation
-    attr_accessor :amount
-    attr_accessor :amount_in_pennies
-    attr_accessor :posted_at
+    attr_accessor :amount, :amount_in_pennies, :posted_at
   end
-end
+end
+

data/lib/ofx/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OFX
   class UnsupportedFileError < StandardError; end
 end

data/lib/ofx/foundation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OFX
   class Foundation
     def initialize(attrs)
@@ -6,4 +8,5 @@ module OFX
       end
     end
   end
-end
+end
+

data/lib/ofx/parser/ofx102.rb

@@ -1,20 +1,31 @@
+# frozen_string_literal: true
+
 module OFX
   module Parser
     class OFX102
-      VERSION = "1.0.2"
+      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
+        '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
+      }.freeze
+
+      attr_reader :headers, :body, :html
 
       def initialize(options = {})
         @headers = options[:headers]
@@ -22,86 +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")
+        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|
+        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
+            memo[key] = value == 'NONE' ? nil : value
           end
-
-          memo
         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.to_s.upcase],
-          :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_transactions
-        html.search("banktranlist > stmttrn").collect do |element|
+      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_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,
-          :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)
-        })
+                               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: occurred_at,
+                               type: build_type(element),
+                               sic: element.search('sic').inner_text
+                             })
       end
 
       def build_type(element)
-        TRANSACTION_TYPES[element.search("trntype").inner_text.to_s.upcase]
+        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: ammount,
+                           amount_in_pennies: (amount * 100).to_i,
+                           posted_at: 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,
+                             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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module OFX
   module Parser
     class OFX211 < OFX102
-      VERSION = "2.1.1"
+      VERSION = '2.1.1'
 
       def self.parse_headers(header_text)
         doc = Nokogiri::XML(header_text)
@@ -9,7 +11,7 @@ module OFX
         # 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"
+          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)
@@ -19,13 +21,14 @@ module OFX
         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]
+
+          k = match[1]
+          v = match[2]
           headers[k] = v
         end
         headers
@@ -33,6 +36,7 @@ module OFX
 
       def self.strip_quotes(s)
         return unless s
+
         s.sub(/^"(.*)"$/, '\1')
       end
     end

data/lib/ofx/parser.rb

@@ -1,27 +1,27 @@
+# frozen_string_literal: true
+
 module OFX
   module Parser
     class Base
-      attr_reader :headers
-      attr_reader :body
-      attr_reader :content
-      attr_reader :parser
+      attr_reader :headers, :body, :conten, :parser
 
       def initialize(resource)
         resource = open_resource(resource)
         resource.rewind
-        @content = convert_to_utf8(resource.read)
-
         begin
+          @content = convert_to_utf8(resource.read)
           @headers, @body = prepare(content)
-        rescue Exception
+        rescue StandardError
           raise OFX::UnsupportedFileError
         end
 
-        case headers["VERSION"]
-        when /102/ then
-          @parser = OFX102.new(:headers => headers, :body => body)
-        when /200|211/ then
-          @parser = OFX211.new(:headers => headers, :body => body)
+        case headers['VERSION']
+        when /102/
+          @parser = OFX102.new(headers: headers, body: body)
+        when /103/
+          @parser = OFX103.new(headersu: headers, body: body)
+        when /200|202|211|220/
+          @parser = OFX211.new(headers: headers, body: body)
         else
           raise OFX::UnsupportedFileError
         end
@@ -33,11 +33,12 @@ module OFX
         else
           open(resource)
         end
-      rescue Exception
+      rescue StandardError
         StringIO.new(resource)
       end
 
       private
+
       def prepare(content)
         # split headers & body
         header_text, body = content.dup.split(/<OFX>/, 2)
@@ -54,9 +55,9 @@ module OFX
         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]
@@ -64,7 +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

data/lib/ofx/sign_on.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OFX
+  class SignOn < Foundation
+    attr_accessor :language, :fi_id, :fi_name, :status
+  end
+end

data/lib/ofx/statement.rb

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

data/lib/ofx/status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module OFX
+  # Error Reporting Aggregate
+  class Status < Foundation
+    attr_accessor :code, :severity, :message
+
+    def success?
+      code.zero?
+    end
+  end
+end

data/lib/ofx/transaction.rb

@@ -1,14 +1,8 @@
+# frozen_string_literal: true
+
 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
+    attr_accessor :amount, :amount_in_pennies, :check_number, :fit_id, :memo, :name, :payee, :posted_at, :occurred_at,
+                  :ref_number, :type, :sic
   end
 end

data/lib/ofx/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module OFX
   module Version
     MAJOR = 0
     MINOR = 3
-    PATCH = 1
+    PATCH = 5
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/lib/ofx.rb

@@ -1,19 +1,24 @@
-require "open-uri"
-require "nokogiri"
-require "bigdecimal"
+# 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/parser/ofx211"
-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