Merge pull request #11 from Rutam21/APPW-4358

Issue-4358: Add Code Linter To utopia-php/messaging

Author: christyjacob4

.github/workflows/linter.yml

@@ -11,7 +11,9 @@ jobs:
       uses: actions/checkout@v3
       with:
         fetch-depth: 2
+
     - run: git checkout HEAD^2
+
     - name: Run Linter
       run: |
         docker run --rm -v $PWD:/app composer sh -c \

composer.json

@@ -7,8 +7,8 @@
   "minimum-stability": "stable",
   "scripts": {
     "test": "vendor/bin/phpunit",
-    "lint": "vendor/bin/phpcs",
-    "format": "vendor/bin/phpcbf"
+    "lint": "./vendor/bin/pint --test",
+    "format": "./vendor/bin/pint"
   },
   "autoload": {
     "psr-4": {
@@ -28,7 +28,7 @@
   "require-dev": {
     "phpunit/phpunit": "9.5.*",
     "phpmailer/phpmailer": "6.6.*",
-    "squizlabs/php_codesniffer": "^3.6"
+    "laravel/pint": "^1.2"
   },
   "config": {
     "platform": {

composer.lock

@@ -35,19 +35,20 @@ abstract public function getMaxMessagesPerRequest(): int;
     /**
      * Send a message.
      *
-     * @param Message $message The message to send.
+     * @param  Message  $message The message to send.
      * @return string The response body.
      */
     abstract public function send(Message $message): string;
 
     /**
      * Send an HTTP request.
      *
-     * @param string $method The HTTP method to use.
-     * @param string $url The URL to send the request to.
-     * @param array $headers An array of headers to send with the request.
-     * @param string|null $body The body of the request.
+     * @param  string  $method The HTTP method to use.
+     * @param  string  $url The URL to send the request to.
+     * @param  array  $headers An array of headers to send with the request.
+     * @param  string|null  $body The body of the request.
      * @return string The response body.
+     *
      * @throws \Exception If the request fails.
      */
     protected function request(
@@ -56,7 +57,7 @@ protected function request(
         array $headers = [],
         mixed $body = null,
     ): string {
-        $headers[] = 'Content-length: ' . \strlen($body);
+        $headers[] = 'Content-length: '.\strlen($body);
 
         $ch = \curl_init();
 
@@ -66,14 +67,14 @@ protected function request(
         \curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
         \curl_setopt($ch, CURLOPT_USERAGENT, "Appwrite {$this->getName()} Message Sender");
 
-        if (!is_null($body)) {
+        if (! is_null($body)) {
             \curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
         }
 
         $response = \curl_exec($ch);
 
         if (\curl_errno($ch)) {
-            throw new \Exception('Error:' . \curl_error($ch));
+            throw new \Exception('Error:'.\curl_error($ch));
         }
         if (\curl_getinfo($ch, CURLINFO_HTTP_CODE) >= 400) {
             throw new \Exception($response);

src/Utopia/Messaging/Adapter.php

@@ -19,24 +19,26 @@ public function getMessageType(): string
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
      * @throws \Exception
      */
     public function send(Message $message): string
     {
-        if (!\is_a($message, $this->getMessageType())) {
+        if (! \is_a($message, $this->getMessageType())) {
             throw new \Exception('Invalid message type.');
         }
         if (\count($message->getTo()) > $this->getMaxMessagesPerRequest()) {
             throw new \Exception("{$this->getName()} can only send {$this->getMaxMessagesPerRequest()} messages per request.");
         }
+
         return $this->process($message);
     }
 
     /**
      * Process an email message.
      *
-     * @param EmailMessage $message Message to process.
+     * @param  EmailMessage  $message Message to process.
      * @return string The response body.
      */
     abstract protected function process(EmailMessage $message): string;

src/Utopia/Messaging/Adapters/Email.php

@@ -2,14 +2,14 @@
 
 namespace Utopia\Messaging\Adapters\Email;
 
-use Utopia\Messaging\Messages\Email;
 use Utopia\Messaging\Adapters\Email as EmailAdapter;
+use Utopia\Messaging\Messages\Email;
 
 class Mailgun extends EmailAdapter
 {
     /**
-     * @param string $apiKey Your Mailgun API key to authenticate with the API.
-     * @param string $domain Your Mailgun domain to send messages from.
+     * @param  string  $apiKey Your Mailgun API key to authenticate with the API.
+     * @param  string  $domain Your Mailgun domain to send messages from.
      */
     public function __construct(
         private string $apiKey,
@@ -28,7 +28,8 @@ public function getMaxMessagesPerRequest(): int
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
      * @throws \Exception
      */
     protected function process(Email $message): string
@@ -37,7 +38,7 @@ protected function process(Email $message): string
             method: 'POST',
             url: "https://api.mailgun.net/v3/{$this->domain}/messages",
             headers: [
-                'Authorization: Basic ' . base64_encode('api:' . $this->apiKey)
+                'Authorization: Basic '.base64_encode('api:'.$this->apiKey),
             ],
             body: [
                 'from' => $message->getFrom(),

src/Utopia/Messaging/Adapters/Email/Mailgun.php

@@ -4,8 +4,8 @@
 
 use PHPMailer\PHPMailer\Exception;
 use PHPMailer\PHPMailer\PHPMailer;
-use Utopia\Messaging\Messages\Email;
 use Utopia\Messaging\Adapters\Email as EmailAdapter;
+use Utopia\Messaging\Messages\Email;
 
 class Mock extends EmailAdapter
 {
@@ -21,7 +21,8 @@ public function getMaxMessagesPerRequest(): int
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
      * @throws Exception
      * @throws \Exception
      */
@@ -49,7 +50,7 @@ protected function process(Email $message): string
             $mail->addAddress($to);
         }
 
-        if (!$mail->send()) {
+        if (! $mail->send()) {
             throw new \Exception($mail->ErrorInfo);
         }
 

src/Utopia/Messaging/Adapters/Email/Mock.php

@@ -2,8 +2,8 @@
 
 namespace Utopia\Messaging\Adapters\Email;
 
-use Utopia\Messaging\Messages\Email;
 use Utopia\Messaging\Adapters\Email as EmailAdapter;
+use Utopia\Messaging\Messages\Email;
 
 class Sendgrid extends EmailAdapter
 {
@@ -28,14 +28,14 @@ protected function process(Email $message): string
             method: 'POST',
             url: 'https://api.sendgrid.com/v3/mail/send',
             headers: [
-                'Authorization: Bearer ' . $this->apiKey,
+                'Authorization: Bearer '.$this->apiKey,
                 'Content-Type: application/json',
             ],
             body: \json_encode([
                 'personalizations' => [
                     [
                         'to' => \array_map(
-                            fn($to) => ['email' => $to],
+                            fn ($to) => ['email' => $to],
                             $message->getTo()
                         ),
                         'subject' => $message->getSubject(),

src/Utopia/Messaging/Adapters/Email/Sendgrid.php

@@ -19,24 +19,26 @@ public function getMessageType(): string
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
      * @throws \Exception
      */
     public function send(Message $message): string
     {
-        if (!\is_a($message, $this->getMessageType())) {
+        if (! \is_a($message, $this->getMessageType())) {
             throw new \Exception('Invalid message type.');
         }
         if (\count($message->getTo()) > $this->getMaxMessagesPerRequest()) {
             throw new \Exception("{$this->getName()} can only send {$this->getMaxMessagesPerRequest()} messages per request.");
         }
+
         return $this->process($message);
     }
 
     /**
      * Send a push message.
      *
-     * @param PushMessage $message Message to process.
+     * @param  PushMessage  $message Message to process.
      * @return string The response body.
      */
     abstract protected function process(PushMessage $message): string;