egg2ofx 0.1.1

data/README

@@ -0,0 +1 @@
+This appears to be in a bit of a mess.  I seem to remember starting with the egg.html -> egg.ofx conversion and then wanting to do the same with ing-direct.  I'm not sure how much of it works anymore.

data/Rakefile

@@ -0,0 +1,118 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+task :default => :test
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+  
+  # Change these as appropriate
+  s.name              = "egg2ofx"
+  s.version           = "0.1.1"
+  s.summary           = "Converts the html statements and recent transactions from the egg site to ofx"
+  s.author            = "Chris Roos"
+  s.email             = "chris@seagul.co.uk"
+  s.homepage          = "http://chrisroos.co.uk"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README)
+  s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(Rakefile README) + Dir.glob("{bin,test,lib}/**/*")
+  s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
+   
+  s.require_paths     = ["lib"]
+  
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+  s.add_dependency 'hpricot'
+  
+  # If your tests use any gems, include them here
+  # s.add_development_dependency("mocha")
+  s.add_development_dependency 'mocha'
+
+  # If you want to publish automatically to rubyforge, you'll may need
+  # to tweak this, and the publishing task below too.
+  s.rubyforge_project = "egg2ofx"
+end
+
+# This task actually builds the gem. We also regenerate a static 
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+  
+  # Generate the gemspec file for github.
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end
+
+# If you want to publish to RubyForge automatically, here's a simple 
+# task to help do that. If you don't, just get rid of this.
+# Be sure to set up your Rubyforge account details with the Rubyforge
+# gem; you'll need to run `rubyforge setup` and `rubyforge config` at
+# the very least.
+begin
+  require "rake/contrib/sshpublisher"
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+    
+    namespace :release do
+      desc "Release a new version of this gem"
+      task :gem => [:package] do
+        require 'rubyforge'
+        rubyforge = RubyForge.new
+        rubyforge.configure
+        rubyforge.login
+        rubyforge.userconfig['release_notes'] = spec.summary
+        path_to_gem = File.join(File.dirname(__FILE__), "pkg", "#{spec.name}-#{spec.version}.gem")
+        puts "Publishing #{spec.name}-#{spec.version.to_s} to Rubyforge..."
+        rubyforge.add_release(spec.rubyforge_project, spec.name, spec.version.to_s, path_to_gem)
+      end
+    
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+ 
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/egg2ofx/" # Should be the same as the rubyforge project name
+        local_dir = 'rdoc'
+ 
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/bin/egg2ofx

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'egg')
+
+html_file = ARGV.shift
+unless html_file and File.exists?(html_file)
+  raise "Usage: egg2ofx path/to/egg-html-file"
+end
+
+html   = File.open(html_file) { |f| f.read }
+parser = Egg::Parser.new(html)
+
+puts parser.to_ofx

data/lib/egg/account.rb

@@ -0,0 +1,8 @@
+module Egg
+  class Account
+    def initialize(currency, number)
+      @currency, @number = currency, number
+    end
+    attr_reader :currency, :number
+  end
+end

data/lib/egg/date.rb

@@ -0,0 +1,10 @@
+require 'date'
+
+module Egg
+  class Date
+    def self.build(date)
+      return nil if date == ''
+      ::Date.parse(date).strftime('%Y%m%d')
+    end
+  end
+end

data/lib/egg/description.rb

@@ -0,0 +1,14 @@
+module Egg
+  class Description
+    attr_reader :payee, :note, :territory
+    def initialize(description)
+      if m = description.match(/(.{23}) (.{13}) (.{2})?/) # territory (last two chars) is not in recent transactions
+        @payee = m[1].strip.squeeze(' ')
+        @note = m[2].strip
+        @territory = m[3].strip if m[3]
+      else
+        @payee = description
+      end
+    end
+  end
+end

data/lib/egg/money.rb

@@ -0,0 +1,13 @@
+module Egg
+  class Money
+    def initialize(money)
+      money = money.sub(/£/, '').gsub(/,/, '')
+      md = money.match(/(\d+\.\d+) ([A-Z]+)/)
+      @money = md ? Float(md[1]) : 0
+      @money = -@money if md && md[2] == 'DR'
+    end
+    def to_f
+      @money
+    end
+  end
+end

data/lib/egg/parser.rb

