Miscellaneous Client Test Suite (#88)

* Miscellaneous Client Test Suite
* InvoiceCheckoutHtml Result Class + Test

src/Client/Miscellaneous.php

@@ -4,13 +4,13 @@
 
 namespace BTCPayServer\Client;
 
-use BTCPayServer\Result\InvoiceCheckoutHTML;
+use BTCPayServer\Result\InvoiceCheckoutHtml;
 use BTCPayServer\Result\LanguageCodeList;
-use BTCPayServer\Result\PermissionMetadata;
+use BTCPayServer\Result\PermissionMetadataList;
 
 class Miscellaneous extends AbstractClient
 {
-    public function getPermissionMetadata(): PermissionMetadata
+    public function getPermissionMetadata(): PermissionMetadataList
     {
         $url = $this->getBaseUrl() . '/misc/permissions';
         $headers = $this->getRequestHeaders();
@@ -19,7 +19,7 @@ public function getPermissionMetadata(): PermissionMetadata
         $response = $this->getHttpClient()->request($method, $url, $headers);
 
         if ($response->getStatus() === 200) {
-            return new PermissionMetadata(
+            return new PermissionMetadataList(
                 json_decode($response->getBody(), true, 512, JSON_THROW_ON_ERROR)
             );
         } else {
@@ -47,7 +47,7 @@ public function getLanguageCodes(): LanguageCodeList
     public function getInvoiceCheckout(
         string $invoiceId,
         ?string $lang
-    ): InvoiceCheckoutHTML {
+    ): InvoiceCheckoutHtml {
         $url = $this->getBaseUrl() . '/i/' . urlencode($invoiceId);
 
         //set language query parameter if passed
@@ -61,9 +61,7 @@ public function getInvoiceCheckout(
         $response = $this->getHttpClient()->request($method, $url, $headers);
 
         if ($response->getStatus() === 200) {
-            return new InvoiceCheckoutHTML(
-                json_decode($response->getBody(), true, 512, JSON_THROW_ON_ERROR)
-            );
+            return new InvoiceCheckoutHtml($response->getBody());
         } else {
             throw $this->getExceptionByStatusCode($method, $url, $response);
         }

src/Result/InvoiceCheckoutHtml.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BTCPayServer\Result;
+
+class InvoiceCheckoutHtml
+{
+    /**
+     * @var string
+     */
+    private $html;
+
+    public function __construct(string $html)
+    {
+        $this->html = $html;
+    }
+
+    public function getHtml(): string
+    {
+        return $this->html;
+    }
+
+    public function __toString()
+    {
+        return $this->html;
+    }
+}

src/Result/LanguageCodeList.php

@@ -7,13 +7,13 @@
 class LanguageCodeList extends AbstractListResult
 {
     /**
-     * @return \BTCPayServer\Result\LanguageCode[]
+     * @return LanguageCode[]
      */
     public function all(): array
     {
         $languageCodes = [];
         foreach ($this->getData() as $languageCode) {
-            $languageCodes[] = new \BTCPayServer\Result\LanguageCode($languageCode);
+            $languageCodes[] = new LanguageCode($languageCode);
         }
         return $languageCodes;
     }

src/Result/PermissionMetadataList.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BTCPayServer\Result;
+
+class PermissionMetadataList extends AbstractListResult
+{
+    /**
+     * @return PermissionMetadata[]
+     */
+    public function all(): array
+    {
+        $permissionMetadataList = [];
+        foreach ($this->getData() as $permissionMetadata) {
+            $permissionMetadataList[] = new PermissionMetadata($permissionMetadata);
+        }
+        return $permissionMetadataList;
+    }
+}

tests/BaseTest.php

@@ -44,4 +44,10 @@ public function testItSetsAllTheEnvironmentVariables(): void
         $this->assertNotEmpty($this->storeId);
         $this->assertNotEmpty($this->nodeUri);
     }
+
+    public function dd($var): void
+    {
+        var_dump($var);
+        die();
+    }
 }

tests/MiscellaneousTest.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BTCPayServer\Tests;
+
+use BTCPayServer\Client\Invoice;
+use BTCPayServer\Client\Miscellaneous;
+use BTCPayServer\Result\InvoiceCheckoutHtml;
+use BTCPayServer\Result\LanguageCode;
+use BTCPayServer\Result\LanguageCodeList;
+use BTCPayServer\Result\PermissionMetadata;
+use BTCPayServer\Result\PermissionMetadataList;
+use BTCPayServer\Util\PreciseNumber;
+
+final class MiscellaneousTest extends BaseTest
+{
+    private Miscellaneous $miscellaneousClient;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->miscellaneousClient = new Miscellaneous($this->host, $this->apiKey);
+    }
+
+    public function testItCanGetPermissionMetadata(): void
+    {
+        $result = $this->miscellaneousClient->getPermissionMetadata();
+
+        $this->assertInstanceOf(PermissionMetadataList::class, $result);
+
+        foreach ($result->all() as $permissionMetadata) {
+            $this->assertInstanceOf(PermissionMetadata::class, $permissionMetadata);
+            $this->assertIsString($permissionMetadata->getName());
+            $this->assertIsArray($permissionMetadata->getIncluded());
+        }
+    }
+
+    public function testItCanGetLanguageCodes(): void
+    {
+        $result = $this->miscellaneousClient->getLanguageCodes();
+
+        $this->assertInstanceOf(LanguageCodeList::class, $result);
+
+        foreach ($result->all() as $languageCode) {
+            $this->assertInstanceOf(LanguageCode::class, $languageCode);
+            $this->assertIsString($languageCode->getCode());
+            $this->assertIsString($languageCode->getCurrentLanguage());
+        }
+    }
+
+    public function testItCanGetInvoiceCheckout(): void
+    {
+        $invoiceClient = new Invoice($this->host, $this->apiKey);
+
+        $invoice = $invoiceClient->createInvoice(
+            storeId: $this->storeId,
+            currency: 'SATS',
+            amount: PreciseNumber::parseString('1000'),
+        );
+
+        $result = $this->miscellaneousClient->getInvoiceCheckout($invoice->getId(), null);
+
+        $this->assertInstanceOf(InvoiceCheckoutHtml::class, $result);
+        $this->assertStringContainsString('<!DOCTYPE html>', $result->getHtml());
+    }
+}