coop_to_ofx 1.0.1

data/lib/ofx/statement/output/builder.rb

@@ -0,0 +1,76 @@
+module OFX
+  module Statement
+    module Output
+      module Builder
+        class OFX2 < ::Builder::XmlMarkup
+          def ofx_stanza!
+            self.instruct!
+            self.instruct! :OFX, :OFXHEADER => "200", :VERSION => "203", :SECURITY => "NONE", 
+                                 :OLDFILEUID => "NONE", :NEWFILEUID => "NONE"
+          end
+        end
+        
+        class OFX1 < ::Builder::XmlMarkup
+          def ofx_stanza!
+            self.text! <<-EOH
+OFXHEADER:100
+DATA:OFXSGML
+VERSION:103
+SECURITY:NONE
+ENCODING:USASCII
+CHARSET:NONE
+COMPRESSION:NONE
+OLDFILEUID:NONE
+NEWFILEUID:NONE
+EOH
+          end
+          # Create SGMLish markup based on the name of the method. This method
+          # is never invoked directly, but is called for each markup method
+          # in the markup block.
+          # 
+          # NB, it's not really SGML, it just doesn't generate empty tags of the form <tag/>
+          # Instead it generates <tag>
+          # That's it, it's a nasty hack.
+          def method_missing(sym, *args, &block)
+            text = nil
+            attrs = nil
+            sym = "#{sym}:#{args.shift}" if args.first.kind_of?(Symbol)
+            args.each do |arg|
+              case arg
+              when Hash
+                attrs ||= {}
+                attrs.merge!(arg)
+              else
+                text ||= ''
+                text << arg.to_s
+              end
+            end
+            if block
+              unless text.nil?
+                raise ArgumentError, "XmlMarkup cannot mix a text argument with a block"
+              end
+              _indent
+              _start_tag(sym, attrs)
+              _newline
+              _nested_structures(block)
+              _indent
+              _end_tag(sym)
+              _newline
+            elsif text.nil?
+              _indent
+              _start_tag(sym, attrs)
+              _newline
+            else
+              _indent
+              _start_tag(sym, attrs)
+              text! text
+              _end_tag(sym)
+              _newline
+            end
+            @target
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ofx/statement/output/credit_card.rb

@@ -0,0 +1,31 @@
+require 'ofx/statement/output/base'
+
+module OFX
+  module Statement
+    module Output
+      class CreditCard < OFX::Statement::Output::Base
+        def message_set_block(node)
+          return node.CREDITCARDMSGSETV1 unless block_given?
+          node.CREDITCARDMSGSETV1 { |child| yield(child) }
+        end
+        
+        def statement_block(node, statement)
+          node.CCSTMTTRNRS do |ccstmttrnrs|
+            ccstmttrnrs.CCSTMTRS do |ccstmtrs|
+              ccstmtrs.CURDEF statement.currency
+              ccstmtrs.CCACCTFROM do |ccacctfrom|
+                ccacctfrom.ACCTID statement.account_number
+              end
+              transaction_list(ccstmtrs, statement) { |list_node| yield(list_node) if block_given? }
+              ledger_balance_block(ccstmtrs, statement)
+              ccstmtrs.AVAILBAL do |availbal|
+                availbal.BALAMT statement.available_credit
+                availbal.DTASOF time_to_ofx_dta(statement.date)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ofx/statement/output/current_account.rb

@@ -0,0 +1,29 @@
+require 'ofx/statement/output/base'
+
+module OFX
+  module Statement
+    module Output
+      class CurrentAccount < OFX::Statement::Output::Base
+        def message_set_block(node)
+          return node.BANKMSGSETV1 unless block_given?
+          node.BANKMSGSETV1 { |child| yield(child) }
+        end
+        
+        def statement_block(node, statement)
+          node.STMTTRNRS do |stmttrnrs|
+            stmttrnrs.STMTRS do |stmtrs|
+              stmtrs.CURDEF statement.currency
+              stmtrs.BANKACCTFROM do |bankacctfrom|
+                bankacctfrom.BANKID statement.sort_code
+                bankacctfrom.ACCTID statement.account_number
+                bankacctfrom.ACCTTYPE "CHECKING"
+              end
+              transaction_list(stmtrs, statement) { |list_node| yield(list_node) if block_given? }
+              ledger_balance_block(stmtrs, statement)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ofx/statement/transaction.rb

