CHANGELOG

Signed-off-by: Finbarrs Oketunji <f@finbarrs.eu>

Author: 0xnu

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.0.1 - 2023-09-21
+* Updated: test.py, README.md, and LONG_DESCRIPTION.rst
+
 ## 1.0.0 - 2023-09-19
 * New MOT History API
 

LONG_DESCRIPTION.rst

@@ -23,14 +23,46 @@ You can install this package by using the pip tool and installing:
 
 .. code-block:: bash
 
-	$ pip install mot-history-api-py-sdk
+	pip install mot-history-api-py-sdk
 
 Or:
 
 .. code-block:: bash
 
-	$ easy_install mot-history-api-py-sdk
+	easy_install mot-history-api-py-sdk
 
+Install from source with:
+
+.. code-block:: bash
+
+    python setup.py install --user
+
+Or, `sudo python setup.py install` to install the package for all users.
+
+Tests
+------
+
+Export environment variables:
+
+.. code-block:: bash
+    export MOT_CLIENT_ID=
+    export MOT_CLIENT_SECRET=
+    export MOT_API_KEY=
+
+Now, you can execute this command: `python3 -m test`
+
+Unset the environment variables after completing the tests:
+
+.. code-block:: bash
+    unset MOT_CLIENT_ID && unset MOT_CLIENT_SECRET && unset MOT_API_KEY
+
+Developers/Engineers can run tests in two scenarios:
+
++ **With real credentials**: They set the environment variables, and the tests use the live API connection.
+
++ **Without credentials**: The tests run using a mock client, allowing basic functionality checks without a live API connection.
+
+The flexibility supports real integration testing and quick, credential-free checks during development.
 
 Request MOT History API Key
 ---------------------------

README.md

@@ -46,6 +46,14 @@ Unset the environment variables after completing the tests:
 unset MOT_CLIENT_ID && unset MOT_CLIENT_SECRET && unset MOT_API_KEY
 ```
 
+Developers/Engineers can run tests in two scenarios:
+
++ **With real credentials**: They set the environment variables, and the tests use the live API connection.
+
++ **Without credentials**: The tests run using a mock client, allowing basic functionality checks without a live API connection.
+
+The flexibility supports real integration testing and quick, credential-free checks during development.
+
 ### Setting up a MOT History API
 
 You can use this support form to request an [API Key](https://documentation.history.mot.api.gov.uk/mot-history-api/register).

test.py

@@ -7,20 +7,35 @@
 import os
 import sys
 from pprint import pprint
-from motapi import MOTDataClient
+from typing import Optional
+from unittest.mock import Mock
 
-# Retrieve credentials from environment variables
-CLIENT_ID = os.environ.get("MOT_CLIENT_ID")
-CLIENT_SECRET = os.environ.get("MOT_CLIENT_SECRET")
-API_KEY = os.environ.get("MOT_API_KEY")
+# It attempts to import MOTDataClient
+# but falls back to a mock if it is present.
+try:
+    from motapi import MOTDataClient
+except ImportError:
+    MOTDataClient = Mock()
 
-# Please set credentials
-if not CLIENT_ID or not CLIENT_SECRET or not API_KEY:
-    print("Error: Please set MOT_CLIENT_ID, MOT_CLIENT_SECRET, and MOT_API_KEY environment variables.")
-    sys.exit(1)
+# Retrieve credentials from environment variables
+CLIENT_ID: Optional[str] = os.environ.get("MOT_CLIENT_ID")
+CLIENT_SECRET: Optional[str] = os.environ.get("MOT_CLIENT_SECRET")
+API_KEY: Optional[str] = os.environ.get("MOT_API_KEY")
 
 # Initialize the client
-client = MOTDataClient(CLIENT_ID, CLIENT_SECRET, API_KEY)
+if all([CLIENT_ID, CLIENT_SECRET, API_KEY]):
+    client = MOTDataClient(
+        client_id=CLIENT_ID,
+        client_secret=CLIENT_SECRET,
+        api_key=API_KEY
+    )
+else:
+    print("Warning: Using mock client as credentials are not set.")
+    client = Mock()
+    # Setup mock responses
+    client.get_vehicle_data.return_value = {"mock": "vehicle data"}
+    client.get_bulk_download_info.return_value = {"mock": "bulk download info"}
+    client.renew_client_secret.return_value = "mock_new_secret"
 
 def test_get_vehicle_data_by_registration():
     """Test retrieving vehicle data by registration number."""