added the ability to get a random image

app/Http/Controllers/Api/v1/ImageController.php

@@ -4,6 +4,7 @@
 
 use App\Http\Controllers\Controller;
 use App\Models\Image;
+use App\Http\Controllers\Api\v1\exceptions\InvalidArgumentException;
 
 class ImageController extends Controller
 {
@@ -30,4 +31,27 @@ public function show(Image $image)
     {
         return response()->json($image);
     }
+
+    /**
+     * @param string|null $rating
+     * @retun \Illuminate\Http\JsonResponse
+     */
+    public function showRandom($rating = null)
+    {
+        $availableRatings = collect(explode(',', env('CRAWLER_RATINGS')))->map(function ($rating) {
+            return strtolower($rating);
+        })->toArray();
+
+        if (!empty($rating) && !in_array(strtolower($rating), $availableRatings)) {
+            return response('The given rating is invalid.', 422);
+        }
+
+        if ($rating) {
+            $image = Image::whereRating($rating)->inRandomOrder()->first();
+        } else {
+            $image = Image::inRandomOrder()->first();
+        }
+
+        return response()->json($image);
+    }
 }

app/Http/Controllers/Api/v1/exceptions/InvalidArgumentException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Http\Controllers\Api\v1\exceptions ;
+
+use Exception;
+
+class InvalidArgumentException extends Exception
+{
+
+}

routes/api.php

@@ -14,6 +14,7 @@
 Route::prefix('v1')->middleware('api')->group(function () {
     Route::get('/health_check', 'Api\v1\HomeController@healthCheck');
 
+    Route::get('/images/random/{rating?}', 'Api\v1\ImageController@showRandom');
     Route::resource('/images', 'Api\v1\ImageController')->only(['index', 'show']);
     Route::get('/images/rating/{rating?}', 'Api\v1\ImageController@index');