add module caissedepargne (closes #787)

modules/caissedepargne/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2012 Romain Bignon
+#
+# This file is part of weboob.
+#
+# weboob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# weboob is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with weboob. If not, see <http://www.gnu.org/licenses/>.
+
+
+from .backend import CaisseEpargneBackend
+
+__all__ = ['CaisseEpargneBackend']

modules/caissedepargne/backend.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2012 Romain Bignon
+#
+# This file is part of weboob.
+#
+# weboob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# weboob is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with weboob. If not, see <http://www.gnu.org/licenses/>.
+
+
+from weboob.capabilities.bank import ICapBank, AccountNotFound
+from weboob.tools.backend import BaseBackend, BackendConfig
+from weboob.tools.value import ValueBackendPassword
+
+from .browser import CaisseEpargne
+
+
+__all__ = ['CaisseEpargneBackend']
+
+
+class CaisseEpargneBackend(BaseBackend, ICapBank):
+    NAME = 'caissedepargne'
+    MAINTAINER = 'Romain Bignon'
+    EMAIL = 'romain@weboob.org'
+    VERSION = '0.d'
+    DESCRIPTION = u'Caisse d\'Épargne French bank website'
+    LICENSE = 'AGPLv3+'
+    CONFIG = BackendConfig(ValueBackendPassword('login',    label='Account ID', masked=False),
+                           ValueBackendPassword('password', label='Password', regexp='\d+'))
+    BROWSER = CaisseEpargne
+
+    def create_default_browser(self):
+        return self.create_browser(self.config['login'].get(),
+                                   self.config['password'].get())
+
+    def iter_accounts(self):
+        with self.browser:
+            return self.browser.get_accounts_list()
+
+    def get_account(self, _id):
+        with self.browser:
+            account = self.browser.get_account(_id)
+
+        if account:
+            return account
+        else:
+            raise AccountNotFound()
+
+    def iter_history(self, account):
+        with self.browser:
+            return self.browser.get_history(account)

modules/caissedepargne/browser.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2012 Romain Bignon
+#
+# This file is part of weboob.
+#
+# weboob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# weboob is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with weboob. If not, see <http://www.gnu.org/licenses/>.
+
+
+from urlparse import urlsplit
+
+from weboob.tools.browser import BaseBrowser, BrowserIncorrectPassword
+
+from .pages import LoginPage, IndexPage
+
+
+__all__ = ['CaisseEpargne']
+
+
+class CaisseEpargne(BaseBrowser):
+    DOMAIN = 'caisse-epargne.fr'
+    PROTOCOL = 'https'
+    PAGES = {'https://[^/]+.caisse-epargne.fr/particuliers/ind_pauthpopup.aspx.*':          LoginPage,
+             'https://[^/]+.caisse-epargne.fr/Portail.aspx':                                IndexPage,
+            }
+
+    def is_logged(self):
+        return self.page and not self.is_on_page(LoginPage)
+
+    def home(self):
+        self.location('https://www.caisse-epargne.fr/particuliers/ind_pauthpopup.aspx?mar=101&reg=&fctpopup=auth&cv=0')
+
+    def login(self):
+        """
+        Attempt to log in.
+        Note: this method does nothing if we are already logged in.
+        """
+        assert isinstance(self.username, basestring)
+        assert isinstance(self.password, basestring)
+
+        if self.is_logged():
+            return
+
+        if not self.is_on_page(LoginPage):
+            self.home()
+
+        self.page.login(self.username)
+        self.page.login2()
+        self.page.login3(self.password)
+
+        if not self.is_logged():
+            raise BrowserIncorrectPassword()
+
+        v = urlsplit(self.page.url)
+        self.DOMAIN = v.netloc
+
+    def get_accounts_list(self):
+        self.location(self.buildurl('/Portail.aspx'))
+
+        return self.page.get_list()
+
+    def get_account(self, id):
+        assert isinstance(id, basestring)
+
+        l = self.get_accounts_list()
+        for a in l:
+            if a.id == id:
+                return a
+
+        return None
+
+    def get_history(self, account):
+        if not self.is_on_page(IndexPage):
+            self.location(self.buildurl('/Portail.aspx'))
+
+        self.page.go_history(account.id)
+
+        assert self.is_on_page(IndexPage)
+
+        return self.page.get_history()

modules/caissedepargne/pages.py

@@ -0,0 +1,130 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2012 Romain Bignon
+#
+# This file is part of weboob.
+#
+# weboob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# weboob is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with weboob. If not, see <http://www.gnu.org/licenses/>.
+
+
+from decimal import Decimal
+import re
+
+from weboob.tools.mech import ClientForm
+from weboob.tools.browser import BasePage, BrokenPageError
+from weboob.capabilities.bank import Account
+from weboob.tools.capabilities.bank.transactions import FrenchTransaction
+
+
+__all__ = ['LoginPage', 'IndexPage']
+
+
+class LoginPage(BasePage):
+    def login(self, login):
+        self.browser.select_form(name='Main')
+        self.browser.set_all_readonly(False)
+        self.browser['ctl01$CC_ind_pauthpopup$ctl01$CC_ind_ident$ctl01$CC_ind_inputuserid_sup$txnuabbd'] = login
+        self.browser['__EVENTTARGET'] = 'ctl01$CC_ind_pauthpopup$ctl01$CC_ind_ident$ctl01$CC_ind_inputuserid_sup$btnValider'
+        self.browser.submit(nologin=True)
+
+    def login2(self):
+        self.browser.select_form(name='Main')
+        self.browser.set_all_readonly(False)
+        self.browser['__EVENTARGUMENT'] = 'idsrv=WE'
+        self.browser.submit(nologin=True)
+
+    def login3(self, passwd):
+        self.browser.select_form(name='Main')
+        self.browser['codconf'] = passwd
+        a = self.document.xpath('//a[@title="Valider"]')[0]
+        m = re.match("javascript:RedirectToDeiPart\('([^']+)'\);", a.attrib['href'])
+        if not m:
+            raise BrokenPageError('Unable to find validate URL')
+        self.browser.form.action = m.group(1)
+        self.browser.submit(nologin=True)
+
+class Transaction(FrenchTransaction):
+    PATTERNS = [(re.compile('^RET DAB (?P<text>.*?) RETRAIT DU (?P<dd>\d{2})(?P<mm>\d{2})(?P<yy>\d{2}).*'),
+                                                            FrenchTransaction.TYPE_WITHDRAWAL),
+                (re.compile('^RET DAB (?P<text>.*?) CARTE ?:.*'),
+                                                            FrenchTransaction.TYPE_WITHDRAWAL),
+                (re.compile('(\w+) (?P<dd>\d{2})(?P<mm>\d{2})(?P<yy>\d{2}) CB:[^ ]+ (?P<text>.*)'),
+                                                            FrenchTransaction.TYPE_CARD),
+                (re.compile('^VIR(EMENT)? (?P<text>.*)'),   FrenchTransaction.TYPE_TRANSFER),
+                (re.compile('^PRLV (?P<text>.*)'),          FrenchTransaction.TYPE_ORDER),
+                (re.compile('^CHEQUE.*'),                   FrenchTransaction.TYPE_CHECK),
+                (re.compile('^(CONVENTION \d+ )?COTIS(ATION)? (?P<text>.*)'),
+                                                            FrenchTransaction.TYPE_BANK),
+                (re.compile(r'^\* (?P<text>.*)'),           FrenchTransaction.TYPE_BANK),
+                (re.compile('^REMISE (?P<text>.*)'),        FrenchTransaction.TYPE_DEPOSIT),
+                (re.compile('^(?P<text>.*)( \d+)? QUITTANCE .*'),
+                                                            FrenchTransaction.TYPE_ORDER),
+               ]
+
+class IndexPage(BasePage):
+    ACCOUNT_TYPES = {u'Epargne liquide':            Account.TYPE_SAVINGS,
+                     u'Compte Courant':             Account.TYPE_CHECKING,
+                    }
+
+    def get_list(self):
+        for table in self.document.xpath('//table[@cellpadding="1"]'):
+            account_type = Account.TYPE_UNKNOWN
+            for tr in table.xpath('./tr'):
+                tds = tr.findall('td')
+                if tr.attrib.get('class', '') == 'DataGridHeader':
+                    account_type = self.ACCOUNT_TYPES.get(tds[1].text.strip(), Account.TYPE_UNKNOWN)
+                else:
+                    a = tds[1].find('a')
+                    m = re.match("^javascript:__doPostBack\('.*','HISTORIQUE_COMPTE&(\d+)'\)", a.attrib['href'])
+
+                    account = Account()
+                    account.id = m.group(1)
+                    account.label = unicode(a.text.strip())
+                    account.type = account_type
+                    account.balance = Decimal(FrenchTransaction.clean_amount(tds[-1].find('a').text.rstrip(' EUR')))
+                    yield account
+
+    def go_history(self, id):
+        self.browser.select_form(name='main')
+        self.browser.set_all_readonly(False)
+        self.browser['__EVENTTARGET'] = 'MM$SYNTHESE'
+        self.browser['__EVENTARGUMENT'] = 'HISTORIQUE_COMPTE&%s' % id
+        self.browser['MM$m_CH$IsMsgInit'] = '0'
+        self.browser.controls.append(ClientForm.TextControl('text', 'm_ScriptManager', {'value': ''}))
+        self.browser['m_ScriptManager'] = 'MM$m_UpdatePanel|MM$SYNTHESE'
+        self.browser.controls.remove(self.browser.find_control(name='Cartridge$imgbtnMessagerie', type='image'))
+        self.browser.controls.remove(self.browser.find_control(name='MM$m_CH$ButtonImageFondMessagerie', type='image'))
+        self.browser.controls.remove(self.browser.find_control(name='MM$m_CH$ButtonImageMessagerie', type='image'))
+        self.browser.submit()
+
+    def get_history(self):
+        i = 0
+        for tr in self.document.xpath('//table[@cellpadding="1"]/tr'):
+            if tr.attrib.get('class', '') == 'DataGridHeader':
+                continue
+
+            tds = tr.findall('td')
+
+            t = Transaction(i)
+
+            date = u''.join([txt.strip() for txt in tds[1].itertext()])
+            raw = u' '.join([txt.strip() for txt in tds[2].itertext()])
+            debit = u''.join([txt.strip() for txt in tds[-2].itertext()])
+            credit = u''.join([txt.strip() for txt in tds[-1].itertext()])
+
+            t.parse(date, raw)
+            t.set_amount(credit, debit)
+            yield t
+
+            i += 1

modules/caissedepargne/test.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2012 Romain Bignon
+#
+# This file is part of weboob.
+#
+# weboob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# weboob is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with weboob. If not, see <http://www.gnu.org/licenses/>.
+
+
+from weboob.tools.test import BackendTest
+
+class CaisseEpargneTest(BackendTest):
+    BACKEND = 'caissedepargne'
+
+    def test_caisse_epargne(self):
+        l = list(self.backend.iter_accounts())
+        if len(l) > 0:
+            a = l[0]
+            list(self.backend.iter_history(a))