Merge branch 'Add-Events'

README.md

@@ -4,7 +4,7 @@
 
 Gives Eloquent models the ability to manage their followers.
 
-##Models can:
+## Models can:
 - Send Follow Requests
 - Accept Follow Requests
 - Deny Follow Requests
@@ -54,32 +54,46 @@ class User extends Model
 ## How to use
 [Check the Test file to see the package in action](https://github.com/skybluesofa/laravel-followers/blob/master/tests/FollowersTest.php)
 
+### Methods
+
 #### Send a Follow Request
+
+Will trigger a `Skybluesofa\LaravelFollowers\Events\FollowRequest` event.
 ```php
 $user->follow($recipient);
 ```
 
 #### Accept a Follow Request
+
+Will trigger a `Skybluesofa\LaravelFollowers\Events\FollowRequestAccepted` event.
 ```php
 $recipient->acceptFollowRequestFrom($user);
 ```
 
 #### Deny a Follow Request
+
+Will trigger a `Skybluesofa\LaravelFollowers\Events\FollowRequestDenied` event.
 ```php
 $recipient->denyFollowRequestFrom($user);
 ```
 
 #### Remove Follow
+
+Will trigger a `Skybluesofa\LaravelFollowers\Events\Unfollow` event.
 ```php
 $user->unfollow($recipient);
 ```
 
 #### Block a User
+
+Will trigger a `Skybluesofa\LaravelFollowers\Events\FollowingBlocked` event.
 ```php
 $user->blockBeingFollowedBy($recipient);
 ```
 
 #### Unblock a User
+
+Will trigger a `Skybluesofa\LaravelFollowers\Events\FollowingUnblocked` event.
 ```php
 $user->unblockBeingFollowedBy($recipient);
 ```
@@ -166,6 +180,21 @@ $user->getFriends();
 $user->getFriends($perPage = 20);
 ```
 
+### Events
+
+These events are triggered during the lifecycle of following/unfollowing/accept/deny followers:
+
+```php
+Skybluesofa\LaravelFollowers\Events\FollowingBlocked(Model $recipient, Model $sender);
+Skybluesofa\LaravelFollowers\Events\FollowingUnblocked(Model $recipient, Model $sender);
+Skybluesofa\LaravelFollowers\Events\FollowRequest(Model $recipient, Model $sender);
+Skybluesofa\LaravelFollowers\Events\FollowRequestAccepted(Model $recipient, Model $sender);
+Skybluesofa\LaravelFollowers\Events\FollowRequestDenied(Model $recipient, Model $sender);
+Skybluesofa\LaravelFollowers\Events\Unfollow(Model $recipient, Model $sender);
+```
+
+To listen for and react to these events, follow the [instructions available in the Laravel Documentation](https://laravel.com/docs/7.x/events#defining-listeners).
+
 ## Thank you
 The basis of this code was garnered from [https://github.com/hootlex/laravel-friendships](https://github.com/hootlex/laravel-friendships). Although it was a jumping off point, much of the code has been rewritten to allow for Following as opposed to Mutual Friendship.
 

composer.json

@@ -9,14 +9,6 @@
             "email": "[email protected]"
         }
     ],
-    "autoload-dev": {
-        "classmap": [
-            "tests/TestCase.php"
-        ],
-        "files": [
-            "tests/helpers.php"
-        ]
-    },
     "require": {
         "php": ">=7.1.0"
     },
@@ -30,5 +22,10 @@
             "Skybluesofa\\Followers\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Skybluesofa\\Followers\\Tests\\": "tests/"
+        }
+    },
     "minimum-stability": "stable"
 }

src/Events/FollowRequest.php

@@ -0,0 +1,26 @@
+<?php
+namespace Skybluesofa\Followers\Events;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Queue\SerializesModels;
+
+class FollowRequest
+{
+    use SerializesModels;
+
+    public $recipient;
+    public $sender;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param Model $sender
+     * @param Model $recipient
+     * @return void
+     */
+    public function __construct(Model $recipient, Model $sender)
+    {
+        $this->recipient = $recipient;
+        $this->sender = $sender;
+    }
+}

src/Events/FollowRequestAccepted.php

@@ -0,0 +1,26 @@
+<?php
+namespace Skybluesofa\Followers\Events;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Queue\SerializesModels;
+
+class FollowRequestAccepted
+{
+    use SerializesModels;
+
+    public $recipient;
+    public $sender;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param Model $sender
+     * @param Model $recipient
+     * @return void
+     */
+    public function __construct(Model $recipient, Model $sender)
+    {
+        $this->recipient = $recipient;
+        $this->sender = $sender;
+    }
+}

src/Events/FollowRequestDenied.php

@@ -0,0 +1,26 @@
+<?php
+namespace Skybluesofa\Followers\Events;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Queue\SerializesModels;
+
+class FollowRequestDenied
+{
+    use SerializesModels;
+
+    public $recipient;
+    public $sender;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param Model $sender
+     * @param Model $recipient
+     * @return void
+     */
+    public function __construct(Model $recipient, Model $sender)
+    {
+        $this->recipient = $recipient;
+        $this->sender = $sender;
+    }
+}

src/Events/FollowingBlocked.php

@@ -0,0 +1,26 @@
+<?php
+namespace Skybluesofa\Followers\Events;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Queue\SerializesModels;
+
+class FollowingBlocked
+{
+    use SerializesModels;
+
+    public $recipient;
+    public $sender;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param Model $sender
+     * @param Model $recipient
+     * @return void
+     */
+    public function __construct(Model $recipient, Model $sender)
+    {
+        $this->recipient = $recipient;
+        $this->sender = $sender;
+    }
+}

src/Events/FollowingUnblocked.php

@@ -0,0 +1,26 @@
+<?php
+namespace Skybluesofa\Followers\Events;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Queue\SerializesModels;
+
+class FollowingUnblocked
+{
+    use SerializesModels;
+
+    public $recipient;
+    public $sender;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param Model $sender
+     * @param Model $recipient
+     * @return void
+     */
+    public function __construct(Model $recipient, Model $sender)
+    {
+        $this->recipient = $recipient;
+        $this->sender = $sender;
+    }
+}

src/Events/Unfollow.php

@@ -0,0 +1,26 @@
+<?php
+namespace Skybluesofa\Followers\Events;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Queue\SerializesModels;
+
+class Unfollow
+{
+    use SerializesModels;
+
+    public $recipient;
+    public $sender;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param Model $sender
+     * @param Model $recipient
+     * @return void
+     */
+    public function __construct(Model $recipient, Model $sender)
+    {
+        $this->recipient = $recipient;
+        $this->sender = $sender;
+    }
+}

src/Traits/CanBeFollowed.php

@@ -4,6 +4,10 @@
 use Skybluesofa\Followers\Models\Follower;
 use Skybluesofa\Followers\Status;
 use Illuminate\Database\Eloquent\Model;
+use Skybluesofa\Followers\Events\FollowingBlocked;
+use Skybluesofa\Followers\Events\FollowingUnblocked;
+use Skybluesofa\Followers\Events\FollowRequestDenied;
+use Skybluesofa\Followers\Events\FollowRequestAccepted;
 
 /**
  * Class Followable
@@ -67,6 +71,8 @@ public function hasFollowRequestFrom(Model $sender)
      */
     public function acceptFollowRequestFrom(Model $sender)
     {
+        event(new FollowRequestAccepted($this, $sender));
+
         return $sender->whenFollowing($this)->update([
             'status' => Status::ACCEPTED,
         ]);
@@ -79,6 +85,8 @@ public function acceptFollowRequestFrom(Model $sender)
      */
     public function denyFollowRequestFrom(Model $sender)
     {
+        event(new FollowRequestDenied($this, $sender));
+
         return $sender->whenFollowing($this)->update([
             'status' => Status::DENIED,
         ]);
@@ -115,6 +123,8 @@ public function blockBeingFollowedBy(Model $sender)
             $this->whenFollowedBy($sender)->delete();
         }
 
+        event(new FollowingBlocked($this, $sender));
+
         return (new Follower)->fillSender($sender)->fillRecipient($this)->fill([
             'status' => Status::BLOCKED,
         ])->save();
@@ -127,6 +137,8 @@ public function blockBeingFollowedBy(Model $sender)
      */
     public function unblockBeingFollowedBy(Model $sender)
     {
+        event(new FollowingUnblocked($this, $sender));
+
         return $this->whenFollowedBy($sender)->delete();
     }
 

src/Traits/CanFollow.php

@@ -4,6 +4,8 @@
 use Skybluesofa\Followers\Models\Follower;
 use Skybluesofa\Followers\Status;
 use Illuminate\Database\Eloquent\Model;
+use Skybluesofa\Followers\Events\FollowRequest;
+use Skybluesofa\Followers\Events\Unfollow;
 
 /**
  * Class Followable
@@ -34,6 +36,8 @@ public function follow(Model $recipient)
             return false;
         }
 
+        event(new FollowRequest($recipient, $this));
+
         $following = (new Follower)->fillRecipient($recipient)->fill([
             'status' => Status::PENDING,
         ]);
@@ -65,6 +69,8 @@ private function followingCountReached()
      */
     public function unfollow(Model $recipient)
     {
+        event(new Unfollow($recipient, $this));
+
         return $this->whenFollowing($recipient)->delete();
     }
 

tests/TestCase.php

@@ -1,8 +1,10 @@
 <?php
+namespace Skybluesofa\Followers\Tests;
 
 use Illuminate\Database\Eloquent\Factory;
+use Orchestra\Testbench\TestCase as BaseTestCase;
 
-abstract class TestCase extends Orchestra\Testbench\TestCase
+abstract class TestCase extends BaseTestCase
 {
 
     /**