update staging

.github/workflows/postman-api-tests.yml

@@ -1,4 +1,4 @@
-name: Scheduled Postman API Tests
+name: Scheduled API Tests
 
 on:
   schedule:
@@ -23,17 +23,15 @@ jobs:
     - name: Run Postman Collection
       run: newman run postman-api-tests.json -r cli,json --reporter-json-export result.json
       continue-on-error: true
-
 
-
-    - name: Transfer test results via SCP
-      uses: appleboy/[email protected]
+    - name: Set up PHP
+      uses: nanasess/setup-php@v4
       with:
-        host: ${{ secrets.SSH_HOST }}
-        username: ${{ secrets.SSH_USER }}
-        password: ${{ secrets.SSH_PASSWORD }}
-        source: "result.json"
-        target: "/var/www/boilerplate-be"
+        php-version: '8.2'
 
-    - name: Clean up
-      run: rm -f result.json
+    - name: Send parsed result to Hosted Application
+      run: |
+          export APP_URL=${{ secrets.APP_URL }}
+          php send-postman-api-tests-results.php 
+
+

.github/workflows/test.yml

@@ -1,9 +1,7 @@
 name: Code Quality
 
 on:
-  push:
-    branches:
-      - dev
+  pull_request_target:
 
 jobs:
   lint:
@@ -31,6 +29,8 @@ jobs:
 
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
 
       - name: Set up PHP
         uses: nanasess/setup-php@v4

.gitignore

@@ -21,3 +21,4 @@ docker-compose.yml
 /public/uploads
 ResponseHTTP_OK,
 can
+result.json

app/Console/Commands/ApiStatus.php

@@ -5,7 +5,6 @@
 use DateTime;
 use DateTimeZone;
 use Illuminate\Console\Command;
-use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Http;
 
 class StoreApiStatus extends Command
@@ -64,13 +63,13 @@ public function handle()
                 $data = [
                     'api_group' => $item['name'],
                     'method' => $item['request']['method'],
-                    'status' => $status,
+                    'status' => $this->determineStatus($execution),
                     'response_time' => $response_time,
                     'last_checked' => $last_checked,
                     'details' => $this->getDetails($execution)
                 ];
 
-                $url = config('app.url') . '/api/v1/api-status';
+                $url = "https://staging.api-php.boilerplate.hng.tech/api/v1/api-status";
 
                 $response = Http::post($url, $data);
 
@@ -93,10 +92,24 @@ private function getDetails($execution)
 
         if ($response_code >= 500 || $response_code === null) {
             return 'API not responding (HTTP ' . ($response_code ?? 'Unknown') . ')';
-        } elseif ($response_time > 400) {
+        } elseif ($response_time > 600) {
             return 'High response time detected';
         } else {
             return 'All tests passed';
         }
     }
+
+    private function determineStatus($execution)
+    {
+        $responseCode = $execution['response']['code'] ?? null;
+        $responseTime = $execution['response']['responseTime'] ?? null;
+
+        if ($responseCode >= 500 || $responseCode === null) {
+            return 'Down';
+        } elseif ($responseTime > 600) {
+            return 'Degraded';
+        } else {
+            return 'Operational';
+        }
+    }
 }

app/Http/Controllers/Api/V1/Admin/BlogController.php

