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;

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

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

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

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

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

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();

app/Transformers/WebhookAttemptTransformer.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * PreferenceTransformer.php
+ * Copyright (c) 2019 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/>.
+ */
+
+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,
+        ];
+    }
+
+}

app/Transformers/WebhookMessageTransformer.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * PreferenceTransformer.php
+ * Copyright (c) 2019 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/>.
+ */
+
+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,
+        ];
+    }
+
+}

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,

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']);
-//    }
-//);
-//
-//
-
 
 
 //