Merge pull request #26 from alnutile/webhook

Webhook

README.md

@@ -121,3 +121,9 @@ git push origin main
 ```
 
 That's it! This will allow you to have a private "fork" of a public repository and to merge updates from the public repository into your private one.
+
+## Test
+
+```bash
+composer test
+```

app/Http/Controllers/Sources/WebHookSourceController.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace App\Http\Controllers\Sources;
+
+use App\Events\SourceRunCompleteEvent;
+use App\Models\Project;
+use App\Models\Source;
+use App\Source\SourceEnum;
+
+class WebHookSourceController extends BaseSourceController
+{
+    public function create(Project $project)
+    {
+        return inertia('Sources/WebHook/Create', [
+            'details' => config('larachain.sources.web_hook'),
+            'project' => $project,
+            'source' => [
+                'meta_data' => [],
+            ],
+        ]);
+    }
+
+    public function edit(Project $project, Source $source)
+    {
+        return inertia('Sources/WebHook/Edit', [
+            'details' => config('larachain.sources.web_hook'),
+            'project' => $project,
+            'source' => $source,
+        ]);
+    }
+
+    public function store(Project $project)
+    {
+        $validated = request()->validate([
+            'name' => ['required'],
+            'description' => ['nullable'],
+            'meta_data' => ['nullable'],
+        ]);
+
+        Source::create([
+            'project_id' => $project->id,
+            'name' => $validated['name'],
+            'description' => $validated['description'],
+            'type' => SourceEnum::WebHook,
+            'order' => 1,
+            'meta_data' => data_get($validated, 'meta_data'),
+        ]);
+
+        request()->session()->flash('flash.banner', 'Source Created 🤘');
+
+        return to_route('projects.show', [
+            'project' => $project->id,
+        ]);
+    }
+
+    public function update(Project $project, Source $source)
+    {
+        $validated = request()->validate([
+            'meta_data' => ['nullable'],
+            'name' => ['required'],
+            'description' => ['nullable'],
+        ]);
+
+        $validated['project_id'] = $project->id;
+
+        $source->update([
+            'project_id' => $validated['project_id'],
+            'name' => $validated['name'],
+            'description' => $validated['description'],
+            'type' => SourceEnum::WebHook,
+            'order' => 1,
+            'meta_data' => data_get($validated, 'meta_data'),
+        ]);
+
+        request()->session()->flash('flash.banner', 'Source Updated ✅');
+
+        return to_route('projects.show', [
+            'project' => $project->id,
+        ]);
+    }
+
+    public function webhook(Project $project, Source $source)
+    {
+        /**
+         * @TODO
+         * Security
+         * Allow to dump into queue
+         * Allow to return any response
+         */
+        $payload = request()->all();
+
+        logger('Webhook coming in', $payload);
+
+        $source->run($payload);
+
+        SourceRunCompleteEvent::dispatch($source);
+
+        return response()->json('OK', 200);
+    }
+}

app/Jobs/ProcessSourceListeners.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Jobs;
+
+use App\Models\Document;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+class ProcessSourceListeners implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * Create a new job instance.
+     */
+    public function __construct(public Document $document)
+    {
+        //
+    }
+
+    /**
+     * Execute the job.
+     */
+    public function handle(): void
+    {
+        /**
+         * See if has attached Listeners
+         * If so queue those up
+         * else just return document
+         *
+         * @TODO how to trigger transformations
+         */
+    }
+}

app/Listeners/RunTransformersListener.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Events\SourceRunCompleteEvent;
+
+class RunTransformersListener
+{
+    /**
+     * Create the event listener.
+     */
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Handle the event.
+     */
+    public function handle(SourceRunCompleteEvent $event): void
+    {
+        //
+    }
+}

app/Models/Source.php

@@ -46,26 +46,13 @@ public function documents()
     /**
      * @throws SourceTypeMissingException
      */
-    public function run()
+    public function run(array $payload = []): Document
     {
         try {
-            $statusTypes = config('larachain.sources');
-            $statusType = $this->type->value;
-            $statusType = data_get($statusTypes, $statusType);
-            $class = data_get($statusType, 'class', null);
-            if (! $class) {
-                throw new \Exception('Source Missing Class');
-            }
+            $sourceType = $this->getSourceTypeClass();
 
-            logger('Running Source '.$class);
-            //@TODO make this check in uses BaseSourceType
-            $sourceType = app($class, [
-                'source' => $this,
-            ]);
-            /** @var BaseSourceType $sourceType */
-            return $sourceType->handle();
+            return $sourceType->setPayload($payload)->handle();
         } catch (\Exception $e) {
-            //@TODO This exception needs to be more specific
             logger($e);
             throw new SourceTypeMissingException();
         }
@@ -75,4 +62,23 @@ public function getTypeFormattedAttribute()
     {
         return str($this->type->value)->headline();
     }
+
+    protected function getSourceTypeClass(): BaseSourceType|\Exception
+    {
+        $statusTypes = config('larachain.sources');
+        $statusType = $this->type->value;
+        $statusType = data_get($statusTypes, $statusType);
+        $class = data_get($statusType, 'class', null);
+
+        if (! $class) {
+            throw new \Exception('Source Missing Class');
+        }
+
+        /** @var BaseSourceType $sourceType */
+        $sourceType = app($class, [
+            'source' => $this,
+        ]);
+
+        return $sourceType;
+    }
 }

app/Providers/EventServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace App\Providers;
 
+use App\Events\SourceRunCompleteEvent;
+use App\Listeners\RunTransformersListener;
 use Illuminate\Auth\Events\Registered;
 use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
 use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
@@ -18,6 +20,9 @@ class EventServiceProvider extends ServiceProvider
         Registered::class => [
             SendEmailVerificationNotification::class,
         ],
+        SourceRunCompleteEvent::class => [
+            RunTransformersListener::class,
+        ],
     ];
 
     /**

app/Source/SourceEnum.php

@@ -12,6 +12,7 @@ enum SourceEnum: string
     use TypeTrait;
 
     //case TemplateType = 'template_type'
+    case WebHook = 'web_hook';
     case FileUploadSource = 'file_upload_source';
     case ScrapeWebPage = 'scrape_web_page';
     case WebFile = 'web_file';

app/Source/Types/BaseSourceType.php

@@ -8,11 +8,26 @@ abstract class BaseSourceType
 {
     protected Source $source;
 
-    public function __construct(Source $source)
+    protected array $payload = [];
+
+    public function __construct(
+        Source $source)
     {
         $this->source = $source;
     }
 
+    public function setPayload(array $payload): self
+    {
+        $this->payload = $payload;
+
+        return $this;
+    }
+
+    public function getPayload(): array
+    {
+        return $this->payload;
+    }
+
     abstract public function handle();
 
     protected function getPath($fileName): string

app/Source/Types/WebHook.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Source\Types;
+
+use App\Ingress\StatusEnum;
+use App\Jobs\ProcessSourceListeners;
+use App\Models\Document;
+use Ramsey\Uuid\Uuid;
+
+class WebHook extends BaseSourceType
+{
+    public function handle(): Document
+    {
+        $document = Document::create(
+                [
+                    'guid' => Uuid::uuid4()->toString(),
+                    'source_id' => $this->source->id,
+                    'status' => StatusEnum::Complete,
+                    'content' => json_encode($this->payload),
+                    'meta_data' => [
+                        'original_payload' => $this->payload,
+                    ],
+                ]
+            );
+
+        ProcessSourceListeners::dispatch($document);
+
+        return $document;
+    }
+}

config/larachain.php

@@ -18,11 +18,12 @@
             'background' => 'bg-blue-500',
         ],
         'web_hook' => [
-            'name' => 'Create a Webhook to Send Data',
-            'description' => 'Add a webhook here to send logs or other data.',
-            'icon' => 'Bars4Icon',
-            'active' => 0,
-            'background' => 'bg-blue-500',
+            'name' => 'WebHook',
+            'description' => 'You can take data from a webhook or trigger a listener',
+            'class' => 'App\\Source\\Types\\WebHook',
+            'requires' => [
+            ],
+            'active' => 1,
         ],
         's3_directory' => [
             'name' => 'S3 Directory to Get Files From',

database/factories/SourceFactory.php

@@ -47,6 +47,16 @@ public function fileUpload()
         });
     }
 
+    public function webHook()
+    {
+        return $this->state(function (array $attributes) {
+            return [
+                'type' => SourceEnum::WebHook,
+                'meta_data' => [],
+            ];
+        });
+    }
+
     public function scrapeWebPage()
     {
         return $this->state(function (array $attributes) {