coop_to_ofx 1.0.1

data/spec/ofx/statement/output/base_spec.rb

@@ -0,0 +1,249 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+describe OFX::Statement::Output::Base do
+  before(:all) do
+    @base = OFX::Statement::Output::Base.new
+  end
+  
+  describe "creating a builder" do
+    it "should pick the right output mechanism for OFX 1 when asked" do
+      @base.create_builder(:ofx1).should be_instance_of(OFX::Statement::Output::Builder::OFX1)
+    end
+    
+    it "should pick the right output mechanism for OFX 2 when asked" do
+      @base.create_builder(:ofx2).should be_instance_of(OFX::Statement::Output::Builder::OFX2)
+    end
+    
+    it "should pick OFX 2 by default" do
+      @base.create_builder.should be_instance_of(OFX::Statement::Output::Builder::OFX2)
+    end
+  end
+  
+  describe "outputting OFX" do
+    describe "making OFX datetimes from Time objects" do
+      it "should be able to turn a Time object into a YYYYMMDD string" do
+        @base.time_to_ofx_dta(Time.utc('2009', '02', '03')).should == '20090203'
+      end
+      
+      it "should be able to turn a Time object into a YYYYMMDDHHMMSS string" do
+        @base.time_to_ofx_dta(Time.utc('2009', '02', '03', '14', '26', '15'), true).should == '20090203142615'
+      end
+    end
+    
+    describe "FITIDs" do
+      it "should use an invocation-persistent store to ensure FITID uniqueness and repeatability" do
+        @base.fitid_hash.should == @base.fitid_hash
+      end
+      
+      describe "generating" do
+        before(:each) do
+          @fitid_hash = {}
+          @base.stubs(:fitid_hash).returns(@fitid_hash)
+        end
+        
+        it "should generate a FITID based on the date of the transaction" do
+          @base.generate_fitid(Time.utc('2009', '2', '3')).should == '200902031'
+        end
+      
+        it "should generate sequential FITIDs for two transaction on the same date" do
+          @base.generate_fitid(Time.utc('2009', '2', '3')).should == '200902031'
+          @base.generate_fitid(Time.utc('2009', '2', '3')).should == '200902032'
+        end
+      end
+    end
+    
+    describe "TRNTYPE" do
+      {
+        :debit => "DEBIT", :credit => "CREDIT", :interest => "INT", :dividend => "DIV",
+        :fee => "FEE", :service_charge => "SRVCHG", :deposit => "DEP", :atm => "ATM", 
+        :point_of_sale => "POS", :transfer => "XFER", :cheque => "CHECK", :check => "CHECK",
+        :payment => "PAYMENT", :cash => "CASH", :direct_deposit => "DIRECTDEP",
+        :direct_debit => "DIRECTDEBIT", :repeating_payment => "REPEATPMT", 
+        :standing_order => "REPEATPMT", :other => "OTHER"
+      }.each do |input, expected|
+        it "should return #{expected} for a trntype of #{input.inspect}" do
+          @base.generate_trntype(input).should == expected
+        end
+      end
+    end
+    
+    describe "components" do
+      before(:each) do
+        @builder = Builder::XmlMarkup.new
+      end
+      
+      describe "OFX wrapper" do
+        it "should be able to generate the correct OFX root element" do
+          @base.ofx_block(@builder)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/OFX').should_not be_nil
+        end
+        
+        it "should yield a child node builder so that document generation can continue" do
+          @base.ofx_block(@builder) { |node| node.fnord }
+          output = Hpricot(@builder.target!)
+          
+          output.at('/OFX/fnord').should_not be_nil
+        end
+      end
+      
+      describe "signon block" do
+        before(:each) do
+          @t = Time.utc('2009', '1', '8', '12', '13', '14')
+          @statement = stub('Statement', :server_response_time => @t, :language => 'ENG')
+        end
+        
+        it "should be able to generate a sensible Signon Message Set, with Signon response block" do
+          
+          @base.signon_block(@builder, @statement)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/SIGNONMSGSRSV1/SONRS').should_not be_nil
+          output.at('/SIGNONMSGSRSV1/SONRS/STATUS/CODE').inner_text.should == '0'
+          output.at('/SIGNONMSGSRSV1/SONRS/STATUS/SEVERITY').inner_text.should == 'INFO'
+          output.at('/SIGNONMSGSRSV1/SONRS/DTSERVER').inner_text.should == '20090108121314'
+          output.at('/SIGNONMSGSRSV1/SONRS/LANGUAGE').inner_text.should == 'ENG'
+        end
+        
+        it "should yield a child node builder so that document generation can continue" do
+          @base.signon_block(@builder, @statement) { |node| node.fnord }
+          output = Hpricot(@builder.target!)
+          
+          output.at('/SIGNONMSGSRSV1/fnord').should_not be_nil
+        end
+      end
+      
+      describe "ledger balance block" do
+        it "should produce the right bits for a ledger balance block" do
+          statement = stub('Statement', :ledger_balance => '350.00', :date => Time.utc('2009', '2', '3'))
+          @base.ledger_balance_block(@builder, statement)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/LEDGERBAL/BALAMT').inner_text.should == "350.00"
+          output.at('/LEDGERBAL/DTASOF').inner_text.should == "20090203"
+        end
+      end
+      
+      describe "transaction list block" do
+        before(:each) do
+          @t = Time.utc('2009', '1', '8', '12', '13', '14')
+          @t_end = Time.utc('2009', '1', '9', '12', '13', '14')
+          @statement = stub('Statement', :start_date => @t, :end_date => @t_end)
+          @base.stubs(:fitid_hash).returns({})
+        end
+        
+        it "should generate a block with the right values" do
+          @base.transaction_list(@builder, @statement)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/BANKTRANLIST/DTSTART').inner_text.should == "20090108"
+          output.at('/BANKTRANLIST/DTEND').inner_text.should == "20090109"
+        end
+        
+        it "should should yield for child node generation in the right place" do
+          @base.transaction_list(@builder, @statement) { |child| child.fnord }
+          output = Hpricot(@builder.target!)
+          
+          output.at('/BANKTRANLIST/fnord').should_not be_nil
+        end
+      end
+      
+      describe "transaction block" do
+        before(:each) do
+          @t = Time.utc('2009', '1', '8', '12', '13', '14')
+          @base.stubs(:fitid_hash).returns({})
+        end
+        
+        it "should be able to generate a transaction block from a debit transaction object without currency conversion details" do
+          transaction = OFX::Statement::Transaction.new("-350.00", @t, "A nice thing wot I bought")
+          transaction.stubs(:fitid).returns("PROPER:FIT:ID")
+          @base.transaction_block(@builder, transaction)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/STMTTRN/TRNTYPE').inner_text.should == "DEBIT"
+          output.at('/STMTTRN/DTPOSTED').inner_text.should == "20090108"
+          output.at('/STMTTRN/TRNAMT').inner_text.should == "-350.00"
+          output.at('/STMTTRN/FITID').inner_text.should == "PROPER:FIT:ID"
+          output.at('/STMTTRN/NAME').inner_text.should == "A nice thing wot I bought"
+        end
+        
+        it "should be able to generate a transaction block from a credit transaction object without currency conversion" do
+          transaction = OFX::Statement::Transaction.new("350.00", @t, "A nice sum wot I was given")
+          transaction.stubs(:fitid).returns("PROPER:FIT:ID")
+          @base.transaction_block(@builder, transaction)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/STMTTRN/TRNTYPE').inner_text.should == "CREDIT"
+          output.at('/STMTTRN/DTPOSTED').inner_text.should == "20090108"
+          output.at('/STMTTRN/TRNAMT').inner_text.should == "350.00"
+          output.at('/STMTTRN/FITID').inner_text.should == "PROPER:FIT:ID"
+          output.at('/STMTTRN/NAME').inner_text.should == "A nice sum wot I was given"
+        end
+        
+        it "should be able to generate a transaction block from a debit transaction object with a memo / currency conversion info" do
+          transaction = OFX::Statement::Transaction.new("-350.00", @t, "A nice thing wot I bought", {:memo => "plenty USD wonga"})
+          transaction.stubs(:fitid).returns("PROPER:FIT:ID")
+          @base.transaction_block(@builder, transaction)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/STMTTRN/TRNTYPE').inner_text.should == "DEBIT"
+          output.at('/STMTTRN/DTPOSTED').inner_text.should == "20090108"
+          output.at('/STMTTRN/TRNAMT').inner_text.should == "-350.00"
+          output.at('/STMTTRN/FITID').inner_text.should == "PROPER:FIT:ID"
+          output.at('/STMTTRN/NAME').inner_text.should == "A nice thing wot I bought"
+          output.at('/STMTTRN/MEMO').inner_text.should == "plenty USD wonga"
+        end
+      end
+    end
+    
+    describe "serialising" do
+      before(:each) do
+        @base.stubs(:ofx_block)
+      end
+      
+      it "should pass through format correctly" do
+        stub_builder = stub('Builder')
+        stub_builder.stubs(:ofx_stanza!)
+        stub_builder.stubs(:target!)
+        @base.expects(:create_builder).with(:format).returns(stub_builder)
+        
+        @base.serialise(nil, :format)
+      end
+      
+      it "should invoke ofx_stanza! on the builder" do
+        mock_builder = mock('Builder')
+        @base.stubs(:create_builder).with(:format).returns(mock_builder)
+        mock_builder.stubs(:target!)
+        
+        mock_builder.expects(:ofx_stanza!)
+        
+        @base.serialise(nil, :format)
+      end
+      
+      it "should invoke ofx_block passing in builder" do
+        stub_builder = stub('Builder')
+        @base.stubs(:create_builder).with(:format).returns(stub_builder)
+        stub_builder.stubs(:ofx_stanza!)
+        stub_builder.stubs(:target!)
+        
+        @base.expects(:ofx_block).with(stub_builder)
+        
+        
+        @base.serialise(:statement, :format)
+      end
+      
+      it "should return a string" do
+        stub_builder = stub('Builder')
+        @base.stubs(:create_builder).with(:format).returns(stub_builder)
+        @base.stubs(:ofx_block).with(stub_builder)
+        stub_builder.stubs(:ofx_stanza!)
+        
+        stub_builder.expects(:target!).returns("output")
+        
+        
+        @base.serialise(:statement, :format).should == "output"
+      end
+    end
+  end
+end

