Webhook API

app/Api/V1/Controllers/Webhook/AttemptController.php

@@ -0,0 +1,128 @@
+<?php
+/*
+ * AttemptController.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\WebhookAttempt;
+use FireflyIII\Models\WebhookMessage;
+use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
+use FireflyIII\Transformers\WebhookAttemptTransformer;
+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 AttemptController
+ */
+class AttemptController extends Controller
+{
+    private WebhookRepositoryInterface $repository;
+    public const RESOURCE_KEY = 'webhook_attempts';
+
+    /**
+     * @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, WebhookMessage $message): JsonResponse
+    {
+        if ($message->webhook_id !== $webhook->id) {
+            throw new FireflyException('Webhook and webhook message are no match');
+        }
+
+        $manager    = $this->getManager();
+        $pageSize   = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $collection = $this->repository->getAttempts($message);
+        $count      = $collection->count();
+        $attempts   = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+
+        // make paginator:
+        $paginator = new LengthAwarePaginator($attempts, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.webhooks.attempts.index', [$webhook->id, $message->id]) . $this->buildParams());
+
+        /** @var WebhookAttemptTransformer $transformer */
+        $transformer = app(WebhookAttemptTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new FractalCollection($attempts, $transformer, 'webhook_attempts');
+        $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
+     * @param WebhookAttempt $attempt
+     *
+     * @return JsonResponse
+     * @throws FireflyException
+     */
+    public function show(Webhook $webhook, WebhookMessage $message, WebhookAttempt $attempt): JsonResponse
+    {
+        if($message->webhook_id !== $webhook->id) {
+            throw new FireflyException('Webhook and webhook message are no match');
+        }
+        if($attempt->webhook_message_id !== $message->id) {
+            throw new FireflyException('Webhook message and webhook attempt are no match');
+
+        }
+
+        $manager = $this->getManager();
+
+        /** @var WebhookAttemptTransformer $transformer */
+        $transformer = app(WebhookAttemptTransformer::class);
+        $transformer->setParameters($this->parameters);
+        $resource = new Item($attempt, $transformer, self::RESOURCE_KEY);
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+}

app/Api/V1/Controllers/Webhook/DestroyController.php

@@ -45,15 +45,18 @@ namespace FireflyIII\Api\V1\Controllers\Webhook;
 
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Webhook;
+use FireflyIII\Models\WebhookAttempt;
+use FireflyIII\Models\WebhookMessage;
 use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 
 /**
- * Class DeleteController
+ * Class DestroyController
  */
-class DeleteController extends Controller
+class DestroyController extends Controller
 {
     private WebhookRepositoryInterface $repository;
 
@@ -92,5 +95,47 @@ class DeleteController extends Controller
         return response()->json([], 204);
     }
 
+    /**
+     * Remove the specified resource from storage.
+     *
+     * @param Webhook $webhook
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function destroyMessage(Webhook $webhook, WebhookMessage $message): JsonResponse
+    {
+        if ($message->webhook_id !== $webhook->id) {
+            throw new FireflyException('Webhook and webhook message are no match');
+        }
+        $this->repository->destroyMessage($message);
+
+        return response()->json([], 204);
+    }
+
+    /**
+     * Remove the specified resource from storage.
+     *
+     * @param Webhook $webhook
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function destroyAttempt(Webhook $webhook, WebhookMessage $message, WebhookAttempt $attempt): JsonResponse
+    {
+        if ($message->webhook_id !== $webhook->id) {
+            throw new FireflyException('Webhook and webhook message are no match');
+        }
+        if($attempt->webhook_message_id !== $message->id) {
+            throw new FireflyException('Webhook message and webhook attempt are no match');
+
+        }
+
+        $this->repository->destroyAttempt($attempt);
+
+        return response()->json([], 204);
+    }
+
+
 
 }

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);
+    }
+
+}

app/Api/V1/Controllers/Webhook/ShowController.php

@@ -1,7 +1,6 @@
 <?php
-
 /*
- * IndexController.php
+ * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
  *
  * This file is part of Firefly III (https://github.com/firefly-iii).
@@ -20,31 +19,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-declare(strict_types=1);
-/*
- * IndexController.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\Api\V1\Controllers\Webhook;
 
 
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Models\Webhook;
 use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
 use FireflyIII\Transformers\WebhookTransformer;
 use FireflyIII\User;
@@ -52,12 +31,14 @@ 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 IndexController
+ * Class ShowController
  */
-class IndexController extends Controller
+class ShowController extends Controller
 {
+    public const RESOURCE_KEY = 'webhooks';
     private WebhookRepositoryInterface $repository;
 
     /**
@@ -80,30 +61,50 @@ class IndexController extends Controller
         );
     }
 
-
     /**
-     * Display a listing of the resource.
+     * Display a listing of the webhooks of the user.
      *
      * @return JsonResponse
      * @codeCoverageIgnore
      */
     public function index(): JsonResponse
     {
-        $webhooks  = $this->repository->all();
-        $manager   = $this->getManager();
-        $pageSize  = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
-        $count     = $webhooks->count();
-        $bills     = $webhooks->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        $manager    = $this->getManager();
+        $collection = $this->repository->all();
+        $pageSize   = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $count      = $collection->count();
+        $webhooks   = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+
+        // make paginator:
         $paginator = new LengthAwarePaginator($webhooks, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.webhooks.index') . $this->buildParams());
 
         /** @var WebhookTransformer $transformer */
         $transformer = app(WebhookTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($bills, $transformer, 'webhooks');
+        $resource = new FractalCollection($webhooks, $transformer, self::RESOURCE_KEY);
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
 
-}
+    /**
+     * Show single instance.
+     *
+     * @param Webhook $webhook
+     *
+     * @return JsonResponse
+     */
+    public function show(Webhook $webhook): JsonResponse
+    {
+        $manager = $this->getManager();
+
+        /** @var WebhookTransformer $transformer */
+        $transformer = app(WebhookTransformer::class);
+        $transformer->setParameters($this->parameters);
+        $resource = new Item($webhook, $transformer, self::RESOURCE_KEY);
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+}

app/Api/V1/Controllers/Webhook/StoreController.php

@@ -0,0 +1,80 @@
+<?php
+/*
+ * StoreController.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\Api\V1\Requests\Models\Webhook\CreateRequest;
+use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
+use FireflyIII\Transformers\WebhookTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;
+
+/**
+ * Class StoreController
+ */
+class StoreController extends Controller
+{
+    public const RESOURCE_KEY = 'webhooks';
+    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 CreateRequest $request
+     *
+     * @return JsonResponse
+     */
+    public function store(CreateRequest $request): JsonResponse
+    {
+        $data    = $request->getData();
+        $webhook = $this->repository->store($data);
+        $manager = $this->getManager();
+        /** @var WebhookTransformer $transformer */
+        $transformer = app(WebhookTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($webhook, $transformer, 'webhooks');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+}

app/Api/V1/Controllers/Webhook/SubmitController.php

@@ -0,0 +1,82 @@
+<?php
+/*
+ * SubmitController.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\Jobs\SendWebhookMessage;
+use FireflyIII\Models\Webhook;
+use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class SubmitController
+ */
+class SubmitController extends Controller
+{
+    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);
+            }
+        );
+    }
+
+    /**
+     * Remove the specified resource from storage.
+     *
+     * @param Webhook $webhook
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function submit(Webhook $webhook): JsonResponse
+    {
+        // count messages that can be sent.
+        $messages = $this->repository->getReadyMessages($webhook);
+        if (0 === $messages->count()) {
+            // nothing to send, return empty
+            return response()->json([], 204);
+        }
+        // send!
+        foreach ($messages as $message) {
+            SendWebhookMessage::dispatch($message)->afterResponse();
+        }
+
+        return response()->json([], 200);
+    }
+}

app/Api/V1/Controllers/Webhook/UpdateController.php

@@ -1,7 +1,6 @@
 <?php
-
 /*
- * EditController.php
+ * UpdateController.php
  * Copyright (c) 2021 james@firefly-iii.org
  *
  * This file is part of Firefly III (https://github.com/firefly-iii).
@@ -20,32 +19,11 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-declare(strict_types=1);
-/*
- * EditController.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\Api\V1\Controllers\Webhook;
 
 
 use FireflyIII\Api\V1\Controllers\Controller;
-use FireflyIII\Api\V1\Requests\Webhook\UpdateRequest;
+use FireflyIII\Api\V1\Requests\Models\Webhook\UpdateRequest;
 use FireflyIII\Models\Webhook;
 use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
 use FireflyIII\Transformers\WebhookTransformer;
@@ -54,9 +32,9 @@ use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
 /**
- * Class EditController
+ * Class UpdateController
  */
-class EditController extends Controller
+class UpdateController extends Controller
 {
     private WebhookRepositoryInterface $repository;
 
@@ -99,4 +77,5 @@ class EditController extends Controller
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
-}
+
+}

app/Api/V1/Requests/Models/Webhook/CreateRequest.php

@@ -41,7 +41,7 @@ declare(strict_types=1);
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-namespace FireflyIII\Api\V1\Requests\Webhook;
+namespace FireflyIII\Api\V1\Requests\Models\Webhook;
 
 use FireflyIII\Rules\IsBoolean;
 use FireflyIII\Support\Request\ChecksLogin;

app/Api/V1/Requests/Models/Webhook/UpdateRequest.php

@@ -41,7 +41,7 @@ declare(strict_types=1);
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-namespace FireflyIII\Api\V1\Requests\Webhook;
+namespace FireflyIII\Api\V1\Requests\Models\Webhook;
 
 use FireflyIII\Rules\IsBoolean;
 use FireflyIII\Support\Request\ChecksLogin;