Merge pull request #5 from iMicknl/refresh_acces_tokens

Refresh acces tokens automatically

Author: iMicknl

CHANGELOG.md

@@ -4,6 +4,10 @@ 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/).
 
+## 0.3 - 2018-02-04
+### Fixed
+- Better exception handling & less code duplication
+
 ## 0.2 - 2018-01-24
 ### Added
 - Basic test function

README.md

@@ -1,5 +1,4 @@
 # python-postnl-api
-
 (Unofficial) Python wrapper for the PostNL API (Dutch Postal Services), which can be used to track packages and letter deliveries. You can use your [jouw.postnl.nl](http://jouw.postnl.nl) credentials to use the API. 
 
 ## Quick test
@@ -25,9 +24,11 @@ letters = postnl.get_letters()
 print (letters)
 ```
 
+## Miscellaneous
+[This blogpost](https://imick.nl/reverse-engineering-the-postnl-consumer-api/) describes the process of figuring out the API endpoints and shows how this can be done for other API's.
+
 ## Changelog
-See the [CHANGELOG](./CHANGELOG.MD) file.
+See the [CHANGELOG](./CHANGELOG.md) file.
 
 ## License
 MIT
-

postnl_api/postnl_api.py

@@ -47,9 +47,18 @@ def __init__(self, user, password):
         self._access_token = data['access_token']
         self._refresh_token = data['refresh_token']
         self._token_expires_in = data['expires_in']
-        self._token_expires_at = datetime.now() + timedelta(0, data['expires_in'])
+        self._token_expires_at = datetime.now(
+        ) + timedelta(0, data['expires_in'])
 
-    def refresh_token(self):
+    def _is_token_expired(self):
+        """ Check if access token is expired """
+        if (datetime.now() > self._token_expires_at):
+            self._refresh_access_token()
+            return True
+
+        return False
+
+    def _refresh_access_token(self):
         """ Refresh access_token """
 
         payload = {
@@ -61,13 +70,15 @@ def refresh_token(self):
         response = requests.request(
             'POST', AUTHENTICATE_URL, data=payload, headers=DEFAULT_HEADER)
 
-        data = response.json()
+        data = response.json()  # TODO Add error handling
 
         self._access_token = data['access_token']
 
     def get_shipments(self):
         """ Retrieve shipments """
 
+        self._is_token_expired()
+
         headers = {
             'authorization': 'Bearer ' + self._access_token
         }
@@ -76,7 +87,7 @@ def get_shipments(self):
             'GET', SHIPMENTS_URL, headers={**headers, **DEFAULT_HEADER})
 
         if response.status_code == 401:
-            self.refresh_token()
+            self._refresh_access_token()
             shipments = self.get_shipments()
         else:
             shipments = response.json()
@@ -86,6 +97,8 @@ def get_shipments(self):
     def get_shipment(self, shipment_id):
         """ Retrieve single shipment by id """
 
+        self._is_token_expired()
+
         headers = {
             'authorization': 'Bearer ' + self._access_token
         }
@@ -94,7 +107,7 @@ def get_shipment(self, shipment_id):
             'GET', SHIPMENTS_URL + '/' + shipment_id, headers={**headers, **DEFAULT_HEADER})
 
         if response.status_code == 401:
-            self.refresh_token()
+            self._refresh_access_token()
             shipments = self.get_shipment(shipment_id)
         else:
             shipments = response.json()
@@ -104,6 +117,8 @@ def get_shipment(self, shipment_id):
     def get_profile(self):
         """ Retrieve profile """
 
+        self._is_token_expired()
+
         headers = {
             'authorization': 'Bearer ' + self._access_token
         }
@@ -112,7 +127,7 @@ def get_profile(self):
             'GET', PROFILE_URL, headers={**headers, **DEFAULT_HEADER})
 
         if response.status_code == 401:
-            self.refresh_token()
+            self._refresh_access_token()
             profile = self.get_profile()
         else:
             profile = response.json()
@@ -122,6 +137,8 @@ def get_profile(self):
     def validate_letters(self):
         """ Retrieve letter validation status """
 
+        self._is_token_expired()
+
         headers = {
             'authorization': 'Bearer ' + self._access_token
         }
@@ -130,7 +147,7 @@ def validate_letters(self):
             'GET', VALIDATE_LETTERS_URL, headers={**headers, **DEFAULT_HEADER})
 
         if response.status_code == 401:
-            self.refresh_token()
+            self._refresh_access_token()
             validation = self.validate_letters()
         else:
             validation = response.json()
@@ -139,16 +156,18 @@ def validate_letters(self):
 
     def get_letters(self):
         """ Retrieve letters """
+        
+        self._is_token_expired()
 
         headers = {
             'authorization': 'Bearer ' + self._access_token
         }
 
         response = requests.request(
             'GET', LETTERS_URL, headers={**headers, **DEFAULT_HEADER})
-            
+
         if response.status_code == 401:
-            self.refresh_token()
+            self._refresh_access_token()
             letters = self.get_letters()
         else:
             letters = response.json()
@@ -163,6 +182,8 @@ def get_letters(self):
     def get_letter(self, letter_id):
         """ Retrieve single letter by id """
 
+        self._is_token_expired()
+
         headers = {
             'authorization': 'Bearer ' + self._access_token
         }
@@ -173,9 +194,9 @@ def get_letter(self, letter_id):
         if response.status_code == 200:
             letter = response.json()
         elif response.status_code == 401:
-            self.refresh_token()
+            self._refresh_access_token()
             letter = self.get_letter(letter_id)
-        else: 
+        else:
             raise Exception('Unknown Error')
 
         return letter

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 setup(name='postnl_api',
-      version='0.2',
+      version='0.3',
       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',