Merge pull request #1 from laravel-notification-channels/master

Updating my fork

Author: Nelwhix

.scrutinizer.yml

@@ -12,7 +12,7 @@
 
 This package makes it easy to send Laravel notifications using [Twitter](https://dev.twitter.com/rest/public). (Laravel 8+)
 
-PS: v.7.0.0 only supports Laravel 10 and PHP 8.1. If you have an older Laravel application or PHP version, you can use an older version of this package. Be aware that these are no longer maintained.
+PS: v8 now uses the new Twitter API V2. Please read the upgrade guide for your app [here](https://developer.twitter.com/en/docs/twitter-api/migrate/overview).
 
 ## Contents
 
@@ -37,7 +37,7 @@ PS: v.7.0.0 only supports Laravel 10 and PHP 8.1. If you have an older Laravel a
 
 This package is part of the [Laravel Notification Channels](http://laravel-notification-channels.com/) project. It provides additional Laravel Notification channels to the ones given by [Laravel](https://laravel.com/docs/master/notifications) itself.
 
-The Twitter channel makes it possible to send out Laravel notifications as a `Twitter status update `(post on the timeline) or as a `direct message`.
+The Twitter channel makes it possible to send out Laravel notifications as a `Twitter tweet` (post on the timeline) or as a `direct message`.
 
 ## Installation
 
@@ -51,9 +51,32 @@ composer require laravel-notification-channels/twitter
 
 The service provider gets loaded automatically.
 
-### Setting up the Twitter service
+### Twitter App & Credentials
 
-You will need to [create](https://developer.twitter.com/apps/) a Twitter app to use this channel. Within this app, you will find the `keys and access tokens`. Place them inside your `.env` file. To load them, add this to your `config/services.php` file:
+You will need to [create](https://developer.twitter.com/apps/) a Twitter app to use this channel. Within this app, you will find the `keys and access tokens`.
+
+Your Twitter app `must be within a project`. Also, make sure to activate the `user authentication settings`:
+
+<img width="1289" alt="image" src="https://github.com/laravel-notification-channels/twitter/assets/1394539/9be260ba-d8db-4af1-be58-9e4ce3b0176d">
+
+After that, you have to regenerate your access token and secret. If done correctly, you should see the right permissions for your access tokens:
+
+<img width="796" alt="image" src="https://github.com/laravel-notification-channels/twitter/assets/1394539/6ee5fc99-0373-4ebb-b8c5-4c84a82632df">
+
+
+Make sure to copy the right credentials and place them inside your `.env` file.
+
+```env
+TWITTER_CONSUMER_KEY=your-consumer-key
+TWITTER_CONSUMER_SECRET=your-consumer-secret
+TWITTER_ACCESS_TOKEN=your-accesss_token
+TWITTER_ACCESS_TOKEN_SECRET=your-access-token-secret
+```
+
+<img width="1168" alt="image" src="https://github.com/laravel-notification-channels/twitter/assets/1394539/7e68325d-0255-4f66-a310-86f3277f52a7">
+
+
+To load them, add this to your `config/services.php` file:
 
 ```php
 ...
@@ -66,8 +89,6 @@ You will need to [create](https://developer.twitter.com/apps/) a Twitter app to
 ...
 ```
 
-This will load the Twitter app data from the `.env` file. Make sure to use the same keys you have used like `TWITTER_CONSUMER_KEY`.
-
 ## Usage
 
 To use this package, you need to create a notification class, like `NewsWasPublished` from the example below, in your Laravel application. Make sure to check out [Laravel's documentation](https://laravel.com/docs/master/notifications) for this process.
@@ -160,7 +181,7 @@ public function toTwitter(mixed $notifiable): TwitterMessage
 }
 ````
 > Note that the reply status ID will be ignored if you omit the author of the original tweet, according to Twitter docs.
-### Send a direct message
+### Send a direct message (NOT working with the FREE Twitter API plan!)
 To send a Twitter direct message to a specific user, you will need the `TwitterDirectMessage` class. Provide the Twitter user handler as the first parameter and the message as the second one.
 ````php
 public function toTwitter(mixed $notifiable): TwitterMessage

.styleci.yml

@@ -20,9 +20,10 @@
         "ext-fileinfo": "*"
     },
     "require-dev": {
+        "laravel/pint": "^1.10",
         "mockery/mockery": "^1.3.1",
-        "phpunit/phpunit": "^9.3",
-        "orchestra/testbench": "^8.0"
+        "orchestra/testbench": "^8.0",
+        "phpunit/phpunit": "^9.3"
     },
     "autoload": {
         "psr-4": {

README.md

@@ -11,7 +11,7 @@ public static function serviceRespondsNotSuccessful(mixed $response): CouldNotSe
         if (isset($response->error)) {
             return new static("Couldn't post notification. Response: ".$response->error);
         }
-     
+
         $responseBody = print_r($response->detail, true);
 
         return new static("Couldn't post notification. Response: ".$responseBody);

composer.json

@@ -15,7 +15,7 @@ public function __construct(protected TwitterOAuth $twitter)
     /**
      * Send the given notification.
      *
-     * @param mixed $notifiable Should be an object that uses the Illuminate\Notifications\Notifiable trait.
+     * @param  mixed  $notifiable Should be an object that uses the Illuminate\Notifications\Notifiable trait.
      *
      * @throws CouldNotSendNotification
      */
@@ -40,7 +40,7 @@ public function send($notifiable, Notification $notification): array|object
             $requestBody,
             $twitterMessage->isJsonRequest,
         );
-      
+
         if ($this->twitter->getLastHttpCode() !== 201) {
             throw CouldNotSendNotification::serviceRespondsNotSuccessful($this->twitter->getLastBody());
         }
@@ -51,7 +51,7 @@ public function send($notifiable, Notification $notification): array|object
     /**
      * Use per user settings instead of default ones.
      *
-     * @param object $notifiable Provide an object that uses the Illuminate\Notifications\Notifiable trait.
+     * @param  object  $notifiable Provide an object that uses the Illuminate\Notifications\Notifiable trait.
      */
     private function changeTwitterSettingsIfNeeded(object $notifiable)
     {

src/Exceptions/CouldNotSendNotification.php

@@ -21,7 +21,7 @@ public function boot()
                     config('services.twitter.access_token'),
                     config('services.twitter.access_secret')
                 );
-            
+
                 return $connection;
             });
     }

src/TwitterChannel.php

@@ -9,9 +9,13 @@
 class TwitterStatusUpdate extends TwitterMessage
 {
     public ?Collection $imageIds = null;
+
     public ?Collection $videoIds = null;
+
     private ?array $images = null;
+
     private ?array $videos = null;
+
     private ?int $inReplyToTweetId = null;
 
     /**
@@ -90,9 +94,6 @@ public function inReplyTo(int $tweetId): self
         return $this;
     }
 
-    /**
-     * @return int|null
-     */
     public function getInReplyToTweetId(): ?int
     {
         return $this->inReplyToTweetId;
@@ -112,7 +113,7 @@ public function getRequestBody(): array
 
         if ($mediaIds->count() > 0) {
             $body['media'] = [
-                'media_ids' => $mediaIds->toArray()
+                'media_ids' => $mediaIds->toArray(),
             ];
         }
 

src/TwitterServiceProvider.php

@@ -42,7 +42,7 @@ public function it_can_send_a_status_update_notification()
         $this->twitter->shouldReceive('getLastHttpCode')
             ->once()
             ->andReturn(201);
-        
+
         $this->channel->send(new TestNotifiable(), new TestNotification());
     }
 
@@ -60,7 +60,7 @@ public function it_can_send_a_status_update_notification_with_images()
             ->once()
             ->with(
                 'tweets',
-                ['text' => 'Laravel Notification Channels are awesome!', 'media' => [ 'media_ids' => [2]]],
+                ['text' => 'Laravel Notification Channels are awesome!', 'media' => ['media_ids' => [2]]],
                 true
             )
             ->andReturn([]);
@@ -96,7 +96,7 @@ public function it_can_send_a_status_update_notification_with_videos()
             ->once()
             ->with(
                 'tweets',
-                ['text' => 'Laravel Notification Channels are awesome!', 'media' => [ 'media_ids' => [2]]],
+                ['text' => 'Laravel Notification Channels are awesome!', 'media' => ['media_ids' => [2]]],
                 true
             )
             ->andReturn([]);
@@ -195,7 +195,7 @@ public function it_throws_an_exception_when_it_could_not_send_the_notification_w
             ->once()
             ->with($media->media_id_string)
             ->andReturn($status);
- 
+
         $this->expectException(CouldNotSendNotification::class);
 
         $this->channel->send(new TestNotifiable(), new TestNotificationWithVideo());
@@ -265,18 +265,11 @@ class TestNotificationWithReplyToStatusId extends Notification
 {
     private int $replyToStatusId;
 
-    /**
-     * @param  int  $replyToStatusId
-     */
     public function __construct(int $replyToStatusId)
     {
         $this->replyToStatusId = $replyToStatusId;
     }
 
-    /**
-     * @param  mixed  $notifiable
-     * @return TwitterMessage
-     */
     public function toTwitter(mixed $notifiable): TwitterMessage
     {
         return (new TwitterStatusUpdate('Laravel Notification Channels are awesome!'))

src/TwitterStatusUpdate.php

@@ -9,7 +9,9 @@
 class TwitterDirectMessageTest extends TestCase
 {
     protected TwitterDirectMessage $messageWithUserId;
+
     protected TwitterDirectMessage $messageWithScreenName;
+
     protected TwitterOAuth $twitter;
 
     public function setUp(): void