ofx_br 0.3.3

data/spec/fixtures/v103.ofx

@@ -0,0 +1,80 @@
+
+
+OFXHEADER:100
+DATA:OFXSGML
+VERSION:103
+SECURITY:NONE
+ENCODING:USASCII
+CHARSET:1252
+COMPRESSION:NONE
+OLDFILEUID:NONE
+NEWFILEUID:NONE
+
+<OFX>
+	<SIGNONMSGSRSV1>
+		<SONRS>
+			<STATUS>
+				<CODE>0</CODE>
+				<SEVERITY>INFO</SEVERITY>
+			</STATUS>
+			<DTSERVER>20150507164333.979[-0300:BRT]</DTSERVER>
+			<LANGUAGE>POR</LANGUAGE>
+			<FI>
+				<ORG>HSBC Bank Brasil S.A.</ORG>
+				<FID>1</FID>
+			</FI>
+		</SONRS>
+	</SIGNONMSGSRSV1>
+	<BANKMSGSRSV1>
+		<STMTTRNRS>
+			<TRNUID>1</TRNUID>
+ 			<STATUS>
+				<CODE>0</CODE>
+				<SEVERITY>INFO</SEVERITY>
+			</STATUS>
+			<STMTRS>
+				<CURDEF>BRL</CURDEF>
+				<BANKACCTFROM>
+					<BANKID>399</BANKID>
+					<ACCTID>26215973324</ACCTID>
+					<ACCTTYPE>CHECKING</ACCTTYPE>
+				</BANKACCTFROM>
+				<BANKTRANLIST>
+					<DTSTART>20150501</DTSTART>
+					<DTEND>20150507</DTEND>
+
+					<STMTTRN>
+						<TRNTYPE>PAYMENT</TRNTYPE>
+						<DTPOSTED>20150504120000</DTPOSTED>
+						<DTUSER>20150504120000</DTUSER>
+						<TRNAMT>-1020.88</TRNAMT>
+						<FITID>201505041</FITID>
+						<CHECKNUM>0390003</CHECKNUM>
+						<NAME>PAGAMENTO TITULO-CNB  </NAME>
+						<MEMO>PAGAMENTO TITULO-CNB  </MEMO>
+					</STMTTRN>
+
+					<STMTTRN>
+						<TRNTYPE>PAYMENT</TRNTYPE>
+						<DTPOSTED>20150505120000</DTPOSTED>
+						<DTUSER>20150505120000</DTUSER>
+						<TRNAMT>-82.10</TRNAMT>
+						<FITID>201505051</FITID>
+						<CHECKNUM>0000000</CHECKNUM>
+						<NAME>TAR PACOTE MENSAL     </NAME>
+						<MEMO>TAR PACOTE MENSAL     </MEMO>
+					</STMTTRN>
+
+				</BANKTRANLIST>
+				<LEDGERBAL>
+					<BALAMT>3806.63</BALAMT>
+					<DTASOF>20150507164333.980[-0300:BRT]</DTASOF>
+				</LEDGERBAL>
+				<AVAILBAL>
+					<BALAMT>3806.63</BALAMT>
+					<DTASOF>20150507164333.980[-0300:BRT]</DTASOF>
+				</AVAILBAL>
+			</STMTRS>
+		</STMTTRNRS>
+	</BANKMSGSRSV1>
+</OFX>

data/spec/fixtures/v211.ofx

