add exception and verify success of API calls

Author: Nightbr

README.md

@@ -54,17 +54,48 @@ MAILJET_APIKEY=YOUR_APIKEY
 MAILJET_APISECRET=YOUR_APISECRET
 ```
 
+## Full configuration
+
+```php
+'mailjet' => [
+    'key' => env('MAILJET_APIKEY'),
+    'secret' => env('MAILJET_APISECRET'),
+    'transactionnal' => [
+        'call' => true,
+        'options' => [
+            'url' => 'api.mailjet.com',
+            'version' => 'v31',
+            'call' => true,
+            'secured' => true
+        ]
+    ],
+    'common' => [
+        'call' => true,
+        'options' => [
+            'url' => 'api.mailjet.com',
+            'version' => 'v3',
+            'call' => true,
+            'secured' => true
+        ]
+    ]
+]
+```
+You can pass settings to [MailjetClient](https://github.com/mailjet/mailjet-apiv3-php#new--version-120-of-the-php-wrapper-).
+
+* `transactionnal`: settings to sendAPI client
+* `common`: setting to MailjetClient accessible throught the Facade Mailjet
+
 ## Mail driver configuration
 
-In order to use Mailjet as Mail driver, you need to change the mail driver in your `config/mail.php` or your `.env` file to `mailjet`, and make sure you have a valid and authorised from-address configured.
+In order to use Mailjet as Mail driver, you need to change the mail driver in your `config/mail.php` or your `.env` file to `MAIL_DRIVER=mailjet`, and make sure you have a valid and authorised from-address configured on your Mailjet account.
 
 For usage, check the [Laravel mail documentation](https://laravel.com/docs/master/mail)
 
 ## Usage
 
 To use it, you need to import Mailjet Facade in your file
 
-    use Mailjet;
+    use Mailjet\LaravelMailjet\Facades\Mailjet;
 
 
 Then, in your code you can use one of the method available in the MailjetServices :
@@ -88,8 +119,11 @@ High level API methods:
 
 For more informations about the filters you can use in each methods, refer to the [Mailjet API documentation](https://dev.mailjet.com/email-api/v3/apikey/)
 
+All method return the data array or throw a MailjetException in case of API error.
+
+You can also get the client with the method `getClient()` and make your own request to Mailjet API.
 
 ## ToDo
 
-* Client Call/Options (common api call and transactionnal mail)
-* Better \Mailjet\Client injection
+* Create Mailjet contract (Laravel 5.4 - DepInject <https://laravel.com/docs/5.4/contracts>)
+* New feature: EventAPI (webhook), Campaign, stats, ...

src/Exception/MailjetException.php

@@ -0,0 +1,82 @@
+<?php
+namespace Mailjet\LaravelMailjet\Exception;
+
+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)
+    {
+        // if you pass a Mailjet\Response
+        if ($response) {
+            $statusCode = $response->getStatus();
+            $message = sprintf('%s: %s', $message, $response->getReasonPhrase());
+            $this->setErrorFromResponse($response);
+        }
+        parent::__construct($message, $statusCode, $previous);
+    }
+    /**
+     * Configure MailjetException from Mailjet\Response
+     * @method setErrorFromResponse
+     * @param  Response $response
+     */
+    private function setErrorFromResponse(Response $response)
+    {
+        $this->statusCode = $response->getStatus();
+        $body = $response->getBody();
+        if (isset($body['ErrorInfo'])) {
+            $this->errorInfo = $body['ErrorInfo'];
+        }
+        if (isset($body['ErrorMessage'])) {
+            $this->errorMessage = $body['ErrorMessage'];
+        }
+        if (isset($body['ErrorIdentifier'])) {
+            $this->errorIdentifier = $body['ErrorIdentifier'];
+        }
+    }
+    /**
+     * @return string
+     */
+    public function getErrorInfo()
+    {
+        return $this->errorInfo;
+    }
+    /**
+     * @return string
+     */
+    public function getErrorMessage()
+    {
+        return $this->errorMessage;
+    }
+    /**
+     * @return string
+     */
+    public function getErrorIdentifier()
+    {
+        return $this->errorIdentifier;
+    }
+}

src/Services/MailjetService.php

@@ -5,6 +5,8 @@
 use \Mailjet\Resources;
 use \Mailjet\Client;
 
+use Mailjet\LaravelMailjet\Exception\MailjetException;
+
 class MailjetService
 {
     /**
@@ -32,7 +34,11 @@ public function __construct($key, $secret, $call = true, array $settings = [])
      */
     public function post($resource, array $args = [], array $options = [])
     {
-        return $this->client->post($resource, $args, $options);
+        $response = $this->client->post($resource, $args, $options);
+        if (!$response->success()) {
+            $this->throwError("MailjetService:post() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -46,7 +52,11 @@ public function post($resource, array $args = [], array $options = [])
      */
     public function get($resource, array $args = [], array $options = [])
     {
-        return $this->client->get($resource, $args, $options);
+        $response = $this->client->get($resource, $args, $options);
+        if (!$response->success()) {
+            $this->throwError("MailjetService:get() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -60,7 +70,11 @@ public function get($resource, array $args = [], array $options = [])
      */
     public function put($resource, array $args = [], array $options = [])
     {
-        return $this->client->put($resource, $args, $options);
+        $response = $this->client->put($resource, $args, $options);
+        if (!$response->success()) {
+            $this->throwError("MailjetService:put() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -74,7 +88,11 @@ public function put($resource, array $args = [], array $options = [])
      */
     public function delete($resource, array $args = [], array $options = [])
     {
-        return $this->client->delete($resource, $args, $options);
+        $response = $this->client->delete($resource, $args, $options);
+        if (!$response->success()) {
+            $this->throwError("MailjetService:delete() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -85,7 +103,10 @@ public function delete($resource, array $args = [], array $options = [])
     public function getAllLists($filters)
     {
         $response = $this->client->get(Resources::$Contactslist, ['filters' => $filters]);
-        return $response;
+        if (!$response->success()) {
+            $this->throwError("MailjetService:getAllLists() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -96,7 +117,10 @@ public function getAllLists($filters)
     public function createList($body)
     {
         $response = $this->client->post(Resources::$Contactslist, ['body' => $body]);
-        return $response;
+        if (!$response->success()) {
+            $this->throwError("MailjetService:createList() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -107,7 +131,10 @@ public function createList($body)
     public function getListRecipients($filters)
     {
         $response = $this->client->get(Resources::$Listrecipient, ['filters' => $filters]);
-        return $response;
+        if (!$response->success()) {
+            $this->throwError("MailjetService:getListRecipients() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -118,7 +145,10 @@ public function getListRecipients($filters)
     public function getSingleContact($id)
     {
         $response = $this->client->get(Resources::$Contact, ['id' => $id]);
-        return $response;
+        if (!$response->success()) {
+            $this->throwError("MailjetService:getSingleContact() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -129,7 +159,10 @@ public function getSingleContact($id)
     public function createContact($body)
     {
         $response = $this->client->post(Resources::$Contact, ['body' => $body]);
-        return $response;
+        if (!$response->success()) {
+            $this->throwError("MailjetService:createContact() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -140,7 +173,10 @@ public function createContact($body)
     public function createListRecipient($body)
     {
         $response = $this->client->post(Resources::$Listrecipient, ['body' => $body]);
-        return $response;
+        if (!$response->success()) {
+            $this->throwError("MailjetService:createListRecipient() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -152,7 +188,10 @@ public function createListRecipient($body)
     public function editListrecipient($id, $body)
     {
         $response = $this->client->put(Resources::$Listrecipient, ['id'=>$id, 'body' => $body]);
-        return $response;
+        if (!$response->success()) {
+            $this->throwError("MailjetService:editListrecipient() failed", $response);
+        }
+        return $response->getData();
     }
 
     /**
@@ -163,4 +202,14 @@ public function getClient()
     {
         return $this->client;
     }
+
+    /**
+     * Helper to throw error
+     * @param  string $title
+     * @param  Response $response
+     */
+     private function throwError($title, Response $response)
+     {
+         throw new MailjetException(0, $title, $response);
+     }
 }