@@ -0,0 +1,32 @@
+$: << File.dirname(__FILE__)
+
+require 'parsers/document_parser'
+require 'parsers/transaction_parser'
+require 'parsers/statement_document_parser'
+require 'parsers/statement_transaction_parser'
+require 'parsers/recent_transactions_document_parser'
+require 'parsers/recent_transactions_transaction_parser'
+
+module Egg
+  
+  class Parser
+    
+    class UnparsableHtmlError < StandardError; end
+    
+    def initialize(html)
+      if html =~ /your egg card statement/i
+        @parser = StatementDocumentParser.new(html)
+      elsif html =~ /egg card recent transactions/i
+        @parser = RecentTransactionsDocumentParser.new(html)
+      else
+        raise UnparsableHtmlError
+      end
+    end
+    
+    def to_ofx
+      @parser.to_ofx
+    end
+    
+  end
+  
+end

data/lib/egg/parsers/document_parser.rb

@@ -0,0 +1,42 @@
+module Egg
+  
+  class DocumentParser
+    
+    attr_reader :doc
+    
+    def initialize(html)
+      @doc = Hpricot(html)
+    end
+    
+    def to_ofx
+      account   = Egg::Account.new('GBP', card_number)
+      statement = Egg::Statement.new(statement_date, closing_balance, account)
+      
+      each_transaction do |transaction_row|
+        next if transaction_row.skip?
+        transaction = Egg::Transaction.new(transaction_row.date, transaction_row.description, transaction_row.money)
+        statement.add_transaction(transaction)
+      end
+
+      Ofx::Statement.new(statement).to_xml
+    end
+    
+  private
+  
+    def each_transaction
+      (doc/"table#tblTransactionsTable"/"tbody"/"tr").each do |row|
+        yield transaction_parser_class.new(row)
+      end
+    end
+    
+    def card_number
+      (doc/"span#lblCardNumber").inner_html
+    end
+    
+    def closing_balance
+      ((doc/"table#tblTransactionsTable"/"tfoot"/"tr").first/"td").inner_html
+    end
+    
+  end
+  
+end

data/lib/egg/parsers/recent_transactions_document_parser.rb

@@ -0,0 +1,19 @@
+module Egg
+  
+  class RecentTransactionsDocumentParser < DocumentParser
+
+  private
+  
+    def transaction_parser_class
+      RecentTransactionsTransactionParser
+    end
+    
+    def statement_date
+      first_transaction_date = (doc/'#tblTransactionsTable'/'tbody'/'tr'/'td.date').first.inner_text
+      last_transaction_date = (doc/'#tblTransactionsTable'/'tbody'/'tr'/'td.date').last.inner_text
+      "#{first_transaction_date} to #{last_transaction_date}"
+    end
+
+  end
+  
+end

data/lib/egg/parsers/recent_transactions_transaction_parser.rb

@@ -0,0 +1,12 @@
+module Egg
+  
+  class RecentTransactionsTransactionParser < TransactionParser
+    
+    def money
+      money = super
+      money =~ /^\-/ ? money + ' CR' : money + ' DR'
+    end
+    
+  end
+  
+end

data/lib/egg/parsers/statement_document_parser.rb

@@ -0,0 +1,17 @@
+module Egg
+  
+  class StatementDocumentParser < DocumentParser
+  
+  private
+  
+    def transaction_parser_class
+      StatementTransactionParser
+    end
+    
+    def statement_date
+      (doc/'#ctl00_content_eggCardStatements_lstPreviousStatements'/'option[@selected=selected]').first.attributes['value']
+    end
+    
+  end
+  
+end

data/lib/egg/parsers/statement_transaction_parser.rb

@@ -0,0 +1,19 @@
+module Egg
+  
+  class StatementTransactionParser < TransactionParser
+  
+    def description
+      description = super
+      if row.next_sibling && (row.next_sibling/"td.date").inner_text == '' && (row.next_sibling/"td.description").inner_text != ''
+        description += ' / ' + (row.next_sibling/"td.description").inner_text
+      end
+      description
+    end
+  
+    def skip?
+      date == '' or description == 'OPENING BALANCE'
+    end
+  
+  end
+  
+end

data/lib/egg/parsers/transaction_parser.rb

