Merge pull request #14 from packagist/t/customer-url-name-paramter

Customers: allow urlName to be passed instead of id for all calls

Author: naderman

README.md

@@ -62,6 +62,9 @@ Returns an array of customers.
 ```php
 $customerId = 42;
 $customer = $client->customers()->show($customerId);
+// or
+$customerUrlName = 'customer-url-name';
+$customer = $client->customers()->show($customerUrlName);
 ```
 Returns a single customer.
 

src/Api/Customers.php

@@ -11,9 +11,9 @@ public function all()
         return $this->get('/customers/');
     }
 
-    public function show($customerId)
+    public function show($customerIdOrUrlName)
     {
-        return $this->get(sprintf('/customers/%s/', $customerId));
+        return $this->get(sprintf('/customers/%s/', $customerIdOrUrlName));
     }
 
     public function create($name, $accessToVersionControlSource = false)
@@ -24,64 +24,64 @@ public function create($name, $accessToVersionControlSource = false)
     /**
      * @deprecated Use edit instead
      */
-    public function update($customerId, array $customer)
+    public function update($customerIdOrUrlName, array $customer)
     {
-        return $this->edit($customerId, $customer);
+        return $this->edit($customerIdOrUrlName, $customer);
     }
 
-    public function edit($customerId, array $customer)
+    public function edit($customerIdOrUrlName, array $customer)
     {
-        return $this->put(sprintf('/customers/%s/', $customerId), $customer);
+        return $this->put(sprintf('/customers/%s/', $customerIdOrUrlName), $customer);
     }
 
-    public function remove($customerId)
+    public function remove($customerIdOrUrlName)
     {
-        return $this->delete(sprintf('/customers/%s/', $customerId));
+        return $this->delete(sprintf('/customers/%s/', $customerIdOrUrlName));
     }
 
-    public function listPackages($customerId)
+    public function listPackages($customerIdOrUrlName)
     {
-        return $this->get(sprintf('/customers/%s/packages/', $customerId));
+        return $this->get(sprintf('/customers/%s/packages/', $customerIdOrUrlName));
     }
 
     /**
      * @deprecated Use addOrEditPackages instead
      */
-    public function addOrUpdatePackages($customerId, array $packages)
+    public function addOrUpdatePackages($customerIdOrUrlName, array $packages)
     {
-        return $this->addOrEditPackages($customerId, $packages);
+        return $this->addOrEditPackages($customerIdOrUrlName, $packages);
     }
 
-    public function addOrEditPackages($customerId, array $packages)
+    public function addOrEditPackages($customerIdOrUrlName, array $packages)
     {
         foreach ($packages as $package) {
             if (!isset($package['name'])) {
                 throw new InvalidArgumentException('Parameter "name" is required.');
             }
         }
 
-        return $this->post(sprintf('/customers/%s/packages/', $customerId), $packages);
+        return $this->post(sprintf('/customers/%s/packages/', $customerIdOrUrlName), $packages);
     }
 
     /**
      * @deprecated Use addOrEditPackages instead
      */
-    public function addPackages($customerId, array $packages)
+    public function addPackages($customerIdOrUrlName, array $packages)
     {
-        return $this->addOrEditPackages($customerId, $packages);
+        return $this->addOrEditPackages($customerIdOrUrlName, $packages);
     }
 
-    public function removePackage($customerId, $packageName)
+    public function removePackage($customerIdOrUrlName, $packageName)
     {
-        return $this->delete(sprintf('/customers/%s/packages/%s/', $customerId, $packageName));
+        return $this->delete(sprintf('/customers/%s/packages/%s/', $customerIdOrUrlName, $packageName));
     }
 
-    public function regenerateToken($customerId, array $confirmation)
+    public function regenerateToken($customerIdOrUrlName, array $confirmation)
     {
         if (!isset($confirmation['IConfirmOldTokenWillStopWorkingImmediately'])) {
             throw new InvalidArgumentException('Confirmation is required to regenerate the Composer repository token.');
         }
 
-        return $this->post(sprintf('/customers/%s/token/regenerate', $customerId), $confirmation);
+        return $this->post(sprintf('/customers/%s/token/regenerate', $customerIdOrUrlName), $confirmation);
     }
 }