firstdirect 0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. data/License.txt +341 -0
  2. data/Manifest.txt +5 -0
  3. data/README.txt +25 -0
  4. data/Rakefile +12 -0
  5. data/lib/firstdirect.rb +374 -0
  6. metadata +80 -0
@@ -0,0 +1,341 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) year name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
341
+
@@ -0,0 +1,5 @@
1
+ Manifest.txt
2
+ README.txt
3
+ Rakefile
4
+ lib/firstdirect.rb
5
+ License.txt
@@ -0,0 +1,25 @@
1
+ = firstdirect
2
+
3
+ Internet banking with First Direct using Ruby.
4
+
5
+ A FirstDirect object will log into First Direct's website and create some
6
+ Account objects for each account listed on the first page after login.
7
+
8
+ Please see the RDoc / source code for further information about firstdirect.rb!
9
+
10
+ == BUGS
11
+
12
+ * Downloading of credit card account statements "doesn't work".
13
+
14
+ firstdirect.rb:51:in `strip_js': undefined method `[]' for nil:NilClass (NoMethodError)
15
+
16
+ * Downloading statements for 'Everyday e-Saver' fails with "no date_form found".
17
+
18
+ * Downloading "Regular Saver" account information often returns 'rubbish':
19
+
20
+ data downloaded looks like rubbish: <!--Build:19.01.0004-
21
+
22
+
23
+ == LICENSE
24
+
25
+ This code is licensed under the terms of the GPL version 2.
@@ -0,0 +1,12 @@
1
+ # vim: syntax=Ruby
2
+
3
+ require 'rubygems'
4
+ require 'hoe'
5
+ require './lib/firstdirect.rb'
6
+
7
+ Hoe.new('firstdirect', FirstDirect::VERSION) do |p|
8
+ p.remote_rdoc_dir = '/'
9
+ p.developer('Edward Speyer', 'edward.rffd@example.com')
10
+ p.summary = 'Internet banking with First Direct using Ruby'
11
+ p.extra_deps = ['mechanize']
12
+ end
@@ -0,0 +1,374 @@
1
+ =begin rdoc
2
+
3
+ = firstdirect.rb -- internet banking with First Direct using Ruby
4
+
5
+ A FirstDirect object will log into First Direct's website and create some
6
+ Account objects for each account listed on the first page after login.
7
+
8
+ require 'firstdirect'
9
+ require 'yaml'
10
+
11
+ secrets = YAML.load <<'...'
12
+ userid: rodney@nelsonmandelahouse.org.uk
13
+ password: notaplonker
14
+ memorable_answer:
15
+ "Favourite lager?": 'Castle lager'
16
+ "Uncle's first name?": 'Albert'
17
+ ...
18
+
19
+ fd = FirstDirect.new(secrets)
20
+ account = fd.account('1st account')
21
+
22
+
23
+ Each Account has a name, number, and balance.
24
+
25
+ puts account
26
+ #=> 1st Account (10-20-30 10000000): £100.00
27
+
28
+
29
+ An Account can also download statements in CSV format:
30
+
31
+ account.download
32
+ #=> Date,Description,Amount,Balance
33
+ # 03/07/2008,"FOOBAR LTD",-600.00,350.21
34
+ # 02/07/2008,"CASH MACHINE @12:34",-50.00,950.21
35
+ # 01/07/2008,"WHERE I WORK LTD",1000.21,1000.21
36
+
37
+ # ...or from a particular date, up to yesterday:
38
+ account.download(:from => '2008-01-01')
39
+
40
+ # ...or between two dates:
41
+ account.download(:from => '2008-01-01', :to => '2008-01-07')
42
+
43
+ # ...or in any other format offered by First Direct:
44
+ account.download(:to => '2008-01-07', :format => 'Quicken 97')
45
+ # => !Type:Bank
46
+ # D06-09-08
47
+ # PREGULAR SAVER TROTTER R
48
+ # T100.00
49
+
50
+
51
+ =end
52
+ class FirstDirect
53
+ VERSION = '0.1'
54
+
55
+ require 'rubygems'
56
+ require 'mechanize'
57
+ require 'pp'
58
+ require 'time'
59
+
60
+ class Error < StandardError
61
+ end
62
+
63
+ #
64
+ # Some useful methods to have lying around.
65
+ #
66
+ module Helpers
67
+ #
68
+ # Turn a javascript @href into a normal URL.
69
+ #
70
+ def strip_js(link)
71
+ if link['href'].match(/reDoGet\('(.+)'\)$/)
72
+ return $1
73
+ else
74
+ raise Error, "link doesn't look like a js link: #{link}"
75
+ end
76
+ end
77
+
78
+ @@colours = { :red => 31, :green => 32 }
79
+
80
+ def colour(colour, format, *args)
81
+ "%s*%s %s" % [ "\033[#{@@colours[colour]}m", "\033[0m", (format % args) ]
82
+ end
83
+
84
+ #
85
+ # Print a message with a red star, then print it again with a green star,
86
+ # once we've yielded.
87
+ #
88
+ # result = trace('doing something'){ ... }
89
+ #
90
+ def trace(*args)
91
+ $stderr.sync = true
92
+ $stderr.print colour(:red, *args)
93
+ begin
94
+ t = Thread.new do
95
+ while true
96
+ $stderr.print '.'
97
+ sleep 0.2
98
+ end
99
+ end
100
+ result = yield
101
+ $stderr.print "\r" + colour(:green, *args)
102
+ ensure
103
+ t.kill
104
+ $stderr.print "\n"
105
+ end
106
+ return result
107
+ end
108
+
109
+ #
110
+ # Make these helpers available as Helpers.<foo> too.
111
+ #
112
+ extend self
113
+ end
114
+
115
+ include Helpers
116
+
117
+ #
118
+ # The Ruby WWW::Mechanize browser doesn't have javascript, but we have to go
119
+ # through lots of Javascript loops to get to the login page :(
120
+ #
121
+ # The javascript on http://firstdirect.com/ takes us (somewhere like) here:
122
+ #
123
+ # http://firstdirect.com/certificate.html?/trends/intbanking_refer.html?12...........
124
+ #
125
+ # But then even *more* javascript causes us to end up at the following URL,
126
+ # which eventually 301 and 302 redirects us to a page with a username_form,
127
+ # so it actually appears to be OK to start at this URL instead:
128
+ #
129
+ @@start_url = 'https://www.banking.first-direct.com/1/2/idv.Logoff?nextPage=fsdtBalances'
130
+
131
+ #
132
+ # +secrets+ should be a Hash of the form:
133
+ #
134
+ # userid: rodney@nelsonmandelahouse.org.uk
135
+ # password: notaplonker
136
+ # memorable_answer:
137
+ # "Favourite lager?": 'Castle lager'
138
+ # "Uncle's first name?": 'Albert'
139
+ #
140
+ # The keys to memorable_answer should be exactly in the form that they appear
141
+ # on the login form.
142
+ #
143
+ # I keep mine in a file called 'secrets' and load it with YAML.load_file.
144
+ #
145
+ def initialize(secrets)
146
+ @secrets = secrets
147
+ @agent = WWW::Mechanize.new
148
+ @agent.user_agent_alias = 'Mac Safari'
149
+
150
+ log_in
151
+ initialize_accounts
152
+ end
153
+
154
+ # The WWW::Mechanize object we are using.
155
+ attr :agent
156
+
157
+ # The Account objects we found after log_in (see initialize_accounts).
158
+ attr :accounts
159
+
160
+ #
161
+ # Log in as far as the main accounts page.
162
+ #
163
+ def log_in
164
+ # Going to the start URL gets a page where we can tell FirstDirect who we
165
+ # are:
166
+ username_page = trace('getting start_url'){ @agent.get @@start_url }
167
+ username_form = username_page.forms.first
168
+ username_form['userid'] = @secrets['userid']
169
+ password_page = trace('submitting username form'){ @agent.submit(username_form) }
170
+
171
+ # Now we'll be asked a question about our password letters.
172
+ #
173
+ # <label for="password" class="light">Please enter the
174
+ # <strong>1st</strong>, <strong>4th</strong> and <strong>5th</strong>
175
+ # characters from your <strong>electronic password</strong>, and the
176
+ # answer to your question.</label>
177
+ #
178
+ secrets_form = password_page.forms.first
179
+ begin
180
+ letter_requests = password_page.search("//label[@for='password']/strong")
181
+ letters = letter_requests[0..2].map do |elem| # Only the first three <strong>s refer to letters.
182
+ as_word = elem.inner_html
183
+ index = case as_word
184
+ when /^(\d+)(st|nd|rd|th)/
185
+ $1.to_i - 1
186
+ when 'last'
187
+ -1
188
+ when 'penultimate'
189
+ -2
190
+ else
191
+ raise Error, "unknown letter index: #{as_word}"
192
+ end
193
+ @secrets['password'].split(//)[index]
194
+ end.join
195
+ secrets_form['password'] = letters
196
+ end
197
+
198
+ # Also, we need to answer the 'memorableAnswer' thingy:
199
+ #
200
+ # <label for="memorableAnswer"><strong>Favourite colour?</strong></label>
201
+ #
202
+ begin
203
+ question = password_page.at("//label[@for='memorableAnswer']/strong").inner_html
204
+ answer = @secrets['memorable_answer'][question]
205
+ raise Error, "no known answer to question: #{question}" if answer.nil? or answer.empty?
206
+ secrets_form['memorableAnswer'] = answer
207
+ end
208
+
209
+ trace('logging in') { @agent.submit(secrets_form) }
210
+ end
211
+
212
+ #
213
+ # An Account represents an item listed on the first page we see on login.
214
+ # It has a pointer to its parent FirstDirect object, so that it can fetch
215
+ # pages etc.
216
+ #
217
+ class Account < Struct.new(:parent, :name, :link, :number, :balance)
218
+ include Helpers
219
+
220
+ def to_s
221
+ "#{name} (#{number}): #{balance}"
222
+ end
223
+
224
+ #
225
+ # Go to the mini-statement page for this account, which we'll need to do
226
+ # statement downloading.
227
+ #
228
+ def page
229
+ trace('getting account page'){ parent.agent.get(link) }
230
+ end
231
+
232
+ #
233
+ # Turn the given object +t+ into a date acceptable by the download form:
234
+ # dd/mm/yyyy.
235
+ #
236
+ def massage_time(t)
237
+ t = Time.parse(t.to_s) unless t.kind_of?(Time)
238
+ t.strftime('%d/%m/%Y')
239
+ end
240
+
241
+ #
242
+ # Fetch this account's most recent statement.
243
+ #
244
+ # By default:
245
+ # * we'll fetch the data *to* yesterday;
246
+ # * we'll fetch *from* a month before the *to* date;
247
+ # * we'll fetch the data in 'Microsoft Excel' format, ie CSV, but you
248
+ # could choose any option that FirstDirect
249
+ # provide on their download page.
250
+ #
251
+ # Example:
252
+ #
253
+ # account.download(:from => '2008-01-01')
254
+ # account.download(:from => '2008-01-01', :to => '2008-01-07')
255
+ # account.download(:to => '2008-01-07', :format => 'Quicken 97')
256
+ #
257
+ def download(options={})
258
+ options[:to] ||= Time.now - 86400
259
+ options[:from] ||= options[:to] - 30 * 86400
260
+ options[:format] ||= 'Microsoft Excel'
261
+
262
+ if Time.now - options[:to] < 86400
263
+ $stderr.puts "we can't look at transactions from less than a day ago: #{to_age}s is too young"
264
+ options[:to] -= 86400
265
+ end
266
+
267
+ # Look for the download link
268
+ download_a = page.search('//a[@class="fdActionLinkStatements"]').select do |elem|
269
+ elem.inner_html.strip == 'download'
270
+ end.first
271
+
272
+ # Choose a date range
273
+ date_page = trace('getting date page') { parent.agent.get Helpers.strip_js(download_a) }
274
+ date_form = date_page.forms.first
275
+
276
+ raise Error, "no date_form found" if date_form.nil?
277
+
278
+ date_form['DownloadFormat'] = options[:format]
279
+ date_form['DownloadFromDate'] = massage_time(options[:from])
280
+ date_form['DownloadToDate'] = massage_time(options[:to])
281
+
282
+ # LiveHTTPHeaders says that the form is posted with these parameters:
283
+ #
284
+ # Transactions=1
285
+ # DownloadFromDate=05%2F04%2F2008
286
+ # DownloadToDate=03%2F07%2F2008
287
+ # DownloadFormat=Quicken+97
288
+ # SaveInCookie=UNSELECTED
289
+ # EVENTID=UPDATE
290
+ # CCID=????
291
+ # FEBCCID=
292
+ # MODIFIER=
293
+ # ALERTS=
294
+ # LINKID=
295
+ # MENUMODE=
296
+ # SupportsDirectPrint=FALSE
297
+ # UTI=0
298
+ #
299
+ # However, I notice that the date_form's "EVENTID" and "CCID" aren't set
300
+ # by default. Maybe they are set by Javascript?
301
+ #
302
+ date_form['EVENTID'] = 'UPDATE'
303
+
304
+ #
305
+ # Oddly, unlike if we use a real browser, when we submit this date
306
+ # form, we get back a page that contains the data we wanted, but inside
307
+ # a <form></form> tag-pair.
308
+ #
309
+ page_with_data = trace('submitting date form'){ parent.agent.submit(date_form) }
310
+ data = page_with_data.at('//form[@name="FsdtL2Wform"]').inner_html.strip
311
+ if data.match(/^<!--/)
312
+ raise Error, "data downloaded looks like rubbish: #{data[0..20]}"
313
+ else
314
+ return data
315
+ end
316
+ end
317
+ end
318
+
319
+ #
320
+ # Fetch all the accounts from the main page. We assume that we are on the
321
+ # main page already (so this method should only be called from
322
+ # FirstDirect.initialize).
323
+ #
324
+ #--
325
+ # Balances look a bit like this:
326
+ #
327
+ # <table class="fdBalancesTable"..>
328
+ # <colgroup>
329
+ # <col..
330
+ # </colgroup>
331
+ # <thead>
332
+ # <tr>
333
+ # <th..>Account details</th>
334
+ # <th..>Limit</th>
335
+ # <th..>&nbsp;Balance</th>
336
+ # <td..>&nbsp;</td>
337
+ # </tr>
338
+ # </thead>
339
+ # <tbody>
340
+ # <tr>
341
+ # <td> <a..>1st Account</a><br> <a..>11-11-11&nbsp;11111111</a> </td>
342
+ # <td> £100.00<br> <a..>my limit</a> </td>
343
+ # <td> <strong>&nbsp;£100.00</strong> </td>
344
+ # <td> <a..>make payment</a><br> <a title="upgrade your account..> </td>
345
+ # </tr>
346
+ #
347
+ def initialize_accounts
348
+ @accounts = []
349
+ @agent.current_page.search('//table[@class="fdBalancesTable"]/tbody/tr').each do |row|
350
+ @accounts << b = Account.new
351
+ b.parent = self
352
+ b.name, b.number, b.balance = [
353
+ row.at('td[1]/a[1]'),
354
+ row.at('td[1]/a[2]'),
355
+ row.at('td[3]/strong')
356
+ ].map do |v|
357
+ require 'cgi'
358
+ v.inner_html.gsub('&nbsp;', ' ').strip.gsub('&pound;', '£')
359
+ end
360
+ b.link = Helpers.strip_js( row.at('td[1]/a[1]') )
361
+ end
362
+ end
363
+
364
+ #
365
+ # Fetch the first account with the given name.
366
+ #
367
+ def account(name)
368
+ if a = @accounts.select{ |a| a.name == name }.first
369
+ return a
370
+ else
371
+ raise Error, "no account found with name '#{a}'"
372
+ end
373
+ end
374
+ end
metadata ADDED
@@ -0,0 +1,80 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: firstdirect
3
+ version: !ruby/object:Gem::Version
4
+ version: "0.1"
5
+ platform: ruby
6
+ authors:
7
+ - Edward Speyer
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2008-07-07 00:00:00 +01:00
13
+ default_executable:
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: mechanize
17
+ type: :runtime
18
+ version_requirement:
19
+ version_requirements: !ruby/object:Gem::Requirement
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: "0"
24
+ version:
25
+ - !ruby/object:Gem::Dependency
26
+ name: hoe
27
+ type: :development
28
+ version_requirement:
29
+ version_requirements: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 1.7.0
34
+ version:
35
+ description: ""
36
+ email:
37
+ - edward.rffd@example.com
38
+ executables: []
39
+
40
+ extensions: []
41
+
42
+ extra_rdoc_files:
43
+ - Manifest.txt
44
+ - README.txt
45
+ - License.txt
46
+ files:
47
+ - Manifest.txt
48
+ - README.txt
49
+ - Rakefile
50
+ - lib/firstdirect.rb
51
+ - License.txt
52
+ has_rdoc: true
53
+ homepage: Internet banking with First Direct using Ruby.
54
+ post_install_message:
55
+ rdoc_options:
56
+ - --main
57
+ - README.txt
58
+ require_paths:
59
+ - lib
60
+ required_ruby_version: !ruby/object:Gem::Requirement
61
+ requirements:
62
+ - - ">="
63
+ - !ruby/object:Gem::Version
64
+ version: "0"
65
+ version:
66
+ required_rubygems_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: "0"
71
+ version:
72
+ requirements: []
73
+
74
+ rubyforge_project: firstdirect
75
+ rubygems_version: 1.2.0
76
+ signing_key:
77
+ specification_version: 2
78
+ summary: Internet banking with First Direct using Ruby
79
+ test_files: []
80
+