API ability to manage webhooks.

2025-09-04 11:48:05 +00:00 · 2020-11-29 18:35:49 +01:00
parent f42bd19c1c
commit 59962005db
17 changed files with 1039 additions and 99 deletions
--- a/app/Models/Webhook.php
+++ b/app/Models/Webhook.php
@@ -0,0 +1,118 @@
+<?php
+/*
+ * Webhook.php
+ * Copyright (c) 2020 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace FireflyIII\Models;
+
+
+use FireflyIII\User;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+
+/**
+ * Class Webhook
+ *
+ * @property int                             $id
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property string|null                     $deleted_at
+ * @property int                             $user_id
+ * @property bool                            $active
+ * @property int                             $trigger
+ * @property int                             $response
+ * @property int                             $delivery
+ * @property string                          $url
+ * @property-read User                       $user
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook query()
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereActive($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereDeletedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereDelivery($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereResponse($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereTrigger($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereUpdatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereUrl($value)
+ * @method static \Illuminate\Database\Eloquent\Builder|Webhook whereUserId($value)
+ * @mixin \Eloquent
+ */
+class Webhook extends Model
+{
+    use SoftDeletes;
+    // dont forget to update the config in firefly.php
+    // triggers
+    public const TRIGGER_CREATE_TRANSACTION = 100;
+    public const TRIGGER_UPDATE_TRANSACTION = 110;
+    public const TRIGGER_DELETE_TRANSACTION = 120;
+
+    // actions
+    public const MESSAGE_TRANSACTIONS = 200;
+    public const MESSAGE_ACCOUNTS     = 210;
+
+    // delivery
+    public const DELIVERY_JSON = 300;
+
+    protected $fillable = ['active', 'trigger', 'response', 'delivery', 'user_id', 'url'];
+
+    protected $casts
+        = [
+            'active'   => 'boolean',
+            'trigger'  => 'integer',
+            'response' => 'integer',
+            'delivery' => 'integer',
+        ];
+
+    /**
+     * Route binder. Converts the key in the URL to the specified object (or throw 404).
+     *
+     * @param string $value
+     *
+     * @throws NotFoundHttpException
+     * @return Webhook
+     */
+    public static function routeBinder(string $value): Webhook
+    {
+        if (auth()->check()) {
+            $budgetId = (int) $value;
+            /** @var User $user */
+            $user = auth()->user();
+            /** @var Webhook $webhook */
+            $webhook = $user->webhooks()->find($budgetId);
+            if (null !== $webhook) {
+                return $webhook;
+            }
+        }
+        throw new NotFoundHttpException;
+    }
+
+    /**
+     * @codeCoverageIgnore
+     * @return BelongsTo
+     */
+    public function user(): BelongsTo
+    {
+        return $this->belongsTo(User::class);
+    }
+
+}