API ability to manage webhooks.

2025-09-29 18:20:01 +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/Repositories/Webhook/WebhookRepository.php
+++ b/app/Repositories/Webhook/WebhookRepository.php
@@ -0,0 +1,90 @@
+<?php
+/*
+ * WebhookRepository.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\Repositories\Webhook;
+
+use FireflyIII\Models\Webhook;
+use FireflyIII\User;
+use Illuminate\Support\Collection;
+
+/**
+ * Class WebhookRepository
+ */
+class WebhookRepository implements WebhookRepositoryInterface
+{
+    private User $user;
+
+    /**
+     * @inheritDoc
+     */
+    public function all(): Collection
+    {
+        return $this->user->webhooks()->get();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function setUser(User $user): void
+    {
+        $this->user = $user;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function store(array $data): Webhook
+    {
+        $fullData = [
+            'user_id'  => $this->user->id,
+            'active'   => $data['active'],
+            'trigger'  => $data['trigger'],
+            'response' => $data['response'],
+            'delivery' => $data['delivery'],
+            'url'      => $data['url'],
+        ];
+
+        return Webhook::create($fullData);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function update(Webhook $webhook, array $data): Webhook
+    {
+        $webhook->active   = $data['active'] ?? $webhook->active;
+        $webhook->trigger  = $data['trigger'] ?? $webhook->trigger;
+        $webhook->response = $data['response'] ?? $webhook->response;
+        $webhook->delivery = $data['delivery'] ?? $webhook->delivery;
+        $webhook->url      = $data['url'] ?? $webhook->url;
+        $webhook->save();
+
+        return $webhook;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function destroy(Webhook $webhook): void
+    {
+        $webhook->delete();
+    }
+}
--- a/app/Repositories/Webhook/WebhookRepositoryInterface.php
+++ b/app/Repositories/Webhook/WebhookRepositoryInterface.php
@@ -0,0 +1,67 @@
+<?php
+/*
+ * WebhookRepositoryInterface.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\Repositories\Webhook;
+
+use FireflyIII\Models\Webhook;
+use FireflyIII\User;
+use Illuminate\Support\Collection;
+
+/**
+ * Interface WebhookRepositoryInterface
+ */
+interface WebhookRepositoryInterface
+{
+    /**
+     * Return all webhooks.
+     *
+     * @return Collection
+     */
+    public function all(): Collection;
+
+    /**
+     * Set user.
+     *
+     * @param User $user
+     */
+    public function setUser(User $user): void;
+
+    /**
+     * @param array $data
+     *
+     * @return Webhook
+     */
+    public function store(array $data): Webhook;
+
+    /**
+     * @param Webhook $webhook
+     * @param array   $data
+     *
+     * @return Webhook
+     */
+    public function update(Webhook $webhook, array $data): Webhook;
+
+    /**
+     * @param Webhook $webhook
+     */
+    public function destroy(Webhook $webhook): void;
+
+}