@@ -0,0 +1,52 @@
+module OFX
+  module Statement
+    class Transaction
+      class << self
+        def valid_trntypes
+          @valid_trntypes ||= OFX::Statement::Output::Base.trntype_hash.keys
+        end
+      end
+      
+      attr_reader :amount, :date, :name, :memo, :trntype
+      attr_accessor :statement
+      
+      def initialize(amount, date, name, options = {})
+        @amount = amount
+        @date = date
+        @name = name
+        @memo = options[:memo]
+        @trntype = verify_trntype(options[:trntype].nil? ? default_trntype : options[:trntype])
+      end
+      
+      def has_memo?
+        !(memo.nil? || memo.empty?)
+      end
+      
+      def fitid
+        statement.fitid_for(self)
+      end
+      
+      private
+      
+      def default_trntype
+        amount.match(/^-/) ? :debit : :credit
+      end
+      
+      def verify_trntype(trntype)
+        raise UnknownTrntype, trntype unless self.class.valid_trntypes.include?(trntype)
+        trntype
+      end
+    end
+    
+    class UnknownTrntype < StandardError
+      def initialize(trntype)
+        super()
+        @trntype = trntype
+      end
+      
+      def to_s
+        "Unknown Trntype #{@trntype.inspect}"
+      end
+    end
+  end
+end

data/lib/ofx/statement.rb

@@ -0,0 +1,3 @@
+require 'ofx/statement/credit_card'
+require 'ofx/statement/current_account'
+require 'ofx/statement/transaction'

data/lib/ofx.rb

@@ -0,0 +1 @@
+require 'ofx/statement'

data/spec/coop_scraper/base_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CoopScraper::Base do
+  before(:each) do
+    klass = Class.new
+    klass.class_eval { include CoopScraper::Base }
+    @instance = klass.new
+  end
+  
+  describe "making Ruby dates from Co-op dates" do
+    it "should be able to turn a DD/MM/YYYY string into a YYYYMMDD one" do
+      @instance.coop_date_to_time('03/02/2009').should == Time.utc('2009', '2', '3')
+    end
+  end
+end

data/spec/coop_scraper/credit_card_spec.rb

