Php code sniffer changes (#868)

* Php code sniffer changes * For `bold` operations we should close resource even if it fails * cs * composer normalize
mailgun · Aug 13, 2023 · 02d8b5c · 02d8b5c
1 parent 181749e
commit 02d8b5c
Show file tree

Hide file tree

Showing 73 changed files with 444 additions and 223 deletions.
diff --git a/composer.json b/composer.json
@@ -20,6 +20,7 @@
         "nyholm/nsa": "^1.2.1",
         "nyholm/psr7": "^1.3.1",
         "phpunit/phpunit": "^9.3",
+        "squizlabs/php_codesniffer": "^3.7",
         "symfony/http-client": "^5.3"
     },
     "suggest": {
@@ -36,6 +37,11 @@
             "Mailgun\\Tests\\": "tests/"
         }
     },
+    "config": {
+        "allow-plugins": {
+            "php-http/discovery": true
+        }
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "3.0-dev"

diff --git a/src/Api/Domain.php b/src/Api/Domain.php
@@ -33,7 +33,7 @@
 use Psr\Http\Message\ResponseInterface;
 
 /**
- * @see    https://documentation.mailgun.com/api-domains.html
+ * @see https://documentation.mailgun.com/api-domains.html
  *
  * @author Sean Johnson <[email protected]>
  */
@@ -43,6 +43,7 @@ class Domain extends HttpApi
 
     /**
      * Returns a list of domains on the account.
+     *
      * @param  int                      $limit
      * @param  int                      $skip
      * @return IndexResponse|array
@@ -84,7 +85,8 @@ public function show(string $domain)
      * Creates a new domain for the account.
      * See below for spam filtering parameter information.
      * {@link https://documentation.mailgun.com/user_manual.html#um-spam-filter}.
-     * @see https://documentation.mailgun.com/en/latest/api-domains.html#domains
+     *
+     * @see    https://documentation.mailgun.com/en/latest/api-domains.html#domains
      * @param  string                                 $domain             name of the domain
      * @param  string|null                            $smtpPass           password for SMTP authentication
      * @param  string|null                            $spamAction         `disable` or `tag` - inbound spam filtering
@@ -93,7 +95,8 @@ public function show(string $domain)
      * @param  string[]                               $ips                an array of ips to be assigned to the domain
      * @param  ?string                                $pool_id            pool id to assign to the domain
      * @param  string                                 $webScheme          `http` or `https` - set your open, click and unsubscribe URLs to use http or https. The default is http
-     * @param  string                                 $dkimKeySize        Set length of your domain’s generated DKIM key
+     * @param  string                                 $dkimKeySize        Set length of your domain’s generated DKIM
+     *                                                                    key
      * @return CreateResponse|array|ResponseInterface
      * @throws Exception
      */

diff --git a/src/Api/EmailValidation.php b/src/Api/EmailValidation.php
@@ -30,6 +30,7 @@ class EmailValidation extends HttpApi
     /**
      * Addresses are validated based off defined checks.
      * This operation is only accessible with the private API key and not subject to the daily usage limits.
+     *
      * @param  string                              $address             An email address to validate. Maximum: 512 characters.
      * @param  bool                                $mailboxVerification If set to true, a mailbox verification check will be performed
      *                                                                  against the address. The default is False.

diff --git a/src/Api/EmailValidationV4.php b/src/Api/EmailValidationV4.php
@@ -24,6 +24,7 @@
 use Mailgun\Model\EmailValidationV4\ValidateResponse;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Message\ResponseInterface;
+use RuntimeException;
 
 /**
  * @see https://documentation.mailgun.com/en/latest/api-email-validation.html
@@ -32,8 +33,10 @@ class EmailValidationV4 extends HttpApi
 {
     /**
      * Addresses are validated based off defined checks.
+     *
      * @param  string                             $address        An email address to validate. Maximum: 512 characters.
-     * @param  bool                               $providerLookup A provider lookup will be performed if Mailgun’s internal analysis is insufficient
+     * @param  bool                               $providerLookup A provider lookup will be performed if Mailgun’s internal analysis is
+     *                                                            insufficient
      * @return ValidateResponse|ResponseInterface
      * @throws Exception|ClientExceptionInterface Thrown when we don't catch a Client or Server side Exception
      */
@@ -73,8 +76,13 @@ public function createBulkJob(string $listId, $filePath)
         $postDataMultipart = [];
         $postDataMultipart[] = $this->prepareFile('file', $fileData);
 
-        $response = $this->httpPostRaw(sprintf('/v4/address/validate/bulk/%s', $listId), $postDataMultipart);
-        $this->closeResources($postDataMultipart);
+        try {
+            $response = $this->httpPostRaw(sprintf('/v4/address/validate/bulk/%s', $listId), $postDataMultipart);
+        } catch (Exception $exception) {
+            throw new RuntimeException($exception->getMessage());
+        } finally {
+            $this->closeResources($postDataMultipart);
+        }
 
         return $this->hydrateResponse($response, CreateBulkJobResponse::class);
     }
