Implement subscription email

driesvints · driesvints · commit 9057fb8a2712 · 2018-01-26T19:06:59.000+01:00
diff --git a/app/Helpers/HasUuid.php b/app/Helpers/HasUuid.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Helpers;
+
+use Ramsey\Uuid\Uuid;
+use Ramsey\Uuid\UuidInterface;
+
+trait HasUuid
+{
+    public function uuid(): UuidInterface
+    {
+        return Uuid::fromString($this->uuid);
+    }
+
+    public function getKeyName()
+    {
+        return 'uuid';
+    }
+
+    public function getIncrementing()
+    {
+        return false;
+    }
+
+    public static function findByUuidOrFail(UuidInterface $uuid): self
+    {
+        return static::where('uuid', $uuid->toString())->firstOrFail();
+    }
+}
diff --git a/app/Http/Controllers/Auth/GithubController.php b/app/Http/Controllers/Auth/GithubController.php
@@ -29,7 +29,7 @@ public function redirectToProvider()
     public function handleProviderCallback()
     {
         try {
-            $socialiteUser = Socialite::driver('github')->user();
+            $socialiteUser = $this->getSocialiteUser();
         } catch (InvalidStateException $exception) {
             $this->error('errors.github_invalid_state');
 
@@ -38,16 +38,21 @@ public function handleProviderCallback()
 
         try {
             $user = User::findByGithubId($socialiteUser->getId());
-
-            return $this->userFound($user, $socialiteUser);
         } catch (ModelNotFoundException $exception) {
-            return $this->userNotFound(new GithubUser($socialiteUser->user));
+            return $this->userNotFound(new GithubUser($socialiteUser->getRaw()));
         }
+
+        return $this->userFound($user, $socialiteUser);
+    }
+
+    private function getSocialiteUser(): SocialiteUser
+    {
+        return Socialite::driver('github')->user();
     }
 
     private function userFound(User $user, SocialiteUser $socialiteUser): RedirectResponse
     {
-        $this->dispatchNow(new UpdateProfile($user, ['github_username' => $socialiteUser->nickname]));
+        $this->dispatchNow(new UpdateProfile($user, ['github_username' => $socialiteUser->getNickname()]));
 
         Auth::login($user);
 
diff --git a/app/Http/Controllers/SubscriptionController.php b/app/Http/Controllers/SubscriptionController.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Jobs\UnsubscribeFromSubscriptionAble;
+use App\Models\Subscription;
+
+class SubscriptionController extends Controller
+{
+    public function unsubscribe(Subscription $subscription)
+    {
+        $thread = $subscription->subscriptionAble();
+
+        $this->dispatch(new UnsubscribeFromSubscriptionAble($subscription->user(), $thread));
+
+        $this->success("You're now unsubscribed from this thread.");
+
+        return redirect()->route('thread', $thread->slug());
+    }
+}
diff --git a/app/Jobs/CreateReply.php b/app/Jobs/CreateReply.php
@@ -9,6 +9,7 @@
 use App\Models\ReplyAble;
 use App\Events\ReplyWasCreated;
 use App\Http\Requests\CreateReplyRequest;
+use Ramsey\Uuid\Uuid;
 
 final class CreateReply
 {
@@ -56,6 +57,7 @@ public function handle(): Reply
 
         if ($this->replyAble instanceof SubscriptionAble && ! $this->replyAble->hasSubscriber($this->author)) {
             $subscription = new Subscription();
+            $subscription->uuid = Uuid::uuid4()->toString();
             $subscription->userRelation()->associate($this->author);
             $subscription->subscriptionAbleRelation()->associate($this->replyAble);
 
diff --git a/app/Jobs/CreateThread.php b/app/Jobs/CreateThread.php
@@ -6,6 +6,7 @@
 use App\User;
 use App\Models\Thread;
 use App\Http\Requests\ThreadRequest;
+use Ramsey\Uuid\Uuid;
 
 final class CreateThread
 {
@@ -68,6 +69,7 @@ public function handle(): Thread
 
         // Subscribe author to the thread.
         $subscription = new Subscription();
+        $subscription->uuid = Uuid::uuid4()->toString();
         $subscription->userRelation()->associate($this->author);
         $subscription->subscriptionAbleRelation()->associate($thread);
 
diff --git a/app/Jobs/SubscribeToSubscriptionAble.php b/app/Jobs/SubscribeToSubscriptionAble.php
@@ -5,6 +5,7 @@
 use App\Models\Subscription;
 use App\User;
 use App\Models\SubscriptionAble;
+use Ramsey\Uuid\Uuid;
 
 class SubscribeToSubscriptionAble
 {
@@ -27,6 +28,7 @@ public function __construct(User $user, SubscriptionAble $subscriptionAble)
     public function handle()
     {
         $subscription = new Subscription();
+        $subscription->uuid = Uuid::uuid4()->toString();
         $subscription->userRelation()->associate($this->user);
         $this->subscriptionAble->subscriptionsRelation()->save($subscription);
     }
diff --git a/app/Listeners/SendNewReplyNotification.php b/app/Listeners/SendNewReplyNotification.php
@@ -12,7 +12,7 @@ public function handle(ReplyWasCreated $event): void
     {
         foreach ($event->reply->replyAble()->subscriptions() as $subscription) {
             if ($this->replyAuthorDoesNotMatchSubscriber($event->reply->author(), $subscription)) {
-                $subscription->user()->notify(new NewReplyNotification($event->reply));
+                $subscription->user()->notify(new NewReplyNotification($event->reply, $subscription));
             }
         }
     }
diff --git a/app/Mail/NewReplyEmail.php b/app/Mail/NewReplyEmail.php
@@ -3,6 +3,7 @@
 namespace App\Mail;
 
 use App\Models\Reply;
+use App\Models\Subscription;
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Mail\Mailable;
@@ -17,9 +18,15 @@ class NewReplyEmail extends Mailable implements ShouldQueue
      */
     public $reply;
 
-    public function __construct(Reply $reply)
+    /**
+     * @var \App\Models\Subscription
+     */
+    public $subscription;
+
+    public function __construct(Reply $reply, Subscription $subscription)
     {
         $this->reply = $reply;
+        $this->subscription = $subscription;
     }
 
     public function build()
diff --git a/app/Models/Subscription.php b/app/Models/Subscription.php
@@ -2,13 +2,16 @@
 
 namespace App\Models;
 
+use App\Helpers\HasUuid;
 use App\User;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 class Subscription extends Model
 {
+    use HasUuid;
+
     /**
      * {@inheritdoc}
      */
diff --git a/app/Notifications/NewReplyNotification.php b/app/Notifications/NewReplyNotification.php
@@ -4,6 +4,7 @@
 
 use App\Mail\NewReplyEmail;
 use App\Models\Reply;
+use App\Models\Subscription;
 use App\User;
 use Illuminate\Bus\Queueable;
 use Illuminate\Notifications\Notification;
@@ -18,9 +19,15 @@ class NewReplyNotification extends Notification implements ShouldQueue
      */
     public $reply;
 
-    public function __construct(Reply $reply)
+    /**
+     * @var \App\Models\Subscription
+     */
+    public $subscription;
+
+    public function __construct(Reply $reply, Subscription $subscription)
     {
         $this->reply = $reply;
+        $this->subscription = $subscription;
     }
 
     public function via(User $user)
@@ -30,7 +37,7 @@ public function via(User $user)
 
     public function toMail(User $user)
     {
-        return (new NewReplyEmail($this->reply))
+        return (new NewReplyEmail($this->reply, $this->subscription))
             ->to($user->emailAddress(), $user->name());
     }
 
diff --git a/composer.json b/composer.json
@@ -14,6 +14,7 @@
         "laravelcollective/html": "5.5.*",
         "lasserafn/php-initial-avatar-generator": "^2.0",
         "league/commonmark": "^0.15.2",
+        "ramsey/uuid": "^3.7",
         "roave/security-advisories": "dev-master",
         "spatie/laravel-robots-middleware": "^1.0",
         "tijsverkoyen/akismet": "^1.1"
diff --git a/composer.lock b/composer.lock
diff --git a/database/factories/SubscriptionFactory.php b/database/factories/SubscriptionFactory.php
@@ -3,9 +3,11 @@
 use App\User;
 use App\Models\Thread;
 use App\Models\Subscription;
+use Ramsey\Uuid\Uuid;
 
 $factory->define(Subscription::class, function (Faker\Generator $faker, array $attributes = []) {
     return [
+        'uuid' => Uuid::uuid4()->toString(),
         'user_id' => $attributes['user_id'] ?? factory(User::class)->create()->id(),
         'subscriptionable_id' => $attributes['subscriptionable_id'] ?? factory(Thread::class)->create()->id(),
         'subscriptionable_type' => Thread::TABLE,
diff --git a/database/migrations/2017_10_18_193001_create_subscriptions_table.php b/database/migrations/2017_10_18_193001_create_subscriptions_table.php
@@ -9,15 +9,16 @@ class CreateSubscriptionsTable extends Migration
     public function up()
     {
         Schema::create('subscriptions', function (Blueprint $table) {
-            $table->increments('id');
+            $table->uuid('uuid');
+            $table->primary('uuid');
             $table->integer('user_id')->unsigned();
             $table->integer('subscriptionable_id');
             $table->string('subscriptionable_type')->default('');
             $table->timestamps();
         });
 
         Schema::table('subscriptions', function (Blueprint $table) {
-            $table->index('user_id');
+            $table->index(['user_id', 'uuid']);
             $table->foreign('user_id')
                 ->references('id')->on('users')
                 ->onDelete('CASCADE');
diff --git a/resources/views/emails/new_reply.blade.php b/resources/views/emails/new_reply.blade.php
@@ -1,13 +1,13 @@
 @component('mail::message')
 
-**{{ $reply->replyAble()->author()->name() }}** has replied to this thread.
+**{{ $reply->author()->name() }}** has replied to this thread.
 
 @component('mail::panel')
 @md($reply->body())
 @endcomponent
 
 You are receiving this because you are subscribed to this thread.<br>
 [View it on Laravel.io]({{ route('thread', $reply->replyAble()->slug()) }}),
-or [unsubscribe]({{ route('threads.unsubscribe', $reply->replyAble()->slug()) }}).
+or [unsubscribe]({{ route('subscriptions.unsubscribe', $subscription->uuid()->toString()) }}).
 
 @endcomponent
diff --git a/routes/bindings.php b/routes/bindings.php
diff --git a/routes/web.php b/routes/web.php
diff --git a/tests/Components/Models/SubscriptionTest.php b/tests/Components/Models/SubscriptionTest.php
diff --git a/tests/Feature/SubscriptionsTest.php b/tests/Feature/SubscriptionsTest.php

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`use App\Models\Subscription;`
`6`	`6`	`use App\User;`
`7`	`7`	`use App\Models\SubscriptionAble;`
	`8`	`+use Ramsey\Uuid\Uuid;`
`8`	`9`
`9`	`10`	`class SubscribeToSubscriptionAble`
`10`	`11`	`{`
`@@ -27,6 +28,7 @@ public function __construct(User $user, SubscriptionAble $subscriptionAble)`
`27`	`28`	`public function handle()`
`28`	`29`	`{`
`29`	`30`	`$subscription = new Subscription();`
	`31`	`+ $subscription->uuid = Uuid::uuid4()->toString();`
`30`	`32`	`$subscription->userRelation()->associate($this->user);`
`31`	`33`	`$this->subscriptionAble->subscriptionsRelation()->save($subscription);`
`32`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public function handle(ReplyWasCreated $event): void`
`12`	`12`	`{`
`13`	`13`	`foreach ($event->reply->replyAble()->subscriptions() as $subscription) {`
`14`	`14`	`if ($this->replyAuthorDoesNotMatchSubscriber($event->reply->author(), $subscription)) {`
`15`		`- $subscription->user()->notify(new NewReplyNotification($event->reply));`
	`15`	`+ $subscription->user()->notify(new NewReplyNotification($event->reply, $subscription));`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`	`}`