Fix rule group API

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

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

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

@@ -0,0 +1,96 @@
+<?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\RuleGroup;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Models\RuleGroup;
+use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
+use FireflyIII\Transformers\RuleTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Pagination\LengthAwarePaginator;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection as FractalCollection;
+
+/**
+ * Class ListController
+ */
+class ListController extends Controller
+{
+    private RuleGroupRepositoryInterface $ruleGroupRepository;
+
+
+    /**
+     * RuleGroupController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                $this->ruleGroupRepository = app(RuleGroupRepositoryInterface::class);
+                $this->ruleGroupRepository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+    /**
+     * @param RuleGroup $group
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function rules(RuleGroup $group): 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->ruleGroupRepository->getRules($group);
+        $count      = $collection->count();
+        $rules      = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+
+        // make paginator:
+        $paginator = new LengthAwarePaginator($rules, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.rule_groups.rules', [$group->id]) . $this->buildParams());
+
+        /** @var RuleTransformer $transformer */
+        $transformer = app(RuleTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new FractalCollection($rules, $transformer, 'rules');
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
+}

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

@@ -0,0 +1,119 @@
+<?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\RuleGroup;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Models\RuleGroup;
+use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
+use FireflyIII\Transformers\RuleGroupTransformer;
+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 RuleGroupRepositoryInterface $ruleGroupRepository;
+
+
+    /**
+     * RuleGroupController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                $this->ruleGroupRepository = app(RuleGroupRepositoryInterface::class);
+                $this->ruleGroupRepository->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 rule groups. Count it and split it.
+        $collection = $this->ruleGroupRepository->get();
+        $count      = $collection->count();
+        $ruleGroups = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+
+        // make paginator:
+        $paginator = new LengthAwarePaginator($ruleGroups, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.rule_groups.index') . $this->buildParams());
+
+        /** @var RuleGroupTransformer $transformer */
+        $transformer = app(RuleGroupTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new FractalCollection($ruleGroups, $transformer, 'rule_groups');
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+
+
+    /**
+     * List single resource.
+     *
+     * @param RuleGroup $ruleGroup
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function show(RuleGroup $ruleGroup): JsonResponse
+    {
+        $manager = $this->getManager();
+        /** @var RuleGroupTransformer $transformer */
+        $transformer = app(RuleGroupTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($ruleGroup, $transformer, 'rule_groups');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
+
+}

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

@@ -0,0 +1,90 @@
+<?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\RuleGroup;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Models\RuleGroup\StoreRequest;
+use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
+use FireflyIII\Transformers\RuleGroupTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;
+
+/**
+ * Class StoreController
+ */
+class StoreController extends Controller
+{
+
+    private AccountRepositoryInterface   $accountRepository;
+    private RuleGroupRepositoryInterface $ruleGroupRepository;
+
+
+    /**
+     * RuleGroupController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                $this->ruleGroupRepository = app(RuleGroupRepositoryInterface::class);
+                $this->ruleGroupRepository->setUser($user);
+
+                $this->accountRepository = app(AccountRepositoryInterface::class);
+                $this->accountRepository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+    /**
+     * Store new object.
+     *
+     * @param StoreRequest $request
+     *
+     * @return JsonResponse
+     */
+    public function store(StoreRequest $request): JsonResponse
+    {
+        $ruleGroup = $this->ruleGroupRepository->store($request->getAll());
+        $manager   = $this->getManager();
+
+        /** @var RuleGroupTransformer $transformer */
+        $transformer = app(RuleGroupTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($ruleGroup, $transformer, 'rule_groups');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
+}

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

@@ -0,0 +1,169 @@
+<?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\RuleGroup;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Models\RuleGroup\TestRequest;
+use FireflyIII\Api\V1\Requests\Models\RuleGroup\TriggerRequest;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\RuleGroup;
+use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
+use FireflyIII\TransactionRules\Engine\RuleEngineInterface;
+use FireflyIII\Transformers\TransactionGroupTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Collection;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection as FractalCollection;
+
+/**
+ * Class TriggerController
+ */
+class TriggerController extends Controller
+{
+    private RuleGroupRepositoryInterface $ruleGroupRepository;
+
+
+    /**
+     * RuleGroupController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                $this->ruleGroupRepository = app(RuleGroupRepositoryInterface::class);
+                $this->ruleGroupRepository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+    /**
+     * @param TestRequest $request
+     * @param RuleGroup            $group
+     *
+     * @return JsonResponse
+     * @throws FireflyException
+     *
+     */
+    public function testGroup(TestRequest $request, RuleGroup $group): JsonResponse
+    {
+        /** @var Collection $rules */
+        $rules = $this->ruleGroupRepository->getActiveRules($group);
+        if (0 === $rules->count()) {
+            throw new FireflyException('200023: No rules in this rule group.');
+        }
+        $parameters = $request->getTestParameters();
+
+        /** @var RuleEngineInterface $ruleEngine */
+        $ruleEngine = app(RuleEngineInterface::class);
+        $ruleEngine->setRules($rules);
+
+        // overrule the rule(s) if necessary.
+        if (array_key_exists('start', $parameters) && null !== $parameters['start']) {
+            // add a range:
+            $ruleEngine->addOperator(['type' => 'date_after', 'value' => $parameters['start']->format('Y-m-d')]);
+        }
+
+        if (array_key_exists('end', $parameters) && null !== $parameters['end']) {
+            // add a range:
+            $ruleEngine->addOperator(['type' => 'date_before', 'value' => $parameters['end']->format('Y-m-d')]);
+        }
+        if (array_key_exists('accounts', $parameters) && '' !== $parameters['accounts']) {
+            $ruleEngine->addOperator(['type' => 'account_id', 'value' => implode(',', $parameters['accounts'])]);
+        }
+
+        // file the rule(s)
+        $transactions = $ruleEngine->find();
+        $count        = $transactions->count();
+
+        $paginator = new LengthAwarePaginator($transactions, $count, 31337, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.rule_groups.test', [$group->id]) . $this->buildParams());
+
+        // resulting list is presented as JSON thing.
+        $manager = $this->getManager();
+        /** @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);
+    }
+
+
+    /**
+     * Execute the given rule group on a set of existing transactions.
+     *
+     * @param TriggerRequest $request
+     * @param RuleGroup               $group
+     *
+     * @return JsonResponse
+     * @throws Exception
+     */
+    public function triggerGroup(TriggerRequest $request, RuleGroup $group): JsonResponse
+    {
+        /** @var Collection $rules */
+        $rules = $this->ruleGroupRepository->getActiveRules($group);
+        if (0 === $rules->count()) {
+            throw new FireflyException('200023: No rules in this rule group.');
+        }
+
+        // Get parameters specified by the user
+        $parameters = $request->getTriggerParameters();
+
+        /** @var RuleEngineInterface $ruleEngine */
+        $ruleEngine = app(RuleEngineInterface::class);
+        $ruleEngine->setRules($rules);
+
+        // overrule the rule(s) if necessary.
+        if (array_key_exists('start', $parameters) && null !== $parameters['start']) {
+            // add a range:
+            $ruleEngine->addOperator(['type' => 'date_after', 'value' => $parameters['start']->format('Y-m-d')]);
+        }
+
+        if (array_key_exists('end', $parameters) && null !== $parameters['end']) {
+            // add a range:
+            $ruleEngine->addOperator(['type' => 'date_before', 'value' => $parameters['end']->format('Y-m-d')]);
+        }
+        if (array_key_exists('accounts', $parameters) && '' !== $parameters['accounts']) {
+            $ruleEngine->addOperator(['type' => 'account_id', 'value' => implode(',', $parameters['accounts'])]);
+        }
+
+        // file the rule(s)
+        $ruleEngine->fire();
+
+        return response()->json([], 204);
+    }
+
+}

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

@@ -0,0 +1,86 @@
+<?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\RuleGroup;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Models\RuleGroup\UpdateRequest;
+use FireflyIII\Models\RuleGroup;
+use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
+use FireflyIII\Transformers\RuleGroupTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;
+
+/**
+ * Class UpdateController
+ */
+class UpdateController extends Controller
+{
+
+    private RuleGroupRepositoryInterface $ruleGroupRepository;
+
+
+    /**
+     * RuleGroupController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                $this->ruleGroupRepository = app(RuleGroupRepositoryInterface::class);
+                $this->ruleGroupRepository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+    /**
+     * Update a rule group.
+     *
+     * @param UpdateRequest $request
+     * @param RuleGroup              $ruleGroup
+     *
+     * @return JsonResponse
+     */
+    public function update(UpdateRequest $request, RuleGroup $ruleGroup): JsonResponse
+    {
+        $ruleGroup = $this->ruleGroupRepository->update($ruleGroup, $request->getAll());
+        $manager   = $this->getManager();
+
+        /** @var RuleGroupTransformer $transformer */
+        $transformer = app(RuleGroupTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($ruleGroup, $transformer, 'rule_groups');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+}