ClientTest.php

<?php

declare(strict_types=1);

namespace TheCodingMachine\Gotenberg;

use HTTP\Client\Exception;
use PHPUnit\Framework\TestCase;
use Safe\Exceptions\FilesystemException;
use function method_exists;

final class ClientTest extends TestCase
{
    public const API_URL = 'gotenberg:3000';

    /** @var HTMLRequest */
    private $HTMLRequest;

    /** @var URLRequest */
    private $URLRequest;

    /** @var MarkdownRequest */
    private $markdownRequest;

    /** @var OfficeRequest */
    private $officeRequest;

    /** @var MergeRequest */
    private $mergeRequest;

    /**
     * @throws RequestException
     */
    public function setUp(): void
    {
        $this->HTMLRequest = $this->createHTMLRequest();
        $this->URLRequest = $this->createURLRequest();
        $this->markdownRequest = $this->createMarkdownRequest();
        $this->officeRequest = $this->createOfficeRequest();
        $this->mergeRequest = $this->createMergeRequest();
    }

    /**
     * @throws RequestException
     */
    private function createHTMLRequest(): HTMLRequest
    {
        $index = DocumentFactory::makeFromPath('index.html', __DIR__ . '/assets/html/index.html');
        $header = DocumentFactory::makeFromPath('header.html', __DIR__ . '/assets/html/header.html');
        $footer = DocumentFactory::makeFromPath('footer.html', __DIR__ . '/assets/html/footer.html');
        $assets = [
            DocumentFactory::makeFromPath('font.woff', __DIR__ . '/assets/html/font.woff'),
            DocumentFactory::makeFromPath('img.gif', __DIR__ . '/assets/html/img.gif'),
            DocumentFactory::makeFromPath('style.css', __DIR__ . '/assets/html/style.css'),
        ];
        $request = new HTMLRequest($index);
        $request->setResultFilename('foo.pdf');
        $request->setWaitTimeout(5.0);
        $request->setWaitDelay(1.0);
        $request->setHeader($header);
        $request->setFooter($footer);
        $request->setAssets($assets);
        $request->setPaperSize(Request::A4);
        $request->setMargins(Request::NO_MARGINS);
        $request->setGoogleChromeRpccBufferSize(1048576);
        $request->setScale(0.9);

        return $request;
    }

    /**
     * @throws RequestException
     */
    private function createURLRequest(): URLRequest
    {
        $header = DocumentFactory::makeFromPath('header.html', __DIR__ . '/assets/url/header.html');
        $footer = DocumentFactory::makeFromPath('footer.html', __DIR__ . '/assets/url/footer.html');
        $request = new URLRequest('https://google.com');
        $request->setResultFilename('foo.pdf');
        $request->setWaitTimeout(5.0);
        $request->setWaitDelay(1.0);
        $request->setHeader($header);
        $request->setFooter($footer);
        $request->setPaperSize(Request::A4);
        $request->setMargins(Request::NO_MARGINS);
        $request->setGoogleChromeRpccBufferSize(1048576);

        return $request;
    }

    /**
     * @throws RequestException
     */
    public function createMarkdownRequest(): MarkdownRequest
    {
        $index = DocumentFactory::makeFromPath('index.html', __DIR__ . '/assets/markdown/index.html');
        $markdowns = [
            DocumentFactory::makeFromPath('paragraph1.md', __DIR__ . '/assets/markdown/paragraph1.md'),
            DocumentFactory::makeFromPath('paragraph2.md', __DIR__ . '/assets/markdown/paragraph2.md'),
            DocumentFactory::makeFromPath('paragraph3.md', __DIR__ . '/assets/markdown/paragraph3.md'),
        ];
        $header = DocumentFactory::makeFromPath('header.html', __DIR__ . '/assets/markdown/header.html');
        $footer = DocumentFactory::makeFromPath('footer.html', __DIR__ . '/assets/markdown/footer.html');
        $assets = [
            DocumentFactory::makeFromPath('font.woff', __DIR__ . '/assets/markdown/font.woff'),
            DocumentFactory::makeFromPath('img.gif', __DIR__ . '/assets/markdown/img.gif'),
            DocumentFactory::makeFromPath('style.css', __DIR__ . '/assets/markdown/style.css'),
        ];
        $request = new MarkdownRequest($index, $markdowns);
        $request->setResultFilename('foo.pdf');
        $request->setWaitTimeout(5.0);
        $request->setWaitDelay(1.0);
        $request->setHeader($header);
        $request->setFooter($footer);
        $request->setAssets($assets);
        $request->setPaperSize(Request::A4);
        $request->setMargins(Request::NO_MARGINS);
        $request->setGoogleChromeRpccBufferSize(1048576);

        return $request;
    }

    public function createOfficeRequest(): OfficeRequest
    {
        $files = [
            DocumentFactory::makeFromPath('document.docx', __DIR__ . '/assets/office/document.docx'),
        ];
        $request = new OfficeRequest($files);
        $request->setResultFilename('foo.pdf');
        $request->setWaitTimeout(5.0);
        $request->setLandscape(false);

        return $request;
    }

    public function createMergeRequest(): MergeRequest
    {
        $files = [
            DocumentFactory::makeFromPath('gotenberg.pdf', __DIR__ . '/assets/pdf/gotenberg.pdf'),
            DocumentFactory::makeFromPath('gotenberg2.pdf', __DIR__ . '/assets/pdf/gotenberg.pdf'),
        ];
        $request = new MergeRequest($files);
        $request->setResultFilename('foo.pdf');
        $request->setWaitTimeout(5.0);

        return $request;
    }

