Merge pull request #20 from QuadraEcommerce/feature/add-partner-key-support

Feature/add partner key support

Author: joecampo

README.md

@@ -33,6 +33,8 @@ After installing via composer you will need to publish the configuration:
 php artisan vendor:publish
 ```
 This will create the configuration file for your API key and API secret key at ```config/shipstation.php```. You will need to obtain your API & Secret key from ShipStation: [How can I get access to ShipStation's API?](https://help.shipstation.com/hc/en-us/articles/206638917-How-can-I-get-access-to-ShipStation-s-API-)
+
+If ShipStation has provided you with a partner API key, set it in your configuration file.
 ## Dependencies
 LaravelShipStation uses ```GuzzleHttp\Guzzle```
 ## Endpoints

config/config.php

@@ -1,7 +1,8 @@
 <?php
 
 return [
-    'apiURL'    => env('SS_URL', 'https://ssapi.shipstation.com'),
-    'apiKey'    => env('SS_KEY', ''),
-    'apiSecret' => env('SS_SECRET', ''),
+    'apiURL'        => env('SS_URL', 'https://ssapi.shipstation.com'),
+    'apiKey'        => env('SS_KEY', ''),
+    'partnerApiKey' => env('SS_PARTNER_KEY', ''),
+    'apiSecret'     => env('SS_SECRET', ''),
 ];

phpunit.xml

@@ -19,6 +19,7 @@
     <php>
         <env name="SHIPSTATION_TESTING" value="false"/>
         <env name="KEY" value=""/>
+        <env name="PARTNER_KEY" value=""/>
         <env name="SECRET" value=""/>
         <env name="API_URL" value=""/>
     </php>

src/ShipStation.php

@@ -47,21 +47,29 @@ class ShipStation extends Client
      *
      * @param  string  $apiKey
      * @param  string  $apiSecret
+     * @param  string  $apiURL
+     * @param  string|null  $partnerApiKey
      * @throws \Exception
      */
-    public function __construct($apiKey, $apiSecret, $apiURL)
+    public function __construct($apiKey, $apiSecret, $apiURL, $partnerApiKey = null)
     {
         if (!isset($apiKey, $apiSecret)) {
             throw new \Exception('Your API key and/or private key are not set. Did you run artisan vendor:publish?');
         }
 
         $this->base_uri = $apiURL;
 
+        $headers = [
+            'Authorization' => 'Basic ' . base64_encode("{$apiKey}:{$apiSecret}"),
+        ];
+
+        if (! empty($partnerApiKey)) {
+            $headers['x-partner'] = $partnerApiKey;
+        }
+
         parent::__construct([
             'base_uri' => $this->base_uri,
-            'headers'  => [
-                'Authorization' => 'Basic ' . base64_encode("{$apiKey}:{$apiSecret}"),
-            ]
+            'headers'  => $headers,
         ]);
     }
 

src/ShipStationServiceProvider.php

@@ -29,7 +29,8 @@ public function register()
             return new ShipStation(
                 config('shipstation.apiKey'),
                 config('shipstation.apiSecret'),
-                config('shipstation.apiURL')
+                config('shipstation.apiURL'),
+                config('shipstation.partnerApiKey')
             );
         });
     }

tests/ShipStationTest.php

@@ -22,7 +22,12 @@ public function setUp()
             exit();
         }
 
-        $this->shipStation = new LaravelShipStation\ShipStation(getenv('KEY'), getenv('SECRET'), getenv('API_URL'));
+        $this->shipStation = new LaravelShipStation\ShipStation(
+            getenv('KEY'),
+            getenv('SECRET'),
+            getenv('API_URL'),
+            getenv('PARTNER_KEY')
+        );
     }
 
     /** @test */
@@ -126,4 +131,19 @@ public function rate_limits_are_set_after_request()
         $this->assertGreaterThanOrEqual(0, $this->shipStation->getSecondsUntilReset());
         $this->assertInternalType('boolean', $this->shipStation->isRateLimited());
     }
+
+    /** @test */
+    public function partner_api_key_header_is_set_when_defined()
+    {
+        if (empty(getenv('PARTNER_KEY'))) {
+            // nothing to test
+            return;
+        }
+
+        $this->shipStation->webhooks->get();
+
+        $headers = $this->shipStation->request->getConfig('headers');
+
+        $this->assertArrayHasKey('x-partner', $headers);
+    }
 }