@@ -65,9 +65,30 @@ public function latest(Request $request)
     public function index()
     {
         try{
-            $blogPosts = Blog::orderBy('created_at', 'desc')
-                ->select('id', 'title', 'content', 'author', 'created_at', 'category', 'image_url')
-                ->get();
+            $blogPosts = Blog::with('comments')
+            ->orderBy('created_at', 'desc')
+            ->select('id', 'title', 'content', 'author', 'created_at', 'category', 'image_url')
+            ->get();
+
+            $blogPosts = $blogPosts->map(function ($blog) {
+                return [
+                    'id' => $blog->id,
+                    'title' => $blog->title,
+                    'content' => $blog->content,
+                    'published_date' => $blog->created_at?->toIso8601String(),
+                    'updated_date' => $blog->updated_at?->toIso8601String(),
+                    'author_id' => $blog->author_id,
+                    'category' => $blog->category,
+                    'image_url' => $blog->image_url,
+                    'comments' => $blog->comments->map(function ($comment) {
+                        return [
+                            'id' => $comment->id,
+                            'content' => $comment->content,
+                            'created_at' => $comment->created_at?->toIso8601String(),
+                        ];
+                    }),
+                ];
+            });
 
             return response()->json([
                 'data' => $blogPosts,
@@ -93,17 +114,17 @@ public function create()
      */
     public function store(Request $request)
     {
-        $author = User::where('id', Auth::id())->first();
-        if(!$author){
-            return response()->json(['error' => 'User Not found.'], 404);
+        $author = User::find(Auth::id());
+
+        if (!$author) {
+            return response()->json(['error' => 'User not found.'], 404);
         }
 
-        Log::error('Error creating blog post: ' . Auth::id());
         $validator = Validator::make($request->all(), [
-            'title' => ['required', 'string', 'max:255'],
-            'content' => ['required', 'string'],
-            'image_url' => ['required', 'mimes:jpeg,png,jpg,gif,svg'],
-            'category' => ['required', 'string', 'max:255'],
+            'title' => 'required|string|max:255',
+            'content' => 'required|string',
+            'category' => 'required|string|max:255',
+            'image_url' => 'required|mimes:jpeg,png,jpg,gif,svg',
         ]);
 
         if ($validator->fails()) {
@@ -112,27 +133,47 @@ public function store(Request $request)
                 'status_code' => 422,
             ], 422);
         }
+
         try {
             DB::beginTransaction();
-            $saved = Storage::disk('public')->put('images', $request->file('image_url'));
+
+            $savedPath = Storage::disk('public')->put('images', $request->file('image_url'));
+            $imageUrl = 'storage/' . $savedPath;
+
             $blog = Blog::create([
                 'title' => $request->get('title'),
-                'content' => (string)$request->get('content'),
-                'author' => $author->name ? $author->name : "",
-                'image_url' => 'storage/'.$saved,
+                'content' => $request->get('content'),
+                'author' => $author->name ?? '',
+                'image_url' => $imageUrl,
                 'category' => $request->get('category'),
-                'author_id' => $author->id
+                'author_id' => $author->id,
             ]);
 
             DB::commit();
+
             return response()->json([
-                'data' => $blog,
-                'message' => 'Blog post created successfully.',
-                'status_code' => Response::HTTP_CREATED,
+                'id' => $blog->id,
+                'title' => $blog->title,
+                'image_url' => $blog->image_url,
+                'content' => $blog->content,
+                'published_date' => $blog->created_at->toIso8601String(),
+                'updated_date' => $blog->updated_at->toIso8601String(),
+                'author_id' => $blog->author_id,
+                'category' => $blog->category,
+                'comments' => $blog->comments->map(function ($comment) {
+                    return [
+                        'id' => $comment->id,
+                        'content' => $comment->content,
+                        'created_at' => $comment->created_at->toIso8601String(),
+                    ];
+                }),
             ], Response::HTTP_CREATED);
+
+
         } catch (\Exception $exception) {
             Log::error('Error creating blog post: ' . $exception->getMessage());
             DB::rollBack();
+
             return response()->json(['error' => 'Internal server error.'], 500);
         }
     }
@@ -143,11 +184,12 @@ public function store(Request $request)
     public function show(Request $request, string $id)
     {
         try {
-            $blog = Blog::find($id);
+            $blog = Blog::with('comments')->find($id);
 
             if(!$blog){
                 return response()->json([
                     'error' => 'Blog not found.',
+                    'message' => 'Blog not found.',
                     'status_code' => Response::HTTP_NOT_FOUND,
                 ], 404);
             }
@@ -158,14 +200,21 @@ public function show(Request $request, string $id)
                     'category' => $blog->category,
                     'content' => $blog->content,
                     'image_url' => $blog->image_url,
-                    'created_at' => $blog->created_at,
+                    'published_date' => $blog->created_at?->toIso8601String(),
+                    'updated_date' => $blog->updated_at?->toIso8601String(),
+                    'author_id' => $blog->author_id,
+                    'comments' => $blog->comments->map(function ($comment) {
+                        return [
+                            'id' => $comment->id,
+                            'content' => $comment->content,
+                            'created_at' => $comment->created_at?->toIso8601String(),
+                        ];
+                }),
                 ],
-                'message' => 'Blog post fetched sucessfully.',
+                'message' => 'Blog post details fetched sucessfully.',
                 'status_code' => Response::HTTP_OK,
             ], Response::HTTP_OK);
         } catch (Exception $exception) {
-            // Log::error('Error creating blog post: ' . $exception->getMessage());
-            DB::rollBack();
             return response()->json(['error' => 'Internal server error.'], 500);
         }
     }

