Add tags

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

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

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

@@ -1,7 +1,7 @@
 <?php
-/**
+/*
- * TagController.php
+ * ListController.php
- * Copyright (c) 2019 james@firefly-iii.org
+ * Copyright (c) 2021 james@firefly-iii.org
  *
  * This file is part of Firefly III (https://github.com/firefly-iii).
  *
@@ -19,18 +19,15 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-declare(strict_types=1);
+namespace FireflyIII\Api\V1\Controllers\Models\Tag;
 
-namespace FireflyIII\Api\V1\Controllers;
 
-use FireflyIII\Api\V1\Requests\TagStoreRequest;
+use FireflyIII\Api\V1\Controllers\Controller;
-use FireflyIII\Api\V1\Requests\TagUpdateRequest;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Tag;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
 use FireflyIII\Support\Http\Api\TransactionFilter;
 use FireflyIII\Transformers\AttachmentTransformer;
-use FireflyIII\Transformers\TagTransformer;
 use FireflyIII\Transformers\TransactionGroupTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
@@ -38,17 +35,14 @@ use Illuminate\Http\Request;
 use Illuminate\Pagination\LengthAwarePaginator;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Resource\Collection as FractalCollection;
-use League\Fractal\Resource\Item;
 
 /**
- * Class TagController
+ * Class ListController
  */
-class TagController extends Controller
+class ListController extends Controller
 {
     use TransactionFilter;
-
+    private TagRepositoryInterface $repository;
-    /** @var TagRepositoryInterface The tag repository */
-    private $repository;
 
 
     /**
@@ -72,51 +66,6 @@ class TagController extends Controller
         );
     }
 
-    /**
-     * Delete the resource.
-     *
-     * @param Tag $tag
-     *
-     * @return JsonResponse
-     * @codeCoverageIgnore
-     */
-    public function delete(Tag $tag): JsonResponse
-    {
-        $this->repository->destroy($tag);
-
-        return response()->json([], 204);
-    }
-
-    /**
-     * 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->get();
-        $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.tags.index') . $this->buildParams());
-
-        /** @var TagTransformer $transformer */
-        $transformer = app(TagTransformer::class);
-        $transformer->setParameters($this->parameters);
-
-        $resource = new FractalCollection($rules, $transformer, 'tags');
-        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
-
-        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
-    }
 
 
     /**
@@ -148,46 +97,7 @@ class TagController extends Controller
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
 
-    /**
-     * List single resource.
-     *
-     * @param Tag $tag
-     *
-     * @return JsonResponse
-     * @codeCoverageIgnore
-     */
-    public function show(Tag $tag): JsonResponse
-    {
-        $manager = $this->getManager();
-        /** @var TagTransformer $transformer */
-        $transformer = app(TagTransformer::class);
-        $transformer->setParameters($this->parameters);
 
-        $resource = new Item($tag, $transformer, 'tags');
-
-        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
-
-    }
-
-    /**
-     * Store new object.
-     *
-     * @param TagStoreRequest $request
-     *
-     * @return JsonResponse
-     */
-    public function store(TagStoreRequest $request): JsonResponse
-    {
-        $rule    = $this->repository->store($request->getAll());
-        $manager = $this->getManager();
-        /** @var TagTransformer $transformer */
-        $transformer = app(TagTransformer::class);
-        $transformer->setParameters($this->parameters);
-
-        $resource = new Item($rule, $transformer, 'tags');
-
-        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
-    }
 
     /**
      * Show all transactions.
@@ -229,7 +139,7 @@ class TagController extends Controller
             $collector->setRange($this->parameters->get('start'), $this->parameters->get('end'));
         }
         $paginator = $collector->getPaginatedGroups();
-        $paginator->setPath(route('api.v1.transactions.index') . $this->buildParams());
+        $paginator->setPath(route('api.v1.tags.transactions', [$tag->id]) . $this->buildParams());
         $transactions = $paginator->getCollection();
 
         /** @var TransactionGroupTransformer $transformer */
@@ -241,26 +151,4 @@ class TagController extends Controller
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
-
-    /**
-     * Update a rule.
-     *
-     * @param TagUpdateRequest $request
-     * @param Tag              $tag
-     *
-     * @return JsonResponse
-     */
-    public function update(TagUpdateRequest $request, Tag $tag): JsonResponse
-    {
-        $rule    = $this->repository->update($tag, $request->getAll());
-        $manager = $this->getManager();
-        /** @var TagTransformer $transformer */
-        $transformer = app(TagTransformer::class);
-        $transformer->setParameters($this->parameters);
-
-        $resource = new Item($rule, $transformer, 'tags');
-
-        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
-
-    }
 }

