From a8a1eca89e45ee8865a7eb76ab337b09d1bf15fc Mon Sep 17 00:00:00 2001 From: James Cole Date: Sat, 6 Mar 2021 19:04:09 +0100 Subject: [PATCH] Add tags --- .../Models/Tag/DestroyController.php | 77 ++++++++++ .../Tag/ListController.php} | 132 ++---------------- .../Controllers/Models/Tag/ShowController.php | 119 ++++++++++++++++ .../Models/Tag/StoreController.php | 85 +++++++++++ .../Models/Tag/UpdateController.php | 88 ++++++++++++ .../Tag/StoreRequest.php} | 7 +- .../Tag/UpdateRequest.php} | 6 +- routes/api.php | 32 ++--- 8 files changed, 401 insertions(+), 145 deletions(-) create mode 100644 app/Api/V1/Controllers/Models/Tag/DestroyController.php rename app/Api/V1/Controllers/{todo/TagController.php => Models/Tag/ListController.php} (56%) create mode 100644 app/Api/V1/Controllers/Models/Tag/ShowController.php create mode 100644 app/Api/V1/Controllers/Models/Tag/StoreController.php create mode 100644 app/Api/V1/Controllers/Models/Tag/UpdateController.php rename app/Api/V1/Requests/{todo/TagStoreRequest.php => Models/Tag/StoreRequest.php} (94%) rename app/Api/V1/Requests/{todo/TagUpdateRequest.php => Models/Tag/UpdateRequest.php} (94%) diff --git a/app/Api/V1/Controllers/Models/Tag/DestroyController.php b/app/Api/V1/Controllers/Models/Tag/DestroyController.php new file mode 100644 index 0000000000..93d273be1b --- /dev/null +++ b/app/Api/V1/Controllers/Models/Tag/DestroyController.php @@ -0,0 +1,77 @@ +. + */ + +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); + } +} \ No newline at end of file diff --git a/app/Api/V1/Controllers/todo/TagController.php b/app/Api/V1/Controllers/Models/Tag/ListController.php similarity index 56% rename from app/Api/V1/Controllers/todo/TagController.php rename to app/Api/V1/Controllers/Models/Tag/ListController.php index bb370d6f47..57f3ada42d 100644 --- a/app/Api/V1/Controllers/todo/TagController.php +++ b/app/Api/V1/Controllers/Models/Tag/ListController.php @@ -1,7 +1,7 @@ . */ -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\Requests\TagUpdateRequest; +use FireflyIII\Api\V1\Controllers\Controller; 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; - - /** @var TagRepositoryInterface The tag repository */ - private $repository; + private TagRepositoryInterface $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); - - } -} +} \ No newline at end of file diff --git a/app/Api/V1/Controllers/Models/Tag/ShowController.php b/app/Api/V1/Controllers/Models/Tag/ShowController.php new file mode 100644 index 0000000000..edf104fb85 --- /dev/null +++ b/app/Api/V1/Controllers/Models/Tag/ShowController.php @@ -0,0 +1,119 @@ +. + */ + +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); + + } +} \ No newline at end of file diff --git a/app/Api/V1/Controllers/Models/Tag/StoreController.php b/app/Api/V1/Controllers/Models/Tag/StoreController.php new file mode 100644 index 0000000000..11b264a5a2 --- /dev/null +++ b/app/Api/V1/Controllers/Models/Tag/StoreController.php @@ -0,0 +1,85 @@ +. + */ + +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); + } +} + diff --git a/app/Api/V1/Controllers/Models/Tag/UpdateController.php b/app/Api/V1/Controllers/Models/Tag/UpdateController.php new file mode 100644 index 0000000000..87811a2ad1 --- /dev/null +++ b/app/Api/V1/Controllers/Models/Tag/UpdateController.php @@ -0,0 +1,88 @@ +. + */ + +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); + + } + +} \ No newline at end of file diff --git a/app/Api/V1/Requests/todo/TagStoreRequest.php b/app/Api/V1/Requests/Models/Tag/StoreRequest.php similarity index 94% rename from app/Api/V1/Requests/todo/TagStoreRequest.php rename to app/Api/V1/Requests/Models/Tag/StoreRequest.php index 02fa2fd7b3..e23101ae47 100644 --- a/app/Api/V1/Requests/todo/TagStoreRequest.php +++ b/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. * diff --git a/app/Api/V1/Requests/todo/TagUpdateRequest.php b/app/Api/V1/Requests/Models/Tag/UpdateRequest.php similarity index 94% rename from app/Api/V1/Requests/todo/TagUpdateRequest.php rename to app/Api/V1/Requests/Models/Tag/UpdateRequest.php index d247837d18..ed43076950 100644 --- a/app/Api/V1/Requests/todo/TagUpdateRequest.php +++ b/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; diff --git a/routes/api.php b/routes/api.php index d74140bdf9..40b00606f6 100644 --- a/routes/api.php +++ b/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(