From ba163f82d1db7dafdae96a66dff7eec3846842b6 Mon Sep 17 00:00:00 2001 From: James Cole Date: Sun, 7 Mar 2021 12:13:22 +0100 Subject: [PATCH] Webhook API --- .../Controllers/Webhook/AttemptController.php | 128 ++++++++++++++++++ .../DestroyController.php} | 49 ++++++- .../Controllers/Webhook/MessageController.php | 116 ++++++++++++++++ .../ShowController.php} | 69 +++++----- .../Controllers/Webhook/StoreController.php | 80 +++++++++++ .../Controllers/Webhook/SubmitController.php | 82 +++++++++++ .../UpdateController.php} | 33 +---- .../Webhook}/CreateRequest.php | 2 +- .../Webhook}/UpdateRequest.php | 2 +- app/Models/Webhook.php | 4 +- app/Models/WebhookAttempt.php | 29 ++++ app/Models/WebhookMessage.php | 27 ++++ .../Webhook/WebhookRepository.php | 52 ++++++- .../Webhook/WebhookRepositoryInterface.php | 33 +++++ .../Webhook/StandardWebhookSender.php | 11 +- .../WebhookAttemptTransformer.php | 54 ++++++++ .../WebhookMessageTransformer.php | 64 +++++++++ config/firefly.php | 4 + routes/api.php | 51 ++++--- 19 files changed, 800 insertions(+), 90 deletions(-) create mode 100644 app/Api/V1/Controllers/Webhook/AttemptController.php rename app/Api/V1/Controllers/{todo-Webhook/DeleteController.php => Webhook/DestroyController.php} (66%) create mode 100644 app/Api/V1/Controllers/Webhook/MessageController.php rename app/Api/V1/Controllers/{todo-Webhook/IndexController.php => Webhook/ShowController.php} (63%) create mode 100644 app/Api/V1/Controllers/Webhook/StoreController.php create mode 100644 app/Api/V1/Controllers/Webhook/SubmitController.php rename app/Api/V1/Controllers/{todo-Webhook/EditController.php => Webhook/UpdateController.php} (71%) rename app/Api/V1/Requests/{todo-Webhook => Models/Webhook}/CreateRequest.php (98%) rename app/Api/V1/Requests/{todo-Webhook => Models/Webhook}/UpdateRequest.php (98%) create mode 100644 app/Transformers/WebhookAttemptTransformer.php create mode 100644 app/Transformers/WebhookMessageTransformer.php diff --git a/app/Api/V1/Controllers/Webhook/AttemptController.php b/app/Api/V1/Controllers/Webhook/AttemptController.php new file mode 100644 index 0000000000..25b1e76fc1 --- /dev/null +++ b/app/Api/V1/Controllers/Webhook/AttemptController.php @@ -0,0 +1,128 @@ +. + */ + +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); + } +} \ No newline at end of file diff --git a/app/Api/V1/Controllers/todo-Webhook/DeleteController.php b/app/Api/V1/Controllers/Webhook/DestroyController.php similarity index 66% rename from app/Api/V1/Controllers/todo-Webhook/DeleteController.php rename to app/Api/V1/Controllers/Webhook/DestroyController.php index 6dd804dd95..61fe2acec5 100644 --- a/app/Api/V1/Controllers/todo-Webhook/DeleteController.php +++ b/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); + } + + } diff --git a/app/Api/V1/Controllers/Webhook/MessageController.php b/app/Api/V1/Controllers/Webhook/MessageController.php new file mode 100644 index 0000000000..25bab9f655 --- /dev/null +++ b/app/Api/V1/Controllers/Webhook/MessageController.php @@ -0,0 +1,116 @@ +. + */ + +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); + } + +} \ No newline at end of file diff --git a/app/Api/V1/Controllers/todo-Webhook/IndexController.php b/app/Api/V1/Controllers/Webhook/ShowController.php similarity index 63% rename from app/Api/V1/Controllers/todo-Webhook/IndexController.php rename to app/Api/V1/Controllers/Webhook/ShowController.php index 89c099c41d..2fe432df79 100644 --- a/app/Api/V1/Controllers/todo-Webhook/IndexController.php +++ b/app/Api/V1/Controllers/Webhook/ShowController.php @@ -1,7 +1,6 @@ . */ -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 . - */ - 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); + } +} \ No newline at end of file diff --git a/app/Api/V1/Controllers/Webhook/StoreController.php b/app/Api/V1/Controllers/Webhook/StoreController.php new file mode 100644 index 0000000000..73766a32b6 --- /dev/null +++ b/app/Api/V1/Controllers/Webhook/StoreController.php @@ -0,0 +1,80 @@ +. + */ + +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); + } +} \ No newline at end of file diff --git a/app/Api/V1/Controllers/Webhook/SubmitController.php b/app/Api/V1/Controllers/Webhook/SubmitController.php new file mode 100644 index 0000000000..5e2f139d26 --- /dev/null +++ b/app/Api/V1/Controllers/Webhook/SubmitController.php @@ -0,0 +1,82 @@ +. + */ + +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); + } +} \ No newline at end of file diff --git a/app/Api/V1/Controllers/todo-Webhook/EditController.php b/app/Api/V1/Controllers/Webhook/UpdateController.php similarity index 71% rename from app/Api/V1/Controllers/todo-Webhook/EditController.php rename to app/Api/V1/Controllers/Webhook/UpdateController.php index d142a130b3..ce4f371445 100644 --- a/app/Api/V1/Controllers/todo-Webhook/EditController.php +++ b/app/Api/V1/Controllers/Webhook/UpdateController.php @@ -1,7 +1,6 @@ . */ -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 . - */ - 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); } -} + +} \ No newline at end of file diff --git a/app/Api/V1/Requests/todo-Webhook/CreateRequest.php b/app/Api/V1/Requests/Models/Webhook/CreateRequest.php similarity index 98% rename from app/Api/V1/Requests/todo-Webhook/CreateRequest.php rename to app/Api/V1/Requests/Models/Webhook/CreateRequest.php index 62dd3b7c6e..f96c524813 100644 --- a/app/Api/V1/Requests/todo-Webhook/CreateRequest.php +++ b/app/Api/V1/Requests/Models/Webhook/CreateRequest.php @@ -41,7 +41,7 @@ declare(strict_types=1); * along with this program. If not, see . */ -namespace FireflyIII\Api\V1\Requests\Webhook; +namespace FireflyIII\Api\V1\Requests\Models\Webhook; use FireflyIII\Rules\IsBoolean; use FireflyIII\Support\Request\ChecksLogin; diff --git a/app/Api/V1/Requests/todo-Webhook/UpdateRequest.php b/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php similarity index 98% rename from app/Api/V1/Requests/todo-Webhook/UpdateRequest.php rename to app/Api/V1/Requests/Models/Webhook/UpdateRequest.php index 85d6397ab2..9c039822f1 100644 --- a/app/Api/V1/Requests/todo-Webhook/UpdateRequest.php +++ b/app/Api/V1/Requests/Models/Webhook/UpdateRequest.php @@ -41,7 +41,7 @@ declare(strict_types=1); * along with this program. If not, see . */ -namespace FireflyIII\Api\V1\Requests\Webhook; +namespace FireflyIII\Api\V1\Requests\Models\Webhook; use FireflyIII\Rules\IsBoolean; use FireflyIII\Support\Request\ChecksLogin; diff --git a/app/Models/Webhook.php b/app/Models/Webhook.php index 1f74dd7b75..18705d949d 100644 --- a/app/Models/Webhook.php +++ b/app/Models/Webhook.php @@ -128,11 +128,11 @@ class Webhook extends Model public static function routeBinder(string $value): Webhook { if (auth()->check()) { - $budgetId = (int)$value; + $webhookId = (int)$value; /** @var User $user */ $user = auth()->user(); /** @var Webhook $webhook */ - $webhook = $user->webhooks()->find($budgetId); + $webhook = $user->webhooks()->find($webhookId); if (null !== $webhook) { return $webhook; } diff --git a/app/Models/WebhookAttempt.php b/app/Models/WebhookAttempt.php index 6d86f5bfa8..7002e7fb8f 100644 --- a/app/Models/WebhookAttempt.php +++ b/app/Models/WebhookAttempt.php @@ -44,8 +44,11 @@ declare(strict_types=1); 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 WebhookAttempt @@ -74,6 +77,7 @@ use Illuminate\Database\Eloquent\Relations\BelongsTo; */ class WebhookAttempt extends Model { + use SoftDeletes; /** * @codeCoverageIgnore * @return BelongsTo @@ -82,4 +86,29 @@ class WebhookAttempt extends Model { return $this->belongsTo(WebhookMessage::class); } + + /** + * Route binder. Converts the key in the URL to the specified object (or throw 404). + * + * @param string $value + * + * @return WebhookAttempt + * @throws NotFoundHttpException + */ + public static function routeBinder(string $value): WebhookAttempt + { + if (auth()->check()) { + $attemptId = (int)$value; + /** @var User $user */ + $user = auth()->user(); + /** @var WebhookAttempt $attempt */ + $attempt = self::find($attemptId); + if (null !== $attempt) { + if($attempt->webhookMessage->webhook->user_id === $user->id) { + return $attempt; + } + } + } + throw new NotFoundHttpException; + } } diff --git a/app/Models/WebhookMessage.php b/app/Models/WebhookMessage.php index 5376250944..a05653866c 100644 --- a/app/Models/WebhookMessage.php +++ b/app/Models/WebhookMessage.php @@ -44,9 +44,11 @@ declare(strict_types=1); namespace FireflyIII\Models; +use FireflyIII\User; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\Relations\HasMany; +use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; /** * FireflyIII\Models\WebhookMessage @@ -93,6 +95,31 @@ class WebhookMessage extends Model 'logs' => 'json', ]; + /** + * Route binder. Converts the key in the URL to the specified object (or throw 404). + * + * @param string $value + * + * @return WebhookMessage + * @throws NotFoundHttpException + */ + public static function routeBinder(string $value): WebhookMessage + { + if (auth()->check()) { + $messageId = (int)$value; + /** @var User $user */ + $user = auth()->user(); + /** @var WebhookMessage $message */ + $message = self::find($messageId); + if (null !== $message) { + if($message->webhook->user_id === $user->id) { + return $message; + } + } + } + throw new NotFoundHttpException; + } + /** * @codeCoverageIgnore * @return BelongsTo diff --git a/app/Repositories/Webhook/WebhookRepository.php b/app/Repositories/Webhook/WebhookRepository.php index 66f12839cd..274b055e14 100644 --- a/app/Repositories/Webhook/WebhookRepository.php +++ b/app/Repositories/Webhook/WebhookRepository.php @@ -44,6 +44,8 @@ declare(strict_types=1); namespace FireflyIII\Repositories\Webhook; use FireflyIII\Models\Webhook; +use FireflyIII\Models\WebhookAttempt; +use FireflyIII\Models\WebhookMessage; use FireflyIII\User; use Illuminate\Support\Collection; use Str; @@ -102,7 +104,7 @@ class WebhookRepository implements WebhookRepositoryInterface $webhook->delivery = $data['delivery'] ?? $webhook->delivery; $webhook->url = $data['url'] ?? $webhook->url; - if (array_key_exists('secret', $data) && null !== $data['secret']) { + if(true === $data['secret']) { $secret = $random = Str::random(24); $webhook->secret = $secret; } @@ -119,4 +121,52 @@ class WebhookRepository implements WebhookRepositoryInterface { $webhook->delete(); } + + /** + * @inheritDoc + */ + public function destroyMessage(WebhookMessage $message): void + { + $message->delete(); + } + + /** + * @inheritDoc + */ + public function destroyAttempt(WebhookAttempt $attempt): void + { + $attempt->delete(); + } + + /** + * @inheritDoc + */ + public function getReadyMessages(Webhook $webhook): Collection + { + return $webhook->webhookMessages() + ->where('webhook_messages.sent', 0) + ->where('webhook_messages.errored', 0) + ->get(['webhook_messages.*']) + ->filter( + function (WebhookMessage $message) { + return $message->webhookAttempts()->count() <= 2; + } + )->splice(0, 3); + } + /** + * @inheritDoc + */ + public function getMessages(Webhook $webhook): Collection + { + return $webhook->webhookMessages() + ->get(['webhook_messages.*']); + } + + /** + * @inheritDoc + */ + public function getAttempts(WebhookMessage $webhookMessage): Collection + { + return $webhookMessage->webhookAttempts; + } } diff --git a/app/Repositories/Webhook/WebhookRepositoryInterface.php b/app/Repositories/Webhook/WebhookRepositoryInterface.php index 8283d2e90f..5c2d0c5b68 100644 --- a/app/Repositories/Webhook/WebhookRepositoryInterface.php +++ b/app/Repositories/Webhook/WebhookRepositoryInterface.php @@ -44,6 +44,8 @@ declare(strict_types=1); namespace FireflyIII\Repositories\Webhook; use FireflyIII\Models\Webhook; +use FireflyIII\Models\WebhookAttempt; +use FireflyIII\Models\WebhookMessage; use FireflyIII\User; use Illuminate\Support\Collection; @@ -86,4 +88,35 @@ interface WebhookRepositoryInterface */ public function destroy(Webhook $webhook): void; + /** + * @param WebhookMessage $message + */ + public function destroyMessage(WebhookMessage $message): void; + + /** + * @param WebhookAttempt $attempt + */ + public function destroyAttempt(WebhookAttempt $attempt): void; + + /** + * @param Webhook $webhook + * + * @return Collection + */ + public function getReadyMessages(Webhook $webhook): Collection; + + /** + * @param Webhook $webhook + * + * @return Collection + */ + public function getMessages(Webhook $webhook): Collection; + + /** + * @param WebhookMessage $webhookMessage + * + * @return Collection + */ + public function getAttempts(WebhookMessage $webhookMessage): Collection; + } diff --git a/app/Services/Webhook/StandardWebhookSender.php b/app/Services/Webhook/StandardWebhookSender.php index cd1745cf03..9f3e720050 100644 --- a/app/Services/Webhook/StandardWebhookSender.php +++ b/app/Services/Webhook/StandardWebhookSender.php @@ -123,10 +123,19 @@ class StandardWebhookSender implements WebhookSenderInterface } catch (ClientException | Exception $e) { Log::error($e->getMessage()); Log::error($e->getTraceAsString()); - //$logs[] = sprintf('%s: %s', date('Y-m-d H:i:s'), $e->getMessage()); + + $logs = sprintf("%s\n%s", $e->getMessage(), $e->getTraceAsString()); + $this->message->errored = true; $this->message->sent = false; $this->message->save(); + + $attempt = new WebhookAttempt; + $attempt->webhookMessage()->associate($this->message); + $attempt->status_code = $e->getResponse() ? $e->getResponse()->getStatusCode() : 0; + $attempt->logs = $logs; + $attempt->save(); + return; } $this->message->save(); diff --git a/app/Transformers/WebhookAttemptTransformer.php b/app/Transformers/WebhookAttemptTransformer.php new file mode 100644 index 0000000000..dd91501787 --- /dev/null +++ b/app/Transformers/WebhookAttemptTransformer.php @@ -0,0 +1,54 @@ +. + */ + +declare(strict_types=1); + +namespace FireflyIII\Transformers; + + +use FireflyIII\Models\WebhookAttempt; + +/** + * Class WebhookAttemptTransformer + */ +class WebhookAttemptTransformer extends AbstractTransformer +{ + /** + * Transform the preference + * + * @param WebhookAttempt $attempt + * + * @return array + */ + public function transform(WebhookAttempt $attempt): array + { + return [ + 'id' => (string)$attempt->id, + 'created_at' => $attempt->created_at->toAtomString(), + 'updated_at' => $attempt->updated_at->toAtomString(), + 'webhook_message_id' => (string)$attempt->webhook_message_id, + 'status_code' => (int)$attempt->status_code, + 'logs' => $attempt->logs, + 'response' => $attempt->response, + ]; + } + +} diff --git a/app/Transformers/WebhookMessageTransformer.php b/app/Transformers/WebhookMessageTransformer.php new file mode 100644 index 0000000000..e4f25d938f --- /dev/null +++ b/app/Transformers/WebhookMessageTransformer.php @@ -0,0 +1,64 @@ +. + */ + +declare(strict_types=1); + +namespace FireflyIII\Transformers; + +use FireflyIII\Models\WebhookMessage; +use Jsonexception; +use Log; + +/** + * Class WebhookMessageTransformer + */ +class WebhookMessageTransformer extends AbstractTransformer +{ + /** + * Transform the preference + * + * @param WebhookMessage $message + * + * @return array + */ + public function transform(WebhookMessage $message): array + { + + $json = '{}'; + try { + $json = json_encode($message->message, JSON_THROW_ON_ERROR); + } catch (JsonException $e) { + Log::error(sprintf('Could not encode webhook message #%d: %s', $message->id, $e->getMessage())); + } + + return [ + 'id' => (string)$message->id, + 'created_at' => $message->created_at->toAtomString(), + 'updated_at' => $message->updated_at->toAtomString(), + 'sent' => $message->sent, + 'errored' => $message->errored, + 'webhook_id' => (string)$message->webhook_id, + 'uuid' => $message->uuid, + 'message' => $json, + ]; + } + +} diff --git a/config/firefly.php b/config/firefly.php index 156fc4f138..f8042f4f49 100644 --- a/config/firefly.php +++ b/config/firefly.php @@ -45,6 +45,8 @@ use FireflyIII\Models\TransactionJournal; use FireflyIII\Models\TransactionJournalLink; use FireflyIII\Models\TransactionType as TransactionTypeModel; use FireflyIII\Models\Webhook; +use FireflyIII\Models\WebhookAttempt; +use FireflyIII\Models\WebhookMessage; use FireflyIII\Support\Binder\AccountList; use FireflyIII\Support\Binder\BudgetList; use FireflyIII\Support\Binder\CategoryList; @@ -380,6 +382,8 @@ return [ 'transactionGroup' => TransactionGroup::class, 'user' => User::class, 'webhook' => Webhook::class, + 'webhookMessage' => WebhookMessage::class, + 'webhookAttempt' => WebhookAttempt::class, // strings 'currency_code' => CurrencyCode::class, diff --git a/routes/api.php b/routes/api.php index 50a3629461..4c34044abe 100644 --- a/routes/api.php +++ b/routes/api.php @@ -507,6 +507,8 @@ Route::group( } ); + + // Users API routes: Route::group( ['middleware' => ['auth:api', 'bindings', IsAdmin::class], 'namespace' => 'FireflyIII\Api\V1\Controllers\System', 'prefix' => 'users', @@ -521,6 +523,10 @@ Route::group( } ); +/** + * USER + */ + // Preference API routes: Route::group( ['namespace' => 'FireflyIII\Api\V1\Controllers\User', 'prefix' => 'preferences', @@ -533,6 +539,30 @@ Route::group( } ); +// Webhook API routes: +Route::group( + ['namespace' => 'FireflyIII\Api\V1\Controllers\Webhook', 'prefix' => 'webhooks', + 'as' => 'api.v1.webhooks.',], + static function () { + Route::get('', ['uses' => 'ShowController@index', 'as' => 'index']); + Route::post('', ['uses' => 'StoreController@store', 'as' => 'store']); + Route::get('{webhook}', ['uses' => 'ShowController@show', 'as' => 'show']); + Route::put('{webhook}', ['uses' => 'UpdateController@update', 'as' => 'update']); + Route::post('{webhook}/submit', ['uses' => 'SubmitController@submit', 'as' => 'submit']); + Route::delete('{webhook}', ['uses' => 'DestroyController@destroy', 'as' => 'destroy']); + + // webhook messages + Route::get('{webhook}/messages', ['uses' => 'MessageController@index', 'as' => 'messages.index']); + Route::get('{webhook}/messages/{webhookMessage}', ['uses' => 'MessageController@show', 'as' => 'messages.show']); + Route::delete('{webhook}/messages/{webhookMessage}', ['uses' => 'DestroyController@destroyMessage', 'as' => 'messages.destroy']); + + // webhook message attempts + Route::get('{webhook}/messages/{webhookMessage}/attempts', ['uses' => 'AttemptController@index', 'as' => 'attempts.index']); + Route::get('{webhook}/messages/{webhookMessage}/attempts/{webhookAttempt}', ['uses' => 'AttemptController@show', 'as' => 'attempts.show']); + Route::delete('{webhook}/messages/{webhookMessage}/attempts/{webhookAttempt}', ['uses' => 'DestroyController@destroyAttempt', 'as' => 'attempts.destroy']); + } +); + @@ -625,27 +655,6 @@ Route::group( -// -//// TODO VERIFY API DOCS -//Route::group( -// ['namespace' => 'FireflyIII\Api\V1\Controllers\Webhook', 'prefix' => 'webhooks', -// 'as' => 'api.v1.webhooks.',], -// static function () { -// -// // Webhook API routes: -// Route::get('', ['uses' => 'IndexController@index', 'as' => 'index']); -// -// // create new one. -// Route::post('', ['uses' => 'CreateController@store', 'as' => 'store']); -// -// // update -// Route::put('{webhook}', ['uses' => 'EditController@update', 'as' => 'update']); -// Route::delete('{webhook}', ['uses' => 'DeleteController@destroy', 'as' => 'destroy']); -// } -//); -// -// - //