@@ -0,0 +1,229 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CoopScraper::CreditCard do
+  def fixture_path(fixture_file_name)
+    full_fixture_path('credit_card', fixture_file_name)
+  end
+  
+  describe "parsing the html components" do
+    def fixture_doc(fixture_file_name = 'cc_statement_fixture.html')
+      open(fixture_path(fixture_file_name)) { |f| Hpricot(f) }
+    end
+    
+    def fixture_with_interest_line_doc
+      fixture_doc('statement_with_interest_line_fixture.html')
+    end
+    
+    def normal_transaction_fixture_doc
+      fixture_doc('normal_transaction_fixture.html')
+    end
+    
+    def payment_in_transaction_fixture_doc
+      fixture_doc('payment_in_transaction_fixture.html')
+    end
+    
+    def foreign_transaction_fixture_doc
+      fixture_doc('foreign_transaction_fixture.html')
+    end
+    
+    def interest_transaction_fixture_doc
+      fixture_doc('interest_transaction_fixture.html')
+    end
+    
+    it "should be able to extract the statement date" do
+      CoopScraper::CreditCard.extract_statement_date(fixture_doc).should == Time.utc('2009', '2', '3')
+    end
+    
+    it "should be able to extract the account (VISA card) number" do
+      CoopScraper::CreditCard.extract_account_number(fixture_doc).should == '1234123412341234'
+    end
+    
+    it "should be able to extract the statement balance" do
+      CoopScraper::CreditCard.extract_statement_balance(fixture_doc).should == '-123.21'
+    end
+    
+    it "should be able to extract the available credit" do
+      CoopScraper::CreditCard.extract_available_credit(fixture_doc).should == '1000.00'
+    end
+    
+    describe "extracting transactions" do
+      it "should find the correct number of transactions" do
+        mock_statement = mock('OFX::Statement')
+        mock_statement.stubs(:date).returns(Time.utc('2009', '2', '3'))
+        CoopScraper::CreditCard.extract_transactions(fixture_doc, mock_statement).size.should == 57
+      end
+      
+      it "should create OFX::Statement::Transaction objects for the transactions" do
+        mock_statement = mock('OFX::Statement')
+        mock_statement.stubs(:date).returns(Time.utc('2009', '2', '3'))
+        CoopScraper::CreditCard.extract_transactions(fixture_doc, mock_statement).first.
+          should be_instance_of(OFX::Statement::Transaction)
+      end
+      
+      describe "processing a normal transaction" do
+        before(:all) do
+          mock_statement = mock('OFX::Statement')
+          mock_statement.stubs(:date).returns(Time.utc('2009', '2', '3'))
+          transactions = CoopScraper::CreditCard.extract_transactions(normal_transaction_fixture_doc, mock_statement)
+          transactions.size.should == 1
+          @transaction = transactions.first
+        end
+        
+        it "should pull out the date" do
+          @transaction.date.should == Time.utc('2009', '1', '6')
+        end
+        
+        it "should pull out the amount" do
+          @transaction.amount.should == '-23.00'
+        end
+        
+        it "should pull out the details" do
+          @transaction.name.should == 'SOME TRANSACTION HERE'
+        end
+      end
+      
+      describe "processing a transaction where money was put in" do
+        before(:all) do
+          mock_statement = mock('OFX::Statement')
+          mock_statement.stubs(:date).returns(Time.utc('2009', '2', '3'))
+          transactions = CoopScraper::CreditCard.extract_transactions(payment_in_transaction_fixture_doc, mock_statement)
+          transactions.size.should == 1
+          @transaction = transactions.first
+        end
+        
+        it "should pull out the date" do
+          @transaction.date.should == Time.utc('2009', '1', '23')
+        end
+        
+        it "should pull out the amount" do
+          @transaction.amount.should == '500.00'
+        end
+        
+        it "should pull out the details" do
+          @transaction.name.should == 'PAYMENT -             THANK YOU     GB'
+        end
+      end
+      
+      describe "processing a transaction with an additional row for currency conversion" do
+        before(:all) do
+          mock_statement = mock('OFX::Statement')
+          mock_statement.stubs(:date).returns(Time.utc('2009', '2', '3'))
+          transactions = CoopScraper::CreditCard.extract_transactions(foreign_transaction_fixture_doc, mock_statement)
+          transactions.size.should == 1
+          @transaction = transactions.first
+        end
+        
+        it "should pull out the date" do
+          @transaction.date.should == Time.utc('2009', '1', '8')
+        end
+        
+        it "should pull out the amount" do
+          @transaction.amount.should == '-27.13'
+        end
+        
+        it "should pull out the details" do
+          @transaction.name.should == 'TUFFMAIL              123-1234567'
+        end
+        
+        it "should pull out the conversion details" do
+          @transaction.memo.should == '##0000        40.00 USD @       1.4744'
+        end
+      end
+      
+      it "should ignore estimated interest lines" do
+        mock_statement = mock('OFX::Statement')
+        mock_statement.stubs(:date).returns(Time.utc('2009', '2', '3'))
+        transactions = CoopScraper::CreditCard.extract_transactions(fixture_with_interest_line_doc, mock_statement)
+        transactions.size.should == 1
+        transactions.first.should_not have_memo
+      end
+      
+      describe "processing an overlimit charge line" do
+        before(:all) do
+          mock_statement = mock('OFX::Statement')
+          mock_statement.stubs(:date).returns(Time.utc('2009', '2', '3'))
+          transactions = CoopScraper::CreditCard.extract_transactions(fixture_doc('overlimit_charge_fixture.html'), mock_statement)
+          transactions.size.should == 2
+          @transaction = transactions.last
+        end
+        
+        it "should be the overlimit charge" do
+          @transaction.name.should == 'OVERLIMIT CHARGE'
+        end
+        
+        it "should pick up the statement date" do
+          @transaction.date.should == Time.utc('2009', '2', '3')
+        end
+        
+        it "should have the right trntype" do
+          @transaction.trntype.should == :service_charge
+        end
+      end
+      
+      describe "processing a transaction for credit card interest" do
+        before(:all) do
+          mock_statement = mock('OFX::Statement')
+          mock_statement.stubs(:date).returns(Time.utc('2009', '2', '3'))
+          transactions = CoopScraper::CreditCard.extract_transactions(interest_transaction_fixture_doc, mock_statement)
+          transactions.size.should == 1
+          @transaction = transactions.first
+        end
+        
+        it "should pull out the date" do
+          @transaction.date.should == Time.utc('2009', '5', '5')
+        end
+        
+        it "should pull out the amount" do
+          @transaction.amount.should == '-40.58'
+        end
+        
+        it "should pull out the details" do
+          @transaction.name.should == 'MERCHANDISE INTEREST AT 1.667% PER MTH'
+        end
+        
+        it "should have the right trntype" do
+          @transaction.trntype.should == :interest
+        end
+      end
+    end
+  end
+  
+  describe "creating the statement object" do
+    before(:each) do
+      fixture = open(fixture_path('cc_statement_fixture.html'))
+      @statement = CoopScraper::CreditCard.generate_statement(fixture, Time.utc('2009', '3', '6'))
+    end
+    
+    it "should have the right server response time" do
+      @statement.server_response_time.should == Time.utc('2009', '3', '6')
+    end
+    
+    it "should the correct statement date" do
+      @statement.date.should == Time.utc('2009', '2', '3')
+    end
+    
+    it "should have the correct account number" do
+      @statement.account_number.should == "1234123412341234"
+    end
+    
+    it "should have the correct statement start date" do
+      @statement.start_date.should == Time.utc('2009', '1', '5')
+    end
+    
+    it "should have the correct statement end date" do
+      @statement.end_date.should == Time.utc('2009', '2', '3')
+    end
+    
+    it "should have the correct balance" do
+      @statement.ledger_balance.should == "-123.21"
+    end
+    
+    it "should have the correct amount of available credit" do
+      @statement.available_credit.should == "1000.00"
+    end
+    
+    it "should have the right number of transactions" do
+      @statement.transactions.size.should == 57
+    end
+  end
+end