data/spec/ofx/statement/output/builder_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+describe OFX::Statement::Output::Builder do
+  describe OFX::Statement::Output::Builder::OFX2 do
+    it "should generate the proper OFX 2 XML declaration stuff when asked" do
+      builder = OFX::Statement::Output::Builder::OFX2.new(:indent => 2)
+      builder.ofx_stanza!
+      result = builder.target!
+      result.should =~ /<\?xml version="1.0" encoding="UTF-8"\?>/
+      result.should =~ /<\?OFX (?:(?:OLDFILEUID="NONE"|NEWFILEUID="NONE"|OFXHEADER="200"|VERSION="203"|SECURITY="NONE") ?)+\?>/
+    end
+  end
+  
+  describe OFX::Statement::Output::Builder::OFX1 do
+    it "should generate the proper OFX 1 SGML header stuff when asked" do
+      builder = OFX::Statement::Output::Builder::OFX1.new(:indent => 2)
+      builder.ofx_stanza!
+      result = builder.target!
+      result.should == <<-EOH
+OFXHEADER:100
+DATA:OFXSGML
+VERSION:103
+SECURITY:NONE
+ENCODING:USASCII
+CHARSET:NONE
+COMPRESSION:NONE
+OLDFILEUID:NONE
+NEWFILEUID:NONE
+EOH
+    end
+    
+    it "should generate empty tags without the trailing slash" do
+      builder = OFX::Statement::Output::Builder::OFX1.new
+      builder.my_tag
+      builder.target!.should == "<my_tag>"
+    end
+  end
+end

