ofx 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c152721af7763671b8e2c6f912f85e3e3a0b7f44
-  data.tar.gz: 8e5f68901a6215bf71079cf67ff756c50630a7fb
+SHA256:
+  metadata.gz: f010daf75c910a87b19c737c27a0970a4a410f5e5b6ba5916f4546e2bb5f9abb
+  data.tar.gz: abf6b0090855e5c063ce2d627e8f2b4907be64a71289cb520d4ae4bf7687371e
 SHA512:
-  metadata.gz: 4eb56b361cf81ec4b091509fec2272a335514fe697fc7dd060d18e8bafa7a255cf2a55f4e0ecd0438fe3303aee2178ca591510d07767365ea310000e01c61d2c
-  data.tar.gz: 3629da082dc5e93a97220e378ac8e8811db2b5f651594ecfe887cce923455325e23981845cc4b82ac434b330d4c01b1c5550e01dbc7db2c03de94d4d73bfc69a
+  metadata.gz: f3ccb6719848c32e3047243715a3ec2aabbc80b2f241bfd2ff7dcbda819bf1baeb3086ee751459a28643345d4272bf4b4481dd56ba727f9ebf94ea6a680d4cf0
+  data.tar.gz: 48076b4428d20fa368544099691ebe1bf877b724b49cfce83265545a84b62b07e45759e00ae0febaf254090d53c157a1f9b7b6340f5c9d59237aa1847e590ca5

data/README.rdoc

@@ -1,5 +1,8 @@
 = OFX
 
+{<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]
+
 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.
@@ -14,6 +17,8 @@ Works on both ruby 1.9 and 2.0.
     p account.transactions
   end
 
+Invalid files will raise an OFX::UnsupportedFileError.
+
 == Creator
 
 * Nando Vieira - http://simplesideias.com.br

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
+      }.freeza
+
+      attr_reader :headers, :body, :html
 
       def initialize(options = {})
         @headers = options[:headers]
@@ -22,8 +33,17 @@ 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
@@ -32,106 +52,153 @@ module OFX
 
       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, ccacctfrom > acctid").inner_text,
-          :type              => ACCOUNT_TYPES[html.search("bankacctfrom > accttype").inner_text.to_s.upcase],
-          :transactions      => build_transactions,
-          :balance           => build_balance,
-          :available_balance => build_available_balance,
-          :currency          => html.search("bankmsgsrsv1 > stmttrnrs > stmtrs > curdef, " +
-                                            "creditcardmsgsrsv1 > ccstmttrnrs > ccstmtrs > 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_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
-        })
+                          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
-        html.search("banktranlist > stmttrn").collect do |element|
+      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),
-          :sic               => element.search("sic").inner_text
-        })
+                               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.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:,
+                           amount_in_pennies: (amount * 100).to_i,
+                           posted_at:
+                         })
       end
 
-      def build_available_balance
-        if html.search("availbal").size > 0
-          amount = html.search("availbal > balamt").inner_text.to_f
+      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(html.search("availbal > dtasof").inner_text)
-          })
-        else
-          return nil
+                             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
 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.rb

@@ -12,14 +12,16 @@ module OFX
         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 = OFX102.new(:headers => headers, :body => body)
-        when /200|211/ then
+        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
@@ -32,7 +34,7 @@ module OFX
         else
           open(resource)
         end
-      rescue Exception
+      rescue
         StringIO.new(resource)
       end
 

data/lib/ofx/sign_on.rb

@@ -3,5 +3,6 @@ module OFX
     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

@@ -8,6 +8,7 @@ module OFX
     attr_accessor :name
     attr_accessor :payee
     attr_accessor :posted_at
+    attr_accessor :occurred_at
     attr_accessor :ref_number
     attr_accessor :type
     attr_accessor :sic

data/lib/ofx/version.rb

@@ -2,7 +2,7 @@ module OFX
   module Version
     MAJOR = 0
     MINOR = 3
-    PATCH = 2
+    PATCH = 4
     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 "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/sign_on"
-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

data/spec/ofx/account_spec.rb

@@ -11,49 +11,49 @@ describe OFX::Account do
     it "should return currency" do
       @account.currency.should == "BRL"
     end
-    
+
     it "should return bank id" do
       @account.bank_id.should == "0356"
     end
-    
+
     it "should return id" do
       @account.id.should == "03227113109"
     end
-    
+
     it "should return type" do
       @account.type.should == :checking
     end
-    
+
     it "should return transactions" do
       @account.transactions.should be_a_kind_of(Array)
       @account.transactions.size.should == 36
     end
-    
+
     it "should return balance" do
-      @account.balance.amount.should == 598.44
+      @account.balance.amount.should == BigDecimal('598.44')
     end
-    
+
     it "should return balance in pennies" do
       @account.balance.amount_in_pennies.should == 59844
     end
-    
+
     it "should return balance date" do
-      @account.balance.posted_at.should == Time.parse("2009-11-01")
+      @account.balance.posted_at.should == Time.gm(2009,11,1)
     end
-    
+
     context "available_balance" do
       it "should return available balance" do
-        @account.available_balance.amount.should == 1555.99
+        @account.available_balance.amount.should == BigDecimal('1555.99')
       end
-    
+
       it "should return available balance in pennies" do
         @account.available_balance.amount_in_pennies.should == 155599
       end
