Merge pull request #124 from regnerisch/main

feat: add dispatchIf, dispatchUnless, dispatchSyncIf and dispatchSync…

Author: freekmurze

README.md

@@ -118,6 +118,28 @@ WebhookCall::create()
    ->dispatchSync();
 ```
 
+### Conditionally sending webhooks
+
+If you would like to conditionally dispatch a webhook, you may use the `dispatchIf`, `dispatchUnless`, `dispatchSyncIf` and `dispatchSyncUnless` methods:
+
+```php
+WebhookCall::create()
+   ...
+   ->dispatchIf($condition);
+
+WebhookCall::create()
+   ...
+   ->dispatchUnless($condition);
+
+WebhookCall::create()
+   ...
+   ->dispatchSyncIf($condition);
+
+WebhookCall::create()
+   ...
+   ->dispatchSyncUnless($condition);
+```
+
 ### How signing requests works
 
 When setting up, it's common to generate, store, and share a secret between your app and the app that wants to receive webhooks. Generating the secret could be done with `Illuminate\Support\Str::random()`, but it's entirely up to you. The package will use the secret to sign a webhook call.

src/WebhookCall.php

@@ -200,13 +200,39 @@ public function dispatch(): PendingDispatch
         return dispatch($this->callWebhookJob);
     }
 
+    public function dispatchIf($condition): PendingDispatch|null
+    {
+        if ($condition) {
+            return $this->dispatch();
+        }
+
+        return null;
+    }
+
+    public function dispatchUnless($condition): PendingDispatch|null
+    {
+        return $this->dispatchIf(!$condition);
+    }
+
     public function dispatchSync(): void
     {
         $this->prepareForDispatch();
 
         dispatch_sync($this->callWebhookJob);
     }
 
+    public function dispatchSyncIf($condition): void
+    {
+        if ($condition) {
+            $this->dispatchSync();
+        }
+    }
+
+    public function dispatchSyncUnless($condition): void
+    {
+        $this->dispatchSyncIf(!$condition);
+    }
+
     protected function prepareForDispatch(): void
     {
         if (! $this->callWebhookJob->webhookUrl) {

tests/WebhookTest.php

@@ -151,4 +151,44 @@ public function it_can_get_the_uuid_property()
         $this->assertIsString($webhookCall->getUuid());
         $this->assertSame('my-unique-identifier', $webhookCall->getUuid());
     }
+
+    /** @test */
+    public function it_can_dispatch_a_job_that_calls_a_webhook_if_condition_true()
+    {
+        $url = 'https://localhost';
+
+        WebhookCall::create()->url($url)->useSecret('123')->dispatchIf(true);
+
+        Queue::assertPushed(CallWebhookJob::class);
+    }
+
+    /** @test */
+    public function it_can_not_dispatch_a_job_that_calls_a_webhook_if_condition_false()
+    {
+        $url = 'https://localhost';
+
+        WebhookCall::create()->url($url)->useSecret('123')->dispatchIf(false);
+
+        Queue::assertNotPushed(CallWebhookJob::class);
+    }
+
+    /** @test */
+    public function it_can_not_dispatch_a_job_that_calls_a_webhook_unless_condition_true()
+    {
+        $url = 'https://localhost';
+
+        WebhookCall::create()->url($url)->useSecret('123')->dispatchUnless(true);
+
+        Queue::assertNotPushed(CallWebhookJob::class);
+    }
+
+    /** @test */
+    public function it_can_dispatch_a_job_that_calls_a_webhook_unless_condition_false()
+    {
+        $url = 'https://localhost';
+
+        WebhookCall::create()->url($url)->useSecret('123')->dispatchUnless(false);
+
+        Queue::assertPushed(CallWebhookJob::class);
+    }
 }