data/spec/coop_scraper/current_account_spec.rb

@@ -0,0 +1,154 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CoopScraper::CurrentAccount do
+  def fixture_path(fixture_file_name)
+    full_fixture_path('current_account', fixture_file_name)
+  end
+  
+  describe "parsing the html components" do
+    def fixture_doc(name = 'current_account_fixture.html')
+      open(fixture_path(name)) { |f| Hpricot(f) }
+    end
+    
+    def normal_transaction_fixture_doc
+      fixture_doc('normal_transaction_fixture.html')
+    end
+    
+    def payment_in_transaction_fixture_doc
+      fixture_doc('payment_in_transaction_fixture.html')
+    end
+    
+    def no_transactions_fixture_doc
+      fixture_doc('no_transactions_fixture.html')
+    end
+    
+    it "should be able to extract the statement date" do
+      CoopScraper::CurrentAccount.extract_statement_date(fixture_doc).should == Time.utc('2008', '10', '3')
+    end
+    
+    it "should be able to extract the account number" do
+      CoopScraper::CurrentAccount.extract_account_number(fixture_doc).should == "12341234"
+    end
+    
+    it "should be able to extract the sort code" do
+      CoopScraper::CurrentAccount.extract_sort_code(fixture_doc).should == "089273"
+    end
+    
+    describe "transactions" do
+      it "should find the correct number of transactions" do
+        CoopScraper::CurrentAccount.extract_transactions(fixture_doc).size.should == 7
+      end
+      
+      it "should create OFX::Statement::Transaction objects for the transactions" do
+        CoopScraper::CurrentAccount.extract_transactions(fixture_doc).first.should be_instance_of(OFX::Statement::Transaction)
+      end
+      
+      describe "processing a normal transaction" do
+        before(:all) do
+          transactions = CoopScraper::CurrentAccount.extract_transactions(normal_transaction_fixture_doc)
+          transactions.size.should == 1
+          @transaction = transactions.first
+        end
+        
+        it "should pull out the date" do
+          @transaction.date.should == Time.utc('2008', '9', '29')
+        end
+        
+        it "should pull out the amount" do
+          @transaction.amount.should == '-20.00'
+        end
+        
+        it "should pull out the details" do
+          @transaction.name.should == 'LINK    10:51SEP28'
+        end
+      end
+      
+      describe "processing a transaction where money was put in" do
+        before(:all) do
+          transactions = CoopScraper::CurrentAccount.extract_transactions(payment_in_transaction_fixture_doc)
+          transactions.size.should == 1
+          @transaction = transactions.first
+        end
+        
+        it "should pull out the date" do
+          @transaction.date.should == Time.utc('2008', '10', '3')
+        end
+        
+        it "should pull out the amount" do
+          @transaction.amount.should == '200.00'
+        end
+        
+        it "should pull out the details" do
+          @transaction.name.should == 'SOME MONEY'
+        end
+      end
+      
+      describe "processing a statement where no transactions occurred" do
+        before(:each) do
+          @transactions = CoopScraper::CurrentAccount.extract_transactions(no_transactions_fixture_doc)
+        end
+        
+        it "should not find any transactions" do
+          @transactions.should be_empty
+        end
+      end
+      
+      describe "processing transactions with non-default transaction types" do
+        it "should be able to pull out a debit interest transaction" do
+          transactions = CoopScraper::CurrentAccount.
+            extract_transactions(fixture_doc('debit_interest_transaction_fixture.html'))
+          
+          transactions.first.trntype.should == :interest
+        end
+        
+        it "should be able to pull out a service charge transaction" do
+          transactions = CoopScraper::CurrentAccount.
+            extract_transactions(fixture_doc('service_charge_transaction_fixture.html'))
+          
+          transactions.first.trntype.should == :service_charge
+        end
+        
+        it "should be able to pull out a transfer transaction" do
+          transactions = CoopScraper::CurrentAccount.
+            extract_transactions(fixture_doc('transfer_transaction_fixture.html'))
+          
+          transactions.first.trntype.should == :transfer
+        end
+        
+        it "should be able to pull out a cash point transaction" do
+          transactions = CoopScraper::CurrentAccount.
+            extract_transactions(fixture_doc('cash_point_transaction_fixture.html'))
+          
+          transactions.first.trntype.should == :atm
+        end
+      end
+    end
+    
+    it "should be able to extract the closing balance" do
+      CoopScraper::CurrentAccount.extract_closing_balance(fixture_doc).should == "219.92"
+    end
+    
+    it "should be able to extract the statement start date" do
+      CoopScraper::CurrentAccount.extract_statement_start_date(fixture_doc).should == Time.utc('2008', '9', '29')
+    end
+    
+    describe "generating the statement" do
+      it "should create a statement object okay" do
+        fixture = open(fixture_path('current_account_fixture.html'))
+        mock_statement = mock('Statement')
+        OFX::Statement::CurrentAccount.expects(:new).returns(mock_statement)
+        
+        mock_statement.expects(:server_response_time=).with(Time.utc('2009', '3', '6'))
+        mock_statement.expects(:date=).with(Time.utc('2008', '10', '3'))
+        mock_statement.expects(:sort_code=).with('089273')
+        mock_statement.expects(:account_number=).with('12341234')
+        mock_statement.expects(:start_date=).with(Time.utc('2008', '9', '29'))
+        mock_statement.expects(:end_date=).with(Time.utc('2008', '10', '3'))
+        mock_statement.expects(:ledger_balance=).with("219.92")
+        mock_statement.expects(:<<).at_least_once.with { |arg| arg.respond_to?(:amount) }
+        
+        CoopScraper::CurrentAccount.generate_statement(fixture, Time.utc('2009', '3', '6'))
+      end
+    end
+  end
+end