Reformat API routes.

app/Api/V1/Requests/Models/Bill/StoreRequest.php

@@ -0,0 +1,110 @@
+<?php
+
+/**
+ * BillStoreRequest.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\Api\V1\Requests\Models\Bill;
+
+use FireflyIII\Rules\IsBoolean;
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Validator;
+
+/**
+ * Class StoreRequest
+ *
+ * @codeCoverageIgnore
+ */
+class StoreRequest extends FormRequest
+{
+    use ConvertsDataTypes, ChecksLogin;
+
+    /**
+     * Get all data from the request.
+     *
+     * @return array
+     */
+    public function getAll(): array
+    {
+        $active = true;
+        if (null !== $this->get('active')) {
+            $active = $this->boolean('active');
+        }
+
+        return [
+            'name'          => $this->string('name'),
+            'amount_min'    => $this->string('amount_min'),
+            'amount_max'    => $this->string('amount_max'),
+            'currency_id'   => $this->integer('currency_id'),
+            'currency_code' => $this->string('currency_code'),
+            'date'          => $this->date('date'),
+            'repeat_freq'   => $this->string('repeat_freq'),
+            'skip'          => $this->integer('skip'),
+            'active'        => $active,
+            'order'         => $this->integer('order'),
+            'notes'         => $this->nlString('notes'),
+        ];
+    }
+
+    /**
+     * The rules that the incoming request must be matched against.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        return [
+            'name'          => 'between:1,255|uniqueObjectForUser:bills,name',
+            'amount_min'    => 'numeric|gt:0',
+            'amount_max'    => 'numeric|gt:0',
+            'currency_id'   => 'numeric|exists:transaction_currencies,id',
+            'currency_code' => 'min:3|max:3|exists:transaction_currencies,code',
+            'date'          => 'date',
+            'repeat_freq'   => 'in:weekly,monthly,quarterly,half-year,yearly',
+            'skip'          => 'between:0,31',
+            'active'        => [new IsBoolean],
+            'notes'         => 'between:1,65536',
+        ];
+    }
+
+    /**
+     * Configure the validator instance.
+     *
+     * @param Validator $validator
+     *
+     * @return void
+     */
+    public function withValidator(Validator $validator): void
+    {
+        $validator->after(
+            static function (Validator $validator) {
+                $data = $validator->getData();
+                $min  = (float) ($data['amount_min'] ?? 0);
+                $max  = (float) ($data['amount_max'] ?? 0);
+                if ($min > $max) {
+                    $validator->errors()->add('amount_min', (string) trans('validation.amount_min_over_max'));
+                }
+            }
+        );
+    }
+}

app/Api/V1/Requests/Models/Bill/UpdateRequest.php

@@ -0,0 +1,111 @@
+<?php
+
+/**
+ * BillUpdateRequest.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\Api\V1\Requests\Models\Bill;
+
+use FireflyIII\Rules\IsBoolean;
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Validator;
+
+/**
+ * Class UpdateRequest
+ *
+ * @codeCoverageIgnore
+ */
+class UpdateRequest extends FormRequest
+{
+    use ConvertsDataTypes, ChecksLogin;
+
+    /**
+     * Get all data from the request.
+     *
+     * @return array
+     */
+    public function getAll(): array
+    {
+        $active = true;
+        if (null !== $this->get('active')) {
+            $active = $this->boolean('active');
+        }
+
+        return [
+            'name'          => $this->string('name'),
+            'amount_min'    => $this->string('amount_min'),
+            'amount_max'    => $this->string('amount_max'),
+            'currency_id'   => $this->integer('currency_id'),
+            'currency_code' => $this->string('currency_code'),
+            'date'          => $this->date('date'),
+            'repeat_freq'   => $this->string('repeat_freq'),
+            'skip'          => $this->integer('skip'),
+            'active'        => $active,
+            'order'         => $this->integer('order'),
+            'notes'         => $this->nlString('notes'),
+        ];
+    }
+
+    /**
+     * The rules that the incoming request must be matched against.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        $bill          = $this->route()->parameter('bill');
+        return [
+            'name'          => sprintf('between:1,255|uniqueObjectForUser:bills,name,%d', $bill->id),
+            'amount_min'    => 'numeric|gt:0',
+            'amount_max'    => 'numeric|gt:0',
+            'currency_id'   => 'numeric|exists:transaction_currencies,id',
+            'currency_code' => 'min:3|max:3|exists:transaction_currencies,code',
+            'date'          => 'date',
+            'repeat_freq'   => 'in:weekly,monthly,quarterly,half-year,yearly',
+            'skip'          => 'between:0,31',
+            'active'        => [new IsBoolean],
+            'notes'         => 'between:1,65536',
+        ];
+    }
+
+    /**
+     * Configure the validator instance.
+     *
+     * @param Validator $validator
+     *
+     * @return void
+     */
+    public function withValidator(Validator $validator): void
+    {
+        $validator->after(
+            static function (Validator $validator) {
+                $data = $validator->getData();
+                $min  = (float) ($data['amount_min'] ?? 0);
+                $max  = (float) ($data['amount_max'] ?? 0);
+                if ($min > $max) {
+                    $validator->errors()->add('amount_min', (string) trans('validation.amount_min_over_max'));
+                }
+            }
+        );
+    }
+}

