added batch action

Author: DomasWEB

src/Api/Batch.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace MailerLiteApi\Api;
+
+use MailerLiteApi\Common\ApiAbstract;
+use MailerLiteApi\Common\BatchRequest;
+use MailerLiteApi\Exceptions\MailerLiteSdkException;
+
+/**
+ * Class Batch
+ *
+ * @package MailerLiteApi\Api
+ */
+class Batch extends ApiAbstract
+{
+
+    protected $endpoint = 'batch';
+
+    /**
+     * @param  BatchRequest[]  $requests
+     *
+     * @return mixed
+     */
+    public function send(array $requests)
+    {
+        if ( ! count($requests)) {
+            throw new MailerLiteSdkException("Provide at least one request");
+        }
+
+        foreach ($requests as &$request) {
+            if ( ! is_object($request) || get_class($request) != BatchRequest::class) {
+                throw new MailerLiteSdkException("All requests must be of type ".BatchRequest::class);
+            }
+
+            $request = $request->toArray();
+        }
+
+        $response = $this->restClient->post($this->endpoint, [
+            'requests' => $requests,
+        ]);
+
+        return $response['body'];
+    }
+
+}

src/Common/BatchRequest.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace MailerLiteApi\Common;
+
+/**
+ * Class BatchRequest
+ *
+ * @package MailerLiteApi\Common
+ */
+class BatchRequest
+{
+
+    const METHOD_GET = 'GET';
+
+    const METHOD_POST = 'POST';
+
+    const METHOD_PUT = 'PUT';
+
+    const METHOD_DELETE = 'DELETE';
+
+    /** @var string $method */
+    protected $method = self::METHOD_GET;
+
+    /** @var string $path */
+    protected $path = '';
+
+    /** @var null|array $body */
+    protected $body = null;
+
+    /**
+     * @return string
+     */
+    public function getMethod(): string
+    {
+        return $this->method;
+    }
+
+    /**
+     * @param  string  $method
+     *
+     * @return BatchRequest
+     */
+    public function setMethod(string $method): BatchRequest
+    {
+        $this->method = $method;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPath(): string
+    {
+        return $this->path;
+    }
+
+    /**
+     * @param  string  $path
+     *
+     * @return BatchRequest
+     */
+    public function setPath(string $path): BatchRequest
+    {
+        $this->path = $path;
+
+        return $this;
+    }
+
+    /**
+     * @return null
+     */
+    public function getBody()
+    {
+        return $this->body;
+    }
+
+    /**
+     * @param  null|array  $body
+     *
+     * @return BatchRequest
+     */
+    public function setBody($body)
+    {
+        $this->body = $body;
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function toArray(): array
+    {
+        $array = [
+            'method' => $this->getMethod(),
+            'path'   => $this->getPath(),
+        ];
+
+        if ($body = $this->getBody()) {
+            $array['body'] = $body;
+        }
+
+        return $array;
+    }
+
+}

src/MailerLite.php

@@ -102,6 +102,14 @@ public function segments()
         return new \MailerLiteApi\Api\Segments($this->restClient);
     }
 
+    /**
+     * @return \MailerLiteApi\Api\Batch
+     */
+    public function batch()
+    {
+        return new \MailerLiteApi\Api\Batch($this->restClient);
+    }
+
     /**
      * @param  string $version
      * @return string
@@ -111,4 +119,4 @@ public function getBaseUrl($version = ApiConstants::VERSION)
         return ApiConstants::BASE_URL . $version . '/';
     }
 
-}
+}

tests/BatchTest.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace MailerLiteApi\Tests;
+
+use MailerLiteApi\Common\BatchRequest;
+use MailerLiteApi\Exceptions\MailerLiteSdkException;
+use MailerLiteApi\MailerLite;
+
+/**
+ * Class BatchTest
+ *
+ * @package MailerLiteApi\Tests
+ */
+class BatchTest extends MlTestCase
+{
+
+    /** @var \MailerLiteApi\Api\Batch */
+    protected $api;
+
+    protected function setUp(): void
+    {
+        $this->api = (new MailerLite(API_KEY))->batch();
+    }
+
+    /** @test * */
+    public function at_least_one_request_is_provided_exception()
+    {
+        $this->expectException(MailerLiteSdkException::class);
+        $this->api->send([]);
+    }
+
+    /** @test * */
+    public function provided_requests_must_be_batch_request_class()
+    {
+        $this->expectException(MailerLiteSdkException::class);
+        $this->api->send([
+            new \stdClass(),
+        ]);
+    }
+
+    /** @test * */
+    public function send_batch()
+    {
+        $requests = [];
+        $batchOne = (new BatchRequest())
+            ->setMethod(BatchRequest::METHOD_POST)
+            ->setPath('/api/v2/subscribers')
+            ->setBody([
+                'email' => '[email protected]',
+            ]);
+
+        $batchTwo = (new BatchRequest())
+            ->setMethod(BatchRequest::METHOD_POST)
+            ->setPath('/api/v2/subscribers')
+            ->setBody([
+                'email' => '[email protected]',
+            ]);
+
+        $requests[] = $batchOne;
+        $requests[] = $batchTwo;
+
+        $result = $this->api->send($requests);
+
+        $this->assertTrue($result[0]->body->email == $batchOne->getBody()['email']);
+        $this->assertTrue($result[1]->body->email == $batchTwo->getBody()['email']);
+    }
+}