@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="US-ASCII"?>
+
+<!-- This example is taken from the 2.1.1 specification, pages 610-612 -->
+<?OFX OFXHEADER="200" VERSION="211" SECURITY="NONE" OLDFILEUID="NONE" NEWFILEUID="NONE"?>
+<OFX> 
+  <SIGNONMSGSRSV1>
+    <SONRS> 
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY> 
+      </STATUS>
+      <DTSERVER>20050831165153.000[-8:PST]</DTSERVER>
+      <LANGUAGE>ENG</LANGUAGE> 
+    </SONRS>
+  </SIGNONMSGSRSV1> 
+  <BANKMSGSRSV1>
+    <STMTTRNRS> 
+      <TRNUID>0</TRNUID> 
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY> 
+      </STATUS>
+      <STMTRS> 
+        <CURDEF>USD</CURDEF> 
+        <BANKACCTFROM>
+          <BANKID>000000123</BANKID> 
+          <ACCTID>123456</ACCTID> 
+          <ACCTTYPE>CHECKING</ACCTTYPE>
+        </BANKACCTFROM> 
+        <BANKTRANLIST>
+          <DTSTART>20040801</DTSTART> 
+          <DTEND>20050831165153.000[-8:PST]</DTEND> 
+          <STMTTRN>
+            <TRNTYPE>POS</TRNTYPE> 
+            <DTPOSTED>20050824080000</DTPOSTED> 
+            <TRNAMT>-80</TRNAMT> 
+            <FITID>219378</FITID> 
+            <NAME>FrogKick Scuba Gear</NAME>
+          </STMTTRN> 
+        </BANKTRANLIST>
+        <LEDGERBAL> 
+          <BALAMT>2156.56</BALAMT> 
+          <DTASOF>20050831165153</DTASOF>
+        </LEDGERBAL> 
+      </STMTRS>
+    </STMTTRNRS> 
+  </BANKMSGSRSV1>
+  <CREDITCARDMSGSRSV1> 
+    <CCSTMTTRNRS>
+      <TRNUID>0</TRNUID> 
+      <STATUS>
+        <CODE>0</CODE>
+        <SEVERITY>INFO</SEVERITY> 
+      </STATUS>
+      <CCSTMTRS> 
+        <CURDEF>USD</CURDEF> 
+        <CCACCTFROM>
+          <ACCTID>123412341234</ACCTID> 
+        </CCACCTFROM>
+        <BANKTRANLIST> 
+          <DTSTART>20050801</DTSTART> 
+          <DTEND>20050831165153.000[-8:PST]</DTEND> 
+          <STMTTRN>
+            <TRNTYPE>INT</TRNTYPE> 
+            <DTPOSTED>20050811080000</DTPOSTED> 
+            <TRNAMT>-23.00</TRNAMT> 
+            <FITID>219867</FITID> 
+            <NAME>Interest Charge</NAME>
+          </STMTTRN> 
+          <STMTTRN>
+            <TRNTYPE>CREDIT</TRNTYPE> 
+            <DTPOSTED>20050811080000</DTPOSTED> 
+            <TRNAMT>350.00</TRNAMT> 
+            <FITID>219868</FITID>
+            <NAME>Payment - Thank You</NAME> 
+          </STMTTRN>
+        </BANKTRANLIST> 
+        <LEDGERBAL>
+          <BALAMT>-562.00</BALAMT> 
+          <DTASOF>20050831165153</DTASOF>
+        </LEDGERBAL> 
+      </CCSTMTRS>
+    </CCSTMTTRNRS> 
+  </CREDITCARDMSGSRSV1>
+</OFX>

data/spec/ofx_br/account_spec.rb

@@ -0,0 +1,131 @@
+require "spec_helper"
+
+describe OFX::Account do
+  before do
+    @ofx = OFX::Parser::Base.new("spec/fixtures/sample.ofx")
+    @parser = @ofx.parser
+    @account = @parser.account
+  end
+
+  describe "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 == 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.gm(2009,11,1)
+    end
+
+    context "available_balance" do
+      it "should return available balance" do
+        @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.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
+        @account = @parser.account
+        @account.available_balance.should be_nil
+      end
+    end
+
+    context "Credit Card" do
+      before do
+        @ofx = OFX::Parser::Base.new("spec/fixtures/creditcard.ofx")
+        @parser = @ofx.parser
+        @account = @parser.account
+      end
+
+      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_br/ofx102_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe OFX::Parser::OFX102 do
+  before 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
+
+  it "should trim trailing whitespace from headers" do
+    headers = OFX::Parser::OFX102.parse_headers("VERSION:102   ")
+    headers["VERSION"].should == "102"
+  end
+
+  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
+
+  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',
+      '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

data/spec/ofx_br/ofx103_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe OFX::Parser::OFX103 do
+  before do
+    @ofx = OFX::Parser::Base.new("spec/fixtures/v103.ofx")
+    @parser = @ofx.parser
+  end
+
+  it "should have a version" do
+    OFX::Parser::OFX103::VERSION.should == "1.0.3"
+  end
+
+  it "should set headers" do
+    @parser.headers.should == @ofx.headers
+  end
+
+  it "should trim trailing whitespace from headers" do
+    headers = OFX::Parser::OFX103.parse_headers("VERSION:103   ")
+    headers["VERSION"].should == "103"
+  end
+
+  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
+
+  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',
+      'CHECK', 'PAYMENT', 'CASH', 'DIRECTDEP', 'DIRECTDEBIT', 'REPEATPMT', 'OTHER'
+    ]
+    valid_types.sort.should == OFX::Parser::OFX103::TRANSACTION_TYPES.keys.sort
+
+    valid_types.each do |transaction_type|
+      transaction_type.downcase.to_sym.should equal OFX::Parser::OFX103::TRANSACTION_TYPES[transaction_type]
+    end
+  end
+end

