✨ add download function for attachments #5 (#6)

Author: devmoath

rector.php

@@ -5,6 +5,7 @@
 use Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector;
 use Rector\CodingStyle\Rector\Encapsed\WrapEncapsedVariableInCurlyBracesRector;
 use Rector\Config\RectorConfig;
+use Rector\EarlyReturn\Rector\If_\ChangeAndIfToEarlyReturnRector;
 use Rector\Privatization\Rector\Class_\FinalizeClassesWithoutChildrenRector;
 use Rector\Set\ValueObject\LevelSetList;
 use Rector\Set\ValueObject\SetList;
@@ -30,5 +31,6 @@
         EncapsedStringsToSprintfRector::class,
         WrapEncapsedVariableInCurlyBracesRector::class,
         FinalizeClassesWithoutChildrenRector::class,
+        ChangeAndIfToEarlyReturnRector::class,
     ]);
 };

src/Contracts/Transporter.php

@@ -20,4 +20,11 @@ interface Transporter
      * @throws \JsonException
      */
     public function request(Payload $payload): ?array;
+
+    /**
+     * @throws \Jira\Exceptions\ErrorException
+     * @throws \Jira\Exceptions\TransporterException
+     * @throws \JsonException
+     */
+    public function requestContent(Payload $payload): string;
 }

src/Resources/Attachments.php

@@ -50,4 +50,18 @@ public function remove(string $id): void
 
         $this->transporter->request(payload: $payload);
     }
+
+    /**
+     * download an attachment.
+     *
+     * @throws \Jira\Exceptions\ErrorException
+     * @throws \Jira\Exceptions\TransporterException
+     * @throws \JsonException
+     */
+    public function download(string $url): string
+    {
+        $payload = Payload::create(uri: $url);
+
+        return $this->transporter->requestContent(payload: $payload);
+    }
 }

src/Transporters/HttpTransporter.php

@@ -38,7 +38,7 @@ public function request(Payload $payload): ?array
             throw new TransporterException(clientException: $clientException);
         }
 
-        $contents = $response->getBody()->getContents();
+        $contents = (string) $response->getBody();
 
         if (trim($contents) === '') {
             return null;
@@ -51,6 +51,42 @@ public function request(Payload $payload): ?array
             throw new UnserializableResponse(jsonException: $jsonException);
         }
 
+        $this->hasErrors($response);
+
+        return $response;
+    }
+
+    public function requestContent(Payload $payload): string
+    {
+        $request = $payload->toRequest($this->baseUri, $this->headers);
+
+        try {
+            $response = $this->client->sendRequest($request);
+        } catch (ClientExceptionInterface $clientException) {
+            throw new TransporterException($clientException);
+        }
+
+        $contents = (string) $response->getBody();
+
+        try {
+            /** @var non-empty-array<array-key, mixed> $response */
+            $response = json_decode(json: $contents, associative: true, flags: JSON_THROW_ON_ERROR);
+
+            $this->hasErrors($response);
+        } catch (JsonException) {
+            // ..
+        }
+
+        return $contents;
+    }
+
+    /**
+     * @param  non-empty-array<array-key, mixed>  $response
+     *
+     * @throws \Jira\Exceptions\ErrorException
+     */
+    private function hasErrors(array $response): void
+    {
         if (isset($response['errorMessage']) && $response['errorMessage'] !== '') {
             // @phpstan-ignore-next-line
             throw new ErrorException(message: $response['errorMessage']);
@@ -63,7 +99,5 @@ public function request(Payload $payload): ?array
         if (isset($response['errors']) && $response['errors'] !== []) {
             throw new ErrorException(message: reset($response['errors']));
         }
-
-        return $response;
     }
 }

src/ValueObjects/Transporter/Payload.php

@@ -64,7 +64,7 @@ public function toRequest(BaseUri $baseUri, Headers $headers): Psr7Request
 
         return new Psr7Request(
             method: $this->method->value,
-            uri: $baseUri.$this->uri.$query,
+            uri: filter_var(value: $this->uri, filter: FILTER_VALIDATE_URL) !== false ? $this->uri.$query : $baseUri.$this->uri.$query,
             headers: $headers->toArray(),
             body: $body,
         );

tests/Datasets/Functions.php

@@ -0,0 +1,6 @@
+<?php
+
+dataset('functions', [
+    'request',
+    'requestContent',
+]);

tests/Fixtures/Attachments.php

@@ -24,3 +24,8 @@ function retrieveAttachment(): array
         'thumbnail' => 'https://www.example.com/jira/secure/thumbnail/10000',
     ];
 }
+
+function downloadAttachment(): string
+{
+    return '{"a":"b"}\n';
+}

tests/Pest.php

@@ -8,19 +8,23 @@
 use Jira\ValueObjects\Transporter\Headers;
 use Jira\ValueObjects\Transporter\Payload;
 
