replace CH class with function

config/settings/base.py

@@ -189,7 +189,7 @@
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
 # Companies House API
-COMPANIES_HOUSE_API_KEY = env("COMPANIES_HOUSE_API_KEY", default=None)
+COMPANIES_HOUSE_API_KEY = env.str("COMPANIES_HOUSE_API_KEY", default="")
 
 # GOV NOTIFY
 GOV_NOTIFY_API_KEY = env.str("GOV_NOTIFY_API_KEY")

report_a_breach/core/services/ch_proxy.py

@@ -2,26 +2,32 @@
 
 import requests
 from django.conf import settings
+from exceptions import CompaniesHouseException
 
 COMPANIES_HOUSE_BASIC_AUTH = base64.b64encode(  # /PS-IGNORE
     bytes(f"{settings.COMPANIES_HOUSE_API_KEY}:", "utf-8")
 ).decode("utf-8")
 COMPANIES_HOUSE_BASE_DOMAIN = "https://api.companieshouse.gov.uk"
 
 
-class CompaniesHouseApi:
-    def get_details_from_companies_house(self, registration_number):
-        """
-        Retrieves and returns details of a company from Companies House
-        using registration number that is passed in.
-        """
+def get_details_from_companies_house(self, registration_number):
+    """
+    Retrieves and returns details of a company from Companies House
+    using registration number that is passed in.
+    """
 
-        if registration_number:
-            headers_get_company = {"Authorization": f"Basic {COMPANIES_HOUSE_BASIC_AUTH}"}
-            response = requests.get(
-                f"{COMPANIES_HOUSE_BASE_DOMAIN}/company/{registration_number}",
-                headers=headers_get_company,
+    if registration_number:
+        headers_get_company = {"Authorization": f"Basic {COMPANIES_HOUSE_BASIC_AUTH}"}
+        response = requests.get(
+            f"{COMPANIES_HOUSE_BASE_DOMAIN}/company/{registration_number}",
+            headers=headers_get_company,
+        )
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise CompaniesHouseException(
+                f"Companies House API request failed: {response.status_code}"
             )
-            if response.status_code == 200:
-                return response.json()
-        return {}
+    else:
+        raise CompaniesHouseException("No registration number provided for Companies House API")
+    return {}

report_a_breach/exceptions.py

@@ -0,0 +1,4 @@
+class CompaniesHouseException(Exception):
+    """Exception raised when issue encountered with Companies House API"""
+
+    pass