data/spec/ofx_br/ofx211_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+describe OFX::Parser::OFX211 do
+  before do
+    @ofx = OFX::Parser::Base.new("spec/fixtures/v211.ofx")
+    @parser = @ofx.parser
+  end
+
+  it "should have a version" do
+    OFX::Parser::OFX211::VERSION.should == "2.1.1"
+  end
+
+  it "should set headers" do
+    @parser.headers.should == @ofx.headers
+  end
+
+  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
+
+  it "should set account" do
+    @parser.sign_on.should be_a_kind_of(OFX::SignOn)
+  end
+
+  it "should set accounts" do
+    @parser.accounts.size.should == 2
+  end
+
+  it "should set statements" do
+    @parser.statements.size.should == 2
+    @parser.statements.first.should be_a_kind_of(OFX::Statement)
+  end
+
+  context "transactions" do
+    # Test file contains only three transactions. Let's just check
+    # them all.
+    context "first" do
+      before do
+        @t = @parser.accounts[0].transactions[0]
+      end
+
+      it "should contain the correct values" do
+        @t.amount.should == BigDecimal('-80')
+        @t.fit_id.should == "219378"
+        @t.memo.should be_empty
+        @t.posted_at.should == Time.parse("2005-08-24 08:00:00 +0000")
+        @t.name.should == "FrogKick Scuba Gear"
+      end
+    end
+
+    context "second" do
+      before do
+        @t = @parser.accounts[1].transactions[0]
+      end
+
+      it "should contain the correct values" do
+        @t.amount.should == BigDecimal('-23')
+        @t.fit_id.should == "219867"
+        @t.memo.should be_empty
+        @t.posted_at.should == Time.parse("2005-08-11 08:00:00 +0000")
+        @t.name.should == "Interest Charge"
+      end
+    end
+
+    context "third" do
+      before do
+        @t = @parser.accounts[1].transactions[1]
+      end
+
+      it "should contain the correct values" do
+        @t.amount.should == BigDecimal('350')
+        @t.fit_id.should == "219868"
+        @t.memo.should be_empty
+        @t.posted_at.should == Time.parse("2005-08-11 08:00:00 +0000")
+        @t.name.should == "Payment - Thank You"
+      end
+    end
+  end
+end
+

data/spec/ofx_br/ofx_parser_spec.rb

