Merge pull request #138 from michaviehauser/michaviehauser/follow-requests

Add follow requests

Author: overtrue

README.md

@@ -14,6 +14,7 @@
 </p>
 
 > 💡 The new version has been split into several packages:
+>
 > - Follow: [overtrue/laravel-follow](https://github.com/overtrue/laravel-follow)
 > - Like: [overtrue/laravel-like](https://github.com/overtrue/laravel-like)
 > - Favorite: [overtrue/laravel-favorite](https://github.com/overtrue/laravel-favorite)
@@ -65,33 +66,48 @@ $user2 = User::find(2);
 $user1->follow($user2);
 $user1->unfollow($user2);
 $user1->toggleFollow($user2);
+$user1->acceptFollowRequestFrom($user2);
+$user1->rejectFollowRequestFrom($user2);
 
-$user1->isFollowing($user2); 
-$user2->isFollowdBy($user1); 
+$user1->isFollowing($user2);
+$user2->isFollowdBy($user1);
+$user2->hasRequestedToFollow($user1);
 
 $user1->areFollowingEachOther($user2);
 ```
 
 #### Get followings:
 
 ```php
-$user->followings; 
+$user->followings;
 ```
 
 #### Get followers:
 
 ```php
-$user->followers; 
+$user->followers;
+```
+
+### Follow Requests
+
+If you would like to have some follow requests to need to be accepted by the user being followed, simply override the **needsToApproveFollowRequests()** method in the model that uses the **Followable** trait with your custom logic:
+
+```php
+public function needsToApproveFollowRequests()
+{
+    // Your custom logic here
+    return (bool) $this->private;
+}
 ```
 
 ### Aggregations
 
 ```php
 // followings count
-$user->followings()->count(); 
+$user->followings()->count();
 
 // with query where
-$user->followings()->where('gender', 'female')->count(); 
+$user->followings()->where('gender', 'female')->count();
 
 // followers count
 $post->followers()->count();
@@ -126,13 +142,12 @@ foreach($users as $user) {
 }
 ```
 
-
 ### Events
 
-| **Event** | **Description** |
-| --- | --- |
-|  `Overtrue\LaravelFollow\Events\Followd` | Triggered when the relationship is created. |
-|  `Overtrue\LaravelFollow\Events\Unfollowd` | Triggered when the relationship is deleted. |
+| **Event**                                 | **Description**                             |
+| ----------------------------------------- | ------------------------------------------- |
+| `Overtrue\LaravelFollow\Events\Followd`   | Triggered when the relationship is created. |
+| `Overtrue\LaravelFollow\Events\Unfollowd` | Triggered when the relationship is deleted. |
 
 ## Contributing
 

migrations/2020_04_04_000000_create_user_follower_table.php

@@ -24,6 +24,7 @@ public function up()
             $table->increments('id');
             $table->unsignedBigInteger('following_id')->index();
             $table->unsignedBigInteger('follower_id')->index();
+            $table->timestamp('accepted_at')->nullable()->index();
             $table->timestamps();
         });
     }

src/Followable.php

@@ -21,32 +21,83 @@
  */
 trait Followable
 {
+    /**
+     * @return bool
+     */
+    public function needsToApproveFollowRequests()
+    {
+        return false;
+    }
+
     /**
      * @param \Illuminate\Database\Eloquent\Model|int $user
+     *
+     * @return array
      */
     public function follow($user)
     {
-        $this->followings()->attach($user);
+        $isPending = $user->needsToApproveFollowRequests() ?: false;
+
+        $this->followings()->attach($user, [
+            'accepted_at' => $isPending ? null : now()
+        ]);
+
+        return ['pending' => $isPending];
     }
 
     /**
      * @param \Illuminate\Database\Eloquent\Model|int $user
-     *
-     * @return int
      */
     public function unfollow($user)
     {
-        return $this->followings()->detach($user);
+        $this->followings()->detach($user);
     }
 
     /**
      * @param \Illuminate\Database\Eloquent\Model|int $user
      *
-     * @return array|array[]
      */
     public function toggleFollow($user)
     {
-        return $this->followings()->toggle($user);
+        $this->isFollowing($user) ? $this->unfollow($user) : $this->follow($user);
+    }
+
+    /**
+     * @param \Illuminate\Database\Eloquent\Model|int $user
+     */
+    public function rejectFollowRequestFrom($user)
+    {
+        $this->followers()->detach($user);
+    }
+
+    /**
+     * @param \Illuminate\Database\Eloquent\Model|int $user
+     */
+    public function acceptFollowRequestFrom($user)
+    {
+        $this->followers()->updateExistingPivot($user, ['accepted_at' => now()]);
+    }
+
+    /**
+     * @param \Illuminate\Database\Eloquent\Model|int $user
+     */
+    public function hasRequestedToFollow(Model $user): bool
+    {
+        if ($user instanceof Model) {
+            $user = $user->getKey();
+        }
+
+        /* @var \Illuminate\Database\Eloquent\Model $this */
+        if ($this->relationLoaded('followings')) {
+            return $this->followings
+                ->whereNull('pivot.accepted_at')
+                ->contains($user);
+        }
+
+        return $this->followings()
+            ->wherePivot('accepted_at', null)
+            ->where($this->getQualifiedKeyName(), $user)
+            ->exists();
     }
 
     /**
@@ -62,10 +113,15 @@ public function isFollowing($user)
 
         /* @var \Illuminate\Database\Eloquent\Model $this */
         if ($this->relationLoaded('followings')) {
-            return $this->followings->contains($user);
+            return $this->followings
+                ->whereNotNull('pivot.accepted_at')
+                ->contains($user);
         }
 
-        return $this->followings()->where($this->getQualifiedKeyName(), $user)->exists();
+        return $this->followings()
+            ->wherePivot('accepted_at', '!=', null)
+            ->where($this->getQualifiedKeyName(), $user)
+            ->exists();
     }
 
     /**
@@ -81,10 +137,15 @@ public function isFollowedBy($user)
 
         /* @var \Illuminate\Database\Eloquent\Model $this */
         if ($this->relationLoaded('followers')) {
-            return $this->followers->contains($user);
+            return $this->followers
+                ->whereNotNull('pivot.accepted_at')
+                ->contains($user);
         }
 
-        return $this->followers()->where($this->getQualifiedKeyName(), $user)->exists();
+        return $this->followers()
+            ->wherePivot('accepted_at', '!=', null)
+            ->where($this->getQualifiedKeyName(), $user)
+            ->exists();
     }
 
     /**
@@ -109,7 +170,7 @@ public function followers()
             \config('follow.relation_table', 'user_follower'),
             'following_id',
             'follower_id'
-        )->withTimestamps()->using(UserFollower::class);
+        )->withPivot('accepted_at')->withTimestamps()->using(UserFollower::class);
     }
 
     /**
@@ -123,6 +184,6 @@ public function followings()
             \config('follow.relation_table', 'user_follower'),
             'follower_id',
             'following_id'
-        )->withTimestamps()->using(UserFollower::class);
+        )->withPivot('accepted_at')->withTimestamps()->using(UserFollower::class);
     }
 }

tests/PrivacyTest.php

@@ -0,0 +1,79 @@
+<?php
+
+/*
+ * This file is part of the overtrue/laravel-follow.
+ *
+ * (c) overtrue <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Tests;
+
+use Illuminate\Support\Facades\Event;
+use Overtrue\LaravelFollow\Events\Followed;
+use Overtrue\LaravelFollow\Events\Unfollowed;
+
+/**
+ * Class PrivacyTest.
+ */
+class PrivacyTest extends TestCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        config(['auth.providers.users.model' => User::class]);
+    }
+
+    public function test_following_private_user_sets_request_pending()
+    {
+        $user1 = User::create(['name' => 'user1']);
+        $user2 = User::create(['name' => 'user2', 'private' => true]);
+
+        $user1->follow($user2);
+
+        $this->assertTrue($user1->hasRequestedToFollow($user2));
+        $this->assertFalse($user2->isFollowedBy($user1));
+    }
+
+    public function test_pending_request_can_be_accepted()
+    {
+        $user1 = User::create(['name' => 'user1']);
+        $user2 = User::create(['name' => 'user2', 'private' => true]);
+
+        $user1->follow($user2);
+
+        $user2->acceptFollowRequestFrom($user1);
+
+        $this->assertFalse($user1->hasRequestedToFollow($user2));
+        $this->assertTrue($user2->isFollowedBy($user1));
+    }
+
+    public function test_pending_request_can_be_rejected()
+    {
+        $user1 = User::create(['name' => 'user1']);
+        $user2 = User::create(['name' => 'user2', 'private' => true]);
+
+        $user1->follow($user2);
+
+        $user2->rejectFollowRequestFrom($user1);
+
+        $this->assertFalse($user1->hasRequestedToFollow($user2));
+        $this->assertFalse($user2->isFollowedBy($user1));
+    }
+
+    public function test_following_private_user_sets_request_pending_with_eager_loading()
+    {
+        $user1 = User::create(['name' => 'user1']);
+        $user2 = User::create(['name' => 'user2', 'private' => true]);
+
+        $user1->follow($user2);
+
+        $user1->load('followings');
+
+        $this->assertTrue($user1->hasRequestedToFollow($user2));
+        $this->assertFalse($user2->isFollowedBy($user1));
+    }
+}

tests/User.php

@@ -21,5 +21,17 @@ class User extends Model
 {
     use Followable;
 
-    protected $fillable = ['name'];
+    protected $fillable = ['name', 'private'];
+
+    protected $casts = [
+        'private' => 'boolean',
+    ];
+
+    /**
+     * @return bool
+     */
+    public function needsToApproveFollowRequests()
+    {
+        return $this->private ?? false;
+    }
 }

tests/migrations/2020_04_04_000000_create_users_table.php

@@ -22,6 +22,7 @@ public function up()
         Schema::create('users', function (Blueprint $table) {
             $table->increments('id');
             $table->string('name');
+            $table->boolean('private')->default(false);
             $table->timestamps();
         });
     }