data/spec/ofx/statement/output/credit_card_spec.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+describe OFX::Statement::Output::CreditCard do
+  describe "generating OFX" do
+    before(:each) do
+      @output = OFX::Statement::Output::CreditCard.new
+    end
+    
+    describe "components" do
+      before(:each) do
+        @builder = Builder::XmlMarkup.new
+      end
+      
+      describe "credit card message set wrapper" do
+        it "should be able to generate the correct OFX root element" do
+          @output.message_set_block(@builder)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/CREDITCARDMSGSETV1').should_not be_nil
+        end
+        
+        it "should yield a child node builder so that document generation can continue" do
+          @output.message_set_block(@builder) { |node| node.fnord }
+          output = Hpricot(@builder.target!)
+          
+          output.at('/CREDITCARDMSGSETV1/fnord').should_not be_nil
+        end
+      end
+      
+      describe "credit card statement block" do
+        before(:each) do
+          @statement = stub('Statement', :start_date => Time.utc('2009', '1', '7', '12', '13', '14'), 
+                                         :end_date => Time.utc('2009', '1', '8', '12', '13', '14'), 
+                                         :date => Time.utc('2009', '1', '8', '12', '13', '14'),
+                                         :currency => 'GBP', :account_number => "1234123412341234", 
+                                         :available_credit => '305.00', :ledger_balance => "-1551.90")
+        end
+        
+        it "should be able to generate the correct Statement block" do
+          @output.statement_block(@builder, @statement)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/CCSTMTTRNRS/CCSTMTRS/CURDEF').should_not be_nil
+          output.at('/CCSTMTTRNRS/CCSTMTRS/CURDEF').inner_text.should == "GBP"
+          
+          output.at('/CCSTMTTRNRS/CCSTMTRS/CCACCTFROM').should_not be_nil
+          output.at('/CCSTMTTRNRS/CCSTMTRS/CCACCTFROM/ACCTID').inner_text.should == "1234123412341234"
+          
+          output.at('/CCSTMTTRNRS/CCSTMTRS/LEDGERBAL').should_not be_nil
+          
+          output.at('/CCSTMTTRNRS/CCSTMTRS/AVAILBAL').should_not be_nil
+          output.at('/CCSTMTTRNRS/CCSTMTRS/AVAILBAL/BALAMT').inner_text.should == "305.00"
+          output.at('/CCSTMTTRNRS/CCSTMTRS/AVAILBAL/DTASOF').inner_text.should == "20090108"
+          
+          output.at('/CCSTMTTRNRS/CCSTMTRS/BANKTRANLIST').should_not be_nil
+        end
+        
+        it "should yield a child node builder so that document generation can continue" do
+          @output.statement_block(@builder, @statement) { |node| node.fnord }
+          output = Hpricot(@builder.target!)
+          
+          output.at('/CCSTMTTRNRS/CCSTMTRS/BANKTRANLIST/fnord').should_not be_nil
+        end
+      end
+    end
+    
+    it "should be able to generate a correct OFX file" do
+      transaction = OFX::Statement::Transaction.new("-15.00", Time.utc('2009', '1', '5'), "COMP HSE FILE-DOM INTERNET GB")
+      statement = OFX::Statement::CreditCard.new
+      statement.server_response_time = Time.utc('2009', '2', '6', '18', '35', '56')
+      statement.account_number = '1234123412341234'
+      statement.start_date = Time.utc('2009', '1', '1')
+      statement.end_date = Time.utc('2009', '2', '3')
+      statement.date = Time.utc('2009', '2', '3')
+      statement.ledger_balance = "-1551.90"
+      statement.available_credit = "305.00"
+      statement << transaction
+      
+      output_doc = Hpricot(@output.serialise(statement))
+      output_doc.search('/OFX/SIGNONMSGSRSV1/SONRS/STATUS/CODE').should_not be_empty
+      output_doc.search('/OFX/SIGNONMSGSRSV1/CREDITCARDMSGSETV1/CCSTMTTRNRS/CCSTMTRS/BANKTRANLIST/STMTTRN/TRNAMT').should_not be_empty
+    end
+  end
+end