app/Api/V1/Controllers/Models/Tag/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\Tag;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Models\Tag;
+use FireflyIII\Repositories\Tag\TagRepositoryInterface;
+use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Transformers\TagTransformer;
+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 TagRepositoryInterface $repository;
+
+
+    /**
+     * TagController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                $this->repository = app(TagRepositoryInterface::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->get();
+        $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.tags.index') . $this->buildParams());
+
+        /** @var TagTransformer $transformer */
+        $transformer = app(TagTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new FractalCollection($rules, $transformer, 'tags');
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+
+
+
+    /**
+     * List single resource.
+     *
+     * @param Tag $tag
+     *
+     * @return JsonResponse
+     * @codeCoverageIgnore
+     */
+    public function show(Tag $tag): JsonResponse
+    {
+        $manager = $this->getManager();
+        /** @var TagTransformer $transformer */
+        $transformer = app(TagTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($tag, $transformer, 'tags');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+
+    }
+}

app/Api/V1/Controllers/Models/Tag/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\Tag;
+
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Models\Tag\StoreRequest;
+use FireflyIII\Repositories\Tag\TagRepositoryInterface;
+use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Transformers\TagTransformer;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+use League\Fractal\Resource\Item;
+
+/**
+ * Class StoreController
+ */
+class StoreController extends Controller
+{
+    private TagRepositoryInterface $repository;
+
+
+    /**
+     * TagController constructor.
+     *
+     * @codeCoverageIgnore
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                /** @var User $user */
+                $user = auth()->user();
+
+                $this->repository = app(TagRepositoryInterface::class);
+                $this->repository->setUser($user);
+
+                return $next($request);
+            }
+        );
+    }
+
+
+
+    /**
+     * Store new object.
+     *
+     * @param StoreRequest $request
+     *
+     * @return JsonResponse
+     */
+    public function store(StoreRequest $request): JsonResponse
+    {
+        $rule    = $this->repository->store($request->getAll());
+        $manager = $this->getManager();
+        /** @var TagTransformer $transformer */
+        $transformer = app(TagTransformer::class);
+        $transformer->setParameters($this->parameters);
+
+        $resource = new Item($rule, $transformer, 'tags');
+
+        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
+    }
+}
+

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

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

@@ -21,7 +21,7 @@
 
 declare(strict_types=1);
 
-namespace FireflyIII\Api\V1\Requests;
+namespace FireflyIII\Api\V1\Requests\Models\Tag;
 
 use FireflyIII\Models\Location;
 use FireflyIII\Support\Request\AppendsLocationData;
@@ -30,15 +30,14 @@ use FireflyIII\Support\Request\ConvertsDataTypes;
 use Illuminate\Foundation\Http\FormRequest;
 
 /**
- * Class TagStoreRequest
+ * Class StoreRequest
  *
  * @codeCoverageIgnore
  */
-class TagStoreRequest extends FormRequest
+class StoreRequest extends FormRequest
 {
     use ConvertsDataTypes, ChecksLogin, AppendsLocationData;
 
-
     /**
      * Get all data from the request.
      *

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

@@ -22,7 +22,7 @@
 
 declare(strict_types=1);
 
-namespace FireflyIII\Api\V1\Requests;
+namespace FireflyIII\Api\V1\Requests\Models\Tag;
 
 use FireflyIII\Models\Location;
 use FireflyIII\Support\Request\AppendsLocationData;
@@ -31,11 +31,11 @@ use FireflyIII\Support\Request\ConvertsDataTypes;
 use Illuminate\Foundation\Http\FormRequest;
 
 /**
- * Class TagUpdateRequest
+ * Class UpdateRequest
  *
  * @codeCoverageIgnore
  */
-class TagUpdateRequest extends FormRequest
+class UpdateRequest extends FormRequest
 {
     use ConvertsDataTypes, ChecksLogin, AppendsLocationData;
 

routes/api.php

@@ -359,6 +359,21 @@ Route::group(
     }
 );
 
+// Tag API routes:
+Route::group(
+    ['namespace' => 'FireflyIII\Api\V1\Controllers\Models\Tag', 'prefix' => 'tags',
+     'as'        => 'api.v1.tags.',],
+    static function () {
+        Route::get('', ['uses' => 'ShowController@index', 'as' => 'index']);
+        Route::post('', ['uses' => 'StoreController@store', 'as' => 'store']);
+        Route::get('{tagOrId}', ['uses' => 'ShowController@show', 'as' => 'show']);
+        Route::put('{tagOrId}', ['uses' => 'UpdateController@update', 'as' => 'update']);
+        Route::delete('{tagOrId}', ['uses' => 'DestroyController@destroy', 'as' => 'delete']);
+
+        Route::get('{tagOrId}/transactions', ['uses' => 'ListController@transactions', 'as' => 'transactions']);
+        Route::get('{tagOrId}/attachments', ['uses' => 'ListController@attachments', 'as' => 'attachments']);
+    }
+);
 
 
 
@@ -607,22 +622,7 @@ Route::group(
 //    }
 //);
 //
-//// TODO VERIFY API DOCS
+
-//Route::group(
-//    ['namespace' => 'FireflyIII\Api\V1\Controllers', 'prefix' => 'tags',
-//     'as'        => 'api.v1.tags.',],
-//    static function () {
-//        // Tag API routes:
-//        Route::get('', ['uses' => 'TagController@index', 'as' => 'index']);
-//        Route::post('', ['uses' => 'TagController@store', 'as' => 'store']);
-//        Route::get('{tagOrId}', ['uses' => 'TagController@show', 'as' => 'show']);
-//        Route::put('{tagOrId}', ['uses' => 'TagController@update', 'as' => 'update']);
-//        Route::delete('{tagOrId}', ['uses' => 'TagController@delete', 'as' => 'delete']);
-//
-//        Route::get('{tagOrId}/transactions', ['uses' => 'TagController@transactions', 'as' => 'transactions']);
-//        Route::get('{tagOrId}/attachments', ['uses' => 'TagController@attachments', 'as' => 'attachments']);
-//    }
-//);
 //
 //// TODO VERIFY API DOCS
 //Route::group(