nordea-rb 0.2.1 → 0.3.0

data/README.markdown

@@ -114,6 +114,7 @@ Transfer money between your own accounts:
       salary_account.deposit(10.0, 'SEK', :withdraw_from => savings)
     end
 
+There are more, real world examples in the examples folder.
 
 ## Command Line Tool
 

data/Rakefile

@@ -18,6 +18,7 @@ begin
     gemspec.email = "name@my-domain.se"
     gemspec.homepage = "http://github.com/haraldmartin/nordea-rb"
     gemspec.authors = ["Martin Ström"]
+    gemspec.add_dependency 'hpricot'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/examples/atom_feed/.htaccess

@@ -0,0 +1,9 @@
+AddHandler cgi-script .cgi
+
+RewriteEngine on
+ 
+# foo.atom -> foo.cgi
+RewriteRule ^(.+)\.atom$  $1.cgi
+ 
+# Give Apache CGI access to HTTP auth, http://www.besthostratings.com/articles/http-auth-php-cgi.html
+RewriteRule .*            -       [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

data/examples/atom_feed/nordea.cgi

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+# Based on/stolen from http://github.com/henrik/atomica -- Thanks!
+
+require 'rubygems'
+require 'nordea'
+require('builder') rescue require('active_support') # gem install builder
+
+class NordeAtom
+  NAME        = "NordeAtom"
+  VERSION     = "1.0"
+  SCHEMA_DATE = "2009-11-02"
+  
+  def initialize(pnr, pin)
+    @pnr, @pin = pnr, pin
+  end
+  
+  def render
+    atomize(fetch)
+  end
+  
+protected
+  
+  def fetch
+    transactions = nil
+    Nordea.new(@pnr, @pin) do |n|
+      transactions = n.accounts.map(&:transactions).flatten.sort_by(&:date).reverse
+    end
+    transactions
+  end
+  
+  def atomize(items)
+    updated_at = (Time.parse(items.first.date.to_s) || Time.now).iso8601
+
+    xml = Builder::XmlMarkup.new(:indent => 2, :target => $stdout)
+    xml.instruct! :xml, :version => "1.0" 
+
+    xml.feed(:xmlns => "http://www.w3.org/2005/Atom") do |feed|
+      feed.title     "Kontohistorik för #{@pnr}"
+      feed.id        "tag:nordea,#{SCHEMA_DATE}:#{@pnr}"
+      feed.link      :href => 'http://www.nordea.se'
+      feed.updated   updated_at
+      feed.author    { |a| a.name 'Nordea' }
+      feed.generator NAME, :version => VERSION
+
+      items.each do |item|
+        item_time = Time.parse(item.date.to_s)
+        item_date = [%w[Sön Mån Tis Ons Tors Fre Lör][item_time.wday], item_time.strftime('%Y-%m-%d')].join(' ')
+        style = item.withdrawal? ? 'color: red' : 'color: green'
+
+        feed.entry do |entry|
+          entry.id      "tag:nordea,#{SCHEMA_DATE}:#{@pnr}/#{item.account.index};" + 
+                        "#{item_time.strftime('%Y-%m-%d')};#{item.text.gsub(/\W/, '')};" + 
+          amount = %Q{%.2f SEK} % item.amount
+          entry.title   "#{item.text} #{amount}"
+                        "#{item.amount};#{}".gsub(/\s+/, '')
+          entry.content %{<table>
+                            <tr><th>Konto:</th>  <td>#{item.account.name}</td></tr>
+                            <tr><th>Datum:</th>  <td>#{item_date}</td></tr>
+                            <tr><th>Belopp:</th> <td style="#{style}">#{item.amount}</td></tr>
+                          </table>}, :type => 'html'
+          entry.updated item_time.iso8601
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+
+  # HTTP Basic auth based on code from http://blogs.23.nu/c0re/2005/04/antville-7409/
+  require 'base64'
+ 
+  auth = ENV.has_key?('HTTP_AUTHORIZATION') && ENV['HTTP_AUTHORIZATION'].to_s.split
+  if auth && auth[0] == 'Basic'
+    pnr, pwd = Base64.decode64(auth[1]).split(':')[0..1]
+    puts "Content-Type: application/atom+xml"
+    puts 
+    NordeAtom.new(pnr, pwd).render
+  else
+    puts "Status: 401 Authorization Required"
+    puts %{WWW-Authenticate: Basic realm="#{NordeAtom::NAME} pnr/PIN"}
+    puts "Content-Type: text/plain"
+    puts
+    puts "Please provide personnummer and PIN as HTTP auth username/password."
+  end
+end

data/examples/transfer-to-salary

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# This script will take an amount as argument (or default to 3000 SEK)
+# and transfer that amount from the salary to the payments account.
+
+require 'rubygems'
+require 'nordea'
+
+amount = (ARGV.first || 3000).to_f
+
+Nordea.new(:keychain) do |n|
+  main, payments = n.accounts[/Salary/], n.accounts[/payments/i]
+  puts "Current balance:", main, payments
+  puts
+  print "Transfer #{amount} SEK to payments account? (yes/no) "
+  
+  if STDIN.gets.chop =~ /^y/i
+    print "\nTransferring..."
+    main.withdraw(amount, 'SEK', :deposit_to => payments)
+    puts "Done"
+    puts
+    puts "Current balance:", main, payments
+  end
+end

data/lib/nordea/resources/account.rb

@@ -3,7 +3,8 @@ module Nordea
     def initialize(fields = {}, command_params = {}, session = nil)
       @name, @balance, @currency, @index = fields[:name], fields[:balance], fields[:currency], fields[:index]
       @command_params = command_params
-      @session = session
+      @session = session if session
+      yield self if block_given?
     end
     
     attr_accessor :name, :balance, :currency, :index, :session
@@ -14,13 +15,21 @@ module Nordea
       @command_params
     end
     
-    # TODO move shared transaction fetching to Nordea::Resource and call super
     def transactions(reload = false)
       @transactions = nil if reload
       @transactions ||= begin
-        doc = session.request(Commands::TRANSACTIONS, to_command_params).parse_xml
-        doc.search('go[@href="#trans"]').inject([]) do |all, node|
-          all << Transaction.new_from_xml(node)
+        # for some reason it needs this otherwise it would use the old transaction list
+        session.request(Nordea::Commands::RESOURCE)
+
+        nodes = session.request(Commands::TRANSACTIONS, to_command_params).parse_xml.search('go[@href="#trans"]')
+        idx = nodes.length
+        
+        nodes.inject([]) do |all, node|
+          trans = Transaction.new_from_xml(node, self)
+          # since transactions don't have a time (just date) but are listed in chronological order
+          # we add one second to each item in the collection so they can be sorted by date
+          trans.date = Time.parse(trans.date.to_s) + (idx -= 1)
+          all << trans
         end
       end
     end
@@ -33,10 +42,15 @@ module Nordea
       %Q{%.#{decimals}f} % balance
     end
 
-    def self.new_from_xml(xml_node, session)
+    def reload
+      @transactions = nil
+      session.accounts(true)
+    end
+
+    def reload_from_xml(xml_node)
       xml_node = Hpricot(xml_node) unless xml_node.class.to_s =~ /^Hpricot::/
       xml_node = xml_node.at("anchor") unless xml_node.name == 'anchor'
-      new _setup_fields(xml_node), _setup_command_params(xml_node), session
+      initialize(self.class._setup_fields(xml_node), self.class._setup_command_params(xml_node))
     end
     
     def withdraw(amount, currency = 'SEK', options = {})
@@ -68,7 +82,7 @@ module Nordea
         :to_currency_code          => currency
       })
 