@@ -118,9 +126,11 @@ public function getBulkJobs(int $limit = 500)
     {
         Assert::greaterThan($limit, 0);
 
-        $response = $this->httpGet('/v4/address/validate/bulk', [
+        $response = $this->httpGet(
+            '/v4/address/validate/bulk', [
             'limit' => $limit,
-        ]);
+            ]
+        );
 
         return $this->hydrateResponse($response, GetBulkJobsResponse::class);
     }
@@ -134,9 +144,11 @@ public function getBulkPreviews(int $limit = 500)
     {
         Assert::greaterThan($limit, 0);
 
-        $response = $this->httpGet('/v4/address/validate/preview', [
+        $response = $this->httpGet(
+            '/v4/address/validate/preview', [
             'limit' => $limit,
-        ]);
+            ]
+        );
 
         return $this->hydrateResponse($response, GetBulkPreviewsResponse::class);
     }
@@ -163,8 +175,13 @@ public function createBulkPreview(string $previewId, $filePath)
         $postDataMultipart = [];
         $postDataMultipart[] = $this->prepareFile('file', $fileData);
 
-        $response = $this->httpPostRaw(sprintf('/v4/address/validate/preview/%s', $previewId), $postDataMultipart);
-        $this->closeResources($postDataMultipart);
+        try {
+            $response = $this->httpPostRaw(sprintf('/v4/address/validate/preview/%s', $previewId), $postDataMultipart);
+        } catch (Exception $exception) {
+            throw new RuntimeException($exception->getMessage());
+        } finally {
+            $this->closeResources($postDataMultipart);
+        }
 
         return $this->hydrateResponse($response, CreateBulkPreviewResponse::class);
     }