data/spec/ofx/statement/output/current_account_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+describe OFX::Statement::Output::CurrentAccount do
+  describe "generating OFX" do
+    before(:each) do
+      @output = OFX::Statement::Output::CurrentAccount.new
+    end
+    describe "components" do
+      before(:each) do
+        @builder = Builder::XmlMarkup.new
+      end
+      
+      describe "bank account message set wrapper" do
+        it "should be able to generate the correct bank account message set element" do
+          @output.message_set_block(@builder)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/BANKMSGSETV1').should_not be_nil
+        end
+        
+        it "should yield a child node builder so that document generation can continue" do
+          @output.message_set_block(@builder) { |node| node.fnord }
+          output = Hpricot(@builder.target!)
+          
+          output.at('/BANKMSGSETV1/fnord').should_not be_nil
+        end
+      end
+      
+      describe "current account statement block" do
+        before(:each) do
+          @statement = stub('Statement', :start_date => Time.utc('2009', '1', '7', '12', '13', '14'), 
+                                         :end_date => Time.utc('2009', '1', '8', '12', '13', '14'), 
+                                         :date => Time.utc('2009', '1', '8', '12', '13', '14'), 
+                                         :currency => 'GBP', :account_number => "12341234", 
+                                         :sort_code => '089273', :ledger_balance => "-1551.90")
+        end
+        
+        it "should be able to generate the correct Statement block" do
+          @output.statement_block(@builder, @statement)
+          output = Hpricot(@builder.target!)
+          
+          output.at('/STMTTRNRS/STMTRS/CURDEF').should_not be_nil
+          output.at('/STMTTRNRS/STMTRS/CURDEF').inner_text.should == "GBP"
+          
+          output.at('/STMTTRNRS/STMTRS/BANKACCTFROM').should_not be_nil
+          output.at('/STMTTRNRS/STMTRS/BANKACCTFROM/BANKID').inner_text.should == "089273"
+          output.at('/STMTTRNRS/STMTRS/BANKACCTFROM/ACCTID').inner_text.should == "12341234"
+          output.at('/STMTTRNRS/STMTRS/BANKACCTFROM/ACCTTYPE').inner_text.should == "CHECKING"
+          
+          output.at('/STMTTRNRS/STMTRS/LEDGERBAL').should_not be_nil
+          
+          output.at('/STMTTRNRS/STMTRS/BANKTRANLIST').should_not be_nil
+        end
+        
+        it "should yield a child node builder so that document generation can continue" do
+          @output.statement_block(@builder, @statement) { |node| node.fnord }
+          output = Hpricot(@builder.target!)
+          
+          output.at('/STMTTRNRS/STMTRS/BANKTRANLIST/fnord').should_not be_nil
+        end
+      end
+
+      it "should be able to generate a correct OFX file" do
+        transaction = OFX::Statement::Transaction.new("-15.00", Time.utc('2009', '1', '5'), "COMP HSE FILE-DOM INTERNET GB")
+        statement = OFX::Statement::CurrentAccount.new
+        statement.server_response_time = Time.utc('2009', '2', '6', '18', '35', '56')
+        statement.account_number = '12341234'
+        statement.start_date = Time.utc('2009', '1', '1')
+        statement.end_date = Time.utc('2009', '2', '3')
+        statement.date = Time.utc('2009', '2', '3')
+        statement.ledger_balance = "-1551.90"
+        statement.sort_code = "089273"
+        statement << transaction
+        
+        output_doc = Hpricot(@output.serialise(statement))
+        output_doc.search('/OFX/SIGNONMSGSRSV1/SONRS/STATUS/CODE').should_not be_empty
+        output_doc.search('/OFX/SIGNONMSGSRSV1/BANKMSGSETV1/STMTTRNRS/STMTRS/BANKTRANLIST/STMTTRN/TRNAMT').should_not be_empty
+      end
+    end
+  end
+end

