API ability to manage webhooks.

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

@@ -0,0 +1,81 @@
+<?php
+/*
+ * CreateController.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\CreateRequest;
+use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
+use FireflyIII\Transformers\WebhookTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;
+
+/**
+ * Class CreateController
+ */
+class CreateController 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);
+            }
+        );
+    }
+
+    /**
+     * @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/DeleteController.php

@@ -0,0 +1,74 @@
+<?php
+/*
+ * DeleteController.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\User;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class DeleteController
+ */
+class DeleteController 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 destroy(Webhook $webhook): JsonResponse
+    {
+        $this->repository->destroy($webhook);
+
+        return response()->json([], 204);
+    }
+
+
+}

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

@@ -0,0 +1,82 @@
+<?php
+/*
+ * 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\Models\Webhook;
+use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
+use FireflyIII\Transformers\WebhookTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;
+
+/**
+ * Class EditController
+ */
+class EditController 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);
+            }
+        );
+    }
+
+    /**
+     * @param Webhook       $webhook
+     * @param UpdateRequest $request
+     *
+     * @return JsonResponse
+     */
+    public function update(Webhook $webhook, UpdateRequest $request): JsonResponse
+    {
+        $data    = $request->getData();
+        $webhook = $this->repository->update($webhook, $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/IndexController.php

@@ -0,0 +1,87 @@
+<?php
+/*
+ * 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\Repositories\Webhook\WebhookRepositoryInterface;
+use FireflyIII\Transformers\WebhookTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Pagination\LengthAwarePaginator;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection as FractalCollection;
+
+/**
+ * Class IndexController
+ */
+class IndexController 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);
+            }
+        );
+    }
+
+
+    /**
+     * Display a listing of the resource.
+     *
+     * @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);
+        $paginator = new LengthAwarePaginator($webhooks, $count, $pageSize, $this->parameters->get('page'));
+
+        /** @var WebhookTransformer $transformer */
+        $transformer = app(WebhookTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new FractalCollection($bills, $transformer, 'webhooks');
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+
+}

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

@@ -0,0 +1,73 @@
+<?php
+/*
+ * CreateRequest.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\Requests\Webhook;
+
+use FireflyIII\Rules\IsBoolean;
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+
+/**
+ * Class CreateRequest
+ */
+class CreateRequest extends FormRequest
+{
+    use ChecksLogin, ConvertsDataTypes;
+
+    /**
+     * @return array
+     */
+    public function getData(): array
+    {
+        $triggers   = array_flip(config('firefly.webhooks.triggers'));
+        $responses  = array_flip(config('firefly.webhooks.responses'));
+        $deliveries = array_flip(config('firefly.webhooks.deliveries'));
+
+        return [
+            'active'   => $this->boolean('active'),
+            'trigger'  => $triggers[$this->string('trigger')] ?? 0,
+            'response' => $responses[$this->string('response')] ?? 0,
+            'delivery' => $deliveries[$this->string('delivery')] ?? 0,
+            'url'      => $this->string('url'),
+        ];
+    }
+
+    /**
+     * Rules for this request.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        $triggers   = implode(',', array_values(config('firefly.webhooks.triggers')));
+        $responses  = implode(',', array_values(config('firefly.webhooks.responses')));
+        $deliveries = implode(',', array_values(config('firefly.webhooks.deliveries')));
+
+        return [
+            'active'   => [new IsBoolean],
+            'trigger'  => sprintf('required|in:%s', $triggers),
+            'response' => sprintf('required|in:%s', $responses),
+            'delivery' => sprintf('required|in:%s', $deliveries),
+            'url'      => ['required', 'url', 'starts_with:https://', 'uniqueWebhook'],
+        ];
+    }
+}

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

@@ -0,0 +1,74 @@
+<?php
+/*
+ * UpdateRequest.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\Requests\Webhook;
+
+use FireflyIII\Rules\IsBoolean;
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+
+/**
+ * Class UpdateRequest
+ */
+class UpdateRequest extends FormRequest
+{
+    use ChecksLogin, ConvertsDataTypes;
+
+    /**
+     * @return array
+     */
+    public function getData(): array
+    {
+        $triggers   = array_flip(config('firefly.webhooks.triggers'));
+        $responses  = array_flip(config('firefly.webhooks.responses'));
+        $deliveries = array_flip(config('firefly.webhooks.deliveries'));
+
+        return [
+            'active'   => $this->boolean('active'),
+            'trigger'  => $triggers[$this->string('trigger')] ?? 0,
+            'response' => $responses[$this->string('response')] ?? 0,
+            'delivery' => $deliveries[$this->string('delivery')] ?? 0,
+            'url'      => $this->string('url'),
+        ];
+    }
+
+    /**
+     * Rules for this request.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        $triggers   = implode(',', array_values(config('firefly.webhooks.triggers')));
+        $responses  = implode(',', array_values(config('firefly.webhooks.responses')));
+        $deliveries = implode(',', array_values(config('firefly.webhooks.deliveries')));
+        $webhook = $this->route()->parameter('webhook');
+
+        return [
+            'active'   => [new IsBoolean],
+            'trigger'  => sprintf('required|in:%s', $triggers),
+            'response' => sprintf('required|in:%s', $responses),
+            'delivery' => sprintf('required|in:%s', $deliveries),
+            'url'      => ['required', 'url', 'starts_with:https://', sprintf('uniqueExistingWebhook:%d', $webhook->id)],
+        ];
+    }
+}