♻️ use enums for endpoints and wrap it all up

willpower232 · willpower232 · commit dc551ae55870 · 2024-04-10T13:57:19.000+01:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -10,9 +10,9 @@ jobs:
       matrix:
         php: [8.1, 8.2, 8.3]
         symfony_process: [4, 5, 6, 7]
-        # exclude:
-        #   - php: 8.1
-        #     symfony_process: 7
+        exclude:
+          - php: 8.1
+            symfony_process: 7
 
     steps:
       - uses: actions/checkout@v4
diff --git a/README.md b/README.md
@@ -3,11 +3,11 @@
 
 _For pre-V1 documentation [click here](https://github.com/SynergiTech/chrome-pdf-php/blob/v0/README.md)_
 
+_For pre-V3 documentation [click here](https://github.com/SynergiTech/chrome-pdf-php/blob/v2/README.md)_
+
 This is a library for creating PDFs from HTML rendered with the SkPDF backend via Chrome. In order to do this, you can opt to use one of the supported drivers:
 * [SynergiTech/chrome-pdf](https://github.com/SynergiTech/chrome-pdf)
-* [browserless](https://www.browserless.io/)
-
-Currently supports PHP ^8
+* [Browserless](https://www.browserless.io/)
 
 ## Installation
 ```
@@ -16,8 +16,8 @@ composer require synergitech/chrome-pdf-php
 ### chrome-pdf
 If you are planning to use the [`chrome-pdf`](https://github.com/SynergiTech/chrome-pdf) driver to render PDFs locally, you should also make sure to install this from npm.
 
-### browserless
-If you are planning to use the [browserless](https://www.browserless.io/) driver to render PDFs remotely or take screenshots, you should register for an API key. Remember that local assets cannot be rendered by browserless.
+### Browserless
+If you are planning to use the [Browserless](https://www.browserless.io/) driver to render PDFs remotely or take screenshots, you should register for an API key. Remember that local assets cannot be rendered by Browserless.
 
 ## Usage
 A common interface is provided via AbstractPDF. The options presented via this class will be available from all drivers.
@@ -26,17 +26,32 @@ You should instantiate one of the available drivers, potentially passing options
 ```php
 use SynergiTech\ChromePDF\Chrome;
 use SynergiTech\ChromePDF\Browserless;
-use SynergiTech\ChromePDF\Browserless\Screenshot;
 
 $pdf = new Chrome('path-to-chrome-pdf');
 $pdf->renderContent('<h1>test</h1>');
 
 $pdf = new Browserless('your-api-key');
 $pdf->renderContent('<h1>test</h1>');
+```
+
+### Advanced Browserless Usage
+
+You can optionally use specific endpoints when you create a client.
+
+```php
+use SynergiTech\ChromePDF\Browserless;
+
+$pdf = new Browserless('your-api-key', Browserless\EndpointsEnum::London);
+```
+
+As this library essentially functions as an API client for Browserless, we have also implemented the screenshot API.
+
+```php
+use SynergiTech\ChromePDF\Browserless;
 
 // For information on options, see https://www.browserless.io/docs/screenshot#custom-options.
 // `render()` defaults to using jpeg with a quality of 75 and fullPage set to false.
-$file = new Screenshot('your-api-key');
+$file = new Browserless\Screenshot('your-api-key');
 $file->render('https://example.com');
 $file->render('https://example.com', [
     'fullPage' => true,
diff --git a/src/Browserless.php b/src/Browserless.php
@@ -182,7 +182,7 @@ public function getFormattedOptions(): array
      */
     private function render(array $options)
     {
-         return $this->request($this->pdfEndpoint, $options);
+        return $this->request($this->pdfEndpoint, $options);
     }
 
     /**
diff --git a/src/Browserless/Client.php b/src/Browserless/Client.php
@@ -17,24 +17,17 @@ trait Client
     private $apiKey;
 
     /**
-     * @var string
-     */
-    private $apiUrl = 'https://chrome.browserless.io';
-
-    // public const EUROPE_REGION_URL = 'production-lon.browserless.io';
-
-    // public const US_REGION_URL = 'production-sfo.browserless.io';
-
-    /**
-     * @param string $apiKey api key from browserless.io
      * @param \GuzzleHttp\Client $client custom Guzzle client
      */
-    public function __construct(string $apiKey = null, $client = null)
-    {
+    public function __construct(
+        string $apiKey = null,
+        EndpointsEnum|string $endpoint = EndpointsEnum::Default,
+        $client = null
+    ) {
         if ($client === null) {
             // @codeCoverageIgnoreStart
             $client = new \GuzzleHttp\Client([
-                'base_uri' => $this->apiUrl,
+                'base_uri' => ($endpoint instanceof EndpointsEnum) ? $endpoint->value : $endpoint,
             ]);
             // @codeCoverageIgnoreEnd
         }
@@ -90,9 +83,9 @@ protected function request(string $endpoint, array $json)
                 }
             }
 
-            throw new APIException("Failed to render PDF: {$message}", $e->getCode(), $e);
+            throw new APIException("Failed to render from Browserless: {$message}", $e->getCode(), $e);
         } catch (\Exception $e) {
-            throw new APIException("Failed to render PDF: {$e->getMessage()}", $e->getCode(), $e);
+            throw new APIException("Failed to render from Browserless: {$e->getMessage()}", $e->getCode(), $e);
         }
 
         return StreamWrapper::getResource($response->getBody());
diff --git a/src/Browserless/EndpointsEnum.php b/src/Browserless/EndpointsEnum.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace SynergiTech\ChromePDF\Browserless;
+
+enum EndpointsEnum: string
+{
+    case Default = 'https://chrome.browserless.io';
+    case London = 'https://production-lon.browserless.io';
+    case SanFrancisco = 'https://production-sfo.browserless.io';
+}
diff --git a/src/Browserless/Screenshot.php b/src/Browserless/Screenshot.php
@@ -7,12 +7,7 @@ class Screenshot
     use Client;
 
     /**
-     * Defaults to the following options:
-     * - quality: 75
-     * - type: jpeg
-     * - fullPage: true
-     *
-     * @param array<string, mixed> $options see https://www.browserless.io/docs/screenshot#custom-options
+     * @param array<string,mixed> $options see https://www.browserless.io/docs/screenshot#custom-options
      *
      * @return resource
      */
@@ -22,6 +17,7 @@ public function render(string $url, array $options = [])
             'type' => 'jpeg',
             'fullPage' => false,
         ], $options);
+
         if ($options['type'] === 'jpeg' && ! isset($options['quality'])) {
             $options['quality'] = 75;
         }
@@ -31,7 +27,7 @@ public function render(string $url, array $options = [])
             json: [
                 'url' => $url,
                 'options' => $options,
-            ]
+            ],
         );
     }
 }
diff --git a/test/Browserless/ScreenshotTest.php b/test/Browserless/ScreenshotTest.php
@@ -3,10 +3,7 @@
 namespace SynergiTech\ChromePDF\Test\Browserless;
 
 use GuzzleHttp\Psr7\Response;
-
-use SynergiTech\ChromePDF\Browserless;
 use SynergiTech\ChromePDF\Browserless\Screenshot;
-use SynergiTech\ChromePDF\Chrome;
 use SynergiTech\ChromePDF\Test\TestCase;
 
 class ScreenshotTest extends TestCase
@@ -20,7 +17,7 @@ public function test_render()
             ->with($this->anything(), $this->hasKeyValue(['json', 'url'], $this->identicalTo('test')))
             ->willReturn(new Response(200, [], 'screenshot'));
 
-        $bl = new Screenshot('', $client);
+        $bl = new Screenshot(client: $client);
         $stream = $bl->render('test');
 
         $this->assertIsResource($stream);
diff --git a/test/BrowserlessTest.php b/test/BrowserlessTest.php
@@ -29,7 +29,7 @@ public function test_rotation()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
 
         $this->assertNull($bl->getRotation());
 
@@ -54,7 +54,7 @@ public function test_safeMode()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
 
         $this->assertFalse($bl->getSafeMode());
 
@@ -74,7 +74,7 @@ public function test_timeout()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
 
         $this->assertNull($bl->getTimeout());
 
@@ -117,7 +117,7 @@ public function test_displayHeaderFooter()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setDisplayHeaderFooter(true);
@@ -155,7 +155,7 @@ public function test_header()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setHeader('header-test');
@@ -180,7 +180,7 @@ public function test_footer()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setFooter('footer-test');
@@ -205,7 +205,7 @@ public function test_format()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setFormat('Letter');
@@ -234,7 +234,7 @@ public function test_width()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setWidth('100px');
@@ -266,7 +266,7 @@ public function test_height()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setHeight('100px');
@@ -298,7 +298,7 @@ public function test_landscape()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setLandscape(true);
@@ -374,7 +374,7 @@ public function test_margin()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setMargin('20px');
@@ -415,7 +415,7 @@ public function test_pageRanges()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setPageRanges('2,5-7');
@@ -451,7 +451,7 @@ public function test_preferCSSPageSize()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setPreferCSSPageSize(true);
@@ -486,7 +486,7 @@ public function test_printBackground()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setPrintBackground(true);
@@ -518,7 +518,7 @@ public function test_scale()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setScale(2);
@@ -550,7 +550,7 @@ public function test_waitUntil()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setWaitUntil('domcontentloaded');
@@ -582,7 +582,7 @@ public function test_mediaEmulation()
             )
             ->willReturn(new Response());
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $bl->renderContent('test');
 
         $bl->setMediaEmulation('screen');
@@ -601,7 +601,7 @@ public function test_renderContent()
             ->with($this->anything(), $this->hasKeyValue(['json', 'html'], $this->identicalTo('test')))
             ->willReturn(new Response(200, [], 'rendered-pdf'));
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $stream = $bl->renderContent('test');
 
         $this->assertIsResource($stream);
@@ -617,7 +617,7 @@ public function test_renderURL()
             ->with($this->anything(), $this->hasKeyValue(['json', 'url'], $this->identicalTo('https://bbc.co.uk')))
             ->willReturn(new Response(200, [], 'rendered-pdf'));
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $stream = $bl->renderURL('https://bbc.co.uk');
 
         $this->assertIsResource($stream);
@@ -637,7 +637,7 @@ public function test_renderFile()
         fwrite($tmpfile, 'test file');
         $path = stream_get_meta_data($tmpfile)['uri'];
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         $stream = $bl->renderFile($path);
 
         $this->assertIsResource($stream);
@@ -658,7 +658,7 @@ public function test_plainError()
         $handler = HandlerStack::create($mock);
         $client = new Client(['handler' => $handler]);
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         try {
             $stream = $bl->renderContent('');
         } catch (APIException $e) {
@@ -681,7 +681,7 @@ public function test_jsonError()
         $handler = HandlerStack::create($mock);
         $client = new Client(['handler' => $handler]);
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         try {
             $stream = $bl->renderContent('');
         } catch (APIException $e) {
@@ -705,7 +705,7 @@ public function test_miscError()
         $handler = HandlerStack::create($mock);
         $client = new Client(['handler' => $handler]);
 
-        $bl = new Browserless('', $client);
+        $bl = new Browserless(client: $client);
         try {
             $stream = $bl->renderContent('');
         } catch (APIException $e) {

Original file line number	Diff line number	Diff line change
`@@ -182,7 +182,7 @@ public function getFormattedOptions(): array`
`182`	`182`	`*/`
`183`	`183`	`private function render(array $options)`
`184`	`184`	`{`
`185`		`- return $this->request($this->pdfEndpoint, $options);`
	`185`	`+ return $this->request($this->pdfEndpoint, $options);`
`186`	`186`	`}`
`187`	`187`
`188`	`188`	`/**`