-    
+
       it "should return available balance date" do
-        @account.available_balance.posted_at.should == Time.parse("2009-11-01")
+        @account.available_balance.posted_at.should == Time.gm(2009,11,1)
       end
-      
+
       it "should return nil if AVAILBAL not found" do
         @ofx = OFX::Parser::Base.new("spec/fixtures/utf8.ofx")
         @parser = @ofx.parser
@@ -61,7 +61,7 @@ describe OFX::Account do
         @account.available_balance.should be_nil
       end
     end
-    
+
     context "Credit Card" do
       before do
         @ofx = OFX::Parser::Base.new("spec/fixtures/creditcard.ofx")
@@ -72,10 +72,60 @@ describe OFX::Account do
       it "should return id" do
         @account.id.should == "XXXXXXXXXXXX1111"
       end
-      
+
       it "should return currency" do
         @account.currency.should == "USD"
       end
     end
+    context "With Issue" do # Bradesco do not provide a valid date in balance
+      before do
+        @ofx = OFX::Parser::Base.new("spec/fixtures/dtsof_balance_issue.ofx")
+        @parser = @ofx.parser
+        @account = @parser.account
+      end
+
+      it "should return nil for date balance" do
+        @account.balance.posted_at.should be_nil
+      end
+    end
+
+    context "Invalid Dates" do
+      before do
+        @ofx = OFX::Parser::Base.new("spec/fixtures/bradesco.ofx")
+        @parser = @ofx.parser
+      end
+      it "should not raise error when balance has date zero" do
+        expect { @parser.account.balance }.to_not raise_error
+      end
+      it "should return NIL in balance.posted_at when balance date is zero" do
+        @parser.account.balance.posted_at.should be_nil
+     end
+    end
+
+    context "decimal values using a comma" do
+      before do
+        @ofx = OFX::Parser::Base.new("spec/fixtures/santander.ofx")
+        @parser = @ofx.parser
+        @account = @parser.account
+      end
+
+      it "should return balance" do
+        @account.balance.amount.should == BigDecimal('348.29')
+      end
+
+      it "should return balance in pennies" do
+        @account.balance.amount_in_pennies.should == 34829
+      end
+
+      context "available_balance" do
+        it "should return available balance" do
+          @account.available_balance.amount.should == BigDecimal('2415.87')
+        end
+
+        it "should return available balance in pennies" do
+          @account.available_balance.amount_in_pennies.should == 241587
+        end
+      end
+    end
   end
 end

data/spec/ofx/ofx102_spec.rb

@@ -5,11 +5,11 @@ describe OFX::Parser::OFX102 do
     @ofx = OFX::Parser::Base.new("spec/fixtures/sample.ofx")
     @parser = @ofx.parser
   end
-  
+
   it "should have a version" do
     OFX::Parser::OFX102::VERSION.should == "1.0.2"
   end
-  
+
   it "should set headers" do
     @parser.headers.should == @ofx.headers
   end
@@ -22,7 +22,7 @@ describe OFX::Parser::OFX102 do
   it "should set body" do
     @parser.body.should == @ofx.body
   end
-  
+
   it "should set account" do
     @parser.account.should be_a_kind_of(OFX::Account)
   end
@@ -30,17 +30,38 @@ describe OFX::Parser::OFX102 do
   it "should set account" do
     @parser.sign_on.should be_a_kind_of(OFX::SignOn)
   end
+
+  it "should set statements" do
+    @parser.statements.size.should == 1
+    @parser.statements.first.should be_a_kind_of(OFX::Statement)
+  end
   
   it "should know about all transaction types" do
     valid_types = [
-      'CREDIT', 'DEBIT', 'INT', 'DIV', 'FEE', 'SRVCHG', 'DEP', 'ATM', 'POS', 'XFER', 
+      'CREDIT', 'DEBIT', 'INT', 'DIV', 'FEE', 'SRVCHG', 'DEP', 'ATM', 'POS', 'XFER',
       'CHECK', 'PAYMENT', 'CASH', 'DIRECTDEP', 'DIRECTDEBIT', 'REPEATPMT', 'OTHER'
     ]
     valid_types.sort.should == OFX::Parser::OFX102::TRANSACTION_TYPES.keys.sort
-    
+
     valid_types.each do |transaction_type|
       transaction_type.downcase.to_sym.should equal OFX::Parser::OFX102::TRANSACTION_TYPES[transaction_type]
     end
   end
-  
+
+  describe "#build_date" do
+    context "without a Time Zone" do
+      it "should default to GMT" do
+        @parser.send(:build_date, "20170904").should == Time.gm(2017, 9, 4)
+        @parser.send(:build_date, "20170904082855").should == Time.gm(2017, 9, 4, 8, 28, 55)
+      end
+    end
+
+    context "with a Time Zone" do
+      it "should returns the correct date" do
+        @parser.send(:build_date, "20150507164333[-0300:BRT]").should == Time.new(2015, 5, 7, 16, 43, 33, "-03:00")
+        @parser.send(:build_date, "20180507120000[0:GMT]").should == Time.gm(2018, 5, 7, 12)
+        @parser.send(:build_date, "20170904082855[-3:GMT]").should == Time.new(2017, 9, 4, 8, 28, 55, "-03:00")
+      end
+    end
+  end
 end