-      session.accounts(true)
+      reload
     end
 
     def deposit(amount, currency = 'SEK', options = {})
@@ -80,8 +94,12 @@ module Nordea
       from.withdraw(amount, currency, options.merge(:deposit_to => self))
     end
 
+    def self.new_from_xml(xml_node, session)
+      new({}, {}, session) { |acc| acc.reload_from_xml(xml_node) }
+    end
+
     private
-    
+      
       def self._setup_fields(xml_node)
         name     = xml_node.at("postfield[@name='account_name']")['value']
         currency = xml_node.at("postfield[@name='account_currency_code']")['value']
@@ -99,4 +117,4 @@ module Nordea
         end
       end
   end
-end
+end

data/lib/nordea/session.rb

@@ -45,19 +45,30 @@ module Nordea
     end
     
     def accounts(reload = false)
-      @accounts = nil if reload
-      @accounts ||= setup_resources(Account)
+      if reload && @accounts
+        reloaded_xml_nodes = reload_resources(Account)
+        @accounts.each_with_index { |account, idx| account.reload_from_xml(reloaded_xml_nodes[idx]) }
+      else
+        @accounts ||= setup_resources(Account)
+      end
     end
     
     private
     
-      def setup_resources(klass)
+      def fetch_resources(klass)
         type = klass.new.account_type_name
         doc = request(Commands::RESOURCE, "account_type_name" => type).parse_xml
