2.x: Split responsability of Request class

netflie · Jan 6, 2023 · 17f76e9 · 17f76e9
1 parent d2b3d72
commit 17f76e9
Show file tree

Hide file tree

Showing 19 changed files with 242 additions and 301 deletions.
diff --git a/src/Client.php b/src/Client.php
@@ -42,11 +42,11 @@ public function __construct(string $graph_version, ?ClientHandler $handler = nul
      *
      * @throws Netflie\WhatsAppCloudApi\Response\ResponseException
      */
-    public function sendRequest(Request $request): Response
+    public function sendMessage(Request\MessageRequest $request): Response
     {
-        $raw_response = $this->handler->send(
-            $this->buildRequestUri($request),
-            $request->encodedBody(),
+        $raw_response = $this->handler->postJsonData(
+            $this->buildRequestUri($request->nodePath()),
+            $request->body(),
             $request->headers(),
             $request->timeout()
         );
@@ -75,8 +75,8 @@ private function buildBaseUri(): string
         return self::BASE_GRAPH_URL . '/' . $this->graph_version;
     }
 
-    private function buildRequestUri(Request $request): string
+    private function buildRequestUri(string $node_path): string
     {
-        return $this->buildBaseUri() . '/' . $request->fromPhoneNumberId() . '/messages';
+        return $this->buildBaseUri() . '/' . $node_path;
     }
 }
diff --git a/src/Http/ClientHandler.php b/src/Http/ClientHandler.php
@@ -5,16 +5,16 @@
 interface ClientHandler
 {
     /**
-     * Sends a request to the server and returns the raw response.
+     * Sends a POST request to the server and returns the raw response.
      *
      * @param string $url     The endpoint to send the request to.
-     * @param string $body    The body of the request.
+     * @param array  $body    The body of the request.
      * @param array  $headers The request headers.
      * @param int    $timeout The timeout in seconds for the request.
      *
      * @return RawResponse Response from the server.
      *
      * @throws Netflie\WhatsAppCloudApi\Response\ResponseException
      */
-    public function send(string $url, string $body, array $headers, int $timeout): RawResponse;
+    public function postJsonData(string $url, array $body, array $headers, int $timeout): RawResponse;
 }
diff --git a/src/Http/GuzzleClientHandler.php b/src/Http/GuzzleClientHandler.php
@@ -23,10 +23,10 @@ public function __construct(?Client $guzzle_client = null)
      * {@inheritDoc}
      *
      */
-    public function send(string $url, string $body, array $headers, int $timeout): RawResponse
+    public function postJsonData(string $url, array $body, array $headers, int $timeout): RawResponse
     {
         $raw_handler_response = $this->guzzle_client->post($url, [
-            'body' => $body,
+            'json' => $body,
             'headers' => $headers,
             'timeout' => $timeout,
         ]);

diff --git a/src/Request.php b/src/Request.php
@@ -2,44 +2,18 @@
 
 namespace Netflie\WhatsAppCloudApi;
 
-use Netflie\WhatsAppCloudApi\Message\Message;
-
 abstract class Request
 {
     /**
      * @const int The timeout in seconds for a normal request.
      */
     public const DEFAULT_REQUEST_TIMEOUT = 60;
 
-    /**
-     * @var Message WhatsApp Message to be sent.
-     */
-    protected Message $message;
-
     /**
      * @var string The access token to use for this request.
      */
     protected string $access_token;
 
-    /**
-     * @var string WhatsApp Number Id from messages will sent.
-     */
-    protected string $from_phone_number_id;
-
-    /**
-     * The raw body request.
-     *
-     * @return array
-     */
-    protected array $body;
-
-    /**
-     * The raw encoded body request.
-     *
-     * @return string
-     */
-    protected string $encoded_body;
-
     /**
      * The timeout request.
      *
@@ -53,35 +27,10 @@ abstract class Request
      * @param Message               $message
      * @param string                $access_token
      */
-    public function __construct(Message $message, string $access_token, string $from_phone_number_id, ?int $timeout = null)
+    public function __construct(string $access_token, ?int $timeout = null)
     {
-        $this->message = $message;
         $this->access_token = $access_token;
-        $this->from_phone_number_id = $from_phone_number_id;
         $this->timeout = $timeout ?? static::DEFAULT_REQUEST_TIMEOUT;
-
-        $this->makeBody();
-        $this->encodeBody();
-    }
-
-    /**
-     * Returns the raw body of the request.
-     *
-     * @return array
-     */
-    public function body(): array
-    {
-        return $this->body;
-    }
-
-    /**
-     * Returns the body of the request encoded.
-     *
-     * @return string
-     */
-    public function encodedBody(): string
-    {
-        return $this->encoded_body;
     }
 
     /**
@@ -93,7 +42,6 @@ public function headers(): array
     {
         return [
             'Authorization' => "Bearer $this->access_token",
-            'Content-Type' => 'application/json',
         ];
     }
 
@@ -107,16 +55,6 @@ public function accessToken(): string
         return $this->access_token;
     }
 
-    /**
-     * Return WhatsApp Number Id for this request.
-     *
-     * @return string
-     */
-    public function fromPhoneNumberId(): string
-    {
-        return $this->from_phone_number_id;
-    }
-
     /**
      * Return the timeout for this request.
      *
@@ -126,21 +64,4 @@ public function timeout(): int
     {
         return $this->timeout;
     }
-
-    /**
-     * Makes the raw body of the request.
-     *
-     * @return array
-     */
-    abstract protected function makeBody(): void;
-
-    /**
-     * Encodes the raw body of the request.
-     *
-     * @return array
-     */
-    private function encodeBody(): void
-    {
-        $this->encoded_body = json_encode($this->body());
-    }
 }
diff --git a/src/Request/MessageRequest.php b/src/Request/MessageRequest.php
@@ -0,0 +1,54 @@
+<?php
+
+namespace Netflie\WhatsAppCloudApi\Request;
+
+use Netflie\WhatsAppCloudApi\Message\Message;
+use Netflie\WhatsAppCloudApi\Request;
+
+abstract class MessageRequest extends Request
+{
+    /**
+     * @var Message WhatsApp Message to be sent.
+     */
+    protected Message $message;
+
+    /**
+     * @var string WhatsApp Number Id from messages will sent.
+     */
+    protected string $from_phone_number_id;
+
+    public function __construct(Message $message, string $access_token, string $from_phone_number_id, ?int $timeout = null)
+    {
+        $this->message = $message;
+        $this->from_phone_number_id = $from_phone_number_id;
+
+        parent::__construct($access_token, $timeout);
+    }
+
+    /**
+     * Returns the raw body of the request.
+     *
+     * @return array
+     */
+    abstract public function body(): array;
+
+    /**
+     * Return WhatsApp Number Id for this request.
+     *
+     * @return string
+     */
+    public function fromPhoneNumberId(): string
+    {
+        return $this->from_phone_number_id;
+    }
+
+    /**
+     * WhatsApp node path.
+     *
+     * @return string
+     */
+    public function nodePath(): string
+    {
+        return $this->from_phone_number_id . '/messages';
+    }
+}
diff --git a/src/Request/RequestAudioMessage.php → ...st/MessageRequest/RequestAudioMessage.php b/src/Request/RequestAudioMessage.php → ...st/MessageRequest/RequestAudioMessage.php
@@ -1,18 +1,17 @@
 <?php
 
-namespace Netflie\WhatsAppCloudApi\Request;
+namespace Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-use Netflie\WhatsAppCloudApi\Request;
+use Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-class RequestAudioMessage extends Request
+class RequestAudioMessage extends MessageRequest
 {
     /**
-     * Makes the raw body of the request.
-     *
-     */
-    protected function makeBody(): void
+    * {@inheritdoc}
+    */
+    public function body(): array
     {
-        $this->body = [
+        return [
             'messaging_product' => $this->message->messagingProduct(),
             'recipient_type' => $this->message->recipientType(),
             'to' => $this->message->to(),

diff --git a/src/Request/RequestContactMessage.php → .../MessageRequest/RequestContactMessage.php b/src/Request/RequestContactMessage.php → .../MessageRequest/RequestContactMessage.php
@@ -1,20 +1,19 @@
 <?php
 
-namespace Netflie\WhatsAppCloudApi\Request;
+namespace Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-use Netflie\WhatsAppCloudApi\Request;
+use Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-class RequestContactMessage extends Request
+class RequestContactMessage extends MessageRequest
 {
     /**
-     * Makes the raw body of the request.
-     *
-     */
-    protected function makeBody(): void
+    * {@inheritdoc}
+    */
+    public function body(): array
     {
         $message_type = $this->message->type();
 
-        $this->body = [
+        $body = [
             'messaging_product' => $this->message->messagingProduct(),
             'recipient_type' => $this->message->recipientType(),
             'to' => $this->message->to(),
@@ -40,7 +39,9 @@ protected function makeBody(): void
                 $phone_array['wa_id'] = $phone->waId();
             }
 
-            $this->body[$message_type][0]['phones'][] = $phone_array;
+            $body[$message_type][0]['phones'][] = $phone_array;
         }
+
+        return $body;
     }
 }
diff --git a/src/Request/RequestDocumentMessage.php → ...MessageRequest/RequestDocumentMessage.php b/src/Request/RequestDocumentMessage.php → ...MessageRequest/RequestDocumentMessage.php
@@ -1,18 +1,17 @@
 <?php
 
-namespace Netflie\WhatsAppCloudApi\Request;
+namespace Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-use Netflie\WhatsAppCloudApi\Request;
+use Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-class RequestDocumentMessage extends Request
+class RequestDocumentMessage extends MessageRequest
 {
     /**
-     * Makes the raw body of the request.
-     *
-     */
-    protected function makeBody(): void
+    * {@inheritdoc}
+    */
+    public function body(): array
     {
-        $this->body = [
+        return [
             'messaging_product' => $this->message->messagingProduct(),
             'recipient_type' => $this->message->recipientType(),
             'to' => $this->message->to(),

diff --git a/src/Request/RequestImageMessage.php → ...st/MessageRequest/RequestImageMessage.php b/src/Request/RequestImageMessage.php → ...st/MessageRequest/RequestImageMessage.php
@@ -1,18 +1,17 @@
 <?php
 
-namespace Netflie\WhatsAppCloudApi\Request;
+namespace Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-use Netflie\WhatsAppCloudApi\Request;
+use Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-class RequestImageMessage extends Request
+class RequestImageMessage extends MessageRequest
 {
     /**
-     * Makes the raw body of the request.
-     *
-     */
-    protected function makeBody(): void
+    * {@inheritdoc}
+    */
+    public function body(): array
     {
-        $this->body = [
+        return [
             'messaging_product' => $this->message->messagingProduct(),
             'recipient_type' => $this->message->recipientType(),
             'to' => $this->message->to(),

diff --git a/src/Request/RequestLocationMessage.php → ...MessageRequest/RequestLocationMessage.php b/src/Request/RequestLocationMessage.php → ...MessageRequest/RequestLocationMessage.php
@@ -1,18 +1,17 @@
 <?php
 
-namespace Netflie\WhatsAppCloudApi\Request;
+namespace Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-use Netflie\WhatsAppCloudApi\Request;
+use Netflie\WhatsAppCloudApi\Request\MessageRequest;
 
-class RequestLocationMessage extends Request
+class RequestLocationMessage extends MessageRequest
 {
     /**
-     * Makes the raw body of the request.
-     *
-     */
-    protected function makeBody(): void
+    * {@inheritdoc}
+    */
+    public function body(): array
     {
-        $this->body = [
+        return [
             'messaging_product' => $this->message->messagingProduct(),
             'recipient_type' => $this->message->recipientType(),
             'to' => $this->message->to(),