banker 0.0.3 → 0.0.4

data/lib/banker/base.rb

@@ -24,5 +24,13 @@ module Banker
     def get_letter(value,index)
       value.to_s[index-1]
     end
+
+    def memorable_required(page)
+      page.labels.collect { |char| cleaner(char.to_s).to_i }
+    end
+
+    def cleaner(str)
+      str.gsub(/[^\d+]/, '')
+    end
   end
 end

data/lib/banker/lloyds_tsb_uk.rb

@@ -1,129 +1,100 @@
 module Banker
-  # This class allows the data retrieval of accounts for Lloyds TSB UK
-  #
-  # == Examples
-  #
-  # Retrieve Account Balance
-  #
-  #     user_params = { username: 'Joe', password: 'password', memorable_word: 'superduper' }
-  #     lloyds = Banker::LloydsTSBUK.new(user_params)
-  #     lloyds.balance
-  #     # => [ {:current_account => { :balance => 160940,
-  #                                   :details => { :sort_code => "928277",
-  #                                                 :account_number => "92837592" }}},
-  #
-  #            {:savings_account => { :balance => 0.0,
-  #                                   :details => { :sort_code => "918260",
-  #                                                 :account_number=>"91850261" }}},
-  #
-  #            {:lloyds_tsb_platinum_mastercard => { :balance => 0.0,
-  #                                                  :details => { :card_number => "9284710274618391" }}}
-  #          ]
-  #
-  class LloydsTSBUK
-    attr_accessor :username, :password, :memorable_word, :balance, :agent
-
-    LOGIN_ENDPOINT = "https://online.lloydstsb.co.uk/personal/logon/login.jsp"
-
-    def initialize(args)
-      @username = args[:username]
-      @password = args[:password]
-      @memorable_word = args[:memorable_word]
-
-      @agent = Mechanize.new
-      @agent.log = Logger.new 'mech.log'
-      @agent.user_agent = 'Mozilla/5.0 (Banker)'
-      @agent.force_default_encoding = 'utf8'
-
-      @balance = authenticate
-    end
+  class LloydsTSBUK < Base
 
-    def get_memorable_word_letter(letter)
-      @memorable_word.to_s[letter.to_i - 1]
-    end
+    LOGIN_URL = "https://online.lloydstsb.co.uk/personal/logon/login.jsp"
+    COLLECT_URL = "https://secure2.lloydstsb.co.uk/personal/a/account_overview_personal/"
 
-    def cleaner(str)
-      str.gsub(/[^\d+]/, '')
-    end
+    attr_accessor :accounts
 
-  private
+    FIELD = {
+      username: 'frmLogin:strCustomerLogin_userID',
+      password: 'frmLogin:strCustomerLogin_pwd',
+      memorable_word: [
+        'frmentermemorableinformation1:strEnterMemorableInformation_memInfo1',
+        'frmentermemorableinformation1:strEnterMemorableInformation_memInfo2',
+        'frmentermemorableinformation1:strEnterMemorableInformation_memInfo3'
+      ]
+    }
 
-    def authenticate
-      page = @agent.get(LOGIN_ENDPOINT)
+    def initialize(args={})
+      @keys = %w(username password memorable_word)
 
-      # Login Page
-      page = page.form('frmLogin') do |f|
-        f.fields[0].value = @username
-        f.fields[1].value = @password
-      end.click_button
+      params(args)
+      @username = args.delete(:username)
+      @password = args.delete(:password)
+      @memorable_word = args.delete(:memorable_word)
 
-      # Memorable Word
-      form = page.form('frmentermemorableinformation1')
-      memorable_set(page, form)
-      page = @agent.submit(form, form.buttons.first)
+      @accounts = []
 
-      # Accounts Page
-      return account_return(page)
+      authenticate!
+      delivery!
     end
 
-    def memorable_letters(page)
-      {
-        first: memorable_required(page)[0],
-        second: memorable_required(page)[1],
-        third: memorable_required(page)[2]
-      }
-    end
+  private
 
-    def memorable_set(page, form)
-      letters = memorable_letters(page)
+    def authenticate!
+      page = get(LOGIN_URL)
+      form = page.form_with(action: '/personal/primarylogin')
 
