options added for error logging and api calls

Author: samnotsowise

src/Services/CyclopsService.php

@@ -23,13 +23,19 @@ class CyclopsService
 
     private $authorization;
 
+    private $enableLogging;
+
+    private $enableApi;
+
     public function __construct(int $brandId)
     {
         $this->brandId = $brandId;
         $this->httpClient = new CurlHttpClient();
         $settings = CyclopsSettings::singleton();
         $this->cyclopsUrl = $settings->cyclopsUrl;
         $this->authorization = base64_encode($settings->authorizationUsername . ':' . $settings->authorizationPassword);
+        $this->enableLogging = $settings->enableLogging;
+        $this->enableApi = $settings->enableApi;
     }
 
     private function logCyclopsErrors(HttpRequest $request, HttpResponse $response)
@@ -38,29 +44,14 @@ private function logCyclopsErrors(HttpRequest $request, HttpResponse $response)
         if (isset($loggableRequest->getHeaders()['Authorization'])) {
             $loggableRequest->addHeader('Authorization', '[[REDACTED]]');
         }
-        error_log('Cyclops exception response: ' . $response->getResponseCode() . ' ' . $response->getResponseBody() .
-            "\n Request: " . var_export($loggableRequest, true));
-    }
-
-    private function handleResponseCodes(HttpResponse $response, HttpRequest $request)
-    {
-        switch ($response->getResponseCode()) {
-            case 200:
-                break;
-            case 403:
-                $this->logCyclopsErrors($request, $response);
-                throw new UserForbiddenException();
-                break;
-            case 404:
-                $this->logCyclopsErrors($request, $response);
-                throw new CustomerNotFoundException();
-                break;
-            case 409:
-                $this->logCyclopsErrors($request, $response);
-                throw new ConflictException();
-            default:
-                $this->logCyclopsErrors($request, $response);
-                throw new CyclopsException();
+        if ($this->enableLogging) {
+            error_log('Cyclops exception response: '
+                . $response->getResponseCode()
+                . ' '
+                . $response->getResponseBody()
+                .
+                "\n Request: "
+                . var_export($loggableRequest, true));
         }
     }
 
@@ -79,8 +70,6 @@ public function loadCustomer(CyclopsIdentityEntity $identityEntity): CustomerEnt
             $response = $this->doCyclopsRequest($request);
         }
 
-        $this->handleResponseCodes($response, $request);
-
         $responseBody = json_decode($response->getResponseBody());
         if ($responseBody) {
             $identityEntity->id = $responseBody->data[0]->cyclopsId;
@@ -93,18 +82,40 @@ public function loadCustomer(CyclopsIdentityEntity $identityEntity): CustomerEnt
 
     protected function doCyclopsRequest(HttpRequest $request)
     {
-        return $this->httpClient->getResponse($request);
+        if (!$this->enableApi) {
+            throw new CyclopsException('Cyclops API disabled');
+        }
+
+        $response = $this->httpClient->getResponse($request);
+
+        switch ($response->getResponseCode()) {
+            case 200:
+                break;
+            case 403:
+                $this->logCyclopsErrors($request, $response);
+                throw new UserForbiddenException();
+                break;
+            case 404:
+                $this->logCyclopsErrors($request, $response);
+                throw new CustomerNotFoundException();
+                break;
+            case 409:
+                $this->logCyclopsErrors($request, $response);
+                throw new ConflictException();
+            default:
+                $this->logCyclopsErrors($request, $response);
+                throw new CyclopsException();
+        }
+
+        return $response;
     }
 
     public function deleteCustomer(CyclopsIdentityEntity $identityEntity)
     {
         $url = $this->cyclopsUrl . "customer/{$identityEntity->id}";
         $request = new HttpRequest($url, 'delete');
         $request->addHeader('Authorization', 'Basic ' . $this->authorization);
-        $response = $this->doCyclopsRequest($request);
-
-        $this->handleResponseCodes($response, $request);
-        return $response;
+        return $this->doCyclopsRequest($request);
     }
 
     public function getBrandOptInStatus(CustomerEntity $customerEntity): bool
@@ -115,8 +126,6 @@ public function getBrandOptInStatus(CustomerEntity $customerEntity): bool
         $request->addHeader('Authorization', 'Basic ' . $this->authorization);
         $response = $this->doCyclopsRequest($request);
 
-        $this->handleResponseCodes($response, $request);
-
         if ($responseBody = json_decode($response->getResponseBody())) {
             foreach ($responseBody->data as $data) {
                 if ($data->brandId == $this->brandId) {
@@ -136,10 +145,7 @@ public function setBrandOptInStatus(CustomerEntity $customerEntity)
         $request = new HttpRequest($url, 'post', $brands);
         $request->addHeader('Authorization', 'Basic ' . $this->authorization);
         $request->addHeader('Content-Type', 'application/json');
-        $response = $this->doCyclopsRequest($request);
-
-        $this->handleResponseCodes($response, $request);
-        return $response;
+        return $this->doCyclopsRequest($request);
     }
 
     public function getBrandOptInStatusChanges(\DateTime $startingDate, int $page = 1)
@@ -149,8 +155,6 @@ public function getBrandOptInStatusChanges(\DateTime $startingDate, int $page =
         $request->addHeader('Authorization', 'Basic ' . $this->authorization);
         $response = $this->doCyclopsRequest($request);
 
-        $this->handleResponseCodes($response, $request);
-
         $changes = [];
         if ($responseBody = json_decode($response->getResponseBody())) {
             foreach ($responseBody->data as $data) {

src/Settings/CyclopsSettings.php

@@ -7,6 +7,8 @@ class CyclopsSettings
     public $cyclopsUrl = '';
     public $authorizationUsername = '';
     public $authorizationPassword = '';
+    public $enableLogging = false;
+    public $enableApi = false;
 
     static $singleton;
 
@@ -17,4 +19,4 @@ public static function singleton()
         }
         return self::$singleton;
     }
-}
+}