app/Http/Controllers/Api/V1/Admin/EmailTemplateController.php

@@ -65,6 +65,7 @@ public function index(Request $request)
             'limit' => $templates->perPage(),
         ], 200);
     }
+
     public function update(Request $request, $id)
     {
         // Validate the request data
@@ -97,7 +98,6 @@ public function update(Request $request, $id)
 
     public function store(Request $request)
     {
-
         // Validate request data
         $validatedData = $request->validate([
             'title' => 'required|string|max:255|unique:email_templates,title',
@@ -108,13 +108,23 @@ public function store(Request $request)
         // Create email template
         $emailTemplate = EmailTemplate::create($validatedData);
 
+        // Format the response to match the API schema in the screenshot
         return response()->json([
-            'status_code' => 200,
+            'data' => [
+                'id' => $emailTemplate->id,
+                'name' => $emailTemplate->title,
+                'subject' => '', // Add subject if applicable
+                'template_body' => $emailTemplate->template,
+                'placeholders' => [
+                    // Add placeholders if available
+                ],
+            ],
             'message' => 'Email template created successfully',
-            'data' => $emailTemplate
-        ], 200);
+            'status_code' => 201
+        ], 201);
     }
 
+
     public function destroy($id)
 {
     // Find the email template by ID

app/Http/Controllers/Api/V1/CategoryController.php

@@ -12,48 +12,19 @@ class CategoryController extends Controller
     public function index(Request $request)
     {
         try {
-            // Optional query parameters
-            $limit = $request->query('limit', 100);
-            $offset = $request->query('offset', 0);
-            $parent_id = $request->query('parent_id', null);
 
-            // Validate query parameters
-            $request->validate([
-                'limit' => 'integer|min:1',
-                'offset' => 'integer|min:0',
-                'parent_id' => 'integer|nullable',
-            ]);
-
-        $categories = Category::when($parent_id, function ($query) use ($parent_id) {
-            return $query->where('parent_id', $parent_id);
-        })
-        ->limit($limit)
-        ->offset($offset)
-        ->get(['id', 'name', 'description', 'slug', 'parent_id']);
-
-        \Log::info($categories);
+        $categories = Category::all();
 
         return response()->json([
             'status_code' => 200,
-            'categories' => $categories,
+            'message' => 'Categories returned successfully',
+            'data' => $categories,
         ]);
-    } catch (\Illuminate\Validation\ValidationException $e) {
-        return response()->json([
-            'status_code' => 400,
-            'error' => [
-                'code' => 'INVALID_QUERY_PARAMETER',
-                'message' => 'The provided query parameter is invalid.',
-                'details' => [
-                    'invalid_parameter' => $e->validator->errors()->keys()[0],
-                    'reason' => $e->validator->errors()->first(),
-                ],
-            ],
-        ], 400);
-    } catch (\Exception $e) {
+
+    }catch (\Exception $e) {
         return response()->json([
             'status_code' => 500,
             'error' => [
-                'code' => 'INTERNAL_SERVER_ERROR',
                 'message' => 'An unexpected error occurred while processing your request.',
                 'details' => [
                     'support_email' => '[email protected]',