@@ -0,0 +1,123 @@
+require "spec_helper"
+
+describe OFX::Parser do
+  before do
+    @ofx = OFX::Parser::Base.new("spec/fixtures/sample.ofx")
+  end
+
+  it "should accept file path" do
+    @ofx = OFX::Parser::Base.new("spec/fixtures/sample.ofx")
+    @ofx.content.should_not be_nil
+  end
+
+  it "should accept file handler" do
+    file = open("spec/fixtures/sample.ofx")
+    @ofx = OFX::Parser::Base.new(file)
+    @ofx.content.should_not be_nil
+  end
+
+  it "should accept file content" do
+    file = open("spec/fixtures/sample.ofx").read
+    @ofx = OFX::Parser::Base.new(file)
+    @ofx.content.should_not be_nil
+  end
+
+  it "should set content" do
+    @ofx.content.should == open("spec/fixtures/sample.ofx").read
+  end
+
+  it "should work with UTF8 and Latin1 encodings" do
+    @ofx = OFX::Parser::Base.new("spec/fixtures/utf8.ofx")
+    @ofx.content.should == open("spec/fixtures/utf8.ofx").read
+  end
+
+  it "should set body" do
+    @ofx.body.should_not be_nil
+  end
+
+  it "should raise exception when trying to parse an unsupported OFX version" do
+    lambda {
+      OFX::Parser::Base.new("spec/fixtures/invalid_version.ofx")
+    }.should raise_error(OFX::UnsupportedFileError)
+  end
+
+  it "should raise exception when trying to parse an invalid file" do
+    lambda {
+      OFX::Parser::Base.new("spec/fixtures/avatar.gif")
+    }.should raise_error(OFX::UnsupportedFileError)
+  end
+
+  it "should use 211 parser to parse version 200 ofx files" do
+    OFX::Parser::OFX211.stub(:new).and_return('ofx-211-parser')
+    ofx = OFX::Parser::Base.new(ofx_2_example('200'))
+    ofx.parser.should == 'ofx-211-parser'
+  end
+
+  it "should use 211 parser to parse version 202 ofx files" do
+    OFX::Parser::OFX211.stub(:new).and_return('ofx-211-parser')
+    ofx = OFX::Parser::Base.new(ofx_2_example('202'))
+    ofx.parser.should == 'ofx-211-parser'
+  end
+
+  describe "headers" do
+    it "should have OFXHEADER" do
+      @ofx.headers["OFXHEADER"].should == "100"
+    end
+
+    it "should have DATA" do
+      @ofx.headers["DATA"].should == "OFXSGML"
+    end
+
+    it "should have VERSION" do
+      @ofx.headers["VERSION"].should == "102"
+    end
+
+    it "should have SECURITY" do
+      @ofx.headers.should have_key("SECURITY")
+      @ofx.headers["SECURITY"].should be_nil
+    end
+
+    it "should have ENCODING" do
+      @ofx.headers["ENCODING"].should == "USASCII"
+    end
+
+    it "should have CHARSET" do
+      @ofx.headers["CHARSET"].should == "1252"
+    end
+
+    it "should have COMPRESSION" do
+      @ofx.headers.should have_key("COMPRESSION")
+      @ofx.headers["COMPRESSION"].should be_nil
+    end
+
+    it "should have OLDFILEUID" do
+      @ofx.headers.should have_key("OLDFILEUID")
+      @ofx.headers["OLDFILEUID"].should be_nil
+    end
+
+    it "should have NEWFILEUID" do
+      @ofx.headers.should have_key("NEWFILEUID")
+      @ofx.headers["NEWFILEUID"].should be_nil
+    end
+
+    it "should parse headers with CR and without LF" do
+      @ofx = OFX::Parser::Base.new(ofx_with_carriage_return)
+      @ofx.headers.size.should be(9)
+    end
+  end
+
+  def ofx_with_carriage_return
+    header = %{OFXHEADER:100\rDATA:OFXSGML\rVERSION:102\rSECURITY:NONE\rENCODING:USASCII\rCHARSET:1252\rCOMPRESSION:NONE\rOLDFILEUID:NONE\rNEWFILEUID:NONE\r}
+    body   = open("spec/fixtures/sample.ofx").read.split(/<OFX>/, 2)[1]
+    header + "<OFX>" + body
+  end
+
+  def ofx_2_example(version)
+    <<-EndOfx
+<?xml version="1.0" encoding="US-ASCII"?>
+<?OFX OFXHEADER="200" VERSION="#{version}" SECURITY="NONE" OLDFILEUID="NONE" NEWFILEUID="NONE"?>"
+<OFX>
+</OFX>
+    EndOfx
+  end
+end

data/spec/ofx_br/ofx_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe OFX do
+  describe "#OFX" do
+    it "should yield an OFX instance" do
+      OFX("spec/fixtures/sample.ofx") do |ofx|
+        ofx.class.should == OFX::Parser::OFX102
+      end
+    end
+
+    it "should be an OFX instance" do
+      OFX("spec/fixtures/sample.ofx") do
+        self.class.should == OFX::Parser::OFX102
+      end
+    end
+
+    it "should return parser" do
+      OFX("spec/fixtures/sample.ofx").class.should == OFX::Parser::OFX102
+    end
+  end
+end

data/spec/ofx_br/sign_on_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe OFX::SignOn do
+  before do
+    @ofx = OFX::Parser::Base.new("spec/fixtures/creditcard.ofx")
+    @parser = @ofx.parser
+    @sign_on = @parser.sign_on
+  end
+
+  describe "sign_on" do
+    it "should return language" do
+      @sign_on.language.should == "ENG"
+    end
+
+    it "should return Financial Institution ID" do
+      @sign_on.fi_id.should == "24909"
+    end
+
+    it "should return Financial Institution Name" do
+      @sign_on.fi_name.should == "Citigroup"
+    end
+
+    it "should return status" do
+      @sign_on.status.should be_a(OFX::Status)
+    end
+  end
+end