    /**
     * @throws ClientException
     * @throws Exception
     */
    public function testPost(): void
    {
        $client = new Client(self::API_URL, new \Http\Adapter\Guzzle6\Client());
        // case 1: HTML.
        $response = $client->post($this->HTMLRequest);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertNotEmpty($response->getBody());
        // case 2: URL.
        $response = $client->post($this->URLRequest);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertNotEmpty($response->getBody());
        // case 3: markdown.
        $response = $client->post($this->markdownRequest);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertNotEmpty($response->getBody());
        // case 4: office.
        $response = $client->post($this->officeRequest);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertNotEmpty($response->getBody());
        // case 5: merge.
        $response = $client->post($this->mergeRequest);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertNotEmpty($response->getBody());
    }

    /**
     * @throws ClientException
     * @throws FilesystemException
     * @throws Exception
     */
    public function testStore(): void
    {
        $client = new Client(self::API_URL);
        // case 1: HTML.
        $filePath = __DIR__ . '/store/resultHTML.pdf';
        $client->store($this->HTMLRequest, $filePath);
        $this->assertFileExists($filePath);
        // case 2: URL.
        $filePath = __DIR__ . '/store/resultURL.pdf';
        $client->store($this->URLRequest, $filePath);
        $this->assertFileExists($filePath);
        // case 3: markdown.
        $filePath = __DIR__ . '/store/resultMarkdown.pdf';
        $client->store($this->markdownRequest, $filePath);
        $this->assertFileExists($filePath);
        // case 4: office.
        $filePath = __DIR__ . '/store/resultOffice.pdf';
        $client->store($this->officeRequest, $filePath);
        $this->assertFileExists($filePath);
        // case 5: merge.
        $filePath = __DIR__ . '/store/resultMerge.pdf';
        $client->store($this->mergeRequest, $filePath);
        $this->assertFileExists($filePath);
    }

    /**
     * @throws ClientException
     * @throws RequestException
     */
    public function testPageRanges(): void
    {
        $client = new Client(self::API_URL, new \Http\Adapter\Guzzle6\Client());
        // case 1: HTML.
        $request = $this->createHTMLRequest();
        $request->setPageRanges('1-1');
        $response = $client->post($request);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertNotEmpty($response->getBody());
        // case 2: URL.
        $request = $this->createURLRequest();
        $request->setPageRanges('1-1');
        $response = $client->post($request);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertNotEmpty($response->getBody());
        // case 3: markdown.
        $request = $this->createMarkdownRequest();
        $request->setPageRanges('1-1');
        $response = $client->post($request);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertNotEmpty($response->getBody());
        // case 4: office.
        $request = $this->createOfficeRequest();
        $request->setPageRanges('1-1');
        $response = $client->post($request);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertNotEmpty($response->getBody());
    }

    /**
     * @throws ClientException
     */
    public function testWebhook(): void
    {
        $client = new Client(self::API_URL, new \Http\Adapter\Guzzle6\Client());
        $request = $this->createMergeRequest();
        $request->setWebhookURL('https://google.com');
        $request->setWebhookURLTimeout(5.0);
        $request->addWebhookURLHTTPHeader('A-Header', 'Foo');
        $response = $client->post($request);
        $this->assertEquals(200, $response->getStatusCode());
    }

    /**
     * @throws RequestException
     * @throws ClientException
     */
    public function testRemoteURLHTTPHeader(): void
    {
        $client = new Client(self::API_URL, new \Http\Adapter\Guzzle6\Client());
        $request = $this->createURLRequest();
        $request->addRemoteURLHTTPHeader('A-Header', 'Foo');
        $response = $client->post($request);
        $this->assertEquals(200, $response->getStatusCode());
    }

    /**
     * @throws RequestException
     * @throws ClientException
     */
    public function testStream(): void
    {
        $client = new Client(self::API_URL, new \Http\Adapter\Guzzle6\Client());
        // case 1: HTML.
        $request = $this->createHTMLRequest();
        $request->setPageRanges('1-1');
        $this->assertCaseFor($request, $client);

        // case 2: URL.
        $request = $this->createURLRequest();
        $request->setPageRanges('1-1');
        $this->assertCaseFor($request, $client);
        // case 3: markdown.
        $request = $this->createMarkdownRequest();
        $request->setPageRanges('1-1');
        $this->assertCaseFor($request, $client);

        // case 4: office.
        $request = $this->createOfficeRequest();
        $request->setPageRanges('1-1');
        $this->assertCaseFor($request, $client);
    }

    private function assertCaseFor($request, $client): void
    {
        if (method_exists($request, 'setWaitTimeout')) {
            $request->setWaitTimeout(30.0);
        }

        $response = $client->stream($request);
        $this->assertEquals($response->getHeaderLine('Content-Type'), 'application/pdf');
        $this->assertEquals($response->getHeaderLine('Content-Disposition'), 'inline; filename=stream.pdf');
        $this->assertEquals($response->getHeaderLine('Cache-Control'), 'max-age=0');
        $this->assertEquals(200, $response->getStatusCode());
        $this->assertNotEmpty($response->getBody());
    }
}