Feat/navigation blog api

routes/blog-api.php

@@ -4,6 +4,7 @@
 use CSlant\Blog\Api\Http\Actions\Post\PostGetCustomFiltersAction;
 use CSlant\Blog\Api\Http\Actions\Author\AuthorGetProfileAction;
 use CSlant\Blog\Api\Http\Actions\Post\PostGetViewCountAction;
+use CSlant\Blog\Api\Http\Actions\Post\PostGetNavigateAction;
 use CSlant\Blog\Api\Http\Actions\Tag\TagGetFiltersAction;
 use CSlant\Blog\Api\Http\Controllers\CategoryController;
 use CSlant\Blog\Api\Http\Controllers\MetaBoxController;
@@ -41,6 +42,7 @@
         Route::get('custom-filters', PostGetCustomFiltersAction::class);
         Route::get('{slug}', [PostController::class, 'findBySlug']);
         Route::get('{slug}/view-count', PostGetViewCountAction::class);
+        Route::get('{slug}/navigate', PostGetNavigateAction::class);
         Route::post('{id}/increment-views', PostStoreViewCountAction::class)
             ->middleware('api-action-rate-limiter:post-views');
     });

src/Http/Actions/Post/PostGetNavigateAction.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace CSlant\Blog\Api\Http\Actions\Post;
+
+use Botble\Blog\Repositories\Interfaces\PostInterface;
+use CSlant\Blog\Api\Http\Resources\Post\PostNavigateResource;
+use CSlant\Blog\Core\Facades\Base\SlugHelper;
+use CSlant\Blog\Core\Http\Responses\Base\BaseHttpResponse;
+use CSlant\Blog\Core\Models\Post;
+use CSlant\Blog\Core\Models\Slug;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Resources\Json\JsonResource;
+use OpenApi\Attributes\Get;
+use OpenApi\Attributes\Parameter;
+use OpenApi\Attributes\Response;
+use OpenApi\Attributes\Schema;
+
+/**
+ * Class PostGetNavigateAction
+ *
+ * @package CSlant\Blog\Api\Http\Actions\Post
+ *
+ * @method BaseHttpResponse httpResponse()
+ * @method BaseHttpResponse setData(mixed $data)
+ * @method BaseHttpResponse|JsonResource|JsonResponse|RedirectResponse toApiResponse()
+ */
+class PostGetNavigateAction
+{
+    public function __construct(
+        protected PostInterface $postRepository
+    ) {
+    }
+
+    /**
+     * @group Blog API
+     *
+     * @param  string  $slug
+     *
+     * @return BaseHttpResponse|JsonResource|JsonResponse|RedirectResponse
+     */
+    #[
+        Get(
+            path: "/posts/{slug}/navigate",
+            operationId: "postGetNavigate",
+            description: "Get the previous and next posts by slug
+This API will return both previous and next posts for navigation purposes.
+            ",
+            summary: "Get previous and next posts for navigation",
+            tags: ["Post"],
+            parameters: [
+                new Parameter(
+                    name: 'slug',
+                    description: 'Post slug',
+                    in: 'path',
+                    required: true,
+                    schema: new Schema(type: 'string')
+                ),
+            ],
+            responses: [
+                new Response(
+                    response: 200,
+                    description: 'Navigation posts retrieved successfully',
+                ),
+                new Response(
+                    response: 404,
+                    description: 'Post not found',
+                ),
+            ]
+        )
+    ]
+    public function __invoke(string $slug): BaseHttpResponse|JsonResponse|JsonResource|RedirectResponse
+    {
+        /** @var Slug $slug */
+        $slug = SlugHelper::getSlug($slug, SlugHelper::getPrefix(Post::getBaseModel()));
+
+        if (!$slug) {
+            return $this
+                ->httpResponse()
+                ->setError()
+                ->setCode(404)
+                ->setMessage('Post not found');
+        }
+
+        $navigationPosts = $this->postRepository->getNavigatePosts($slug->reference_id);
+
+        return $this
+            ->httpResponse()
+            ->setData(new PostNavigateResource($navigationPosts))
+            ->toApiResponse();
+    }
+
+    /**
+     * @return BaseHttpResponse
+     */
+    protected function httpResponse(): BaseHttpResponse
+    {
+        return new BaseHttpResponse;
+    }
+}

src/Http/Resources/Post/PostNavigateResource.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace CSlant\Blog\Api\Http\Resources\Post;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+/**
+ * Post Navigate Resource for combined previous/next response
+ */
+class PostNavigateResource extends JsonResource
+{
+    /**
+     * @param  Request  $request
+     *
+     * @return array<string, mixed>
+     */
+    public function toArray($request): array
+    {
+        return [
+            'previous' => $this->resource['previous'] ? new PostNavigationResource($this->resource['previous']) : null,
+            'next' => $this->resource['next'] ? new PostNavigationResource($this->resource['next']) : null,
+        ];
+    }
+}

src/Http/Resources/Post/PostNavigationResource.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace CSlant\Blog\Api\Http\Resources\Post;
+
+use CSlant\Blog\Core\Facades\Base\Media\RvMedia;
+use CSlant\Blog\Core\Models\Post;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+/**
+ * Post Navigation Resource for previous/next navigation
+ */
+class PostNavigationResource extends JsonResource
+{
+    /**
+     * @param  Request  $request
+     *
+     * @return array<string, mixed>
+     */
+    public function toArray($request): array
+    {
+        if (!$this->resource) {
+            return [];
+        }
+
+        /** @var Post $this */
+        return [
+            'id' => $this->id,
+            'name' => $this->name,
+            'description' => $this->description,
+            'slug' => $this->slug,
+            'url' => $this->url,
+            'image' => $this->image ? RvMedia::getImageUrl($this->image) : null,
+            'created_at' => $this->created_at,
+            'updated_at' => $this->updated_at,
+        ];
+    }
+}