Merge pull request #16 from SynergiTech/v2

V2

Author: willpower232

.github/workflows/tests.yml

@@ -0,0 +1,17 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [7.4, "8.0", 8.1, 8.2]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: test on PHP ${{ matrix.php }}
+        run: docker build . --build-arg PHP_VERSION=${{ matrix.php }}

.gitignore

@@ -2,3 +2,5 @@ vendor/
 .DS_Store
 test.php
 composer.lock
+*.cache
+coverage

Dockerfile

@@ -0,0 +1,28 @@
+ARG PHP_VERSION=7.4
+FROM php:$PHP_VERSION-cli-alpine
+
+RUN apk add git zip unzip autoconf make g++ icu-dev
+
+RUN docker-php-ext-configure intl \
+    && docker-php-ext-install -j $(nproc) intl
+
+RUN curl -sS https://getcomposer.org/installer | php \
+    && mv composer.phar /usr/local/bin/composer
+
+RUN adduser -S php
+
+WORKDIR /package
+
+RUN chown php /package
+
+USER php
+
+COPY composer.json ./
+
+RUN composer install
+
+COPY src src
+COPY tests tests
+COPY ecs.php phpunit.xml phpstan.neon ./
+
+RUN composer test

README.md

@@ -1,6 +1,6 @@
 # Postal for PHP
 
-This library helps you send e-mails through [Postal](https://github.com/atech/postal) in PHP 5.4 and above.
+This library helps you send e-mails through [Postal](https://github.com/postalserver/postal) in PHP 7.4 and above.
 
 ## Installation
 
@@ -20,7 +20,7 @@ need to login to our web interface and generate a new API credential.
 $client = new Postal\Client('https://postal.yourdomain.com', 'your-api-key');
 
 // Create a new message
-$message = new Postal\SendMessage($client);
+$message = new Postal\Send\Message();
 
 // Add some recipients
 $message->to('john@example.com');
@@ -46,12 +46,12 @@ $message->header('X-PHP-Test', 'value');
 $message->attach('textmessage.txt', 'text/plain', 'Hello world!');
 
 // Send the message and get the result
-$result = $message->send();
+$result = $client->send->message($message);
 
 // Loop through each of the recipients to get the message ID
 foreach ($result->recipients() as $email => $message) {
-    $email;            // The e-mail address of the recipient
-    $message->id();    // Returns the message ID
-    $message->token(); // Returns the message's token
+    $email;          // The e-mail address of the recipient
+    $message->id;    // The message ID
+    $message->token; // The message's token
 }
 ```

composer.json

@@ -8,16 +8,41 @@
         {
             "name": "Adam Cooke",
             "email": "me@adamcooke.io"
+        },
+        {
+            "name": "Josh Grant",
+            "email": "josh@grantj.io"
+        },
+        {
+            "name": "William Hall",
+            "email": "william.hall@synergitech.co.uk"
         }
     ],
     "type": "library",
     "require": {
-        "php": ">=5.4",
-        "rmccue/requests": "^1.0"
+        "php": "^7.4 || ^8.0",
+        "guzzlehttp/guzzle": "^6 || ^7"
     },
     "autoload": {
         "psr-4": {
             "Postal\\": "src/"
         }
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^9.6",
+        "symplify/easy-coding-standard": "^11.3"
+    },
+    "scripts": {
+        "test": [
+            "ecs",
+            "phpunit",
+            "phpstan"
+        ]
+    },
+    "config": {
+        "platform": {
+            "php": "7.4"
+        }
     }
 }

ecs.php

@@ -0,0 +1,18 @@
+<?php
+
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
+
+return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->paths([__DIR__ . '/src', __DIR__ . '/tests']);
+
+    $ecsConfig->sets([
+        SetList::ARRAY,
+        SetList::CLEAN_CODE,
+        SetList::CONTROL_STRUCTURES,
+        SetList::DOCBLOCK,
+        SetList::NAMESPACES,
+        SetList::PSR_12,
+        SetList::SPACES,
+    ]);
+};

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+    level: 9
+    paths:
+        - src

phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
+</phpunit>

src/ApiException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Postal;
+
+class ApiException extends \Exception
+{
+}

src/Client.php

@@ -1,45 +1,103 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Postal;
 
+use GuzzleHttp\Client as HttpClient;
+use Psr\Http\Message\ResponseInterface;
+
 class Client
 {
-    public function __construct($host, $serverKey)
+    public MessagesService $messages;
+
+    public SendService $send;
+
+    protected HttpClient $httpClient;
+
+    public function __construct(
+        string $host,
+        string $apiKey,
+        HttpClient $httpClient = null
+    ) {
+        $this->httpClient = $httpClient ?: HttpClientFactory::create($host, $apiKey);
+        $this->messages = new MessagesService($this);
+        $this->send = new SendService($this);
+    }
+
+    public function getHttpClient(): HttpClient
+    {
+        return $this->httpClient;
+    }
+
+    /**
+     * @template T
+     * @param class-string<T> $class
+     * @return T
+     */
+    public function prepareResponse(ResponseInterface $response, $class)
+    {
+        return new $class($this->validateResponse($response));
+    }
+
+    /**
+     * @template T
+     * @param class-string<T> $class
+     * @return array<T>
+     */
+    public function prepareListResponse(ResponseInterface $response, $class)
+    {
+        $list = $this->validateResponse($response);
+
+        // if (! array_is_list($list)) {
+        if (! $this->arrayIsList($list)) {
+            throw new ApiException('Unexpected response received, expected a list');
+        }
+
+        return array_map(fn ($item) => new $class($item), $list);
+    }
+
+    /**
+     * @return array<string|int, mixed>
+     */
+    protected function validateResponse(ResponseInterface $response): array
     {
-        $this->host = $host;
-        $this->serverKey = $serverKey;
+        $json = json_decode((string) $response->getBody(), true);
+
+        if (json_last_error() !== JSON_ERROR_NONE || ! is_array($json)) {
+            throw new ApiException('Malformed response body received');
+        }
+
+        if (! isset($json['status']) || $json['status'] !== 'success') {
+            $message = $json['data']['message'] ?? 'An unexpected error was received';
+            $code = 0;
+            if (isset($json['data']['code'])) {
+                $message = $json['data']['code'] . ': ' . $message;
+                $code = $json['data']['code'];
+            }
+
+            throw new ApiException($message, $code);
+        }
+
+        if (! isset($json['data'])) {
+            throw new ApiException('Unexpected response received');
+        }
+
+        return $json['data'];
     }
 
-    public function makeRequest($controller, $action, $parameters)
+    /**
+     * @param array<mixed> $array
+     */
+    private function arrayIsList(array $array): bool
     {
-        $url = sprintf('%s/api/v1/%s/%s', $this->host, $controller, $action);
-
-        // Headers
-        $headers = [
-            'x-server-api-key' => $this->serverKey,
-            'content-type' => 'application/json',
-        ];
-
-        // Make the body
-        $json = json_encode($parameters);
-
-        // Make the request
-        $response = \Requests::post($url, $headers, $json);
-
-        if ($response->status_code === 200) {
-            $json = json_decode($response->body);
-
-            if ($json->status == 'success') {
-                return $json->data;
-            } else {
-                if (isset($json->data->code)) {
-                    throw new Error(sprintf('[%s] %s', $json->data->code, $json->data->message));
-                } else {
-                    throw new Error($json->data->message);
-                }
+        $i = 0;
+        foreach ($array as $k => $v) {
+            if ($k !== $i++) {
+                return false;
             }
         }
 
-        throw new Error('Couldn’t send message to API');
+        return true;
     }
 }