-        (doc/"go postfield[@name='OBJECT'][@value='#{Commands::TRANSACTIONS}']").
-          inject(ResourceCollection.new) do |all, field| 
-            all << klass.new_from_xml(field.parent.parent, self)
-          end
+        (doc/"go postfield[@name='OBJECT'][@value='#{Commands::TRANSACTIONS}']")
+      end
+
+      def reload_resources(klass)
+        fetch_resources(klass).map { |field| field.parent.parent }
+      end
+
+      def setup_resources(klass)
+        fetch_resources(klass).inject(ResourceCollection.new) do |all, field| 
+          all << klass.new_from_xml(field.parent.parent, self)
+        end
       end
   end
 end

data/lib/nordea/transaction.rb

@@ -2,11 +2,11 @@ require 'date'
 
 module Nordea  
   class Transaction
-    def initialize(date, amount, text)
-      @date, @amount, @text = date, amount, text
+    def initialize(date, amount, text, account = nil)
+      @date, @amount, @text, @account = date, amount, text, account
     end
     
-    attr_accessor :date, :amount, :text
+    attr_accessor :date, :amount, :text, :account
     
     def withdrawal?
       amount < 0
@@ -16,12 +16,12 @@ module Nordea
       amount > 0
     end
     
-    def self.new_from_xml(xml)
+    def self.new_from_xml(xml, account = nil)
       node   = xml.is_a?(String) ? Hpricot.XML(xml) : xml
       date   = Date.parse(node.at("setvar[@name='date']")['value'])
       amount = Support.dirty_currency_string_to_f(node.at("setvar[@name='amount']")['value'])
       text   = node.at("setvar[@name='text']")['value']
-      new date, amount, text
+      new(date, amount, text, account)
     end
   end
 end

data/lib/nordea/version.rb

@@ -1,8 +1,8 @@
 module Nordea
   module Version
     MAJOR  = 0
-    MINOR  = 2
-    TINY   = 1
+    MINOR  = 3
+    TINY   = 0
 
     STRING = [MAJOR, MINOR, TINY].join(".")
   end

data/lib/nordea.rb

@@ -40,30 +40,39 @@ module Nordea
   
   private
   
-    # TODO clean up
     def self.extract_login_details(pnr_or_hash, pin_or_options)
       if pnr_or_hash.is_a?(Hash)
-        pnr_or_hash.symbolize_keys!
-        pnr = pnr_or_hash[:pnr]
-        pin = pnr_or_hash[:pin]
+        pnr, pin = _login_details_from_hash(pnr_or_hash)
       elsif pnr_or_hash.is_a?(Symbol)