data/spec/ofx/statement/transaction_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe OFX::Statement::Transaction do
+  describe "instantiating" do
+    it "should require amount, date, details, and allow an options hash" do
+      OFX::Statement::Transaction.new("350", Time.now, "Details", {:memo => "Memo"}).should be_instance_of(OFX::Statement::Transaction)
+    end
+  end
+  
+  describe "instances" do
+    before(:each) do
+      @t = Time.now
+      @transaction = OFX::Statement::Transaction.new("350.00", @t, "Details", {:memo => "Memo"})
+    end
+    
+    it "should report its amount" do
+      @transaction.amount.should == "350.00"
+    end
+    
+    it "should report its date" do
+      @transaction.date.should == @t
+    end
+    
+    it "should report its name" do
+      @transaction.name.should == "Details"
+    end
+    
+    it "should report its memo" do
+      @transaction.memo.should == "Memo"
+    end
+    
+    it "should should allow its statement to be set and retrieved" do
+      @transaction.statement = :statement
+      @transaction.statement.should == :statement
+    end
+    
+    it "should be able to get a sane FITID" do
+      mock_statement = mock('Statement')
+      @transaction.stubs(:statement).returns(mock_statement)
+      
+      mock_statement.expects(:fitid_for).with(@transaction).returns(:sane_fitid)
+      
+      @transaction.fitid.should == :sane_fitid
+    end
+    
+    describe "memo" do
+      it "should report that it has a memo" do
+        @transaction.has_memo?.should be_true
+      end
+      
+      it "should report that it does not have a memo" do
+        transaction = OFX::Statement::Transaction.new("350.00", @t, "Details")
+        
+        transaction.has_memo?.should be_false
+      end
+    end
+    
+    describe "basic transaction types" do
+      it "should default to :credit for a positive amount" do
+        @transaction.trntype.should == :credit
+      end
+      
+      it "should default to debit for a negative amount" do
+        transaction = OFX::Statement::Transaction.new("-350.00", @t, "Details")
+        
+        transaction.trntype.should == :debit
+      end
+      
+      it "should allow the type to be set in the options hash" do
+        transaction = OFX::Statement::Transaction.new("-350.00", @t, "Details", :trntype => :credit)
+        
+        transaction.trntype.should == :credit
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'mocha'
+$:.push(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+require 'ofx'
+require 'coop_scraper'
+require 'hpricot'
+
+def full_fixture_path(fixture_dir, fixture_filename)
+  File.dirname(__FILE__) + "/fixtures/#{fixture_dir}/" + fixture_filename
+end
+
+def read_fixture(fixture_filename)
+  File.read(fixture_path(fixture_filename))
+end
+
+class Class
+  def publicize_methods
+    saved_private_instance_methods = self.private_instance_methods
+    saved_protected_instance_methods = self.protected_instance_methods
+    self.class_eval do
+      public *saved_private_instance_methods
+      public *saved_protected_instance_methods
+    end
+    
+    yield
+    
+    self.class_eval do
+      private *saved_private_instance_methods
+      protected *saved_protected_instance_methods
+    end
+  end
+end