-      form.fields[2].value = '&nbsp;' + get_memorable_word_letter(letters.fetch(:first))
-      form.fields[3].value = '&nbsp;' + get_memorable_word_letter(letters.fetch(:second))
-      form.fields[4].value = '&nbsp;' + get_memorable_word_letter(letters.fetch(:third))
-    end
+      form[FIELD[:username]] = @username
+      form[FIELD[:password]] = @password
 
-    def memorable_required(page)
-      page.labels.collect { |char| cleaner(char.to_s) }
-    end
+      page = @agent.submit(form, form.buttons.first)
 
-    def account_name(page)
-      page.search('div.accountDetails h2').collect {|a| a.content.downcase.gsub(/\s/, '_').to_sym }
-    end
+      form = page.form_with(action: '/personal/a/logon/entermemorableinformation.jsp')
+      letters = memorable_required(page).delete_if { |v| v if v == 0 }
 
-    def account_detail(page)
-      page.search('div.accountDetails p.numbers').collect {|n| n.content }
+      form[FIELD[:memorable_word][0]] = '&nbsp;' + get_letter(@memorable_word, letters[0])
+      form[FIELD[:memorable_word][1]] = '&nbsp;' + get_letter(@memorable_word, letters[1])
+      form[FIELD[:memorable_word][2]] = '&nbsp;' + get_letter(@memorable_word, letters[2])
+
+      @agent.submit(form, form.buttons.first)
     end
 
-    def account_balance(page)
-      page.search('div.balanceActionsWrapper p.balance').collect {|b| b.content }
+    def name(page)
+      page.search('div.accountDetails h2').collect do |a|
+        a.content.downcase.gsub(/\s/, '_').to_sym
+      end
     end
 
-    def formatted_detail(page)
-      resp = account_detail(page).map { |detail| detail.split(',').map { |d| cleaner(d) } }
-      resp.map! do |r|
-        if r.length == 2
-          { sort_code: r[0], account_number: r[1] }
-        elsif r.length == 1
-          { card_number: r[0] }
-        else
-          STDERR.puts "[Error] It seems we got account details that we did not expect! - #{r.inspect}"
-        end
+    def identifier(page)
+      page.search('div.accountDetails p.numbers').collect do |n|
+        n.content.split(',').map { |d| cleaner(d) }
       end
     end
 
-    def formatted_balance(page)
-      account_balance(page).map do |b|
+    def balance(page)
+      bal = page.search('div.balanceActionsWrapper p.balance').collect {|b| b.content }
+
+      bal.map do |b|
         resp = cleaner(b)
         resp.empty? ? 0.00 : resp.to_i
       end
     end
 
-    def account_return(page)
-      resp = []
-      account_name(page).zip(formatted_balance(page), formatted_detail(page)).each_with_index do |acc, index|
-        resp << { acc[0] => { balance: acc[1], details: acc[2] } }
+    def limit(page)
+      page.search('div.accountBalance').inject([]) do |acc, b|
+        if b.content.downcase.include?('limit')
+          acc << cleaner(b.content.scan(/[\d.]+$/).first)
+        else
+          acc << 0.00
+        end
+        acc
+      end
+    end
+
+    def delivery!
+      page = get(COLLECT_URL)
+      name(page).zip(balance(page), identifier(page), limit(page)).each_with_index do |acc, index|
+        next if acc[2].nil?
+        uid = Digest::MD5.hexdigest("LloydsTSBUK#{acc[2].last}")
+        @accounts << Banker::Account.new(uid: uid,
+                                         name: "#{acc[0]}",
+                                         limit: acc[3],
+                                         amount: acc[1],
+                                         currency: 'GBP'
+                                        )
       end
-      resp
     end
 
   end

data/lib/banker/version.rb

@@ -1,3 +1,3 @@
 module Banker
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/banker/lloyds_tsb_uk_spec.rb

@@ -1,53 +1,175 @@
-# -*- encoding: utf-8 -*-
 require 'spec_helper'
-require 'mechanize'
 
 describe Banker::LloydsTSBUK do