-        if pnr_or_hash == :keychain
-          options = { :label => 'Nordea' }.merge(pin_or_options.symbolize_keys)
-          pnr, pin = account_details_from_keychain(options)
-        end
+        pnr, pin = _login_details_from_symbol(pnr_or_hash, pin_or_options)
       elsif pnr_or_hash.is_a?(String) && pin_or_options.is_a?(String)
-        pnr = pnr_or_hash
-        pin = pin_or_options
+        pnr, pin = pnr_or_hash, pin_or_options
       else
         raise ArgumentError
       end
       [pnr.to_s.gsub(/\D+/, ''), pin.to_s.gsub(/\D+/, '')]
     end
-  
-    def Nordea.account_details_from_keychain(options)
+
+    def Nordea._login_details_from_hash(pnr_or_hash)
+      pnr_or_hash.symbolize_keys!
+      [pnr_or_hash[:pnr], pnr_or_hash[:pin]]
+    end
+    
+    def Nordea._login_details_from_symbol(symbol, options)
+      if symbol == :keychain
+        _account_details_from_keychain({ :label => 'Nordea' }.merge(options.symbolize_keys))
+      else
+        raise ArgumentError
+      end
+    end
+    
+    def Nordea._account_details_from_keychain(options)
       command = "security find-generic-password -l '#{options[:label]}' -g"
       command << " #{options[:keychain_file].inspect}" if options[:keychain_file]
       command << " 2>&1"
-      `#{command}`.scan(/password: "(\d{4})"|"acct"<blob>="(\d{10})"/).flatten.compact.reverse
+      output = `#{command}`
+      pnr = output.match(/"acct"<blob>="(\d{10})"/)[1]
+      pin = output.match(/password: "(\d{4})"/)[1]
+      [pnr, pin]
     end
 end

data/nordea-rb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{nordea-rb}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Str\303\266m"]
-  s.date = %q{2009-10-24}
+  s.date = %q{2009-11-10}
   s.default_executable = %q{nordea}
   s.description = %q{Ruby library for accessing your Nordea Bank account and transferring money between your own accounts.}
   s.email = %q{name@my-domain.se}
@@ -25,6 +25,9 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "bin/nordea",
+     "examples/atom_feed/.htaccess",
+     "examples/atom_feed/nordea.cgi",
+     "examples/transfer-to-salary",
      "lib/nordea.rb",
      "lib/nordea/request.rb",
      "lib/nordea/resources.rb",
@@ -80,9 +83,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
     else
+      s.add_dependency(%q<hpricot>, [">= 0"])
     end
   else
+    s.add_dependency(%q<hpricot>, [">= 0"])
   end
 end
 

data/test/test_account.rb

@@ -6,6 +6,7 @@ class TestAccount < Test::Unit::TestCase
       @session = Nordea::Session.new('foo', 'bar')
       @account = Nordea::Account.new(:name => "savings account", :balance => 1234.50, :currency => 'EUR', :index => '2')
       @account.session = @session
+      @session.stubs(:request)
     end
   
     context "each Account instance" do
@@ -20,8 +21,14 @@ class TestAccount < Test::Unit::TestCase
       should "request the transactions from the server" do
         response = mock(:parse_xml => Hpricot.XML(fixture_content('account')))
         @session.expects(:request).with('KF11TW', {}).returns(response)
+        @session.expects(:request).with('KF00TW') # it needs this command to reset the transaction list
         @account.transactions
       end
+      
+      should "reload the account object from session" do
+        @session.expects(:accounts).with(true)
+        @account.reload
+      end
     end
     
     context "transfers" do
@@ -72,7 +79,7 @@ class TestAccount < Test::Unit::TestCase
         end
         
         should "reload the accounts" do
-          @session.expects(:accounts).with(true)
+          @account.expects(:reload)
           @savings.withdraw(6.5, "EUR", :deposit_to => @checking)
         end
       end
