Merge pull request #40 from packagist/t/add-artifact-package

Add artifact to an existing package

Author: glaubinix

.travis.yml

@@ -5,6 +5,7 @@ php:
   - 7.0
   - 7.1
   - 7.2
+  - 7.4
 
 before_install:
   - if [ -n "$GH_TOKEN" ]; then composer config github-oauth.github.com ${GH_TOKEN}; fi;

README.md

@@ -72,7 +72,8 @@
             * [List all customers with access to a package](#list-all-customers-with-access-to-a-package)
             * [Create an artifact package file](#create-an-artifact-package-file)
             * [Create an artifact package](#create-an-artifact-package)
-            * [Update artifact files of a package](#update-artifact-files-of-a-package)
+            * [Add an artifact file to an existing package](#add-an-artifact-file-to-an-existing-package)
+            * [Update or replace artifact files of a package](#update-or-replace-artifact-files-of-a-package)
          * [Credential](#credential)
             * [List an organization's credentials](#list-an-organizations-credentials)
             * [Show a credential](#show-a-credential)
@@ -98,7 +99,7 @@
          * [Validate incoming webhook payloads](#validate-incoming-webhook-payloads)
       * [License](#license)
 
-<!-- Added by: wissem, at: Tue Jul 21 10:32:47 CEST 2020 -->
+<!-- Added by: wissem, at: Fri Oct 16 14:23:54 CEST 2020 -->
 
 <!--te-->
 
@@ -597,13 +598,34 @@ $response = $client->packages()->artifacts()->create($file, 'application/zip', $
 $artifactId = $response['id'];
 $client->packages()->createArtifactPackage([$artifactId]);
 ```
-#### Update artifact files of a package
+#### Add an artifact file to an existing package
 
 ```php
-$result = $client->packages()->artifacts()->showPackageArtifacts('acme-website/package'); // get artifact files details for a package
-$artifactFileIds = [42, 43];
-$client->packages()->editArtifactPackage('acme-website/package', $artifactFileIds);
+$packageName = 'acme/artifact';
+$fileName = 'package1.zip';
+$file = file_get_contents($fileName);
+$client->packages()->artifacts()->add($packageName, $file, 'application/zip', $fileName);
 ```
+#### Update or replace artifact files of a package
+
+```php
+// in case you want to replace the artifact file with a newly uploaded one
+// 1. get current artifact ids
+$result = $client->packages()->artifacts()->showPackageArtifacts('acme-website/package');
+$artifactIds = array_column($result, 'id'); // [41, 42]
+
+// 2. upload the new artifact file
+$fileName = 'package1.zip';
+$file = file_get_contents($fileName);
+$response = $client->packages()->artifacts()->create($file, 'application/zip', $fileName);
+$newArtifactId = $response['id'];
+
+// 3. let's say we don't want to have the artifact file id = 41 and use the newly uploaded file instead
+$artifactIds = array_shift($artifactIds);
+$artifactIds[] = $newArtifactId;
+$client->packages()->editArtifactPackage('acme-website/package', $artifactIds);
+```
+
 ### Credential
 
 #### List an organization's credentials

composer.json

@@ -19,7 +19,7 @@
         "php-http/client-common": "^1.9 || ^2.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.5 || ^6.0",
+        "phpunit/phpunit": "^5.5 || ^7.0",
         "php-http/guzzle6-adapter": "^1.0 || ^2.0",
         "php-http/mock-client": "^1.0",
         "guzzlehttp/psr7": "^1.2",

src/Api/Packages/Artifacts.php

@@ -21,6 +21,14 @@ public function create($file, $contentType, $fileName)
         ]));
     }
 
+    public function add($packageName, $file, $contentType, $fileName)
+    {
+        return $this->postFile('/packages/'.$packageName.'/artifacts/', $file, array_filter([
+            'Content-Type' => $contentType,
+            'X-FILENAME' => $fileName
+        ]));
+    }
+
     public function show($artifactId)
     {
         return $this->get(sprintf('/packages/artifacts/%s/', $artifactId));

tests/Api/Packages/ArtifactsTest.php

@@ -35,6 +35,29 @@ public function testCreate()
         $this->assertSame($expected, $api->create($rawFileContent, $headers['Content-Type'], $headers['X-FILENAME']));
     }
 
+    public function testAdd()
+    {
+        $packageName = 'acme/artifact';
+        $expected = [
+            'id' => 1,
+        ];
+        $rawFileContent = 'foobar';
+        $headers = [
+            'Content-Type' => 'application/zip',
+            'X-FILENAME' => 'file.zip'
+        ];
+
+        /** @var Artifacts&\PHPUnit_Framework_MockObject_MockObject $api */
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('postFile')
+            ->with($this->equalTo('/packages/'.$packageName.'/artifacts/'), $rawFileContent, $headers)
+            ->willReturn($expected);
+
+
+        $this->assertSame($expected, $api->add($packageName,$rawFileContent, $headers['Content-Type'], $headers['X-FILENAME']));
+    }
+
     public function testShow()
     {
         $expected = [