Merge pull request #42 from mailerlite/develop

v0.3.0

Author: dominykasmailer

README.md

@@ -6,7 +6,7 @@ You can find more examples and information about MailerLite API v2 here: [http:/
 
 ## Getting started
 
-In order to use this library you need to have at least PHP 5.6 version.
+In order to use this library you need to have at least PHP 7.1 version.
 
 There are two ways to use MailerLite PHP SDK:
 
@@ -20,6 +20,13 @@ Then you will need to run this simple command using CLI:
 composer require mailerlite/mailerlite-api-v2-php-sdk
 ```
 
+This library is built atop of [PSR-7](https://www.php-fig.org/psr/psr-7/) and
+[PSR-18](https://www.php-fig.org/psr/psr-18/). If you are receiving `Http\Discovery\Exception\DiscoveryFailedException` exception, you will need to run:
+
+```bash
+composer require php-http/guzzle6-adapter
+```
+
 ##### Manual (preferable for shared hostings)
 
 This way is preferable only if you are using shared hosting and do not have a possibility to use Composer. You will need to download [this archive](https://bit.ly/32jmi7M)(v0.2.3), extract it and place its contents in root folder of your project. The next step is the same as using Composer, you will need to require `vendor/autoload.php` file in your index.php and lets dive in!

composer.json

@@ -5,25 +5,16 @@
     "license": "MIT",
     "keywords": ["mailerlite", "sdk", "email", "marketing"],
     "type": "library",
-    "authors": [
-        {
-            "name": "Justinas Pošiūnas",
-            "email": "justinas.posiunas@mailerlite.com",
-            "homepage": "https://mailerlite.com",
-            "role": "Developer"
-        }
-    ],
     "require": {
-        "php" : "^5.5|^7.0",
-        "guzzlehttp/psr7": "~1.2",
-        "php-http/httplug": "^1.0",
-        "php-http/curl-client": "^1.4",
-        "php-http/message": "^1.2"
+        "php" : "^7.1",
+        "php-http/client-common": "^2.0",
+        "php-http/discovery": "^1.7",
+        "nyholm/psr7": "^1.0",
+        "ext-json": "*"
     },
     "require-dev": {
-        "php-http/guzzle6-adapter": "^1.0",
-        "phpunit/phpunit": "5.3.*",
-        "mockery/mockery": "^0.9.4"
+        "php-http/guzzle6-adapter": "^2.0",
+        "phpunit/phpunit": "6.* | 7.* | 8.* | 9.*"
     },
     "autoload": {
         "psr-4": {

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 \MailerLiteApi\Common\Collection
+     */
+    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/Api/Campaigns.php

@@ -3,7 +3,13 @@
 namespace MailerLiteApi\Api;
 
 use MailerLiteApi\Common\ApiAbstract;
+use MailerLiteApi\Exceptions\MailerLiteSdkException;
 
+/**
+ * Class Campaigns
+ *
+ * @package MailerLiteApi\Api
+ */
 class Campaigns extends ApiAbstract {
 
     protected $endpoint = 'campaigns';
@@ -13,11 +19,17 @@ class Campaigns extends ApiAbstract {
      *
      * @param int   $campaignId
      * @param array $contentData
-     * @param array $params
      * @return [type]
      */
-    public function addContent($campaignId, $contentData = [], $params = [])
+    public function addContent(int $campaignId, array $contentData)
     {
+        if ( ! array_key_exists('html', $contentData)) {
+            throw new MailerLiteSdkException("HTML must be provided");
+        }
+        if ( ! array_key_exists('plain', $contentData)) {
+            throw new MailerLiteSdkException("Plain text must be provided");
+        }
+
         $endpoint = $this->endpoint . '/' . $campaignId . '/content';
 
         $response = $this->restClient->put($endpoint, $contentData);
@@ -59,7 +71,7 @@ public function cancel($campaignId)
     /**
      * Get collection of items
      * @param  array $fields
-     * @return [type]
+     * @return \MailerLiteApi\Common\Collection
      */
     public function get($type = 'sent', $fields = ['*'])
     {
@@ -78,4 +90,4 @@ public function get($type = 'sent', $fields = ['*'])
 
         return $entities;
     }
-}
+}

src/Api/Fields.php

@@ -4,6 +4,11 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Fields
+ *
+ * @package MailerLiteApi\Api
+ */
 class Fields extends ApiAbstract {
 
     protected $endpoint = 'fields';
@@ -15,4 +20,4 @@ public function getAccountFields() {
         return $response['body'];
     }
 
-}
+}

src/Api/Groups.php

@@ -4,6 +4,11 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Groups
+ *
+ * @package MailerLiteApi\Api
+ */
 class Groups extends ApiAbstract {
 
     protected $endpoint = 'groups';
@@ -102,4 +107,4 @@ public function importSubscribers(
 
         return $response['body'];
     }
-}
+}

src/Api/Segments.php

@@ -4,8 +4,13 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Segments
+ *
+ * @package MailerLiteApi\Api
+ */
 class Segments extends ApiAbstract {
 
     protected $endpoint = 'segments';
 
-}
+}

src/Api/Settings.php

@@ -4,6 +4,11 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Settings
+ *
+ * @package MailerLiteApi\Api
+ */
 class Settings extends ApiAbstract {
 
     protected $endpoint = 'settings';
@@ -33,4 +38,4 @@ public function setDoubleOptin( $status ) {
         return $response['body'];
     }
 
-}
+}

src/Api/Stats.php

@@ -4,6 +4,11 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Stats
+ *
+ * @package MailerLiteApi\Api
+ */
 class Stats extends ApiAbstract {
 
     protected $endpoint = 'stats';
@@ -22,4 +27,4 @@ public function getHistorical($timestamp)
         return $response['body'];
     }
 
-}
+}

src/Api/Subscribers.php

@@ -4,8 +4,19 @@
 
 use MailerLiteApi\Common\ApiAbstract;
 
+/**
+ * Class Subscribers
+ *
+ * @package MailerLiteApi\Api
+ */
 class Subscribers extends ApiAbstract {
 
+    const TYPE_ACTIVE = 'active';
+    const TYPE_UNSUBSCRIBED = 'unsubscribed';
+    const TYPE_BOUNCED = 'bounced';
+    const TYPE_JUNK = 'junk';
+    const TYPE_UNCONFIRMED = 'unconfirmed';
+
     protected $endpoint = 'subscribers';
 
     /**
@@ -66,4 +77,29 @@ public function search($query)
         return $response['body'];
     }
 
-}
+    /**
+     * Get all subscribers
+     *
+     * @param  string[]  $fields
+     * @param  null|string  $type
+     *
+     * @return \MailerLiteApi\Common\Collection
+     */
+    public function get($fields = ['*'], $type = null)
+    {
+        $params = $this->prepareParams();
+
+        if ( ! empty($fields) && is_array($fields) && $fields != ['*']) {
+            $params['fields'] = $fields;
+        }
+
+        if ($type !== null) {
+            $params['type'] = $type;
+        }
+
+        $response = $this->restClient->get($this->endpoint, $params);
+
+        return $this->generateCollection($response['body']);
+    }
+
+}