@@ -105,7 +112,11 @@ class TestAccount < Test::Unit::TestCase
       end
   
       should "set transaction's date" do
-        assert_equal "2009-08-16", @transactions.first.date.to_s
+        assert_equal "2009-08-16", @transactions.first.date.strftime("%Y-%m-%d")
+      end
+      
+      should "set each transaction's time increased in the same order as listed" do
+        assert_equal (0...20).to_a.reverse, @transactions.map { |t| t.date.sec }
       end
 
       should "set transaction's amount" do
@@ -115,6 +126,10 @@ class TestAccount < Test::Unit::TestCase
       should "set transaction's text" do
         assert_equal "Res. köp", @transactions.first.text
       end
+
+      should "set transaction's account" do
+        assert_equal @account, @transactions.first.account
+      end
     end
   
     context "creating a new Account object from XML" do
@@ -163,6 +178,12 @@ class TestAccount < Test::Unit::TestCase
       should "have an index" do
         assert_equal "1", @account.index
       end
+    
+      should "reload via xml" do
+        xml = @xml_node.sub('2.000,00', '1.234,00')
+        @account.reload_from_xml(xml)
+        assert_equal 1234.0, @account.balance
+      end
     end
   end
 end

data/test/test_functional.rb

@@ -18,13 +18,6 @@ class FunctionalTest < Test::Unit::TestCase
     end
     
     should "login and display the number of accounts" do
-      def assert_requests_made(session, num_requests = 1, msg = nil, &blk)
-        before = session.num_requests
-        yield
-        after = session.num_requests
-        assert_equal before + num_requests, after, msg
-      end
-      
       Nordea.new('1234567890', '0987') do |n|
         
         # logging in
@@ -39,7 +32,7 @@ class FunctionalTest < Test::Unit::TestCase
         assert_requests_made(n, 1, "reloading the accounts cache") { n.accounts(true) }
         
         # getting one of the account's transactions
-        assert_requests_made(n, 1) do
+        assert_requests_made(n, 2) do
           assert_equal 5, n.accounts.first.transactions.size # we use the same ficture so all accounts have 20 transactions
         end
         
@@ -48,12 +41,12 @@ class FunctionalTest < Test::Unit::TestCase
           assert_equal 5, n.accounts['Sparkonto'].transactions.size
         end
         
