Webhook API

2025-10-31 10:47:00 +00:00 · 2021-03-07 12:13:22 +01:00
parent c4882231d1
commit ba163f82d1
19 changed files with 800 additions and 90 deletions
--- a/app/Api/V1/Controllers/Webhook/MessageController.php
+++ b/app/Api/V1/Controllers/Webhook/MessageController.php
@@ -0,0 +1,116 @@
+<?php
+/*
+ * MessageController.php
+ * Copyright (c) 2021 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\Api\V1\Controllers\Webhook;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\Webhook;
+use FireflyIII\Models\WebhookMessage;
+use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
+use FireflyIII\Transformers\WebhookMessageTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Pagination\LengthAwarePaginator;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection as FractalCollection;
+use League\Fractal\Resource\Item;
+
+class MessageController extends Controller
+{
+    public const RESOURCE_KEY = 'webhook_messages';
+    private WebhookRepositoryInterface $repository;
+
+    /**
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $admin */
+                $admin = auth()->user();
+
+                /** @var WebhookRepositoryInterface repository */
+                $this->repository = app(WebhookRepositoryInterface::class);
+                $this->repository->setUser($admin);
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * @param Webhook $webhook
+     *
+     * @return JsonResponse
+     */
+    public function index(Webhook $webhook): JsonResponse
+    {
+        $manager    = $this->getManager();
+        $pageSize   = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $collection = $this->repository->getMessages($webhook);
+
+        $count       = $collection->count();
+        $messages = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+
+        // make paginator:
+        $paginator = new LengthAwarePaginator($messages, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.webhooks.messages.index', [$webhook->id]) . $this->buildParams());
+
+        /** @var WebhookMessageTransformer $transformer */
+        $transformer = app(WebhookMessageTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new FractalCollection($messages, $transformer, 'webhook_messages');
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+
+    /**
+     * Show single instance.
+     *
+     * @param Webhook        $webhook
+     * @param WebhookMessage $message
+     *
+     * @return JsonResponse
+     * @throws FireflyException
+     */
+    public function show(Webhook $webhook, WebhookMessage $message): JsonResponse
+    {
+        if($message->webhook_id !== $webhook->id) {
+            throw new FireflyException('Webhook and webhook message are no match');
+        }
+
+        $manager = $this->getManager();
+
+        /** @var WebhookMessageTransformer $transformer */
+        $transformer = app(WebhookMessageTransformer::class);
+        $transformer->setParameters($this->parameters);
+        $resource = new Item($message, $transformer, self::RESOURCE_KEY);
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+
+}