app/Api/V1/Requests/Models/Category/StoreRequest.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * CategoryStoreRequest.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\Api\V1\Requests\Models\Category;
+
+use FireflyIII\Rules\ZeroOrMore;
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+
+/**
+ * Class StoreRequest
+ *
+ * @codeCoverageIgnore
+ */
+class StoreRequest extends FormRequest
+{
+    use ConvertsDataTypes, ChecksLogin;
+
+    /**
+     * Get all data from the request.
+     *
+     * @return array
+     */
+    public function getAll(): array
+    {
+        return [
+            'name'  => $this->string('name'),
+            'notes' => $this->nlString('notes'),
+        ];
+    }
+
+    /**
+     * The rules that the incoming request must be matched against.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        return [
+            'name' => 'required|between:1,100|uniqueObjectForUser:categories,name',
+        ];
+    }
+}

app/Api/V1/Requests/Models/Category/UpdateRequest.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * CategoryUpdateRequest.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\Api\V1\Requests\Models\Category;
+
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+
+/**
+ * Class UpdateRequest
+ *
+ * @codeCoverageIgnore
+ */
+class UpdateRequest extends FormRequest
+{
+    use ConvertsDataTypes, ChecksLogin;
+
+    /**
+     * Get all data from the request.
+     *
+     * @return array
+     */
+    public function getAll(): array
+    {
+        $notes = null;
+        $all   = $this->all();
+        if (array_key_exists('notes', $all)) {
+            $notes = $this->nlString('notes');
+        }
+
+        return [
+            'name'  => $this->string('name'),
+            'notes' => $notes,
+        ];
+    }
+
+    /**
+     * The rules that the incoming request must be matched against.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        $category = $this->route()->parameter('category');
+
+        return [
+            'name' => sprintf('required|between:1,100|uniqueObjectForUser:categories,name,%d', $category->id),
+        ];
+    }
+}

app/Api/V1/Requests/Models/PiggyBank/StoreRequest.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * PiggyBankStoreRequest.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\Api\V1\Requests\Models\PiggyBank;
+
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+
+/**
+ * Class StoreRequest
+ *
+ * @codeCoverageIgnore
+ */
+class StoreRequest extends FormRequest
+{
+    use ConvertsDataTypes, ChecksLogin;
+
+    /**
+     * Get all data from the request.
+     *
+     * @return array
+     */
+    public function getAll(): array
+    {
+        return [
+            'name'               => $this->string('name'),
+            'account_id'         => $this->integer('account_id'),
+            'targetamount'       => $this->string('target_amount'),
+            'current_amount'     => $this->string('current_amount'),
+            'startdate'          => $this->date('start_date'),
+            'targetdate'         => $this->date('target_date'),
+            'notes'              => $this->nlString('notes'),
+            'object_group_id'    => $this->integer('object_group_id'),
+            'object_group_title' => $this->string('object_group_title'),
+        ];
+    }
+
+    /**
+     * The rules that the incoming request must be matched against.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        return [
+            'name'               => 'required|between:1,255|uniquePiggyBankForUser',
+            'current_amount'     => ['numeric', 'gte:0', 'lte:target_amount'],
+            'account_id'         => 'required|numeric|belongsToUser:accounts,id',
+            'object_group_id'    => 'numeric|belongsToUser:object_groups,id',
+            'object_group_title' => 'between:1,255',
+            'target_amount'      => ['numeric', 'gte:0', 'lte:target_amount', 'required'],
+            'start_date'         => 'date|nullable',
+            'target_date'        => 'date|nullable|after:start_date',
+            'notes'              => 'max:65000',
+        ];
+    }
+
+}

app/Api/V1/Requests/Models/PiggyBank/UpdateRequest.php

@@ -0,0 +1,89 @@
+<?php
+/**
+ * PiggyBankUpdateRequest.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\Api\V1\Requests\Models\PiggyBank;
+
+use FireflyIII\Rules\IsAssetAccountId;
+use FireflyIII\Rules\LessThanPiggyTarget;
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+
+/**
+ * Class UpdateRequest
+ *
+ * @codeCoverageIgnore
+ */
+class UpdateRequest extends FormRequest
+{
+    use ConvertsDataTypes, ChecksLogin;
+
+    /**
+     * Get all data from the request.
+     *
+     * @return array
+     */
+    public function getAll(): array
+    {
+        // if the value isn't present, dont return it at all.
+        // TODO this should be the way to collect fields for all API things.
+        // TODO make sure piggy bank uses 'start_date' etc. until right up to DB update.
+        // TODO can we configure this and return it from config?
+
+        // TODO this is the way.
+        $fields = [
+            'name'            => ['name', 'string'],
+            'account_id'      => ['account_id', 'integer'],
+            'targetamount'    => ['target_amount', 'string'],
+            'current_amount'  => ['current_amount', 'string'],
+            'startdate'       => ['start_date', 'date'],
+            'targetdate'      => ['target_date', 'string'],
+            'notes'           => ['notes', 'nlString'],
+            'order'           => ['order', 'integer'],
+            'object_group'    => ['object_group', 'string'],
+            'object_group_id' => ['object_group_id', 'integer'],
+        ];
+        return $this->getAllData($fields);
+    }
+
+    /**
+     * The rules that the incoming request must be matched against.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        $piggyBank = $this->route()->parameter('piggyBank');
+
+        return [
+            'name'           => 'between:1,255|uniquePiggyBankForUser:' . $piggyBank->id,
+            'current_amount' => ['numeric', 'gte:0', new LessThanPiggyTarget],
+            'target_amount'  => 'numeric|gt:0',
+            'start_date'     => 'date|nullable',
+            'target_date'    => 'date|nullable|after:start_date',
+            'notes'          => 'max:65000',
+            'account_id'     => ['belongsToUser:accounts', new IsAssetAccountId],
+        ];
+    }
+
+}