-        assert_requests_made(n, 1, "reload the cached transactions list") { 
+        assert_requests_made(n, 2, "reload the cached transactions list") { 
           n.accounts['Sparkonto'].transactions(true).size 
         }
         
         # ask for the other accounts's transactions
-        assert_requests_made(n, 2) do
+        assert_requests_made(n, 4) do
           assert_equal 10, n.accounts['Huvudkonto'].transactions.size
           assert_equal 20, n.accounts['Betalkonto'].transactions.size
         end

data/test/test_helper.rb

@@ -55,4 +55,15 @@ class Test::Unit::TestCase
       end
     end
   end
+
+  def assert_requests_made(session, num_requests = 1, msg = nil, &blk)
+    before = session.num_requests
+    yield
+    after = session.num_requests
+    assert_equal before + num_requests, after, msg
+  end
+  
+  def assert_no_requests_made(session, msg = nil, &blk)
+    assert_requests_made(session, 0, msg, &blk)
+  end
 end

data/test/test_nordea.rb

@@ -45,5 +45,39 @@ class TestNordea < Test::Unit::TestCase
     should "raise an error if there is no pin provided" do
       assert_raise(ArgumentError) { Nordea.new("1234567890") }
     end
+    
+    should "raise an error when using a symbol other than :keychain" do
+      assert_raise(ArgumentError) { Nordea.new(:foo) }
+    end
+
+    should "raise call the secutiry commando on OS X to retreive the password" do
+      #Nordea.expects(:`).returns(<<-EOF)
+      return_value = <<-EOF
+keychain: "/Users/me/Library/Keychains/login.keychain"
+class: "genp"
+attributes:
+    0x00000001 <blob>="Nordea"
+    0x00000002 <blob>=<NULL>
+    "acct"<blob>="1234567890"
+    "cdat"<timedate>=0x11111111111111111111111111111111  "111111111111111\000"
+    "crtr"<uint32>=<NULL>
+    "cusi"<sint32>=<NULL>
+    "desc"<blob>=<NULL>
+    "gena"<blob>=<NULL>
+    "icmt"<blob>=<NULL>
+    "invi"<sint32>=<NULL>
+    "mdat"<timedate>=0x22222222222222222222222222222222  "222222222222222\000"
+    "nega"<sint32>=<NULL>
+    "prot"<blob>=<NULL>
+    "scrp"<sint32>=<NULL>
+    "svce"<blob>="Nordea"
+    "type"<uint32>=<NULL>
+password: "1337"
+      EOF
+      
+      Nordea.expects(:`).with(anything).returns(return_value)
+
+      Nordea.new(:keychain)
+    end
   end
 end

data/test/test_session.rb

@@ -125,5 +125,34 @@ class TestSession < Test::Unit::TestCase
     should "find the account's name by pattern when using #[] with a regexp" do
       assert_equal @session.accounts[1], @session.accounts[/huvud/i]
     end
+
+    should "cache the account objects" do
+      @session.accounts
+      assert_no_requests_made(@session) do
+        @session.accounts
+        @session.accounts
+      end
+    end
+    
+    should "refetch the account objects when passing true as argument" do
+      @session.accounts
+      assert_requests_made(@session, 1) { @session.accounts(true) }
+    end
+    
+    should "not create new account objects when reloading" do
+      assert_equal @session.accounts, @session.accounts(true)
+    end
+    
+    should "setup the objects first time when passing reload flag" do
+      assert_requests_made(@session, 1) { @session.accounts(true) }
+      assert_equal 3, @session.accounts.length
+    end
+    
+    should "set new balance when reloading" do
+      @session.accounts # create the account objects
+      xml = Hpricot.XML(fixture_content('accounts').sub('179,05', '1234,56'))  
+      Nordea::Request.stubs(:new).returns(stub(:parse_xml => xml))
+      assert_equal 1234.56, @session.accounts(true)[/Betal/].balance
+    end
   end
 end

data/test/test_transaction.rb

@@ -11,6 +11,7 @@ class TestTransaction < Test::Unit::TestCase
 			</go>
 		</anchor>
     END
+    @account = stub("Account", :name => 'fake account')
     @transaction = Nordea::Transaction.new_from_xml(@xml_node)
   end
   
@@ -55,4 +56,15 @@ class TestTransaction < Test::Unit::TestCase
     assert t.deposit?
     assert !t.withdrawal?
   end
+  
+  should "allow to pass an account to the contstructor" do
+    t = Nordea::Transaction.new('2009-01-01', 10.00, 'Salery', @account)
+    assert_equal @account, t.account
+  end
+  
+  should "have a setter for the account property" do
+    t = Nordea::Transaction.new('2009-01-01', 10.00, 'Salery')
+    t.account = @account
+    assert_equal @account, t.account
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nordea-rb
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - "Martin Str\xC3\xB6m"
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-24 00:00:00 -04:00
+date: 2009-11-10 00:00:00 +01:00
 default_executable: nordea
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Ruby library for accessing your Nordea Bank account and transferring money between your own accounts.
 email: name@my-domain.se
 executables: 
@@ -29,6 +38,9 @@ files:
 - Rakefile
 - VERSION
 - bin/nordea
+- examples/atom_feed/.htaccess
+- examples/atom_feed/nordea.cgi
+- examples/transfer-to-salary
 - lib/nordea.rb
 - lib/nordea/request.rb
 - lib/nordea/resources.rb