-function mockClient(Method $method, string $uri, array $response = null): Client
+function mockClient(Method $method, string $uri, mixed $response = null, $function = 'request'): Client
 {
     $transporter = Mockery::mock(Transporter::class);
 
     $transporter
-        ->shouldReceive('request')
+        ->shouldReceive($function)
         ->once()
-        ->withArgs(function (Payload $payload) use ($uri, $method) {
+        ->withArgs(function (Payload $payload) use ($function, $uri, $method) {
             $baseUri = BaseUri::from('jira.domain.com');
             $headers = Headers::withAuthorization(BasicAuthentication::from('foo', 'bar'));
 
             $request = $payload->toRequest($baseUri, $headers);
 
+            if ($function === 'requestContent') {
+                return $request->getMethod() === $method->value && $request->getUri()->__toString() === $uri;
+            }
+
             return $request->getMethod() === $method->value
                 && $request->getUri()->getScheme() === 'https'
                 && $request->getUri()->getHost() === 'jira.domain.com'

tests/Resources/Attachments.php

@@ -24,3 +24,16 @@
 
     expect($result)->toBeNull();
 });
+
+it('can download an attachment content', function () {
+    $client = mockClient(
+        method: Method::GET,
+        uri: 'https://www.example.com/jira/attachments/10000',
+        response: downloadAttachment(),
+        function: 'requestContent'
+    );
+
+    $result = $client->attachments()->download(url: 'https://www.example.com/jira/attachments/10000');
+
+    expect($result)->toBe(downloadAttachment());
+});

tests/Transporters/HttpTransporter.php

@@ -38,29 +38,35 @@
     $this->http->request(payload: Payload::create(uri: 'api/2/issues'));
 });
 
-it('can send valid request and receive invalid response (errorMessage)', function () {
+it('can send valid request and receive invalid response (errorMessage)', function (string $function) {
     $this->client->shouldReceive('sendRequest')
         ->once()
         ->andReturn(new Response(status: 400, body: json_encode(errorMessage())));
 
-    $this->http->request(payload: Payload::create(uri: 'api/2/issues'));
-})->throws(ErrorException::class, errorMessage()['errorMessage'], 0);
+    $this->http->{$function}(payload: Payload::create(uri: 'api/2/issues'));
+})
+    ->with('functions')
+    ->throws(ErrorException::class, errorMessage()['errorMessage'], 0);
 
-it('can send valid request and receive invalid response (errorMessages)', function () {
+it('can send valid request and receive invalid response (errorMessages)', function (string $function) {
     $this->client->shouldReceive('sendRequest')
         ->once()
         ->andReturn(new Response(status: 400, body: json_encode(errorMessages())));
 
-    $this->http->request(payload: Payload::create(uri: 'api/2/issues'));
-})->throws(ErrorException::class, errorMessages()['errorMessages'][0], 0);
+    $this->http->{$function}(payload: Payload::create(uri: 'api/2/issues'));
+})
+    ->with('functions')
+    ->throws(ErrorException::class, errorMessages()['errorMessages'][0], 0);
 
-it('can send valid request and receive invalid response (errors)', function () {
+it('can send valid request and receive invalid response (errors)', function (string $function) {
     $this->client->shouldReceive('sendRequest')
         ->once()
         ->andReturn(new Response(status: 400, body: json_encode(errors())));
 
-    $this->http->request(payload: Payload::create(uri: 'api/2/issues'));
-})->throws(ErrorException::class, errors()['errors']['customfield_18208'], 0);
+    $this->http->{$function}(payload: Payload::create(uri: 'api/2/issues'));
+})
+    ->with('functions')
+    ->throws(ErrorException::class, errors()['errors']['customfield_18208'], 0);
 
 it('can send valid request and receive invalid response (syntax)', function () {
     $this->client->shouldReceive('sendRequest')
@@ -70,7 +76,7 @@
     $this->http->request(payload: Payload::create(uri: 'api/2/issues'));
 })->throws(UnserializableResponse::class, 'Syntax error', 0);
 
-it('will fail because of a client errors', function () {
+it('will fail because of a client errors', function (string $function) {
     $payload = Payload::create(
         uri: 'api/2/issues',
     );
@@ -87,5 +93,15 @@
             )
         );
 
-    $this->http->request(payload: $payload);
-})->throws(TransporterException::class, 'Could not resolve host.', 0);
+    $this->http->{$function}(payload: $payload);
+})
+    ->with('functions')
+    ->throws(TransporterException::class, 'Could not resolve host.', 0);
+
+it('can send valid requestContent and receive valid response', function () {
+    $this->client->shouldReceive('sendRequest')
+        ->once()
+        ->andReturn(new Response(body: ''));
+
+    $this->http->requestContent(payload: Payload::create(uri: 'https://www.example.com/jira/attachments/10000', query: ['a' => 'b']));
+});