diff --git a/src/Api/HttpApi.php b/src/Api/HttpApi.php
@@ -138,6 +138,7 @@ protected function httpGet(string $path, array $parameters = [], array $requestH
 
     /**
      * Send a POST request with parameters.
+     *
      * @param  string                   $path           Request path
      * @param  array                    $parameters     POST parameters
      * @param  array                    $requestHeaders Request headers

diff --git a/src/Api/HttpClient.php b/src/Api/HttpClient.php
@@ -18,7 +18,7 @@
 use Psr\Http\Message\ResponseInterface;
 
 /**
- * @see    https://documentation.mailgun.com/api-domains.html
+ * @see https://documentation.mailgun.com/api-domains.html
  *
  * @author Sean Johnson <[email protected]>
  */

diff --git a/src/Api/Ip.php b/src/Api/Ip.php
@@ -27,6 +27,7 @@ class Ip extends HttpApi
 {
     /**
      * Returns a list of IPs.
+     *
      * @return IndexResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */
@@ -45,6 +46,7 @@ public function index(?bool $dedicated = null)
 
     /**
      * Returns a list of IPs assigned to a domain.
+     *
      * @return IndexResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */
@@ -59,6 +61,7 @@ public function domainIndex(string $domain)
 
     /**
      * Returns a single ip.
+     *
      * @return ShowResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */
@@ -73,6 +76,7 @@ public function show(string $ip)
 
     /**
      * Assign a dedicated IP to the domain specified.
+     *
      * @return UpdateResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */
@@ -92,6 +96,7 @@ public function assign(string $domain, string $ip)
 
     /**
      * Unassign an IP from the domain specified.
+     *
      * @return UpdateResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */

diff --git a/src/Api/MailingList.php b/src/Api/MailingList.php
@@ -39,6 +39,7 @@ public function member(): Member
 
     /**
      * Returns a paginated list of mailing lists on the domain.
+     *
      * @param  int                                $limit Maximum number of records to return (optional: 100 by default)
      * @return PagesResponse
      * @throws Exception|ClientExceptionInterface
@@ -58,6 +59,7 @@ public function pages(int $limit = 100)
 
     /**
      * Creates a new mailing list on the current domain.
+     *
      * @param  string                             $address         Address for the new mailing list
      * @param  string|null                        $name            Name for the new mailing list (optional)
      * @param  string|null                        $description     Description for the new mailing list (optional)
@@ -89,6 +91,7 @@ public function create(string $address, ?string $name = null, ?string $descripti
 
     /**
      * Returns a single mailing list.
+     *
      * @param  string                             $address Address of the mailing list
      * @return ShowResponse
      * @throws Exception|ClientExceptionInterface
@@ -104,6 +107,7 @@ public function show(string $address)
 
     /**
      * Updates a mailing list.
+     *
      * @param  string                             $address    Address of the mailing list
      * @param  array                              $parameters Array of field => value pairs to update
      * @return UpdateResponse
@@ -136,6 +140,7 @@ public function update(string $address, array $parameters = [])
 
     /**
      * Removes a mailing list from the domain.
+     *
      * @param  string                             $address Address of the mailing list
      * @return DeleteResponse
      * @throws Exception|ClientExceptionInterface
@@ -151,6 +156,7 @@ public function delete(string $address)
 
     /**
      * Validates mailing list.
+     *
      * @param  string                             $address Address of the mailing list
      * @return ValidateResponse
      * @throws Exception|ClientExceptionInterface
@@ -166,6 +172,7 @@ public function validate(string $address)
 
     /**
      * Get mailing list validation status.
+     *
      * @param  string                             $address Address of the mailing list
      * @return ValidationStatusResponse
      * @throws Exception|ClientExceptionInterface
@@ -181,6 +188,7 @@ public function getValidationStatus(string $address)
 
     /**
      * Cancel mailing list validation.
+     *
      * @param  string                             $address Address of the mailing list
      * @return ValidationCancelResponse
      * @throws Exception|ClientExceptionInterface

diff --git a/src/Api/MailingList/Member.php b/src/Api/MailingList/Member.php
@@ -82,6 +82,7 @@ public function show(string $list, string $address)
 
     /**
      * Creates (or updates) a member of the mailing list.
+     *
      * @param  string         $list       Address of the mailing list
      * @param  string         $address    Address for the member
      * @param  string|null    $name       Name for the member (optional)

diff --git a/src/Api/Message.php b/src/Api/Message.php
@@ -19,6 +19,7 @@
 use Mailgun\Model\Message\ShowResponse;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Message\ResponseInterface;
+use RuntimeException;
 
 /**
  * @see https://documentation.mailgun.com/en/latest/api-sending.html
@@ -65,8 +66,13 @@ public function send(string $domain, array $params)
         }
 
         $postDataMultipart = array_merge($this->prepareMultipartParameters($params), $postDataMultipart);
-        $response = $this->httpPostRaw(sprintf('/v3/%s/messages', $domain), $postDataMultipart);
-        $this->closeResources($postDataMultipart);
+        try {
+            $response = $this->httpPostRaw(sprintf('/v3/%s/messages', $domain), $postDataMultipart);
+        } catch (Exception $exception) {
+            throw new RuntimeException($exception->getMessage());
+        } finally {
+            $this->closeResources($postDataMultipart);
+        }
 
         return $this->hydrateResponse($response, SendResponse::class);
     }
@@ -101,8 +107,13 @@ public function sendMime(string $domain, array $recipients, string $message, arr
             ];
         }
         $postDataMultipart[] = $this->prepareFile('message', $fileData);
-        $response = $this->httpPostRaw(sprintf('/v3/%s/messages.mime', $domain), $postDataMultipart);
-        $this->closeResources($postDataMultipart);
+        try {
+            $response = $this->httpPostRaw(sprintf('/v3/%s/messages.mime', $domain), $postDataMultipart);
+        } catch (Exception $exception) {
+            throw new RuntimeException($exception->getMessage());
+        } finally {
+            $this->closeResources($postDataMultipart);
+        }
 
         return $this->hydrateResponse($response, SendResponse::class);
     }

diff --git a/src/Api/Route.php b/src/Api/Route.php
@@ -28,6 +28,7 @@ class Route extends HttpApi
 {
     /**
      * Fetches the list of Routes.
+     *
      * @param  int                      $limit Maximum number of records to return. (100 by default)
      * @param  int                      $skip  Number of records to skip. (0 by default)
      * @return IndexResponse
@@ -51,6 +52,7 @@ public function index(int $limit = 100, int $skip = 0)
 
     /**
      * Returns a single Route object based on its ID.
+     *
      * @param  string                   $routeId Route ID returned by the Routes::index() method
      * @return ShowResponse
      * @throws ClientExceptionInterface
@@ -66,6 +68,7 @@ public function show(string $routeId)
 
     /**
      * Creates a new Route.
+     *
      * @param  string                   $expression  A filter expression like "match_recipient('.*@gmail.com')"
      * @param  array                    $actions     Route action. This action is executed when the expression evaluates to True. Example: "forward('[email protected]')"
      * @param  string                   $description An arbitrary string
@@ -92,6 +95,7 @@ public function create(string $expression, array $actions, string $description,
     /**
      * Updates a given Route by ID. All parameters are optional.
      * This API call only updates the specified fields leaving others unchanged.
+     *
      * @param  string                   $routeId     Route ID returned by the Routes::index() method
      * @param  string|null              $expression  A filter expression like "match_recipient('.*@gmail.com')"
      * @param  array                    $actions     Route action. This action is executed when the expression evaluates to True. Example: "forward('[email protected]')"
@@ -136,6 +140,7 @@ public function update(
 
     /**
      * Deletes a Route based on the ID.
+     *
      * @param  string                   $routeId Route ID returned by the Routes::index() method
      * @return DeleteResponse
      * @throws ClientExceptionInterface

diff --git a/src/Api/Tag.php b/src/Api/Tag.php
@@ -34,6 +34,7 @@ class Tag extends HttpApi
 
     /**
      * Returns a list of tags.
+     *
      * @return IndexResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */
@@ -53,6 +54,7 @@ public function index(string $domain, int $limit = 100)
 
     /**
      * Returns a single tag.
+     *
      * @return ShowResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */
@@ -68,6 +70,7 @@ public function show(string $domain, string $tag)
 
     /**
      * Update a tag.
+     *
      * @return UpdateResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */
@@ -87,6 +90,7 @@ public function update(string $domain, string $tag, string $description)
 
     /**
      * Returns statistics for a single tag.
+     *
      * @return StatisticsResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */
@@ -102,6 +106,7 @@ public function stats(string $domain, string $tag, array $params)
 
     /**
      * Removes a tag from the account.
+     *
      * @return DeleteResponse|ResponseInterface
      * @throws ClientExceptionInterface
      */