Add dateTime parsers (#6)

### Added
- Add custom exception
- Add date time parser for status messages

Author: iMicknl

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.0 - 2018-04-22
+### Added
+- Add custom exception
+- Add date time parser for status messages
+- Initial public release
+
 ## 0.3 - 2018-02-04
 ### Fixed
 - Better exception handling & less code duplication

README.md

@@ -17,8 +17,12 @@ postnl = PostNL_API('email@domain.com', 'password')
 shipments = postnl.get_relevant_shipments()
 
 for shipment in shipments:
-    print (shipment['key'])
+    name = shipment['settings']['title']    
+    status = shipment['status']['formatted']['short']
+    status = postnl.parse_datetime(status, '%d-%m-%Y', '%H:%M')
 
+    print (shipment['key'] + ' ' + name + ' ' + status)
+    
 # Get letters
 letters = postnl.get_letters()
 print (letters)

postnl_api/postnl_api.py

@@ -1,7 +1,8 @@
 """ Python wrapper for the PostNL API """
 
-import logging
 from datetime import datetime, timedelta
+import re
+
 import requests
 
 BASE_URL = 'https://jouw.postnl.nl'
@@ -17,6 +18,11 @@
     'user-agent': 'PostNL/1 CFNetwork/889.3 Darwin/17.2.0',
 }
 
+
+class UnauthorizedException(Exception):
+    pass
+
+
 class PostNL_API(object):
     """ Interface class for the PostNL API """
 
@@ -39,10 +45,10 @@ def __init__(self, user, password):
             data = response.json()
 
         except Exception:
-            raise(Exception)
+            raise(UnauthorizedException())
 
         if 'error' in data:
-            raise Exception(data['error'])
+            raise UnauthorizedException(data['error'])
 
         self._access_token = data['access_token']
         self._refresh_token = data['refresh_token']
@@ -70,10 +76,25 @@ def _refresh_access_token(self):
         response = requests.request(
             'POST', AUTHENTICATE_URL, data=payload, headers=DEFAULT_HEADER)
 
-        data = response.json()  # TODO Add error handling
+        data = response.json()
 
         self._access_token = data['access_token']
 
+    def parse_datetime(self, text, dateFormat='%d-%m-%Y', timeFormat='%H:%M'):
+
+        def parse_date(date):
+            return datetime.strptime(date.group(1)
+                                     .replace(' ', '')[:-6], '%Y-%m-%dT%H:%M:%S').strftime(dateFormat)
+
+        def parse_time(date):
+            return datetime.strptime(date.group(1)
+                                     .replace(' ', '')[:-6], '%Y-%m-%dT%H:%M:%S').strftime(timeFormat)
+
+        text = re.sub(r'{(?:Date|dateAbs):(.*?)}', parse_date, text)
+        text = re.sub(r'{(?:time):(.*?)}', parse_time, text)
+
+        return text
+
     def get_shipments(self):
         """ Retrieve shipments """
 
@@ -156,7 +177,7 @@ def validate_letters(self):
 
     def get_letters(self):
         """ Retrieve letters """
-        
+
         self._is_token_expired()
 
         headers = {
@@ -237,7 +258,7 @@ def get_relevant_letters(self):
                 expected_delivery_date = datetime.strptime(
                     letter['expectedDeliveryDate'][:19], "%Y-%m-%dT%H:%M:%S")
 
-                if expected_delivery_date.date() == datetime.today().date():
+                if expected_delivery_date.date() >= datetime.today().date():
                     relevant_letters.append(letter)
 
         return relevant_letters

postnl_api/test_postnl_api.py

@@ -1,6 +1,7 @@
 import argparse
 from postnl_api import PostNL_API
 
+
 def main():
     """Main function."""
     parser = argparse.ArgumentParser(description="Run the test for PostNL_API")
@@ -19,17 +20,18 @@ def main():
     # Get relevant shipments
     print("Getting shipments")
     shipments = postnl.get_relevant_shipments()
-    print("Number of shipments: ",len(shipments))
+    print("Number of shipments: ", len(shipments))
     print("Listing shipments:")
     for shipment in shipments:
         print (shipment['key'])
 
     # Get letters
     print("Getting letters")
     letters = postnl.get_letters()
-    print("Number of letters: ",len(letters))
+    print("Number of letters: ", len(letters))
     print("Listing letters:")
     print (letters)
 
+
 if __name__ == '__main__':
-    main()
+    main()

setup.py

@@ -1,12 +1,12 @@
 from setuptools import setup, find_packages
 
 setup(name='postnl_api',
-      version='0.3',
+      version='1.0',
       description='Python wrapper for the PostNL API, a way to track packages using their online portal',
       url='https://github.com/imicknl/python-postnl-api',
       author='Mick Vleeshouwer',
       author_email='mick@imick.nl',
       license='MIT',
       install_requires=['requests>=2.0'],
       packages=find_packages(),
-      zip_safe=True)
+      zip_safe=True)