Merge pull request #47 from mailjet/ref

Ref

Author: uavn

composer.json

@@ -36,7 +36,23 @@
     },
     "autoload": {
         "psr-4": {
-            "Mailjet\\LaravelMailjet\\": "src/"
+            "Mailjet\\LaravelMailjet\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Mailjet\\LaravelMailjet\\Tests\\": "tests"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Mailjet\\LaravelMailjet\\MailjetServiceProvider",
+                "Mailjet\\LaravelMailjet\\MailjetMailServiceProvider"
+            ],
+            "aliases": {
+                "Mailjet": "Mailjet\\LaravelMailjet\\Facades\\Mailjet"
+            }
         }
     },
     "config": {

src/Contracts/CampaignContract.php

@@ -1,17 +1,18 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Mailjet\LaravelMailjet\Contracts;
 
 use Mailjet\LaravelMailjet\Model\Campaign;
 
 interface CampaignContract
 {
-
     public function getAllCampaigns(array $filters = null);
 
-    public function findByCampaignId($CampaignId);
+    public function findByCampaignId(string $id);
 
-    public function findByNewsletterId($NewsletterId);
+    public function findByNewsletterId(string $id);
 
-    public function updateCampaign($CampaignId, Campaign $campaign);
-}
+    public function updateCampaign(string $id, Campaign $campaign);
+}

src/Contracts/CampaignDraftContract.php

@@ -1,35 +1,36 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Mailjet\LaravelMailjet\Contracts;
 
 use Mailjet\LaravelMailjet\Model\CampaignDraft;
 
 interface CampaignDraftContract
 {
-
     public function getAllCampaignDrafts(array $filters = null);
 
-    public function findByCampaignDraftId($CampaignId);
+    public function findByCampaignDraftId(string $id);
 
     public function create(CampaignDraft $campaignDraft);
 
-    public function update($CampaignId, CampaignDraft $campaignDraft);
+    public function update(string $id, CampaignDraft $campaignDraft);
 
-    public function getDetailContent($id);
+    public function getDetailContent(string $id);
 
-    public function createDetailContent($id, $contentData);
+    public function createDetailContent(string $id, array $content);
 
-    public function getSchedule($CampaignId);
+    public function getSchedule(string $id);
 
-    public function scheduleCampaign($CampaignId, $date);
+    public function scheduleCampaign(string $id, string $date);
 
-    public function updateCampaignSchedule($CampaignId, $date);
+    public function updateCampaignSchedule(string $id, string $date);
 
-    public function removeSchedule($CampaignId);
+    public function removeSchedule(string $id);
 
-    public function sendCampaign($CampaignId);
+    public function sendCampaign(string $id);
 
-    public function testCampaign($CampaignId, $recipients);
+    public function testCampaign(string $id, array $recipients);
 
-    public function getCampaignStatus($CampaignId);
-}
+    public function getCampaignStatus(string $id);
+}

src/Contracts/ContactMetadataContract.php

@@ -1,24 +1,20 @@
 <?php
-/*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
- */
+
+declare(strict_types=1);
 
 namespace Mailjet\LaravelMailjet\Contracts;
 
 use Mailjet\LaravelMailjet\Model\ContactMetadata;
 
 interface ContactMetadataContract
 {
-
     public function getAll();
 
-    public function get($id);
+    public function get(string $id);
 
-    public function create(ContactMetadata $contactMetadata);
+    public function create(ContactMetadata $metadata);
 
-    public function update($id, ContactMetadata $contactMetadata);
+    public function update(string $id, ContactMetadata $metadata);
 
-    public function delete($id);
-}
+    public function delete(string $id);
+}

src/Contracts/ContactsListContract.php

@@ -1,26 +1,25 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Mailjet\LaravelMailjet\Contracts;
 
 use Mailjet\LaravelMailjet\Model\Contact;
 use Mailjet\LaravelMailjet\Model\ContactsList;
 
 interface ContactsListContract
 {
+    public function create(string $id, Contact $contact, $action = Contact::ACTION_ADDFORCE): array;
 
-    public function create($listId, Contact $contact,
-                           $action = Contact::ACTION_ADDFORCE);
-
-    public function update($listId, Contact $contact,
-                           $action = Contact::ACTION_ADDNOFORCE);
+    public function update(string $id, Contact $contact, $action = Contact::ACTION_ADDNOFORCE): array;
 
-    public function subscribe($listId, Contact $contact, $force = true);
+    public function subscribe(string $id, Contact $contact, bool $force = true): array;
 
-    public function unsubscribe($listId, Contact $contact);
+    public function unsubscribe(string $id, Contact $contact): array;
 
-    public function delete($listId, Contact $contact);
+    public function delete(string $id, Contact $contact): array;
 
-    public function updateEmail($listId, Contact $contact, $oldEmail);
+    public function updateEmail(string $id, Contact $contact, string $oldEmail): array;
 
-    public function uploadManyContactsList(ContactsList $contactsList);
-}
+    public function uploadManyContactsList(ContactsList $list): array;
+}

src/Contracts/EventCallbackUrlContract.php

