Merge pull request #1 from jayanratna/client

feat: add client to make API requests to Resend

Author: jayanratna

.github/workflows/tests.yml

@@ -4,9 +4,9 @@ on:
   push:
     branches:
       - main
-    pull_request:
-    schedule:
-      - cron: '0 0 * * *'
+  pull_request:
+  schedule:
+    - cron: '0 0 * * *'
 
 jobs:
   tests:
@@ -15,10 +15,29 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: ['8.0', 8.1, 8.2]
+        php: [8.1, 8.2]
 
     name: PHP ${{ matrix.php }}
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }},
+          extensions: dom, mbstring, zip,
+          coverage: none
+
+      - name: Install dependencies
+        run: composer update --no-interaction --prefer-dist
+
+      - name: Execute tests
+        run: vendor/bin/pest --verbose

.gitignore

@@ -1,6 +1,7 @@
 # Ignore cache directories and files.
 /.phpunit.cache
 .php-cs-fixer.cache
+.psysh.php
 
 # Mac OS X dumps these all over the place.
 .DS_Store

README.md

@@ -1,8 +1,29 @@
 # Resend PHP
 
-![Tests](https://img.shields.io/github/actions/workflow/status/jayanratna/resend-php/tests.yml?label=tests&style=for-the-badge&labelColor=000000)
-![License](https://img.shields.io/github/license/jayanratna/resend-php?color=9cf&style=for-the-badge&labelColor=000000)
+[![Tests](https://img.shields.io/github/actions/workflow/status/jayanratna/resend-php/tests.yml?label=tests&style=for-the-badge&labelColor=000000)](https://github.com/jayanratna/resend-php/actions/workflows/tests.yml)
+[![License](https://img.shields.io/github/license/jayanratna/resend-php?color=9cf&style=for-the-badge&labelColor=000000)](https://github.com/jayanratna/resend-php/blob/main/LICENSE)
+
+---
 
 ## Getting started
 
-Visit [Resend](https://resend.com).
+> **Requires [PHP 8.1+](https://php.net/releases/)**
+
+First, install Resend via the [Composer](https://getcomposer.org/) package manager:
+
+```bash
+composer require resend/client
+```
+
+Then, interact with Resend's API:
+
+```php
+$resend = Resend::client('re_123456789');
+
+$resend->sendEmail([
+    'from' => '[email protected]',
+    'to' => '[email protected]',
+    'subject' => 'hello world',
+    'text' => 'it works!',
+]);
+```

composer.json

@@ -10,11 +10,13 @@
         }
     ],
     "require": {
-        "php": "^8.0"
+        "php": "^8.0",
+        "guzzlehttp/guzzle": "^7.5"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.13",
-        "pestphp/pest": "^1.22"
+        "pestphp/pest": "^1.22",
+        "pestphp/pest-plugin-mock": "^1.0"
     },
     "autoload": {
         "psr-4": {

src/Client.php

@@ -2,6 +2,30 @@
 
 namespace Resend;
 
+use Resend\Contracts\Transporter;
+use Resend\Responses\Email\EmailSent;
+use Resend\ValueObjects\Transporter\Payload;
+
 class Client
 {
+    /**
+     * Create a new Client instance with the given transporter.
+     */
+    public function __construct(
+        private readonly Transporter $transporter
+    ) {
+        //
+    }
+
+    /**
+     * Send an email with the given parameters.
+     */
+    public function sendEmail(array $parameters): EmailSent
+    {
+        $payload = Payload::create('email', $parameters);
+
+        $result = $this->transporter->request($payload);
+
+        return EmailSent::from($result);
+    }
 }

src/Concerns/ArrayAccessible.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Resend\Concerns;
+
+use BadMethodCallException;
+
+trait ArrayAccessible
+{
+    public function offsetExists(mixed $offset): bool
+    {
+        return array_key_exists($offset, $this->toArray());
+    }
+
+    public function offsetGet(mixed $offset): mixed
+    {
+        return $this->toArray()[$offset];
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        throw new BadMethodCallException('Cannot set response attributes.');
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        throw new BadMethodCallException('Cannot unset response attributes.');
+    }
+}

src/Contracts/Response.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Resend\Contracts;
+
+use ArrayAccess;
+
+interface Response extends ArrayAccess
+{
+    /**
+     * Returns the array representation of the Response.
+     *
+     * @return TArray
+     */
+    public function toArray(): array;
+}

src/Contracts/Stringable.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Resend\Contracts;
+
+interface Stringable
+{
+    /**
+     * Returns the string representation of the object.
+     */
+    public function toString(): string;
+}

src/Contracts/Transporter.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Resend\Contracts;
+
+use Resend\ValueObjects\Transporter\Payload;
+
+interface Transporter
+{
+    /**
+     * Sends a request to the Resend API.
+     *
+     * @return array<array-key, mixed>
+     */
+    public function request(Payload $payload): array;
+}

src/Enums/Transporter/ContentType.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Resend\Enums\Transporter;
+
+enum ContentType: string
+{
+    case JSON = 'application/json';
+    case MULTIPART = 'multipart/form-data';
+}

src/Enums/Transporter/Method.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Resend\Enums\Transporter;
+
+enum Method: string
+{
+    case GET = 'GET';
+    case POST = 'POST';
+    case PUT = 'PUT';
+    case DELETE = 'DELETE';
+}

src/Exceptions/ErrorException.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Resend\Exceptions;
+
+use Exception;
+
+final class ErrorException extends Exception
+{
+    /**
+     * Creates a new Error Exception instance.
+     */
+    public function __construct(private readonly array $contents)
+    {
+        parent::__construct($contents['message']);
+    }
+}

src/Exceptions/TransporterException.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Resend\Exceptions;
+
+use Exception;
+use Psr\Http\Client\ClientExceptionInterface;
+
+final class TransporterException extends Exception
+{
+    /**
+     * Create a new Transporter exception.
+     */
+    public function __construct(ClientExceptionInterface $exception)
+    {
+        parent::__construct($exception->getMessage(), 0, $exception);
+    }
+}

src/Exceptions/UnserializableResponse.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Resend\Exceptions;
+
+use Exception;
+use JsonException;
+
+final class UnserializableResponse extends Exception
+{
+    /**
+     * Create a new Unserializable Response exception.
+     */
+    public function __construct(JsonException $exception)
+    {
+        parent::__construct($exception->getMessage(), 0, $exception);
+    }
+}

src/Resend.php

@@ -1,11 +1,26 @@
 <?php
 
+use GuzzleHttp\Client as GuzzleClient;
 use Resend\Client;
+use Resend\Transporters\HttpTransporter;
+use Resend\ValueObjects\ApiKey;
+use Resend\ValueObjects\Transporter\BaseUri;
+use Resend\ValueObjects\Transporter\Headers;
 
 final class Resend
 {
+    /**
+     * Creates a new Resend Client with the given API key.
+     */
     public static function client(string $apiKey): Client
     {
-        return new Client($apiKey);
+        $apiKey = ApiKey::from($apiKey);
+        $baseUri = BaseUri::from('api.resend.com');
+        $headers = Headers::withAuthorization($apiKey);
+
+        $client = new GuzzleClient();
+        $transporter = new HttpTransporter($client, $baseUri, $headers);
+
+        return new Client($transporter);
     }
 }

src/Responses/Email/EmailSent.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Resend\Responses\Email;
+
+use Resend\Concerns\ArrayAccessible;
+use Resend\Contracts\Response;
+
+final class EmailSent implements Response
+{
+    use ArrayAccessible;
+
+    public function __construct(
+        public readonly string $id,
+        public readonly string $from,
+        public readonly string $to
+    ) {
+        //
+    }
+
+    public static function from(array $attributes): self
+    {
+        return new self(
+            $attributes['id'],
+            $attributes['from'],
+            $attributes['to']
+        );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function toArray(): array
+    {
+        return [
+            'id' => $this->id,
+            'from' => $this->from,
+            'to' => $this->to,
+        ];
+    }
+}