@@ -0,0 +1,29 @@
+module Egg
+  
+  class TransactionParser
+  
+    attr_reader :row
+  
+    def initialize(row)
+      @row = row
+    end
+  
+    def skip?
+      false
+    end
+    
+    def money
+      (row/"td.money").inner_text.sub(/^\?/, '').sub(/^£/, '')
+    end
+  
+    def date
+      (row/"td.date").inner_text
+    end
+  
+    def description
+      (row/"td.description").inner_text
+    end
+  
+  end
+  
+end

data/lib/egg/statement.rb

@@ -0,0 +1,24 @@
+module Egg
+  class Statement
+    def initialize(statement_date, closing_balance, account)
+      from_date, to_date = statement_date.split(' to ')
+      @from_date = Date.build(from_date)
+      @to_date = Date.build(to_date)
+      @closing_balance = Money.new(closing_balance).to_f
+      @account = account
+      @transactions = []
+    end
+    attr_reader :from_date, :to_date, :closing_balance, :transactions
+    def add_transaction(transaction)
+      transaction.date = from_date unless transaction.date
+      @transactions << transaction
+    end
+    def method_missing(sym, *args, &blk)
+      if account_method = sym.to_s[/^account_(.+)/, 1]
+        @account.__send__(account_method, *args, &blk)
+      else
+        super(sym, *args, &blk)
+      end
+    end
+  end
+end

data/lib/egg/transaction.rb

@@ -0,0 +1,33 @@
+require 'digest/md5'
+
+module Egg
+  class Transaction
+    def initialize(date, description, money)
+      @date = Date.build(date)
+      @raw_description = description
+      @description = Description.new(description)
+      @amount = Money.new(money).to_f
+      @ofx_id = nil
+    end
+    attr_reader :date, :amount
+    def payee
+      @description.payee
+    end
+    def note
+      @description.note
+    end
+    def ofx_id
+      @ofx_id ||= Digest::MD5.hexdigest(to_s)
+    end
+    def to_s
+      [date, @raw_description, amount].join(', ')
+    end
+    def type
+      if payee =~ /INTEREST/
+        'INT'
+      else
+        (amount < 0) ? 'DEBIT' : 'CREDIT'
+      end
+    end
+  end
+end

data/lib/egg.rb

@@ -0,0 +1,15 @@
+$: << File.dirname(__FILE__)
+
+require 'hpricot'
+
+require 'egg/date'
+
+require 'egg/statement'
+require 'egg/account'
+require 'egg/transaction'
+require 'egg/money'
+require 'egg/description'
+
+require 'egg/parser'
+
+require 'ofx'

data/lib/ofx.rb

@@ -0,0 +1,49 @@
+require 'builder'
+
+module Ofx
+  class Statement
+    def initialize(statement)
+      @statement = statement
+      @xml = nil
+    end
+    def to_xml
+      @xml ||= (
+        buffer = ''
+        builder = Builder::XmlMarkup.new(:target => buffer, :indent => 2)
+        builder.instruct!
+        builder << "<?OFX OFXHEADER=\"200\" VERSION=\"200\" SECURITY=\"NONE\" OLDFILEUID=\"NONE\" NEWFILEUID=\"NONE\"?>\n"
+        builder.OFX do
+          builder.CREDITCARDMSGSRSV1 do
+            builder.CCSTMTTRNRS do
+              builder.CCSTMTRS do
+                builder.CURDEF @statement.account_currency
+                builder.CCACCTFROM do
+                  builder.ACCTID @statement.account_number
+                end
+                builder.BANKTRANLIST do
+                  builder.DTSTART @statement.from_date
+                  builder.DTEND @statement.to_date
+                  @statement.transactions.each do |transaction|
+                    builder.STMTTRN do
+                      builder.TRNTYPE transaction.type
+                      builder.DTPOSTED transaction.date
+                      builder.NAME transaction.payee
+                      builder.MEMO transaction.note
+                      builder.TRNAMT transaction.amount
+                      builder.FITID transaction.ofx_id
+                    end
+                  end
+                end
+                builder.LEDGERBAL do
+                  builder.BALAMT @statement.closing_balance
+                  builder.DTASOF @statement.to_date
+                end
+              end
+            end
+          end
+        end
+        buffer
+      )
+    end
+  end
+end