@@ -1,19 +1,20 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Mailjet\LaravelMailjet\Contracts;
 
 use Mailjet\LaravelMailjet\Model\EventCallbackUrl;
 
 interface EventCallbackUrlContract
 {
+    public function getAll(): array;
 
-    public function getAll();
-
-    public function get($id);
+    public function get(string $id): array;
 
-    public function create(EventCallbackUrl $eventCallbackUrl);
+    public function create(EventCallbackUrl $url): array;
 
-    public function update($id, EventCallbackUrl $eventCallbackUrl);
+    public function update(string $id, EventCallbackUrl $url): array;
 
-    public function delete($id);
-}
+    public function delete(string $id): array;
+}

src/Contracts/MailjetServiceContract.php

@@ -1,17 +1,21 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Mailjet\LaravelMailjet\Contracts;
 
+use Mailjet\Client;
+use Mailjet\Response;
+
 interface MailjetServiceContract
 {
+    public function post(array $resource, array $args = [], array $options = []): Response;
 
-    public function post($resource, array $args = [], array $options = []);
-
-    public function get($resource, array $args = [], array $options = []);
+    public function get(array $resource, array $args = [], array $options = []): Response;
 
-    public function put($resource, array $args = [], array $options = []);
+    public function put(array $resource, array $args = [], array $options = []): Response;
 
-    public function delete($resource, array $args = [], array $options = []);
+    public function delete(array $resource, array $args = [], array $options = []): Response;
 
-    public function getClient();
-}
+    public function getClient(): Client;
+}

src/Contracts/TemplateServiceContract.php

@@ -1,25 +1,26 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Mailjet\LaravelMailjet\Contracts;
 
 use Mailjet\LaravelMailjet\Model\Template;
 
 interface TemplateServiceContract
 {
+    public function getAll(array $filters = null): array;
 
-    public function getAll(array $filters = null);
-
-    public function get($id);
+    public function get(string $id): array;
 
-    public function create(Template $Template);
+    public function create(Template $template): array;
 
-    public function update($id, Template $Template);
+    public function update(string $id, Template $template): array;
 
-    public function delete($id);
+    public function delete(string $id): array;
 
-    public function getDetailContent($id);
+    public function getDetailContent(string $id): array;
 
-    public function createDetailContent($id, $contentData);
+    public function createDetailContent(string $id, array $content): array;
 
-    public function deleteDetailContent($id);
-}
+    public function deleteDetailContent(string $id): array;
+}

src/Exception/MailjetException.php

@@ -1,53 +1,55 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Mailjet\LaravelMailjet\Exception;
 
+use Throwable;
 use \Mailjet\Response;
 
-/**
- * Handle Mailjet API errors
- */
 class MailjetException extends \Exception
 {
-    /**
-     * @var int
-     */
-    private $statusCode;
     /**
      * @var string
      */
     private $errorInfo;
+
     /**
      * @var string
      */
     private $errorMessage;
+
     /**
      * @var string
      */
     private $errorIdentifier;
+
     /**
      * https://dev.mailjet.com/guides/#about-the-mailjet-restful-api
+     *
      * @param Response  $response
      * @param \Throwable $previous
      */
-    public function __construct($statusCode=0, $message=null, Response $response=null, \Throwable $previous=null)
+    public function __construct($statusCode = 0, $message = null, Response $response = null, Throwable $previous = null)
     {
-        // if you pass a Mailjet\Response
         if ($response) {
             $statusCode = $response->getStatus();
-            $message = sprintf('%s: %s', $message, $response->getReasonPhrase());
+            $message = "{$message}: {$response->getReasonPhrase()}";
+
             $this->setErrorFromResponse($response);
         }
+
         parent::__construct($message, $statusCode, $previous);
     }
     /**
-     * Configure MailjetException from Mailjet\Response
-     * @method setErrorFromResponse
+     * Configure MailjetException from Mailjet\Response.
+     *
      * @param  Response $response
      */
-    private function setErrorFromResponse(Response $response)
+    private function setErrorFromResponse(Response $response): void
     {
-        $this->statusCode = $response->getStatus();
         $body = $response->getBody();
+
         if (isset($body['ErrorInfo'])) {
             $this->errorInfo = $body['ErrorInfo'];
         }
@@ -58,24 +60,27 @@ private function setErrorFromResponse(Response $response)
             $this->errorIdentifier = $body['ErrorIdentifier'];
         }
     }
+
     /**
      * @return string
      */
-    public function getErrorInfo()
+    public function getErrorInfo(): string
     {
         return $this->errorInfo;
     }
+
     /**
      * @return string
      */
-    public function getErrorMessage()
+    public function getErrorMessage(): string
     {
         return $this->errorMessage;
     }
+
     /**
      * @return string
      */
-    public function getErrorIdentifier()
+    public function getErrorIdentifier(): string
     {
         return $this->errorIdentifier;
     }

src/Facades/Mailjet.php

@@ -1,12 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Mailjet\LaravelMailjet\Facades;
 
 use Illuminate\Support\Facades\Facade;
 
 class Mailjet extends Facade
 {
-    protected static function getFacadeAccessor()
+    protected static function getFacadeAccessor(): string
     {
         return 'Mailjet';
     }