Laravel package improvements.

Author: oleksandr-mykhailenko

README.md

@@ -29,6 +29,17 @@ Please also set your email from address and name.
 ]
 ```
 
+## Laravel 11.0+
+In the file  `example-app/bootstrap/providers.php`
+```php
+use Mailjet\LaravelMailjet\MailjetServiceProvider;
+
+return [
+    App\Providers\AppServiceProvider::class,
+    MailjetServiceProvider::class,
+];
+````
+
 * In the aliases array:
 
 ```php
@@ -128,7 +139,3 @@ public function handle(ContactsV4Service $contactsV4Service)
     ...
 }
 ```
-
-## ToDo
-
-* Add additional unit tests to increase code coverage.

composer.json

@@ -31,8 +31,9 @@
     ],
     "require": {
         "php": "^7.1.3|^8.0",
-        "laravel/framework": "~5.1|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0",
+        "laravel/framework": "^9.0|^10.0|^11.0",
         "mailjet/mailjet-apiv3-php": "^1.5.6|^1.5",
+        "symfony/http-client": "^7.1",
         "symfony/mailjet-mailer": "^6.0"
     },
     "require-dev": {

src/Contracts/CampaignContract.php

@@ -8,11 +8,28 @@
 
 interface CampaignContract
 {
-    public function getAllCampaigns(array $filters = null);
+    /**
+     * @param array|null $filters
+     * @return array
+     */
+    public function getAllCampaigns(array $filters = null): array;
 
-    public function findByCampaignId(string $id);
+    /**
+     * @param string $id
+     * @return array
+     */
+    public function findByCampaignId(string $id): array;
 
-    public function findByNewsletterId(string $id);
+    /**
+     * @param string $id
+     * @return array
+     */
+    public function findByNewsletterId(string $id): array;
 
-    public function updateCampaign(string $id, Campaign $campaign);
+    /**
+     * @param string $id
+     * @param Campaign $campaign
+     * @return array
+     */
+    public function updateCampaign(string $id, Campaign $campaign): array;
 }

src/Contracts/CampaignDraftContract.php

@@ -8,29 +8,86 @@
 
 interface CampaignDraftContract
 {
-    public function getAllCampaignDrafts(array $filters = null);
-
-    public function findByCampaignDraftId(string $id);
-
-    public function create(CampaignDraft $campaignDraft);
-
-    public function update(string $id, CampaignDraft $campaignDraft);
-
-    public function getDetailContent(string $id);
-
-    public function createDetailContent(string $id, array $content);
-
-    public function getSchedule(string $id);
-
-    public function scheduleCampaign(string $id, string $date);
-
-    public function updateCampaignSchedule(string $id, string $date);
-
-    public function removeSchedule(string $id);
-
-    public function sendCampaign(string $id);
-
-    public function testCampaign(string $id, array $recipients);
-
-    public function getCampaignStatus(string $id);
+    /**
+     * @param array|null $filters
+     * @return array
+     */
+    public function getAllCampaignDrafts(array $filters = null): array;
+
+    /**
+     * @param string $id
+     * @return array
+     */
+    public function findByCampaignDraftId(string $id): array;
+
+    /**
+     * @param CampaignDraft $campaignDraft
+     * @return array
+     */
+    public function create(CampaignDraft $campaignDraft): array;
+
+    /**
+     * @param string $id
+     * @param CampaignDraft $campaignDraft
+     * @return array
+     */
+    public function update(string $id, CampaignDraft $campaignDraft): array;
+
+    /**
+     * @param string $id
+     * @return array
+     */
+    public function getDetailContent(string $id): array;
+
+    /**
+     * @param string $id
+     * @param array $content
+     * @return array
+     */
+    public function createDetailContent(string $id, array $content): array;
+
+    /**
+     * @param string $id
+     * @return array
+     */
+    public function getSchedule(string $id): array;
+
+    /**
+     * @param string $id
+     * @param string $date
+     * @return array
+     */
+    public function scheduleCampaign(string $id, string $date): array;
+
+    /**
+     * @param string $id
+     * @param string $date
+     * @return array
+     */
+    public function updateCampaignSchedule(string $id, string $date): array;
+
+    /**
+     * @param string $id
+     * @return array
+     */
+    public function removeSchedule(string $id): array;
+
+    /**
+     * @param string $id
+     * @return array
+     */
+    public function sendCampaign(string $id): array;
+
+    /**
+     * @param string $id
+     * @param array $recipients
+     * @return array
+     */
+    public function testCampaign(string $id, array $recipients): array;
+
+    /**
+     * @param string $id
+     * @return array
+     */
+    public function getCampaignStatus(string $id): array;
 }

src/Services/CampaignDraftService.php

@@ -27,9 +27,9 @@ public function __construct(MailjetService $mailjet)
 
     /**
      * List campaign draft resources available for this apikey.
-     *
+     * @param array|null $filters
      * @return array
-     * @throws \Mailjet\LaravelMailjet\Exception\MailjetException
+     * @throws MailjetException
      */
     public function getAllCampaignDrafts(array $filters = null): array
     {
@@ -44,12 +44,11 @@ public function getAllCampaignDrafts(array $filters = null): array
 
     /**
      * Access a given CampaignDraft resource.
-     *
      * @param string $id
-     *
      * @return array
+     * @throws MailjetException
      */
-    public function findByCampaignDraftId(string $id)
+    public function findByCampaignDraftId(string $id): array
     {
         $response = $this->mailjet->get(Resources::$Campaigndraft,
             ['id' => $id]);
@@ -63,10 +62,10 @@ public function findByCampaignDraftId(string $id)
 
     /**
      * create a new fresh CampaignDraft
-     *
      * @param Campaigndraft $campaignDraft
+     * @throws MailjetException
      */
-    public function create(CampaignDraft $campaignDraft)
+    public function create(CampaignDraft $campaignDraft): array
     {
         $response = $this->mailjet->post(Resources::$Campaigndraft,
             ['body' => $campaignDraft->format()]);
@@ -79,11 +78,12 @@ public function create(CampaignDraft $campaignDraft)
 
     /**
      * Update one specific campaigndraft resource
-     *
-     * @param int           $id
+     * @param string $id
      * @param Campaigndraft $campaignDraft
+     * @return array
+     * @throws MailjetException
      */
-    public function update($id, CampaignDraft $campaignDraft)
+    public function update(string $id, CampaignDraft $campaignDraft): array
     {
         $response = $this->mailjet->put(Resources::$Campaigndraft,
             ['id' => $id, 'body' => $campaignDraft->format()]);
@@ -96,12 +96,11 @@ public function update($id, CampaignDraft $campaignDraft)
 
     /**
      * Return the text and html contents of the campaigndraft
-     *
      * @param string $id
-     *
      * @return array
+     * @throws MailjetException
      */
-    public function getDetailContent(string $id)
+    public function getDetailContent(string $id): array
     {
         $response = $this->mailjet->get(Resources::$CampaigndraftDetailcontent,
             ['id' => $id]);
@@ -115,12 +114,12 @@ public function getDetailContent(string $id)
 
     /**
      * Creates the content of a  campaigndraft
-     *
      * @param string $id
-     *
+     * @param array $contentData
      * @return array
+     * @throws MailjetException
      */
-    public function createDetailContent($id, $contentData)
+    public function createDetailContent(string $id, array $contentData): array
     {
         $response = $this->mailjet->post(Resources::$CampaigndraftDetailcontent,
             ['id' => $id, 'body' => $contentData]);
@@ -134,12 +133,11 @@ public function createDetailContent($id, $contentData)
 
     /**
      * Return the date of the scheduled sending of the campaigndraft
-     *
-     * @param string Campaign $id
-     *
+     * @param string $id
      * @return array
+     * @throws MailjetException
      */
-    public function getSchedule(string $id)
+    public function getSchedule(string $id): array
     {
         $response = $this->mailjet->get(Resources::$CampaigndraftSchedule,
             ['id' => $id]);
@@ -153,13 +151,12 @@ public function getSchedule(string $id)
 
     /**
      * Schedule when the campaigndraft will be sent
-     *
      * @param string $id
      * @param string $date (RFC3339 format "Y-m-d\TH:i:sP")
-     *
      * @return array
+     * @throws MailjetException
      */
-    public function scheduleCampaign(string $id, string $date)
+    public function scheduleCampaign(string $id, string $date): array
     {
         $response = $this->mailjet->post(Resources::$CampaigndraftSchedule,
             ['id' => $id, 'body' => $date]);
@@ -173,13 +170,12 @@ public function scheduleCampaign(string $id, string $date)
 
     /**
      * Update the date when the campaigndraft will be sent
-     *
-     * @param string Campaign $id
-     * @param string Schedule $date
-     *
+     * @param string $id
+     * @param string $date
      * @return array
+     * @throws MailjetException
      */
-    public function updateCampaignSchedule($id, $date)
+    public function updateCampaignSchedule(string $id, string $date): array
     {
         $response = $this->mailjet->put(Resources::$CampaigndraftSchedule,
             ['id' => $id, 'body' => $date]);
@@ -193,12 +189,11 @@ public function updateCampaignSchedule($id, $date)
 
     /**
      * Cancel a future sending
-     *
-     * @param string Campaign $id
-     *
+     * @param string $id
      * @return array
+     * @throws MailjetException
      */
-    public function removeSchedule(string $id)
+    public function removeSchedule(string $id): array
     {
         $response = $this->mailjet->delete(Resources::$CampaigndraftSchedule,
             ['id' => $id]);
@@ -212,12 +207,11 @@ public function removeSchedule(string $id)
 
     /**
      * Send the campaign immediately
-     *
-     * @param string Campaign $id
-     *
+     * @param string $id
      * @return array
+     * @throws MailjetException
      */
-    public function sendCampaign(string $id)
+    public function sendCampaign(string $id): array
     {
         $response = $this->mailjet->post(Resources::$CampaigndraftSend,
             ['id' => $id]);
@@ -231,12 +225,11 @@ public function sendCampaign(string $id)
 
     /**
      * Return the status of a CampaignDraft
-     *
-     * @param string Campaign $id
-     *
+     * @param string $id
      * @return array
+     * @throws MailjetException
      */
-    public function getCampaignStatus(string $id)
+    public function getCampaignStatus(string $id): array
     {
         $response = $this->mailjet->get(Resources::$CampaigndraftStatus,
             ['id' => $id]);
@@ -250,13 +243,12 @@ public function getCampaignStatus(string $id)
 
     /**
      * An action to test a CampaignDraft.
-     *
-     * @param string Campaign $id
-     * @param array of  $recipients
-     *
+     * @param string $id
+     * @param array $recipients
      * @return array
+     * @throws MailjetException
      */
-    public function testCampaign($id, $recipients)
+    public function testCampaign(string $id, array $recipients): array
     {
         $response = $this->mailjet->post(Resources::$CampaigndraftTest,
             ['id' => $id, 'body' => $recipients]);
@@ -268,7 +260,12 @@ public function testCampaign($id, $recipients)
         return $response->getData();
     }
 
-    private function throwError($title, Response $response)
+    /**
+     * @param $title
+     * @param Response $response
+     * @throws MailjetException
+     */
+    private function throwError($title, Response $response): void
     {
         throw new MailjetException(0, $title, $response);
     }