nordea-rb 0.2.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Martin Str�m
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,163 @@
+# Nordea-rb
+
+
+# First, Please note
+I don't take no responsable at all if somethings messes up with your bank account or if you break 
+any terms of service (which this lib probably does). It has worked fine for me for a while though.
+
+
+## What?
+
+nordea-rb is a small Ruby library to access your Nordea bank account and list balances etc. 
+
+It uses the WAP-version (https://mobil.nordea.se) to access the data. This version has many variables names etc
+in Swedish so I suppose this only works for the Swedish version right now but it might be easy to adjust it if 
+other languages use the same system.
+
+I've only tested it with my own login details so there might be issues if you have a different setup. 
+
+
+## Storing the account details in Mac OS X's Keychain
+
+On Mac OS X, the recommended way of storing your accounts details is in the built-in Keychain.
+Here's how to set it up:
+
+1. Run the application "Keychain Access" (located in /Applications/Utilities)
+2. Add a new Password Item (File → New Password Item)
+3. You can use which name you'd like for "Keychain Item Name" but by default, nordea-rb will look for an item named "Nordea" (with capital "N")
+4. Enter your "personnummer" (Swedish SSN) as "Account Name"
+5. Enter your PIN code as "Password". (yes it indicates that its password strength is "weak")
+6. Save
+
+
+## Examples
+
+Creating a new instance
+
+    # use the following account details
+    n = Nordea.new("1234567890", "1337")
+  
+    # or using a hash
+    n = Nordea.new(:pnr => "1234567890", :pin => "1337")
+  
+
+Getting account details from the Keychain:
+  
+    # use the default keychain and look for an account called "Nordea"
+    n = Nordea.new(:keychain)
+
+    # default keychain with an account named "My Nordea"
+    n = Nordea.new(:keychain, :label => 'My Nordea') 
+
+    # Use another keychain file
+    n = Nordea.new(:keychain, :label => 'nordea-rb', :keychain_file => '/Users/me/Library/Keychains/login.keychain')
+
+
+Logging in and out
+    
+    # manually login and logout
+    n = Nordea.new(:keychain)
+    n.login
+    # ...
+    n.logout
+    
+    
+    # If you pass a block, then it will login and logout automatically    
+    Nordea.new("1234567890", "1337") do |n|
+      # no need to login or out
+    end
+
+Listing your accounts
+
+    Nordea.new(...) do |n|
+      puts "you have #{n.accounts.size} account(s)"
+    end
+    
+Accessing your account details
+    
+    Nordea.new(...) do |n|
+      account = n.accounts.first
+      another_account = n.accounts['Savings']
+      puts another_account.name # => "Savings"
+      puts account.balance, account.currency, account.to_s
+      
+      # You can also access accounts using a regexp:
+      puts n.accounts[/saving/i]
+    end
+
+Getting a list of transactions for an account
+    
+    Nordea.new(...) do |n|
+      savings = n.accounts['Savings']
+      puts savings.transactions.size # => displays 20 per page, paging is not yet supported
+      
+      salary_account = n.accounts['Salary']
+      latest = salary_account.transactions.first
+      
+      puts latest.text        # => the text on the transaction
+      puts latest.amount      # => -2000.0
+      puts latest.date        # => 2009-01-02
+      puts latest.withdrawal? # => true
+      puts latest.deposit?    # => false
+    end
+
+Transfer money between your own accounts:
+
+    Nordea.new(...) do |n|
+      savings = n.accounts['Savings']
+      salary_account = n.accounts['Salary']
+      
+      # transfer 10 SEK from the savings account to the salary account
+      savings.withdraw(10.0, 'SEK', :deposit_to => salary_account)
+      
+      # basically the same transaction:
+      salary_account.deposit(10.0, 'SEK', :withdraw_from => savings)
+    end
+
+
+## Command Line Tool
+
+The command line tool is pretty basic right now and it only prints the given account(s) balance(s).
+Improving it to do more things (like list transactions etc) would just be a matter of polishing the 
+option parser which I throw together quickly. 
+
+Show the balances for the savings account
+
+    ./nordea --pnr=1234567890 --pin=0987 Savings
+
+Show the balances for the accounts named "Savings" and "Salary". Login from keychain
+
+     ./nordea --keychain Savings Salary
+
+
+## TODO
+
+- Support for transfering money between your own accounts
+- Clean up the API and class architecture
+- Add support for paging in transactions list
+- Build an iPhone optimized web app which uses nordea-rb as backend so we finally can have a better mobile bank
+
+
+## Credits and license
+
+By [Martin Ström](http://twitter.com/haraldmartin) under the MIT license:
+
+>  Copyright (c) 2009 Martin Ström
+>
+>  Permission is hereby granted, free of charge, to any person obtaining a copy
+>  of this software and associated documentation files (the "Software"), to deal
+>  in the Software without restriction, including without limitation the rights
+>  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+>  copies of the Software, and to permit persons to whom the Software is
+>  furnished to do so, subject to the following conditions:
+>
+>  The above copyright notice and this permission notice shall be included in
+>  all copies or substantial portions of the Software.
+>
+>  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+>  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+>  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+>  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+>  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+>  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+>  THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,25 @@
+require "rubygems"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/test_*.rb"]
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "nordea-rb"
+    gemspec.summary = "Ruby library for accessing your Nordea Bank account and transferring money between your own accounts."
+    gemspec.description = "Ruby library for accessing your Nordea Bank account and transferring money between your own accounts."
+    gemspec.email = "name@my-domain.se"
+    gemspec.homepage = "http://github.com/haraldmartin/nordea-rb"
+    gemspec.authors = ["Martin Ström"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/nordea

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require File.join(File.dirname(__FILE__), *%w".. lib nordea")
+
+options, accounts, pnr, command = {}, []
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: nordea [options]"
+  
+  def opts.show_usage
+    puts self
+    exit  
+  end
+  
+  opts.on('-p', '--pnr=PERSONNUMMER', "Login using the PERSONNUMMER") do |p|
+    pnr = p
+  end
+  
+  opts.on('-i', '--pin=PIN', "Login using the PIN code") do |pin|
+    options = pin
+  end
+  
+  opts.on('-k', '--keychain', "Get account details from the default keychain. See README how to set this up") do
+    pnr = :keychain
+  end
+  
+  opts.on('-f', '--keychain-file=FILE', "Use the keychain FILE") do |file|
+    options[:keychain_file] = file
+  end
+
+  opts.on('-l', '--keychain-label=LABEL', "Look for a keychain item named LABEL") do |label|
+    options[:label] = label
+  end
+
+  opts.on('-b', '--balance', "Print the account's balance") do
+    # right now balance is the only supported command
+  end
+  
+  opts.on_tail("-h", "--help", "Shows this help message") { opts.show_usage }
+  opts.on_tail("-v", "--version", "Shows version") do
+    puts Nordea::Version::STRING
+    exit
+  end
+
+  begin
+    opts.order(ARGV) { |a| accounts << a }
+  rescue OptionParser::ParseError => e
+    opts.warn e.message
+    opts.show_usage
+  end
+
+end
+
+opts.parse!
+opts.show_usage unless pnr && accounts.length > 0
+
+begin
+  Nordea.new(pnr, options) do |n|
+    accounts.each do |account|
+      puts n.accounts[/#{account}/i].to_s
+    end
+  end
+rescue Nordea::InvalidLogin => e
+  puts "Invalid login: #{e.message}"
+end

data/lib/nordea/request.rb

@@ -0,0 +1,42 @@
+module Nordea
+  class Request
+    HOST_NAME   = 'gfs.nb.se'
+    HOST_PORT   = 443
+    SCRIPT_NAME = '/bin2/gfskod'
+    USER_AGENT  = 'Nokia9110/1.0'
+    
+    def initialize(command, extra_params = {})
+      @command, @extra_params = command, extra_params
+      request
+    end
+    
+    def connection
+      http = Net::HTTP.new(HOST_NAME, HOST_PORT)
+      http.use_ssl = true
+      http
+    end
+    
+    def parse_xml 
+      Hpricot.XML(response)
+    end
+    
+    def request
+      res = connection.post(SCRIPT_NAME, query, headers)
+      @result = res.body
+    end
+    
+    def headers
+      { "User-Agent"  => USER_AGENT }
+    end
+    
+    def response
+      @result
+    end
+    
+    def query
+      @extra_params.merge({ "OBJECT" => @command }).
+        inject([]) { |all, (key, value)| all << "#{key}=#{value}" }.
+        join("&")
+    end
+  end
+end

data/lib/nordea/resources/account.rb

@@ -0,0 +1,102 @@
+module Nordea
+  class Account < Resource
+    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
+    end
+    
+    attr_accessor :name, :balance, :currency, :index, :session
+    
+    def account_type_name; 'konton' end
+
+    def to_command_params
+      @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)
+        end
+      end
+    end
+    
+    def to_s
+      "#{name}: #{balance_to_s} #{currency}"
+    end
+    
+    def balance_to_s(decimals = 2)
+      %Q{%.#{decimals}f} % balance
+    end
+
+    def self.new_from_xml(xml_node, session)
+      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
+    end
+    
+    def withdraw(amount, currency = 'SEK', options = {})
+      options.symbolize_keys!
+      to = options[:deposit_to]
+
+      raise ArgumentError, "options[:deposit_to] must be a Nordea::Account" unless to.is_a?(Nordea::Account)
+
+      currency, amount  = currency.to_s, amount.to_s.sub(".", ",")
+      from_account_info = [index, currency, name].join(":")
+      to_account_info   = [to.index, to.currency, to.name].join(":")
+
+      params = { :from_account_info => from_account_info,
+                 :to_account_info   => to_account_info,
+                 :amount            => amount,
+                 :currency_code     => currency }
+      
+      session.request(Nordea::Commands::TRANSFER_TO_OWN_ACCOUNT_PHASE_1, params)
+      session.request(Nordea::Commands::TRANSFER_TO_OWN_ACCOUNT_PHASE_2, params)
+      session.request(Nordea::Commands::TRANSFER_TO_OWN_ACCOUNT_PHASE_3, {
+        :currency_code             => currency,
+        :from_account_number       => index,
+        :from_account_name         => name,
+        :to_account_number         => to.index,
+        :to_account_name           => to.name,
+        :amount                    => amount,
+        :exchange_rate             => "0",
+        :from_currency_code        => currency,
+        :to_currency_code          => currency
+      })
+
+      session.accounts(true)
+    end
+
+    def deposit(amount, currency = 'SEK', options = {})
+      options.symbolize_keys!
+      from = options.delete(:withdraw_from)
+      
+      raise ArgumentError unless from.is_a?(Nordea::Account)
+      
+      from.withdraw(amount, currency, options.merge(:deposit_to => self))
+    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']
+        index    = xml_node.at("postfield[@name='account_index']")['value']
+        balance  = xml_node.next_sibling.next
+        { :name => name, :currency => currency, 
+          :balance => Support.dirty_currency_string_to_f(balance), :index => index }
+      end
+    
+      def self._setup_command_params(xml_node)
+        command_params = (xml_node/'postfield').to_a.inject({}) do |all, postfield|
+          name = postfield['name']
+          all[name] = postfield['value'] unless name =~ /sid|OBJECT/
+          all
+        end
+      end
+  end
+end

data/lib/nordea/resources/card.rb

@@ -0,0 +1,5 @@
+module Nordea
+  class Card < Resource
+    def account_type_name; 'kort' end
+  end
+end

data/lib/nordea/resources/fund.rb

@@ -0,0 +1,5 @@
+module Nordea
+  class Fund < Resource
+    def account_type_name; 'fonder' end
+  end
+end

data/lib/nordea/resources/loan.rb

@@ -0,0 +1,5 @@
+module Nordea
+  class Loan < Resource
+    def account_type_name; "lan" end
+  end
+end

data/lib/nordea/resources/resource.rb

@@ -0,0 +1,7 @@
+module Nordea
+  class Resource
+    def request_xml
+      # Request.new("KF00TW", "account_type_name" => account_type_name)
+    end
+  end
+end

data/lib/nordea/resources.rb

@@ -0,0 +1,17 @@
+require 'nordea/resources/resource'
+require 'nordea/resources/account'
+require 'nordea/resources/card'
+require 'nordea/resources/fund'
+require 'nordea/resources/loan'
+
+class ResourceCollection < Array
+  def [](account_name)
+    if account_name.is_a?(String)
+      detect { |e| e.name == account_name }
+    elsif account_name.is_a?(Regexp)
+      detect { |e| e.name =~ account_name }
+    else
+      super
+    end
+  end
+end

data/lib/nordea/session.rb

@@ -0,0 +1,63 @@
+module Nordea
+  class Session
+    attr_accessor :pnr, :pin, :token
+    attr_reader :num_requests
+
+    def initialize(pnr, pin, &block)
+      @pnr, @pin = pnr, pin
+      @num_requests = 0
+      if block_given?
+       login
+       yield self
+       logout
+      end
+    end
+    
+    def login
+      doc = request(Commands::LOGIN_PHASE_1, { "kundnr" => pnr, "pinkod" => pin, "sid" => "0" }).parse_xml
+      begin 
+        @token = (doc/'*[@name=sid]').attr("value")
+        contract = (doc/'postfield[@name=contract]').attr("value")
+      rescue Exception => e
+        if node = doc.at("card[@title='Fel']")
+          error_message = node.at("p").inner_text.strip
+        else
+          error_message = ""
+        end
+        raise Nordea::InvalidLogin, error_message
+      end
+      request Commands::LOGIN_PHASE_2, "bank" => "mobile_light", "no_prev" => "1", "contract" => contract
+    end
+    
+    alias_method :login!, :login
+    
+    def logout
+      request Commands::LOGOUT
+    end
+    
+    alias_method :logout!, :logout
+    
+    def request(command, extra_params = {})
+      extra_params.symbolize_keys!
+      extra_params.merge!(:sid => token) unless extra_params.has_key?(:sid)
+      @num_requests += 1
+      Nordea::Request.new(command, extra_params)
+    end
+    
+    def accounts(reload = false)
+      @accounts = nil if reload
+      @accounts ||= setup_resources(Account)
+    end
+    
+    private
+    
+      def setup_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
+      end
+  end
+end

data/lib/nordea/support.rb

@@ -0,0 +1,63 @@
+module Nordea
+  class Support
+    def self.dirty_currency_string_to_f(string)
+      string.to_s.strip.gsub(/(\302|\240)/, "").gsub('.', '').gsub(',', '.').delete('SEK').to_f
+    end
+  end
+end
+
+def quietly
+  v = $VERBOSE
+  $VERBOSE = nil
+  yield
+ensure
+  $VERBOSE = v
+end
+
+# quietly { OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE }
+
+class Net::HTTP
+  alias_method :old_initialize, :initialize
+  def initialize(*args)
+    old_initialize(*args)
+    @ssl_context = OpenSSL::SSL::SSLContext.new
+    @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  end
+end
+
+class Symbol
+  def to_proc
+    Proc.new { |obj, *args| obj.send(self, *args) }
+  end
+end
+
+# from ActiveSupport
+class Hash
+  def stringify_keys
+    inject({}) do |options, (key, value)|
+      options[key.to_s] = value
+      options
+    end
+  end
+
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+
+  alias_method :to_options,  :symbolize_keys
+  alias_method :to_options!, :symbolize_keys!
+end

data/lib/nordea/transaction.rb

@@ -0,0 +1,27 @@
+require 'date'
+
+module Nordea  
+  class Transaction
+    def initialize(date, amount, text)
+      @date, @amount, @text = date, amount, text
+    end
+    
+    attr_accessor :date, :amount, :text
+    
+    def withdrawal?
+      amount < 0
+    end
+
+    def deposit?
+      amount > 0
+    end
+    
+    def self.new_from_xml(xml)
+      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
+    end
+  end
+end

data/lib/nordea/version.rb

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