Added module gls

This module allows to track parcels sent with GLS

Currently, only some status codes are handled, because the others are not known.

Signed-off-by: Matthieu Weber <mweber+weboob@free.fr>
Signed-off-by: Romain Bignon <romain@symlink.me>

modules/gls/__init__.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2015      Matthieu Weber
+#
+# 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 .module import GLSModule
+
+
+__all__ = ['GLSModule']

modules/gls/browser.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2015      Matthieu Weber
+#
+# 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.browser import PagesBrowser, URL
+from weboob.browser.exceptions import HTTPNotFound
+from weboob.capabilities.parcel import ParcelNotFound
+
+from .pages import SearchPage
+
+
+class GLSBrowser(PagesBrowser):
+    BASEURL = 'https://gls-group.eu'
+
+    search_page = URL('/app/service/open/rest/EU/en/rstt001\?match=(?P<id>.+)', SearchPage)
+
+    def get_tracking_info(self, _id):
+        try:
+            return self.search_page.go(id=_id).get_info(_id)
+        except HTTPNotFound:
+            raise ParcelNotFound("No such ID: %s" % _id)

modules/gls/module.py

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2015      Matthieu Weber
+#
+# 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.backend import Module
+from weboob.capabilities.parcel import CapParcel
+
+from .browser import GLSBrowser
+
+
+__all__ = ['GLSModule']
+
+
+class GLSModule(Module, CapParcel):
+    NAME = 'gls'
+    DESCRIPTION = u'GLS website'
+    MAINTAINER = u'Matthieu Weber'
+    EMAIL = 'mweber+weboob@free.fr'
+    LICENSE = 'AGPLv3+'
+    VERSION = '1.1'
+
+    BROWSER = GLSBrowser
+
+    def get_parcel_tracking(self, id):
+        """
+        Get information abouut a parcel.
+
+        :param id: ID of the parcel
+        :type id: :class:`str`
+        :rtype: :class:`Parcel`
+        :raises: :class:`ParcelNotFound`
+        """
+        return self.browser.get_tracking_info(id)

modules/gls/pages.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2015      Matthieu Weber
+#
+# 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 dateutil.parser import parse as parse_date
+
+from weboob.browser.pages import JsonPage
+from weboob.capabilities.parcel import Parcel, Event
+
+STATUSES = {
+    "DELIVEREDPS": Parcel.STATUS_ARRIVED,
+    "DELIVERED": Parcel.STATUS_ARRIVED,
+}
+
+
+class SearchPage(JsonPage):
+    def get_info(self, _id):
+        p = Parcel(_id)
+        events = self.doc["tuStatus"][0]["history"]
+        p.history = [self.build_event(i, tr) for i, tr in enumerate(events)]
+        p.status = self.guess_status(self.doc["tuStatus"][0]["progressBar"]["statusInfo"])
+        p.info = self.doc["tuStatus"][0]["progressBar"]["statusText"]
+        return p
+
+    def guess_status(self, code):
+        return STATUSES.get(code, Parcel.STATUS_UNKNOWN)
+
+    def build_event(self, index, data):
+        event = Event(index)
+        date = "%s %s" % (data["date"], data["time"])
+        event.date = parse_date(date, dayfirst=False)
+        event.location = ", ".join(
+            [unicode(data["address"][field]) for field in ["city", "countryName"] if data["address"][field]])
+        event.activity = unicode(data["evtDscr"])
+        return event

modules/gls/test.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2015      Matthieu Weber
+#
+# 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
+from weboob.capabilities.parcel import ParcelNotFound
+
+
+class GLSTest(BackendTest):
+    MODULE = 'gls'
+
+    def test_gls(self):
+        self.assertRaises(ParcelNotFound, self.backend.get_parcel_tracking, "foo")