Improved PHPDocs, started providing previous exceptions where possible

src/Exceptions/CouldNotSendNotification.php

@@ -6,25 +6,26 @@
 
 use Psr\Http\Message\ResponseInterface;
 use RuntimeException;
+use Throwable;
 
 class CouldNotSendNotification extends RuntimeException
 {
-    public static function pushbulletRespondedWithAnError(ResponseInterface $response): self
+    public static function pushbulletRespondedWithAnError(ResponseInterface $response, Throwable $previous = null): self
     {
         $code = $response->getStatusCode();
 
         $message = $response->getBody();
 
-        return new self("Pushbullet responded with error: `{$code} - {$message}`.");
+        return new self("Pushbullet responded with error: `{$code} - {$message}`.", 0, $previous);
     }
 
     public static function providedEmailIsInvalid(string $email): self
     {
         return new self("Provided email `{$email}` of `notifiable` is not valid.");
     }
 
-    public static function couldNotCommunicateWithPushbullet(): self
+    public static function couldNotCommunicateWithPushbullet(Throwable $previous = null): self
     {
-        return new self('Could not connect to Pushbullet API.');
+        return new self('Could not connect to Pushbullet API.', 0, $previous);
     }
 }

src/Pushbullet.php

@@ -68,9 +68,9 @@ public function send($params): ResponseInterface
                 'headers' => $this->getHeaders(),
             ]);
         } catch (ClientException $exception) {
-            throw CouldNotSendNotification::pushbulletRespondedWithAnError($exception->getResponse());
+            throw CouldNotSendNotification::pushbulletRespondedWithAnError($exception->getResponse(), $exception);
         } catch (Exception $exception) {
-            throw CouldNotSendNotification::couldNotCommunicateWithPushbullet();
+            throw CouldNotSendNotification::couldNotCommunicateWithPushbullet($exception);
         }
     }
 }

src/PushbulletChannel.php

@@ -44,7 +44,7 @@ public function send($notifiable, Notification $notification): void
 
     /**
      * @param $notifiable
-     * @return \NotificationChannels\Pushbullet\Targets\Targetable|void
+     * @return \NotificationChannels\Pushbullet\Targets\Targetable|null
      */
     private function getTarget($notifiable): ?Targetable
     {

src/PushbulletMessage.php

@@ -136,7 +136,7 @@ public function url($url): self
     /**
      * Get array representation of message for Pushbullet client.
      *
-     * @return array
+     * @return array{type: string, title: string, body: string, url?: string, channel_tag?: string, device_iden?: string, email?: string}
      */
     public function toArray(): array
     {
@@ -162,7 +162,7 @@ private function isLink(): bool
     }
 
     /**
-     * @return array
+     * @return array{url?: string}
      */
     private function getUrlParameter(): array
     {

src/Targets/Channel.php

@@ -24,7 +24,7 @@ public function __construct($channelTag)
     }
 
     /**
-     * {@inheritdoc}
+     * @return array{channel_tag: string}
      */
     public function getTarget(): array
     {

src/Targets/Device.php

@@ -24,7 +24,7 @@ public function __construct($device)
     }
 
     /**
-     * {@inheritdoc}
+     * @return array{device_iden: string}
      */
     public function getTarget(): array
     {

src/Targets/Email.php

@@ -30,7 +30,7 @@ public function __construct($email)
     }
 
     /**
-     * {@inheritdoc}
+     * @return array{email: string}
      */
     public function getTarget(): array
     {

tests/Exceptions/CouldNotSendNotificationTest.php

@@ -4,6 +4,7 @@
 
 namespace NotificationChannels\Pushbullet\Test\Exceptions;
 
+use Exception;
 use NotificationChannels\Pushbullet\Exceptions\CouldNotSendNotification;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ResponseInterface;
@@ -24,12 +25,14 @@ public function invalid_email_exception_can_be_created(): void
     /** @test */
     public function pushbullet_connection_exception_can_be_created(): void
     {
-        $exception = CouldNotSendNotification::couldNotCommunicateWithPushbullet();
+        $previousException = new Exception();
+        $exception = CouldNotSendNotification::couldNotCommunicateWithPushbullet($previousException);
 
         $this->assertEquals(
             'Could not connect to Pushbullet API.',
             $exception->getMessage()
         );
+        $this->assertSame($previousException, $exception->getPrevious());
     }
 
     /** @test */
@@ -45,11 +48,14 @@ public function pushbullet_error_exception_can_be_created(): void
             ->method('getBody')
             ->willReturn('Oops');
 
-        $exception = CouldNotSendNotification::pushbulletRespondedWithAnError($response);
+        $previousException = new Exception();
+
+        $exception = CouldNotSendNotification::pushbulletRespondedWithAnError($response, $previousException);
 
         $this->assertEquals(
             'Pushbullet responded with error: `400 - Oops`.',
             $exception->getMessage()
         );
+        $this->assertSame($previousException, $exception->getPrevious());
     }
 }