-  let(:support_files) {File.expand_path('../../support/lloyds_tsb_uk/',__FILE__)}
-  let(:login) { File.read(File.expand_path('login.jsp.html', support_files)) }
-  let(:memorable) { File.read(File.expand_path('entermemorableinformation.jsp.html', support_files)) }
-  let(:accounts) { File.read(File.expand_path('account_overview_personal.html', support_files)) }
-  # let(:welcome) { File.read(File.expand_path('interstitialpage.jsp.html', support_files)) }
+  TEST_FIELD = {
+    username: 'frmLogin:strCustomerLogin_userID',
+    password: 'frmLogin:strCustomerLogin_pwd',
+    memorable_word: [
+      'frmentermemorableinformation1:strEnterMemorableInformation_memInfo1',
+      'frmentermemorableinformation1:strEnterMemorableInformation_memInfo2',
+      'frmentermemorableinformation1:strEnterMemorableInformation_memInfo3'
+    ]
+  }
+
+  let(:mechanize) {mock('mechanize').as_null_object}
+  let(:form) {mock('form')}
+  let(:button) {mock('button')}
+  let(:args) { { username: 'Doe',
+                 password: '82736',
+                 memorable_word: 'testing' } }
+
+  subject { Banker::LloydsTSBUK }
 
   before do
-    stub_request(:get, "https://online.lloydstsb.co.uk/personal/logon/login.jsp").
-      to_return(:status => 200, :body => login, :headers => { "Content-Type" => "text/html" })
-    stub_request(:post, "https://online.lloydstsb.co.uk/personal/primarylogin").
-      to_return(:status => 200, :body => memorable, :headers => { "Content-Type" => "text/html" })
-    stub_request(:post, "https://online.lloydstsb.co.uk/personal/a/logon/entermemorableinformation.jsp").
-      to_return(:status => 200, :body => accounts, :headers => { "Content-Type" => "text/html" })
+    subject.any_instance.stub(:params)
+    subject.any_instance.stub(:authenticate!)
+    subject.any_instance.stub(:delivery!)
   end
 
-  subject { Banker::LloydsTSBUK.new(:username => 'Joe',
-                                                :password => 'password',
-                                                :memorable_word => 'superduper') }
+  it {subject.new.should respond_to(:accounts)}
 
-  describe '.new' do
-    it { subject.username.should eql 'Joe' }
-    it { subject.password.should eql 'password' }
-    it { subject.balance.should be_a_kind_of(Array) }
+  describe "Parameters" do
+    before do
+      subject.any_instance.unstub(:params)
+    end
 
-    it "should authenticate account login" do
-      subject
-      WebMock.should have_requested(:get, 'https://online.lloydstsb.co.uk/personal/logon/login.jsp')
-      WebMock.should have_requested(:post, 'https://online.lloydstsb.co.uk/personal/primarylogin')
-      WebMock.should have_requested(:post, 'https://online.lloydstsb.co.uk/personal/a/logon/entermemorableinformation.jsp')
+    it "raises InvalidParams when username is missing" do
+      expect{
+        subject.new
+      }.to raise_error(Banker::Error::InvalidParams,
+                       "missing parameters `username` `password` `memorable_word` ")
     end
-  end
 
-  describe '.get_memorable_word_letter' do
-    it { should respond_to(:get_memorable_word_letter) }
-    it 'should return requested letter' do
-      @memorable_word = 'Test'
-      subject.get_memorable_word_letter('4').should eql 'e'
+    it "raises InvalidParams when password is missing" do
+      expect{
+        subject.new(username: "joe")
+      }.to raise_error(Banker::Error::InvalidParams,
+                       "missing parameters `password` `memorable_word` ")
+    end
+
+    it "raises InvalidParams when memorable_word is missing" do
+      expect{
+        subject.new(username: "joe", password: "123456")
+      }.to raise_error(Banker::Error::InvalidParams,
+                       "missing parameters `memorable_word` ")
+
+    end
+
+    it "accepts username, password and memorable_word" do
+      expect{
+        subject.new(username: "joe", password: "123456",
+                    memorable_word: "superduper")
+      }.to_not raise_error
     end
   end
 
-  describe '.cleaner' do
-    it { should respond_to(:cleaner) }
-    it 'should remove unwanted characters' do
-      subject.cleaner("Test123Test").should eql '123'
+  describe "Method Calls" do
+    it "should Call params Method" do
+      subject.any_instance.should_receive(:params)
+      subject.new
+    end
+
+    it "should Call authenticate! Method" do
+      subject.any_instance.should_receive(:authenticate!)
+      subject.new
+    end
+
+    it "should Call delivery! Method" do
+      subject.any_instance.should_receive(:delivery!)
+      subject.new
     end
   end
 
