Revert "removing basic auth from the client in favor of oauth. including removing no longer used properties"

bc-bfenton · bc-bfenton · commit 4e8086ab4375 · 2015-06-09T10:00:23.000-07:00
This reverts commit 03fccfc.
diff --git a/src/Bigcommerce/Api/Client.php b/src/Bigcommerce/Api/Client.php
@@ -9,6 +9,27 @@
  */
 class Client
 {
+    /**
+     * Full Store URL to connect to
+     *
+     * @var string
+     */
+    static private $store_url;
+
+    /**
+     * Username to connect to the store API with
+     *
+     * @var string
+     */
+    static private $username;
+
+    /**
+     * API key
+     *
+     * @var string
+     */
+    static private $api_key;
+
     /**
      * Connection instance
      *
@@ -24,37 +45,41 @@ class Client
     static private $resource;
 
     /**
-     * Full URL path to the configured store API.
+     * API path prefix to be added to store URL for requests
      *
      * @var string
      */
-    static public $api_path;
+    static private $path_prefix = '/api/v2';
+
     /**
-     * Client ID from app installation
+     * Full URL path to the configured store API.
      *
      * @var string
      */
+    static public $api_path;
     static private $client_id;
     static private $store_hash;
     static private $auth_token;
-    /**
-     * Appended to API URL to create API endpoints
-     *
-     * @var string
-     */
     static private $stores_prefix = '/stores/%s/v2';
-    /**
-     * Base URL for the Bigcommerce API
-     *
-     * @var string
-     */
     static private $api_url = 'https://api.bigcommerce.com';
+    static private $login_url = 'https://login.bigcommerce.com';
+
     /**
-     * Endpoint for getting tokens
+     * Configure the API client with the required settings to access
+     * the API for a store.
      *
-     * @var string
+     * Accepts both OAuth and Basic Auth credentials
+     *
+     * @param array $settings
      */
-    static private $login_url = 'https://login.bigcommerce.com';
+    public static function configure($settings)
+    {
+        if (isset($settings['client_id'])) {
+            self::configureOAuth($settings);
+        } else {
+            self::configureBasicAuth($settings);
+        }
+    }
 
     /**
      * Configure the API client with the required OAuth credentials.
@@ -68,7 +93,7 @@ class Client
      * @param array $settings
      * @throws \Exception
      */
-    public static function configure($settings)
+    public static function configureOAuth($settings)
     {
         if (!isset($settings['auth_token'])) {
             throw new Exception("'auth_token' must be provided");
@@ -85,6 +110,39 @@ public static function configure($settings)
         self::$connection = false;
     }
 
+    /**
+     * Configure the API client with the required credentials.
+     *
+     * Requires a settings array to be passed in with the following keys:
+     *
+     * - store_url
+     * - username
+     * - api_key
+     *
+     * @param array $settings
+     * @throws \Exception
+     */
+    public static function configureBasicAuth(array $settings)
+    {
+        if (!isset($settings['store_url'])) {
+            throw new Exception("'store_url' must be provided");
+        }
+
+        if (!isset($settings['username'])) {
+            throw new Exception("'username' must be provided");
+        }
+
+        if (!isset($settings['api_key'])) {
+            throw new Exception("'api_key' must be provided");
+        }
+
+        self::$username = $settings['username'];
+        self::$api_key = $settings['api_key'];
+        self::$store_url = rtrim($settings['store_url'], '/');
+        self::$api_path = self::$store_url . self::$path_prefix;
+        self::$connection = false;
+    }
+
     /**
      * Configure the API client to throw exceptions when HTTP errors occur.
      *
@@ -156,7 +214,11 @@ private static function connection()
     {
         if (!self::$connection) {
             self::$connection = new Connection();
-            self::$connection->authenticate(self::$client_id, self::$auth_token);
+            if (self::$client_id) {
+                self::$connection->authenticateOauth(self::$client_id, self::$auth_token);
+            } else {
+                self::$connection->authenticateBasic(self::$username, self::$api_key);
+            }
         }
 
         return self::$connection;
diff --git a/src/Bigcommerce/Api/Connection.php b/src/Bigcommerce/Api/Connection.php
@@ -152,12 +152,23 @@ public function failOnError($option = true)
     }
 
     /**
-     * Sets OAuth authentication headers
+     * Sets the HTTP basic authentication.
+     *
+     * @param string $username
+     * @param string $password
+     */
+    public function authenticateBasic($username, $password)
+    {
+        curl_setopt($this->curl, CURLOPT_USERPWD, "$username:$password");
+    }
+
+    /**
+     * Sets Oauth authentication headers
      *
      * @param string $clientId
      * @param string $authToken
      */
-    public function authenticate($clientId, $authToken)
+    public function authenticateOauth($clientId, $authToken)
     {
         $this->addHeader('X-Auth-Client', $clientId);
         $this->addHeader('X-Auth-Token', $authToken);
@@ -519,8 +530,6 @@ public function getBody()
     /**
      * Access given header from the response.
      *
-     * @param string $header
-     *
      * @return string|void
      */
     public function getHeader($header)
diff --git a/test/Unit/Api/ClientTest.php b/test/Unit/Api/ClientTest.php
@@ -46,20 +46,26 @@ public function setUp()
 
     public function tearDown()
     {
-        Client::configure(array('client_id' => '', 'auth_token' => '', 'store_hash' => ''));
+        Client::configure(array('username' => '', 'api_key' => '', 'store_url' => ''));
         unset($this->connection);
     }
 
-    public function testConfigureRequiresAuthToken()
+    public function testConfigureRequiresStoreUrl()
     {
-        $this->setExpectedException('\\Exception', "'auth_token' must be provided");
-        Client::configure(array('client_id' => 'whatever', 'store_hash' => 'whatever'));
+        $this->setExpectedException('\\Exception', "'store_url' must be provided");
+        Client::configure(array('username' => 'whatever', 'api_key' => 'whatever'));
     }
 
-    public function testConfigureRequiresStoreHash()
+    public function testConfigureRequiresUsername()
     {
-        $this->setExpectedException('\\Exception', "'store_hash' must be provided");
-        Client::configure(array('client_id' => 'whatever', 'auth_token' => 'whatever'));
+        $this->setExpectedException('\\Exception', "'username' must be provided");
+        Client::configure(array('store_url' => 'whatever', 'api_key' => 'whatever'));
+    }
+
+    public function testConfigureRequiresApiKey()
+    {
+        $this->setExpectedException('\\Exception', "'api_key' must be provided");
+        Client::configure(array('username' => 'whatever', 'store_url' => 'whatever'));
     }
 
     public function testFailOnErrorPassesThroughToConnection()
@@ -116,14 +122,10 @@ public function testGetResourceReturnsSpecifiedType()
     {
         $this->connection->expects($this->once())
             ->method('get')
-            ->with('https://api.bigcommerce.com/stores/hash/v2/whatever', false)
+            ->with('http://storeurl' . $this->basePath . '/whatever', false)
             ->will($this->returnValue(array(array())));
 
-        Client::configure(array(
-            'store_hash' => 'hash',
-            'client_id' => 'whatever',
-            'auth_token' => 'whatever'
-        ));
+        Client::configure(array('store_url' => 'http://storeurl', 'username' => 'whatever', 'api_key' => 'whatever'));
         Client::setConnection($this->connection); // re-set the connection since Client::configure unsets it
         $resource = Client::getResource('/whatever');
         $this->assertInstanceOf('Bigcommerce\\Api\\Resource', $resource);
@@ -133,14 +135,10 @@ public function testGetCountReturnsSpecifiedCount()
     {
         $this->connection->expects($this->once())
             ->method('get')
-            ->with('https://api.bigcommerce.com/stores/hash/v2/whatever', false)
+            ->with('http://storeurl' . $this->basePath . '/whatever', false)
             ->will($this->returnValue((object)array('count' => 5)));
 
-        Client::configure(array(
-            'store_hash' => 'hash',
-            'client_id' => 'whatever',
-            'auth_token' => 'whatever'
-        ));
+        Client::configure(array('store_url' => 'http://storeurl', 'username' => 'whatever', 'api_key' => 'whatever'));
         Client::setConnection($this->connection); // re-set the connection since Client::configure unsets it
         $count = Client::getCount('/whatever');
         $this->assertSame(5, $count);
@@ -150,14 +148,10 @@ public function testGetCollectionReturnsCollectionOfSpecifiedTypes()
     {
         $this->connection->expects($this->once())
             ->method('get')
-            ->with('https://api.bigcommerce.com/stores/hash/v2/whatever', false)
+            ->with('http://storeurl' . $this->basePath . '/whatever', false)
             ->will($this->returnValue(array(array(), array())));
 
-        Client::configure(array(
-            'store_hash' => 'hash',
-            'client_id' => 'whatever',
-            'auth_token' => 'whatever'
-        ));
+        Client::configure(array('store_url' => 'http://storeurl', 'username' => 'whatever', 'api_key' => 'whatever'));
         Client::setConnection($this->connection); // re-set the connection since Client::configure unsets it
         $resources = Client::getCollection('/whatever');
         $this->assertInternalType('array', $resources);
@@ -171,14 +165,10 @@ public function testCreateResourcePostsToTheRightPlace()
         $new = array(rand() => rand());
         $this->connection->expects($this->once())
             ->method('post')
-            ->with('https://api.bigcommerce.com/stores/hash/v2/whatever', (object)$new)
+            ->with('http://storeurl' . $this->basePath . '/whatever', (object)$new)
             ->will($this->returnValue($new));
 
-        Client::configure(array(
-            'store_hash' => 'hash',
-            'client_id' => 'whatever',
-            'auth_token' => 'whatever'
-        ));
+        Client::configure(array('store_url' => 'http://storeurl', 'username' => 'whatever', 'api_key' => 'whatever'));
         Client::setConnection($this->connection); // re-set the connection since Client::configure unsets it
         $result = Client::createResource('/whatever', $new);
         $this->assertSame($new, $result);
@@ -189,14 +179,10 @@ public function testUpdateResourcePutsToTheRightPlace()
         $update = array(rand() => rand());
         $this->connection->expects($this->once())
             ->method('put')
-            ->with('https://api.bigcommerce.com/stores/hash/v2/whatever', (object)$update)
+            ->with('http://storeurl' . $this->basePath . '/whatever', (object)$update)
             ->will($this->returnValue($update));
 
-        Client::configure(array(
-            'store_hash' => 'hash',
-            'client_id' => 'whatever',
-            'auth_token' => 'whatever'
-        ));
+        Client::configure(array('store_url' => 'http://storeurl', 'username' => 'whatever', 'api_key' => 'whatever'));
         Client::setConnection($this->connection); // re-set the connection since Client::configure unsets it
         $result = Client::updateResource('/whatever', $update);
         $this->assertSame($update, $result);
@@ -206,14 +192,10 @@ public function testDeleteResourceDeletesToTheRightPlace()
     {
         $this->connection->expects($this->once())
             ->method('delete')
-            ->with('https://api.bigcommerce.com/stores/hash/v2/whatever')
+            ->with('http://storeurl' . $this->basePath . '/whatever')
             ->will($this->returnValue("Successfully deleted"));
 
-        Client::configure(array(
-            'store_hash' => 'hash',
-            'client_id' => 'whatever',
-            'auth_token' => 'whatever'
-        ));
+        Client::configure(array('store_url' => 'http://storeurl', 'username' => 'whatever', 'api_key' => 'whatever'));
         Client::setConnection($this->connection); // re-set the connection since Client::configure unsets it
         $result = Client::deleteResource('/whatever');
         $this->assertSame("Successfully deleted", $result);
@@ -267,18 +249,18 @@ public function testGetRequestsRemainingRequestsTimeWhenNoValueAvailable()
     public function collections()
     {
         return array(
-            //      path            function            classname
-            array('products',       'getProducts',      'Product'),
-            array('brands',         'getBrands',        'Brand'),
-            array('orders',         'getOrders',        'Order'),
-            array('customers',      'getCustomers',     'Customer'),
-            array('coupons',        'getCoupons',       'Coupon'),
+            //      path           function             classname
+            array('products', 'getProducts', 'Product'),
+            array('brands', 'getBrands', 'Brand'),
+            array('orders', 'getOrders', 'Order'),
+            array('customers', 'getCustomers', 'Customer'),
+            array('coupons', 'getCoupons', 'Coupon'),
             array('order_statuses', 'getOrderStatuses', 'OrderStatus'),
-            array('categories',     'getCategories',    'Category'),
-            array('options',        'getOptions',       'Option'),
-            array('optionsets',     'getOptionSets',    'OptionSet'),
-            array('products/skus',  'getSkus',          'Sku'),
-            array('requestlogs',    'getRequestLogs',   'RequestLog'),
+            array('categories', 'getCategories', 'Category'),
+            array('options', 'getOptions', 'Option'),
+            array('optionsets', 'getOptionSets', 'OptionSet'),
+            array('products/skus', 'getSkus', 'Sku'),
+            array('requestlogs', 'getRequestLogs', 'RequestLog'),
         );
     }
 
@@ -321,15 +303,15 @@ public function testGettingTheCountOfACollectionReturnsThatCollectionsCount($pat
     public function resources()
     {
         return array(
-            //    path           function        classname
-            array('products',    '%sProduct',    'Product'),
-            array('brands',      '%sBrand',      'Brand'),
-            array('orders',      '%sOrder',      'Order'),
-            array('customers',   '%sCustomer',   'Customer'),
-            array('categories',  '%sCategory',   'Category'),
-            array('options',     '%sOption',     'Option'),
-            array('optionsets',  '%sOptionSet',  'OptionSet'),
-            array('coupons',     '%sCoupon',     'Coupon'),
+            //    path               function          classname
+            array('products',        '%sProduct',      'Product'),
+            array('brands',          '%sBrand',        'Brand'),
+            array('orders',          '%sOrder',        'Order'),
+            array('customers',       '%sCustomer',     'Customer'),
+            array('categories',      '%sCategory',     'Category'),
+            array('options',         '%sOption',       'Option'),
+            array('optionsets',      '%sOptionSet',    'OptionSet'),
+            array('coupons',         '%sCoupon',       'Coupon'),
         );
     }
 
