new api structure applied

Author: mkorkmaz

composer.json

@@ -8,7 +8,8 @@
         "guzzlehttp/guzzle": "^6.3",
         "psr/http-message": "^1.0",
         "psr/log": "^1.0",
-        "monolog/monolog": "^1.23"
+        "monolog/monolog": "^1.23",
+        "robinvdvleuten/ulid": "^3.0"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.3",

src/API/Client.php

@@ -19,10 +19,12 @@
 use TK\API\Exception\RequestException;
 use TypeError;
 use GuzzleHttp\Exception\RequestException as GuzzleRequestException;
+use Ulid\Ulid;
 
 final class Client
 {
-
+    public const HTTP_POST = 'POST';
+    public const HTTP_GET = 'GET';
     /**
      * @var array
      */
@@ -40,18 +42,21 @@ final class Client
 
 
     /**
-     * @var string
+     * @var Environment
      */
-    private $apiUrl;
+    private $environment;
     /**
      * @var GuzzleClient
      */
     private $guzzleClient;
 
     private $logger;
+    private $languageCode;
+    private $airlineCode;
+
 
     private $headers = [
-        'User-Agent' => 'mkorkmaz/tk-api-php-client 1.0'
+        'User-Agent' => 'mkorkmaz/tk-api-php-client 2.0'
     ];
 
     /**
@@ -62,13 +67,28 @@ final class Client
      */
     public function __construct(Environment $environment, GuzzleClient $guzzleClient, LoggerInterface $logger)
     {
-        $this->apiUrl = $environment->getApiUrl();
+        $this->environment = $environment;
         $this->headers['apiKey'] = $environment->getApiKey();
         $this->headers['apiSecret'] = $environment->getApiSecret();
         $this->guzzleClient = $guzzleClient;
         $this->logger = $logger;
+        $this->airlineCode = 'TK';
+        $this->languageCode = 'TR';
     }
 
+    public function withAirlineCode(string $airlineCode) : self
+    {
+        $new = clone $this;
+        $new->airlineCode = $airlineCode;
+        return $new;
+    }
+
+    public function withLanguageCode(string $languageCode) : self
+    {
+        $new = clone $this;
+        $new->languageCode = $languageCode;
+        return $new;
+    }
     /**
      * @param $name
      * @param $arguments
@@ -147,34 +167,60 @@ private function request(EndpointInterface $endpoint) : array
     private function httpRequest(EndpointInterface $endpoint) : ResponseInterface
     {
         $this->headers = array_merge($this->headers, $endpoint->getHeaders());
-        $uri = $this->apiUrl . $endpoint->getEndpoint();
+           $queryParams = $this->getQueryParams($endpoint);
+
+        $uri = $this->environment->getApiUrl() . $endpoint->getEndpoint();
         $options = [];
-        $httpRequestMethod = strtolower($endpoint->getHttpRequestMethod());
-        if ($httpRequestMethod === 'post') {
+        $httpRequestMethod = $endpoint->getHttpRequestMethod();
+        if ($httpRequestMethod === self::HTTP_POST) {
             $this->headers['Content-Type'] = 'application/json';
-            $options['json'] = $endpoint->getQueryParams();
+            $options['json'] = $queryParams;
         }
-        if ($httpRequestMethod === 'get') {
-            $uri .= '?' . http_build_query($endpoint->getQueryParams());
+        if ($httpRequestMethod === self::HTTP_GET) {
+            $uri .= '?' . http_build_query($queryParams);
         }
+        $uri .=  '?apikey='. $this->environment->getApiKey();
         $options['headers'] = $this->headers;
-
         $this->logger->debug(
             'API call for :' . $endpoint->getEndpoint(),
             [
                 'httpRequestMethod' => $httpRequestMethod,
                 'uri' => $uri,
                 'headers' => $this->headers,
-                'queryParams' => $endpoint->getQueryParams()
+                'queryParams' => $queryParams
             ]
         );
         try {
-            return $this->guzzleClient->{$httpRequestMethod}($uri, $options);
+            return $this->guzzleClient->{strtolower($httpRequestMethod)}($uri, $options);
         } catch (GuzzleRequestException $e) {
-            $exceptionMessage = (string) $e->getResponse()->getBody()->getContents();
+            $exceptionMessage = (string) $e->getResponse()
+                ->getBody()
+                ->getContents();
             $message = sprintf('TK API REQUEST ERROR: %s', $exceptionMessage);
             $this->logger->error($message);
             throw new RequestException($message);
         }
     }
+
+    private function getQueryParams(EndpointInterface $endpoint) : array
+    {
+        $requiresRequestHeaders = $endpoint->doesRequireRequestHeaders();
+        $queryParams = $endpoint->getQueryParams();
+        if ($requiresRequestHeaders) {
+            $queryParams['requestHeader'] = [
+                'clientUsername' => $this->environment->getClientUsername(),
+                'clientTransactionId' => (string) Ulid::generate(),
+                'channel' => $this->environment->getChannel(),
+                'languageCode' => $queryParams['languageCode'] ?? $this->languageCode,
+                'airlineCode' => $queryParams['airlineCode'] ?? $this->airlineCode
+            ];
+            if (array_key_exists('languageCode', $queryParams)) {
+                unset($queryParams['languageCode']);
+            }
+            if (array_key_exists('airlineCode', $queryParams)) {
+                unset($queryParams['airlineCode']);
+            }
+        }
+        return $queryParams;
+    }
 }

src/API/ClientBuilder.php

@@ -21,9 +21,12 @@ public static function create()
     public function setEnvironment(
         string $apiUrl,
         string $apiKey,
-        string $apiSecret
+        string $apiSecret,
+        ?string $clientUsername = null,
+        ?string $appName = null,
+        ?string $channel = null
     ) {
-        $this->environment = new Environment($apiUrl, $apiKey, $apiSecret);
+        $this->environment = new Environment($apiUrl, $apiKey, $apiSecret, $clientUsername, $appName, $channel);
         return $this;
     }
 

src/API/Endpoint/CalculateAwardMilesWithTax.php

@@ -12,5 +12,6 @@ public function __construct(CalculateAwardMilesWithTaxParameters $queryParameter
         $this->endpoint = '/calculateAwardMilesWithTax';
         $this->responseRoot = 'return';
         $this->queryParameters = $queryParameters->getValue();
+        $this->requestHeaderRequired = false;
     }
 }

src/API/Endpoint/CalculateFlightMiles.php

@@ -12,5 +12,6 @@ public function __construct(CalculateFlightMilesParameters $queryParameters)
         $this->endpoint = '/calculateFlightMiles';
         $this->responseRoot = 'milesResponseDetail';
         $this->queryParameters = $queryParameters->getValue();
+        $this->requestHeaderRequired = false;
     }
 }

src/API/Endpoint/EndpointAbstract.php

@@ -2,13 +2,17 @@
 
 namespace TK\API\Endpoint;
 
+use TK\API\Client;
+
 abstract class EndpointAbstract
 {
+
     protected $endpoint;
     protected $queryParameters = [];
     protected $headers = [];
-    protected $httpRequestMethod = 'POST';
+    protected $httpRequestMethod = Client::HTTP_POST;
     protected $responseRoot = '';
+    protected $requestHeaderRequired = true;
 
     public function getEndpoint() : string
     {
@@ -34,4 +38,9 @@ public function getResponseRoot() : string
     {
         return $this->responseRoot;
     }
+
+    public function doesRequireRequestHeaders() : bool
+    {
+        return $this->requestHeaderRequired;
+    }
 }

src/API/Endpoint/EndpointInterface.php

@@ -10,4 +10,5 @@ public function getHeaders() : array;
     public function getQueryParams() : array;
     public function getHttpRequestMethod() : string;
     public function getResponseRoot() : string;
+    public function doesRequireRequestHeaders() : bool;
 }

src/API/Endpoint/GetFareFamilyList.php

@@ -12,5 +12,6 @@ public function __construct(GetFareFamilyListParameters $queryParameters)
         $this->endpoint = '/getFareFamilyList';
         $this->responseRoot = 'fareFamilyOTAResponse';
         $this->queryParameters = $queryParameters->getValue();
+        $this->requestHeaderRequired = false;
     }
 }

src/API/Endpoint/GetPortList.php

@@ -10,7 +10,6 @@ final class GetPortList extends EndpointAbstract implements EndpointInterface
     public function __construct(GetPortListParameters $queryParameters)
     {
         $this->endpoint = '/getPortList';
-        $this->httpRequestMethod = 'GET';
         $this->responseRoot = 'Port';
         $this->queryParameters = $queryParameters->getValue();
     }

src/API/Endpoint/RetrieveReservationDetail.php

@@ -11,7 +11,6 @@ public function __construct(RetrieveReservationDetailParameters $queryParameters
     {
         $this->endpoint = '/retrieveReservationDetail';
         $this->responseRoot = 'retrieveReservationOTAResponse';
-        $this->httpRequestMethod = 'get';
         $this->queryParameters = $queryParameters->getValue();
     }
 }