New relaiscolis module

modules/relaiscolis/__init__.py

+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2017      Mickaël Thomas
+#
+# 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 __future__ import unicode_literals
+
+
+from .module import RelaiscolisModule
+
+
+__all__ = ['RelaiscolisModule']

modules/relaiscolis/browser.py

+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2017      Mickaël Thomas
+#
+# 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 collections import OrderedDict
+
+from dateutil.parser import parse as parse_date
+
+from weboob.capabilities.parcel import Event, ParcelNotFound
+from weboob.browser.browsers import DomainBrowser
+
+
+__all__ = ['RelaiscolisBrowser']
+
+
+class RelaiscolisBrowser(DomainBrowser):
+    BASEURL = 'https://www.relaiscolis.com'
+
+    def iter_events(self, merchant, code, name):
+        data = dict(
+            codeEnseigne=merchant,
+            nomClient=name,
+            typeRecherche='EXP',
+            valeur=code
+        )
+        # Ref: https://www.relaiscolis.com/js/lib/suivi.js
+        req = self.open('/suivi-de-colis/index/tracking/', data=data)
+        resp = None
+        try:
+            resp = req.json()
+            if resp and 'error' in resp:
+                raise ParcelNotFound(resp['error']['msg'])
+        except (ValueError, KeyError):
+            self.raise_for_status(req)
+            raise
+        else:
+            self.raise_for_status(req)
+
+        def ensure_list(data):
+            if isinstance(data, list):
+                return data
+            return [data]
+
+        parcel_data = ensure_list(resp['Colis']['Colis'])[-1]
+        events_data = ensure_list(parcel_data['ListEvenements'].get('Evenement', []))
+
+        final_location = None
+        try:
+            relay = resp['Relais']['Relais']
+            name = relay['Nom'].strip()
+            city = relay['Commune'].strip()
+            final_location = ' '.join((name, city))
+        except KeyError:
+            pass
+
+        for event_data in events_data:
+            event = Event()
+            event.date = parse_date(event_data['Date'].strip())
+            event.activity = event_data['Libelle'].strip()
+
+            if final_location and (
+                    "Votre colis est disponible" in event.activity):
+                event.location = final_location
+            yield event
+
+    def get_merchants(self):
+        req = self.open('/suivi-de-colis/index/getEnseignes/')
+        resp = req.json()
+
+        return OrderedDict(
+            (merchant['Code'], '{Nom} ({Code})'.format(**merchant))
+            for merchant in resp
+            if merchant['Nom']
+        )

modules/relaiscolis/module.py

+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2017      Mickaël Thomas
+#
+# 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 __future__ import unicode_literals
+
+from weboob.tools.backend import Module, BackendConfig
+from weboob.capabilities.base import NotAvailable
+from weboob.capabilities.parcel import CapParcel, Parcel, ParcelNotFound
+from weboob.tools.value import Value
+from weboob.exceptions import BrowserQuestion
+
+from .browser import RelaiscolisBrowser
+
+__all__ = ['RelaiscolisModule']
+
+
+class RelaiscolisModule(Module, CapParcel):
+    NAME = 'relaiscolis'
+    DESCRIPTION = 'Relais colis parcel tracking website'
+    MAINTAINER = 'Mickaël Thomas'
+    EMAIL = 'mickael9@gmail.com'
+    LICENSE = 'AGPLv3+'
+    VERSION = '1.4'
+    CONFIG = BackendConfig(
+        Value('last_name', label='Last name'),
+        Value('merchant', label='Merchant (leave blank)', default=''),
+    )
+
+    BROWSER = RelaiscolisBrowser
+
+    def get_parcel_tracking(self, _id):
+        """
+        Get information about a parcel.
+
+        :param _id: _id of the parcel
+        :type _id: :class:`str`
+        :rtype: :class:`Parcel`
+        :raises: :class:`ParcelNotFound`
+        """
+        # Tracking number format:
+        # - 2 chars: optional merchant identifier (eg, AM for Amazon, 85 for cdiscount, ...)
+        # - 10 digits: shipment tracking number
+        # - 2 digits: optional suffix, seems to always be "01" when present but is never sent to the API
+        #
+        # Many merchants seem to give only the 10 digits tracking number so the user needs to
+        # manually select the merchant from a list in that case.
+
+        merchant = None
+        code = None
+
+        _id = _id.strip().upper()
+
+        if len(_id) == 10:
+            code = _id
+        elif len(_id) in (12, 14):
+            merchant = _id[:2]
+            code = _id[2:12]
+        else:
+            raise ParcelNotFound(
+                "Tracking number must be 10, 12 or 14 characters long."
+            )
+
+        merchant = merchant or self.config['merchant'].get()
+
+        if not merchant:
+            # No merchant info in the tracking number
+            # we have to ask the user to select it
+            merchants = self.browser.get_merchants()
+            raise BrowserQuestion(Value(
+                'merchant', label='Merchant prefix (prepend to tracking number): ', tiny=False,
+                choices=merchants,
+            ))
+
+        self.config['merchant'].set(None)
+        name = self.config['last_name'].get()[:4].ljust(4).upper()
+
+        events = list(self.browser.iter_events(merchant, code, name))
+
+        parcel = Parcel(merchant + code)
+        parcel.arrival = NotAvailable
+
+        # This is what the legacy tracking website used to show
+        # when there are no events yet
+        parcel.info = "Votre commande est en cours d'acheminement dans notre réseau."
+
+        parcel.history = events
+        parcel.status = Parcel.STATUS_IN_TRANSIT
+
+        if not events:
+            parcel.status = Parcel.STATUS_PLANNED
+            return parcel
+
+        parcel.info = events[0].activity
+
+        arrived_event = next((event for event in events
+                             if "Votre colis est disponible" in event.activity),
+                             None)
+
+        if arrived_event:
+            parcel.status = Parcel.STATUS_ARRIVED
+            parcel.arrival = arrived_event.date
+
+        return parcel

tools/py3-compatible.modules

@@ -75,6 +75,7 @@ pornhub/
 ratp/
 razibus/
 regionsjob/
+relaiscolis/
 seloger/
 senscritique/
 societegenerale/