Packages: add filter by origin

Author: glaubinix

README.md

@@ -82,7 +82,10 @@ $client->customers()->removePackage($customerId, $packageName);
 
 ##### List an organization's packages
 ```php
-$packages = $client->packages()->all();
+$filters = [
+    'origin' => \PrivatePackagist\ApiClient\Api\Packages::ORIGIN_PRIVATE, // optional filter to only receive packages that can be added to customers 
+];
+$packages = $client->packages()->all($filters);
 ```
 Returns an array of packages.
 

src/Api/Packages.php

@@ -2,10 +2,32 @@
 
 namespace PrivatePackagist\ApiClient\Api;
 
+use PrivatePackagist\ApiClient\Exception\InvalidArgumentException;
+
 class Packages extends AbstractApi
 {
-    public function all()
+    /**
+     * Packages that are mirrored from a public Composer repository like packagist.org.
+     */
+    const ORIGIN_PUBLIC_PROXY = 'public-proxy';
+
+    /**
+     * Packages that are mirrored from a private Composer repository requiring authentication like repo.magento.com.
+     */
+    const ORIGIN_PRIVATE_PROXY = 'private-proxy';
+
+    /**
+     * All other packages from a VCS repository or a custom JSON definition.
+     */
+    const ORIGIN_PRIVATE = 'private';
+
+    public function all(array $filters = [])
     {
-        return $this->get('/packages/');
+        $availableOrigins = [self::ORIGIN_PUBLIC_PROXY, self::ORIGIN_PRIVATE_PROXY, self::ORIGIN_PRIVATE];
+        if (isset($filters['origin']) && !in_array($filters['origin'], $availableOrigins, true)) {
+            throw new InvalidArgumentException('Filter "origin" has to be one of: "' . implode('", "', $availableOrigins) . '".');
+        }
+
+        return $this->get('/packages/', $filters);
     }
 }

tests/Api/PackagesTest.php

@@ -9,7 +9,7 @@ public function testAll()
         $expected = [
             [
                 'id' => 1,
-                'name' => 'composer/composer',
+                'name' => 'acme-website/package',
             ],
         ];
 
@@ -23,6 +23,46 @@ public function testAll()
         $this->assertSame($expected, $api->all());
     }
 
+    public function testAllWithFilters()
+    {
+        $expected = [
+            [
+                'id' => 1,
+                'name' => 'acme-website/package',
+            ],
+        ];
+
+        $filters = [
+            'origin' => Packages::ORIGIN_PRIVATE,
+        ];
+
+        /** @var Packages&\PHPUnit_Framework_MockObject_MockObject $api */
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with($this->equalTo('/packages/'), $this->equalTo($filters))
+            ->will($this->returnValue($expected));
+
+        $this->assertSame($expected, $api->all($filters));
+    }
+
+    /**
+     * @expectedException \PrivatePackagist\ApiClient\Exception\InvalidArgumentException
+     */
+    public function testAllWithInvalidFilters()
+    {
+        $filters = [
+            'origin' => 'invalid'
+        ];
+
+        /** @var Packages&\PHPUnit_Framework_MockObject_MockObject $api */
+        $api = $this->getApiMock();
+        $api->expects($this->never())
+            ->method('get');
+
+        $api->all($filters);
+    }
+
     protected function getApiClass()
     {
         return Packages::class;