Add support for getting the list of files provided by the print-api service

Author: leganz

.phpunit.result.cache

@@ -1 +1 @@
-C:37:"PHPUnit\Runner\DefaultTestResultCache":1964:{a:2:{s:7:"defects";a:6:{s:93:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWorksWithMinimalSetup";i:4;s:89:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillFillTheResult";i:4;s:79:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterCanFail";i:4;s:99:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillCallUrlWithoutException";i:4;s:117:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillNotBeExecutedIfCreateWasNotSuccessful";i:4;s:96:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillRespectTheFolder";i:4;}s:5:"times";a:12:{s:93:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWorksWithMinimalSetup";d:0.09;s:89:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillFillTheResult";d:0.005;s:79:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterCanFail";d:0.006;s:99:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillCallUrlWithoutException";d:0.006;s:117:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillNotBeExecutedIfCreateWasNotSuccessful";d:0.005;s:96:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillRespectTheFolder";d:0.007;s:82:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWorksWithMinimalSetup";d:0.084;s:78:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillFillTheResult";d:0.006;s:68:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterCanFail";d:0.006;s:88:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillCallUrlWithoutException";d:0.005;s:106:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillNotBeExecutedIfCreateWasNotSuccessful";d:0.004;s:85:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillRespectTheFolder";d:0.005;}}}
+C:37:"PHPUnit\Runner\DefaultTestResultCache":2731:{a:2:{s:7:"defects";a:13:{s:93:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWorksWithMinimalSetup";i:4;s:89:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillFillTheResult";i:4;s:79:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterCanFail";i:4;s:99:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillCallUrlWithoutException";i:4;s:117:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillNotBeExecutedIfCreateWasNotSuccessful";i:4;s:96:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillRespectTheFolder";i:4;s:79:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterListWillReturnData";i:5;s:82:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWorksWithMinimalSetup";i:4;s:78:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillFillTheResult";i:4;s:68:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterCanFail";i:4;s:88:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillCallUrlWithoutException";i:4;s:106:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillNotBeExecutedIfCreateWasNotSuccessful";i:4;s:85:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillRespectTheFolder";i:4;}s:5:"times";a:13:{s:93:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWorksWithMinimalSetup";d:0.09;s:89:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillFillTheResult";d:0.005;s:79:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterCanFail";d:0.006;s:99:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillCallUrlWithoutException";d:0.006;s:117:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillNotBeExecutedIfCreateWasNotSuccessful";d:0.005;s:96:"AMBERSIVE\PdfPrinter\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillRespectTheFolder";d:0.007;s:82:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWorksWithMinimalSetup";d:0.057;s:78:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillFillTheResult";d:0.003;s:68:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterCanFail";d:0.004;s:88:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterWillCallUrlWithoutException";d:0.003;s:106:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillNotBeExecutedIfCreateWasNotSuccessful";d:0.004;s:85:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterSaveWillRespectTheFolder";d:0.003;s:79:"AMBERSIVE\Tests\Unit\Classes\PdfPrinterTest::testIfPdfPrinterListWillReturnData";d:0.004;}}}

CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [0.3.0] - 2020-07-30
+### Added
+- Added support for the [GET] /api/browse endpoint from the printer-api
+
 ## [0.2.0] - 2020-07-10
 ### Changed
 - Restructure the project to be able to run unit tests automatically.

src/Classes/PdfPrinter.php

@@ -4,11 +4,13 @@
 
 use AMBERSIVE\PdfPrinter\Interfaces\PdfPrinterInterface;
 use AMBERSIVE\PdfPrinter\Classes\PdfPrinterOption;
+use AMBERSIVE\PdfPrinter\Classes\PdfPrinterFile;
 
 use GuzzleHttp\Exception\GuzzleException;
 use \GuzzleHttp\Client;
 
 use \Illuminate\Http\Response;
+use Illuminate\Support\Collection;
 
 use Validator;
 use Storage;
@@ -96,6 +98,33 @@ public function create(String $url, PdfPrinterOption $options = null, Callable $
         return $this;
     }
 
+    /**
+     * Returns a collection of all files available on the printer api
+     *
+     * @return Collection
+     */
+    public function listFiles(): Collection {
+
+        $headers = [];
+
+        if ($this->authType !== null && $this->authType !== "") {
+            $headers['Authorization'] = $this->authToken;
+        }
+
+        $response = $this->client->request("GET", $this->settings->url("api/browse"), [
+            'headers' => $headers
+        ]);
+
+        $json = $response === null ? null : json_decode($response->getBody());
+
+        $result = collect($json)->map(function($item){
+            return new PdfPrinterFile($item);
+        });
+
+        return $result;
+
+    }
+    
     /**
      * Downlaod the pdf document if the the endpoint failed uploading it.
      *

src/Classes/PdfPrinterFile.php

@@ -0,0 +1,24 @@
+<?php
+
+
+namespace AMBERSIVE\PdfPrinter\Classes;
+
+use GuzzleHttp\Psr7\Response;
+
+use Carbon\Carbon;
+ 
+class PdfPrinterFile {
+
+     public String $file;
+     public String $path;
+     public Carbon $createdAt;
+     public Carbon $updatedAt;
+
+     public function __construct(Object $file = null) {
+            $this->file = optional($file)->filename !== null ? optional($file)->filename : '';
+            $this->path = optional($file)->path !== null ? optional($file)->path : '';
+            $this->createdAt = Carbon::parse(optional($file)->created_at);
+            $this->updatedAt = Carbon::parse(optional($file)->updated_at);
+     }
+
+}

tests/Unit/PdfPrinterTest.php

@@ -238,4 +238,26 @@ public function testIfPdfPrinterSaveWillRespectTheFolder():void {
 
     }
 
+    /**
+     * Test if the method will the listed files from the api endpoint
+     */
+    public function testIfPdfPrinterListWillReturnData(): void {
+
+        $response =  new PdfPrinterMockResponse(200,[
+            [
+                "file" =>  "XXX.pdf",
+                "path" =>  "test/XXX.pd",
+                "created_at" => "2020-06-27T22:27:09.876Z",
+                "updated_at" => "2020-06-27T22:27:09.876Z"
+            ]
+        ]);
+
+        $pdfPrinter = $this->createApiMock([$response]); 
+        $result = $pdfPrinter->listFiles();
+
+        $this->assertNotNull($result);
+        $this->assertEquals(1, $result->count());
+
+    }
+
 }