Recurring transactions.

app/Api/V1/Controllers/Models/Recurrence/DestroyController.php

@@ -0,0 +1,75 @@
+<?php
+/*
+ * DestroyController.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\Models\Recurrence;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Models\Recurrence;
+use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class DestroyController
+ */
+class DestroyController extends Controller
+{
+    private RecurringRepositoryInterface $repository;
+
+    /**
+     * RecurrenceController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                /** @var RecurringRepositoryInterface repository */
+                $this->repository = app(RecurringRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+    /**
+     * Delete the resource.
+     *
+     * @param Recurrence $recurrence
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function destroy(Recurrence $recurrence): JsonResponse
+    {
+        $this->repository->destroy($recurrence);
+
+        return response()->json([], 204);
+    }
+}

app/Api/V1/Controllers/Models/Recurrence/ListController.php

@@ -0,0 +1,123 @@
+<?php
+/*
+ * ListController.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\Models\Recurrence;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Helpers\Collector\GroupCollectorInterface;
+use FireflyIII\Models\Recurrence;
+use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
+use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Transformers\TransactionGroupTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection as FractalCollection;
+
+/**
+ * Class ListController
+ */
+class ListController extends Controller
+{
+    use TransactionFilter;
+
+    private RecurringRepositoryInterface $repository;
+
+    /**
+     * RecurrenceController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                /** @var RecurringRepositoryInterface repository */
+                $this->repository = app(RecurringRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * Show transactions for this recurrence.
+     *
+     * @param Request    $request
+     * @param Recurrence $recurrence
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function transactions(Request $request, Recurrence $recurrence): JsonResponse
+    {
+        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $type     = $request->get('type') ?? 'default';
+        $this->parameters->set('type', $type);
+
+        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
+        $manager = $this->getManager();
+        // whatever is returned by the query, it must be part of these journals:
+        $journalIds = $this->repository->getJournalIds($recurrence);
+
+        /** @var User $admin */
+        $admin = auth()->user();
+
+        // use new group collector:
+        /** @var GroupCollectorInterface $collector */
+        $collector = app(GroupCollectorInterface::class);
+        $collector
+            ->setUser($admin)
+            // filter on journal IDs.
+            ->setJournalIds($journalIds)
+            // all info needed for the API:
+            ->withAPIInformation()
+            // set page size:
+            ->setLimit($pageSize)
+            // set page to retrieve
+            ->setPage($this->parameters->get('page'))
+            // set types of transactions to return.
+            ->setTypes($types);
+
+        if (null !== $this->parameters->get('start') && null !== $this->parameters->get('end')) {
+            $collector->setRange($this->parameters->get('start'), $this->parameters->get('end'));
+        }
+        $paginator = $collector->getPaginatedGroups();
+        $paginator->setPath(route('api.v1.transactions.index') . $this->buildParams());
+        $transactions = $paginator->getCollection();
+
+        /** @var TransactionGroupTransformer $transformer */
+        $transformer = app(TransactionGroupTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new FractalCollection($transactions, $transformer, 'transactions');
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+}

app/Api/V1/Controllers/Models/Recurrence/ShowController.php

@@ -0,0 +1,120 @@
+<?php
+/*
+ * ShowController.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\Models\Recurrence;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Models\Recurrence;
+use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
+use FireflyIII\Transformers\RecurrenceTransformer;
+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 ShowController
+ */
+class ShowController extends Controller
+{
+    private RecurringRepositoryInterface $repository;
+
+    /**
+     * RecurrenceController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                /** @var RecurringRepositoryInterface repository */
+                $this->repository = app(RecurringRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * List all of them.
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function index(): JsonResponse
+    {
+        $manager = $this->getManager();
+
+        // types to get, page size:
+        $pageSize = (int)app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+
+        // get list of budgets. Count it and split it.
+        $collection = $this->repository->getAll();
+        $count      = $collection->count();
+        $piggyBanks = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+
+        // make paginator:
+        $paginator = new LengthAwarePaginator($piggyBanks, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.recurrences.index') . $this->buildParams());
+
+        /** @var RecurrenceTransformer $transformer */
+        $transformer = app(RecurrenceTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new FractalCollection($piggyBanks, $transformer, 'recurrences');
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
+
+    /**
+     * List single resource.
+     *
+     * @param Recurrence $recurrence
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function show(Recurrence $recurrence): JsonResponse
+    {
+        $manager = $this->getManager();
+
+        /** @var RecurrenceTransformer $transformer */
+        $transformer = app(RecurrenceTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($recurrence, $transformer, 'recurrences');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+
+    }
+}

app/Api/V1/Controllers/Models/Recurrence/StoreController.php

@@ -0,0 +1,85 @@
+<?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\Models\Recurrence;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Models\Recurrence\StoreRequest;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
+use FireflyIII\Transformers\RecurrenceTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;
+
+/**
+ * Class StoreController
+ */
+class StoreController extends Controller
+{
+    private RecurringRepositoryInterface $repository;
+
+    /**
+     * RecurrenceController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                /** @var RecurringRepositoryInterface repository */
+                $this->repository = app(RecurringRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * Store new object.
+     *
+     * @param StoreRequest $request
+     *
+     * @return JsonResponse
+     * @throws FireflyException
+     */
+    public function store(StoreRequest $request): JsonResponse
+    {
+        $data       = $request->getAll();
+        $recurrence = $this->repository->store($data);
+        $manager    = $this->getManager();
+
+        /** @var RecurrenceTransformer $transformer */
+        $transformer = app(RecurrenceTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($recurrence, $transformer, 'recurrences');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+}

app/Api/V1/Controllers/Models/Recurrence/TriggerController.php

@@ -0,0 +1,86 @@
+<?php
+/*
+ * TriggerController.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\Models\Recurrence;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
+use FireflyIII\Support\Cronjobs\RecurringCronjob;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use Log;
+
+/**
+ * Class TriggerController
+ */
+class TriggerController extends Controller
+{
+    private RecurringRepositoryInterface $repository;
+
+    /**
+     * RecurrenceController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                /** @var RecurringRepositoryInterface repository */
+                $this->repository = app(RecurringRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+    /**
+     * @return JsonResponse
+     * @throws FireflyException
+     * @codeCoverageIgnore
+     *
+     * TODO currently unused + unreachable.
+     */
+    public function trigger(): JsonResponse
+    {
+        /** @var RecurringCronjob $recurring */
+        $recurring = app(RecurringCronjob::class);
+        try {
+            $result = $recurring->fire();
+        } catch (FireflyException $e) {
+            Log::error($e->getMessage());
+            throw new FireflyException('200022: Error in cron job.', 0, $e);
+        }
+        if (false === $result) {
+            return response()->json([], 204);
+        }
+
+        return response()->json();
+    }
+}

app/Api/V1/Controllers/Models/Recurrence/UpdateController.php

@@ -0,0 +1,88 @@
+<?php
+/*
+ * UpdateController.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\Models\Recurrence;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\RecurrenceUpdateRequest;
+use FireflyIII\Models\Recurrence;
+use FireflyIII\Repositories\Recurring\RecurringRepositoryInterface;
+use FireflyIII\Transformers\RecurrenceTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;
+
+/**
+ * Class UpdateController
+ */
+class UpdateController extends Controller
+{
+    private RecurringRepositoryInterface $repository;
+
+    /**
+     * RecurrenceController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                /** @var RecurringRepositoryInterface repository */
+                $this->repository = app(RecurringRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+
+    /**
+     * Update single recurrence.
+     *
+     * @param RecurrenceUpdateRequest $request
+     * @param Recurrence              $recurrence
+     *
+     * @return JsonResponse
+     */
+    public function update(RecurrenceUpdateRequest $request, Recurrence $recurrence): JsonResponse
+    {
+        $data     = $request->getAll();
+        $category = $this->repository->update($recurrence, $data);
+        $manager  = $this->getManager();
+
+        /** @var RecurrenceTransformer $transformer */
+        $transformer = app(RecurrenceTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($category, $transformer, 'recurrences');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
+}