+  describe "private" do
+    before do
+      Mechanize.stub(:new).and_return(mechanize)
+      Mechanize.any_instance.stub(get: mechanize)
+    end
+
+    describe "#authenticate!" do
+      before do
+        subject.any_instance.unstub(:authenticate!)
+        mechanize.stub(form_with: form.as_null_object)
+        mechanize.stub(:submit).and_return(mechanize)
+        subject.any_instance.stub(:get_letter).and_return('s')
+      end
+
+      it "should call to LOGIN_URL" do
+        mechanize.should_receive(:get).
+          with("https://online.lloydstsb.co.uk/personal/logon/login.jsp").
+          and_return(mechanize.as_null_object)
+
+        subject.new(args)
+      end
+
+      it 'should find the form element' do
+        mechanize.should_receive(:form_with).with( action: '/personal/primarylogin' ).
+          and_return(form.as_null_object)
+
+        subject.new(args)
+      end
+
+      it "should fill in the form" do
+        form.should_receive(:[]=).with(TEST_FIELD[:username], 'Doe')
+        form.should_receive(:[]=).with(TEST_FIELD[:password], '82736')
+
+        subject.new(args)
+      end
+
+      it "should submit" do
+        Mechanize.stub(:new).and_return(mechanize.as_null_object)
+
+        form.should_receive(:buttons).exactly(2).times.and_return([button])
+        mechanize.should_receive(:submit).exactly(2).times.with(form, button).
+          and_return(mechanize.as_null_object)
+
+        subject.new(args)
+      end
+
+      it 'should find the form element' do
+        mechanize.should_receive(:form_with).
+          with( action: '/personal/a/logon/entermemorableinformation.jsp' ).
+          and_return(form)
+
+        subject.new(args)
+      end
+
+      it "should fill in the form" do
+        subject.any_instance.unstub(:get_letter)
+        subject.any_instance.stub(:memorable_required).with(mechanize).and_return([1,2,3])
+
+        form.should_receive(:[]=).with(TEST_FIELD[:memorable_word][0], " t")
+        form.should_receive(:[]=).with(TEST_FIELD[:memorable_word][1], " e")
+        form.should_receive(:[]=).with(TEST_FIELD[:memorable_word][2], " s")
+
+        subject.new(args)
+      end
+    end
+
+    describe '#delivery!' do
+      let(:obj) { subject.new(args).accounts.first }
+
+      before do
+        subject.any_instance.unstub(:delivery!)
+        subject.any_instance.stub(:name).and_return(['A', 'B', 'C'])
+        subject.any_instance.stub(:identifier).and_return([['A'], ['B'], ['C']])
+        subject.any_instance.stub(:balance).and_return([1.00, 2.00, 3.00])
+        subject.any_instance.stub(:limit).and_return([1.00, 2.00, 3.00])
+      end
+
+      it 'should call to EXPORT_URL' do
+        mechanize.should_receive(:get).
+          with('https://secure2.lloydstsb.co.uk/personal/a/account_overview_personal/').
+          and_return(mechanize.as_null_object)
+
+        subject.new(args)
+      end
+
+      it { obj.name.should == "A" }
+      it { obj.uid.should == "9f0728995cad501bad95aa513f07b4e9" }
+      it { obj.amount.should == 1.0 }
+      it { obj.limit.should == 1.0 }
+      it { obj.currency.should == 'GBP' }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: banker
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-21 00:00:00.000000000 Z
+date: 2012-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
-  requirement: &70148720229580 !ruby/object:Gem::Requirement
+  requirement: &70275203406640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70148720229580
+  version_requirements: *70275203406640
 - !ruby/object:Gem::Dependency
   name: ofx
-  requirement: &70148720229080 !ruby/object:Gem::Requirement
+  requirement: &70275203405920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70148720229080
+  version_requirements: *70275203405920
 - !ruby/object:Gem::Dependency
   name: gem-release
-  requirement: &70148720244820 !ruby/object:Gem::Requirement
+  requirement: &70275203405420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148720244820
+  version_requirements: *70275203405420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70148720244020 !ruby/object:Gem::Requirement
+  requirement: &70275203421160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148720244020
+  version_requirements: *70275203421160
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70148720243580 !ruby/object:Gem::Requirement
+  requirement: &70275203420040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148720243580
+  version_requirements: *70275203420040
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70148720242920 !ruby/object:Gem::Requirement
+  requirement: &70275203418820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148720242920
+  version_requirements: *70275203418820
 description: A collection of strategies to access online bank accounts to obtain balance
   and transaction details.
 email: