Added custom PDF object resource

Author: luisdalmolin

README.md

@@ -26,6 +26,53 @@ $bee = new Bee(new \GuzzleHttp\Client);
 $bee->setApiToken('your-api-token-here');
 ```
 
+### Using Message Services API: HTML
+
+This API allows you to post the JSON content generated on the Bee editor, and it will return the rendered HTML of the JSON. Reference: https://docs.beefree.io/message-services-api-reference/#html
+
+```php
+$beeEditorData = []; // this will be the JSON generated using the editor
+$html = $bee->html($beeEditorData);
+```
+
+### Using Message Services API: PDF
+
+This API allows you to post the HTML content and get an URL with a PDF created from the HTML. Reference: https://docs.beefree.io/message-services-api-reference/#pdf
+
+```php
+$pdf = $bee->pdf([
+    'html' => $html, // HTML generated using the HTML API (required)
+    'page_size' => 'Letter', // (optional)
+    'page_orientation' => 'Landscape', // (optional)
+]);
+
+// then, you can call these methods:
+$pdf->getUrl();
+$pdf->getFilename();
+$pdf->getPageSize();
+$pdf->getPageOrientation();
+$pdf->getContentType();
+```
+
+### Using Message Services API: Image
+
+This API allows you to post the HTML content and get an URL with a PDF created from the HTML. Reference: https://docs.beefree.io/message-services-api-reference/#image
+
+```php
+$image = $bee->image([
+    'html' => $html, // HTML generated using the HTML API (required)
+    'width' => 500, // (required)
+    'height' => 400, // (optional)
+    'file_type' => 'jpg',
+]);
+
+// then, you can save the image content somewhere, some examples on how you may do this:
+file_put_contents('/path/to/storage/image.jpg', $image);
+
+// on Laravel with Storage object:
+Storage::put('/path/to/storage/image.jpg', $image);
+```
+
 ### Testing
 
 ``` bash

src/Bee.php

@@ -2,7 +2,9 @@
 
 namespace KirschbaumDevelopment\Bee;
 
+use Exception;
 use GuzzleHttp\Client as GuzzleClient;
+use KirschbaumDevelopment\Bee\Resources\Pdf;
 
 class Bee
 {
@@ -68,6 +70,10 @@ public function html(array $json)
      */
     public function pdf(array $payload)
     {
+        if (! isset($payload['html'])) {
+            throw new Exception('"html" parameter is required to generate PDFs');
+        }
+
         $response = $this->httpClient->post(
             sprintf('%s/pdf', static::API_BASE_URL),
             [
@@ -78,7 +84,7 @@ public function pdf(array $payload)
             ]
         );
 
-        return json_decode($response->getBody()->getContents(), true);
+        return new Pdf(json_decode($response->getBody()->getContents(), true));
     }
 
     /**

src/Resources/Pdf.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace KirschbaumDevelopment\Bee\Resources;
+
+class Pdf
+{
+    /**
+     * @var string
+     */
+    protected $url;
+
+    /**
+     * @var string
+     */
+    protected $filename;
+
+    /**
+     * @var string
+     */
+    protected $pageSize;
+
+    /**
+     * @var string
+     */
+    protected $pageOrientation;
+
+    /**
+     * @var string
+     */
+    protected $contentType;
+
+    public function __construct($pdfData)
+    {
+        $this->url = $pdfData['url'] ?? null;
+        $this->filename = $pdfData['filename'] ?? null;
+        $this->pageSize = $pdfData['page_size'] ?? null;
+        $this->pageOrientation = $pdfData['page_orientation'] ?? null;
+        $this->contentType = $pdfData['content_type'] ?? 'application/pdf';
+    }
+
+    /**
+     * @return string
+     */
+    public function getUrl()
+    {
+        return $this->url;
+    }
+
+    /**
+     * @return string
+     */
+    public function getFilename()
+    {
+        return $this->filename;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPageSize()
+    {
+        return $this->pageSize;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPageOrientation()
+    {
+        return $this->pageOrientation;
+    }
+
+    /**
+     * @return string
+     */
+    public function getContentType()
+    {
+        return $this->contentType;
+    }
+
+    /**
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->getUrl();
+    }
+}

tests/BeeTest.php

@@ -6,8 +6,9 @@
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Psr7\Response;
 use PHPUnit\Framework\TestCase;
-use GuzzleHttp\Handler\MockHandler;
 use KirschbaumDevelopment\Bee\Bee;
+use GuzzleHttp\Handler\MockHandler;
+use KirschbaumDevelopment\Bee\Resources\Pdf;
 
 /**
  * @coversDefaultClass \KirschbaumDevelopment\Bee\Bee
@@ -46,9 +47,14 @@ public function testPdf()
         $guzzleClient = new Client(['handler' => HandlerStack::create($mock)]);
 
         $beeClient = new Bee($guzzleClient);
-        $this->assertEquals($response, $beeClient->pdf([
-            'html' => $html,
-        ]));
+        $pdf = $beeClient->pdf(['html' => $html]);
+
+        $this->assertInstanceOf(Pdf::class, $pdf);
+        $this->assertEquals($response['url'], $pdf->getUrl());
+        $this->assertEquals($response['filename'], $pdf->getFilename());
+        $this->assertEquals($response['page_size'], $pdf->getPageSize());
+        $this->assertEquals($response['page_orientation'], $pdf->getPageOrientation());
+        $this->assertEquals($response['content_type'], $pdf->getContentType());
     }
 
     /**