DEV-4690 - Update to a much cleaner way of doing it

Pawel knows his stuff

Author: ethancarlsson-pf

README.md

@@ -18,21 +18,23 @@ Check out **example** and **test** directories for more specific usage examples.
 is the preferred way of doing authorization in Printful API. Read more about how to acquire and
 use an access token in our docs: https://developers.printful.com/docs/#section/Authentication
 
-In order to use OAuth through the SDK you can set you can pass it in as the second argument to the constructor of the client
+You can create an OAuth enabled APIClient using the following factory method:
 ```php
-$client = new PrintfulApiClient(null, $myOauthToken)
+...
+use Printful\PrintfulApiClient;
+... 
+$client = PrintfulApiClient::createOauthClient('my-oauth-token')
 ```
 
-You can still use the old store keys
+You can still use the old store keys, like this:
 ```php
-$client = new PrintfulApiClient($storeKey)
+...
+use Printful\PrintfulApiClient;
+... 
+$client = PrintfulApiClient::createLegacyStoreKeyClient('my-legacy-store-key')
 ```
-But theses are being phased out and will no longer work after
-September 30th, 2022.
-
-If you pass in both a store key and an OAuth token, the OAuth
-token will take precedence.
+or, by using the constructor like this:
 ```php
-// $myOauthToken will be used when making requests, not $storeKey
-$client = new PrintfulApiClient($storeKey, $myOauthToken)
+$client = new PrintfulApiClient($storeKey)
 ```
+However, please note that legacy keys will be phased out on September 30th, 2022.

src/PrintfulApiClient.php

@@ -10,15 +10,19 @@
  */
 class PrintfulApiClient
 {
+    const TYPE_LEGACY_STORE_KEY = 'legacy-store-key';
+    const TYPE_OAUTH_TOKEN = 'oauth-token';
+    const DEFAULT_KEY = self::TYPE_LEGACY_STORE_KEY;
+
     /**
      * Printful API key
-     * @var string
+     * @var string|null
      */
     private $key;
 
     /**
      * Printful OAuth token
-     * @var string
+     * @var string|null
      */
     private $oauthToken;
 
@@ -43,22 +47,35 @@ class PrintfulApiClient
     public $curlTimeout = 20;
 
     /**
-     * @param ?string $key
-     * @param ?string $oauthToken
+     * @param string $key
      * @throws \Printful\Exceptions\PrintfulException if the library failed to initialize
      */
-    public function __construct($key = null, $oauthToken = null)
+    public function __construct($key, $type = self::DEFAULT_KEY)
     {
-        if ($key === null && $oauthToken === null) {
-            throw new PrintfulException('Missing credentials, please provide a store key or an OAuth token!');
-        }
-
-        if ($key && strlen($key) < 32) {
+        if ($type === self::TYPE_LEGACY_STORE_KEY && strlen($key) < 32) {
             throw new PrintfulException('Invalid Printful store key!');
         }
 
-        $this->key = $key;
-        $this->oauthToken = $oauthToken;
+        $this->key = $type === self::TYPE_LEGACY_STORE_KEY ? $key : null;
+        $this->oauthToken = $type === self::TYPE_OAUTH_TOKEN ? $key : null;
+    }
+
+    /**
+     * @param string $key
+     * @throws PrintfulException
+     */
+    public static function createOauthClient($key)
+    {
+        return new self($key, self::TYPE_OAUTH_TOKEN);
+    }
+
+    /**
+     * @param string $key
+     * @throws PrintfulException
+     */
+    public static function createLegacyStoreKeyClient($key)
+    {
+        return new self($key, self::TYPE_LEGACY_STORE_KEY);
     }
 
     /**
@@ -215,8 +232,8 @@ private function request($method, $path, array $params = [], $data = null)
     private function setCredentials($curl)
     {
         if ($this->oauthToken !== null) {
-            curl_setopt($curl, CURLOPT_HTTPHEADER, ["Authorization: Bearer $this->oauthToken" ]);
-        } else if ($this->key !== null) {
+            curl_setopt($curl, CURLOPT_HTTPHEADER, ["Authorization: Bearer $this->oauthToken"]);
+        } elseif ($this->key !== null) {
             curl_setopt($curl, CURLOPT_USERPWD, $this->key);
         } else {
             throw new PrintfulException('Either OAuth token or store key must be set to make this request.');

tests/ApiClient/PrintfulApiClientTest.php

@@ -9,21 +9,24 @@
 
 class PrintfulApiClientTest extends TestCase
 {
+
     /**
      * @throws \Printful\Exceptions\PrintfulException
      * @throws \Printful\Exceptions\PrintfulApiException
      */
     public function testGet_withApiKey_returnsWithNoAuthErrors()
     {
-        $sut = new PrintfulApiClient(Credentials::$apiKey);
+        $sut = PrintfulApiClient::createLegacyStoreKeyClient(Credentials::$apiKey);
 
         $this->overrideUrl($sut);
 
-        $sut->get('orders', [
+        $result = $sut->get('orders', [
             'offset' => 0,
             'limit' => 10,
             'status' => null,
         ]);
+
+        self::assertNotNull($result);
     }
 
     /**
@@ -32,21 +35,34 @@ public function testGet_withApiKey_returnsWithNoAuthErrors()
      */
     public function testGet_withOauthToken_returnsWithNoAuthErrors()
     {
-        $sut = new PrintfulApiClient(null, Credentials::$oAuthToken);
+        $sut = PrintfulApiClient::createOauthClient(Credentials::$oAuthToken);
 
         $this->overrideUrl($sut);
 
-        $sut->get('orders', [
+        $result = $sut->get('orders', [
             'offset' => 0,
             'limit' => 10,
             'status' => null,
         ]);
+        self::assertNotNull($result);
     }
 
-    public function testConstruct_withNoCredentials_throwsException()
+    /**
+     * @throws \Printful\Exceptions\PrintfulException
+     * @throws \Printful\Exceptions\PrintfulApiException
+     */
+    public function testGet_withInvalidCredentials_throwsApiException()
     {
+        $sut = PrintfulApiClient::createOauthClient('invalid key');
+
+        $this->overrideUrl($sut);
+
         $this->expectException(PrintfulException::class);
-        new PrintfulApiClient();
+        $sut->get('orders', [
+            'offset' => 0,
+            'limit' => 10,
+            'status' => null,
+        ]);
     }
 
     private function overrideUrl(PrintfulApiClient $sut)