Merge pull request #18 from resendlabs/feat-new-api-endpoints

Author: jayanratna

.php-cs-fixer.php

@@ -113,6 +113,10 @@
         'positions' => ['inside', 'outside'],
     ],
     'no_spaces_inside_parenthesis' => true,
+    'no_superfluous_phpdoc_tags' => [
+        'allow_mixed' => true,
+        'allow_unused_params' => true,
+    ],
     'no_trailing_comma_in_list_call' => true,
     'no_trailing_comma_in_singleline_array' => true,
     'no_trailing_whitespace' => true,

phpunit.xml

@@ -9,9 +9,9 @@
             <directory suffix=".php">./tests</directory>
         </testsuite>
     </testsuites>
-    <coverage>
+    <source>
         <include>
             <directory suffix=".php">./src</directory>
         </include>
-    </coverage>
+    </source>
 </phpunit>

src/ApiKey.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Resend;
+
+/**
+ * @property string $id The unique identifier for the API key.
+ * @property string $name The name of the API key.
+ * @property string $created_at Time at which the API key was created.
+ * @property string|null $token The new API key to authenticate request with Resend.
+ */
+final class ApiKey extends Resource
+{
+    //
+}

src/Client.php

@@ -3,11 +3,22 @@
 namespace Resend;
 
 use Resend\Contracts\Transporter;
-use Resend\Responses\Email\Sent;
+use Resend\Service\ServiceFactory;
 use Resend\ValueObjects\Transporter\Payload;
 
+/**
+ * Client used to send requests to the Resend API.
+ *
+ * @property \Resend\Service\ApiKey $apiKeys
+ * @property \Resend\Service\Domain $domains
+ */
 class Client
 {
+    /**
+     * The service factory instance.
+     */
+    private ServiceFactory $serviceFactory;
+
     /**
      * Create a new Client instance with the given transporter.
      */
@@ -22,12 +33,32 @@ public function __construct(
      *
      * @see https://resend.com/docs/api-reference/send-email#body-parameters
      */
-    public function sendEmail(array $parameters): Sent
+    public function sendEmail(array $parameters): Email
     {
         $payload = Payload::create('email', $parameters);
 
         $result = $this->transporter->request($payload);
 
-        return Sent::from($result);
+        return Email::from($result);
+    }
+
+    /**
+     * Magic method to retrieve a service by name.
+     */
+    public function __get(string $name)
+    {
+        return $this->getService($name);
+    }
+
+    /**
+     * Attach the given API service to the client.
+     */
+    private function getService(string $name)
+    {
+        if (! isset($this->serviceFactory)) {
+            $this->serviceFactory = new ServiceFactory($this->transporter);
+        }
+
+        return $this->serviceFactory->getService($name);
     }
 }

src/Collection.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Resend;
+
+use ArrayIterator;
+use InvalidArgumentException;
+use IteratorAggregate;
+use Traversable;
+
+/**
+ * @template TResource of Resource
+ * @template-implements \IteratorAggregate<TResource>
+ *
+ * @property TResource[] $data
+ */
+final class Collection extends Resource implements IteratorAggregate
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getIterator(): Traversable
+    {
+        return new ArrayIterator($this->data);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function offsetGet(mixed $offset): mixed
+    {
+        if (is_string($offset)) {
+            return parent::offsetGet($offset);
+        }
+
+        throw new InvalidArgumentException("You tried to access the {$offset} index, but Collection types only support string keys.");
+    }
+}

src/Concerns/ArrayAccessible.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Resend\Contracts;
+
+use ArrayAccess;
+use JsonSerializable;
+
+interface Resource extends ArrayAccess, JsonSerializable
+{
+    //
+}

src/Contracts/Resource.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Resend;
+
+final class Domain extends Resource
+{
+    //
+}

src/Domain.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Resend;
+
+/**
+ * @property string $id The unique identifier for the API key.
+ * @property string $from The sender's email address.
+ * @property string $to The email recipient address.
+ * @property string $created_at Time at which the API key was created.
+ */
+final class Email extends Resource
+{
+    //
+}

src/Email.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Resend\Exceptions;
+
+use OutOfBoundsException;
+
+class MissingAttributeException extends OutOfBoundsException
+{
+    //
+}

src/Exceptions/MissingAttributeException.php

@@ -0,0 +1,133 @@
+<?php
+
+namespace Resend;
+
+use BadMethodCallException;
+use Resend\Contracts\Resource as ResourceContract;
+use Resend\Exceptions\MissingAttributeException;
+
+class Resource implements ResourceContract
+{
+    /**
+     * The resources's attributes.
+     */
+    protected $attributes = [];
+
+    /**
+     * Create a new Resource instance.
+     */
+    public function __construct(array $attributes = [])
+    {
+        $this->fill($attributes);
+    }
+
+    /**
+     * Create a new resource from the given attributes.
+     */
+    public static function from(array $attributes): static
+    {
+        return new static($attributes);
+    }
+
+    /**
+     * Fill the resource with an array of attributes.
+     */
+    protected function fill(array $attributes): void
+    {
+        $fillable = $attributes;
+
+        foreach ($fillable as $key => $value) {
+            $this->attributes[$key] = $value;
+        }
+    }
+
+    /**
+     * Get an attribute by name.
+     */
+    public function getAttribute($name)
+    {
+        if (! $name) {
+            return;
+        }
+
+        if (array_key_exists($name, $this->attributes)) {
+            return $this->getAttributes()[$name] ?? null;
+        }
+
+        return null;
+    }
+
+    /**
+     * Get all attributes for the resource.
+     */
+    public function getAttributes(): array
+    {
+        return $this->attributes;
+    }
+
+    /**
+     * Convert the resource instance into an array.
+     */
+    public function toArray(): array
+    {
+        return $this->getAttributes();
+    }
+
+    /**
+     * Convert the resource instance into JSON.
+     */
+    public function toJson(int $options = 0): string
+    {
+        $json = json_encode($this->jsonSerialize(), $options);
+
+        return $json;
+    }
+
+    /**
+     * Convert the object into something JSON serializable.
+     */
+    public function jsonSerialize(): mixed
+    {
+        return $this->toArray();
+    }
+
+    /**
+     * Dynamically retrieve attributes on the resource.
+     */
+    public function __get($name)
+    {
+        return $this->getAttribute($name);
+    }
+
+    /**
+     * Get all the attributes when dumping the resource.
+     */
+    public function __debugInfo(): array
+    {
+        return $this->getAttributes();
+    }
+
+    public function offsetExists(mixed $offset): bool
+    {
+        try {
+            return ! is_null($this->getAttribute($offset));
+        } catch (MissingAttributeException) {
+            return false;
+        }
+    }
+
+    public function offsetGet(mixed $offset): mixed
+    {
+        return $this->getAttribute($offset);
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        throw new BadMethodCallException('Cannot set resource attributes.');
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        throw new BadMethodCallException('Cannot unset resource attributes.');
+    }
+}