Improve API responses for invalid/missing things

TechnicPack · May 18, 2022 · 380d511 · 380d511
1 parent 2b6036c
commit 380d511
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 8 deletions.
diff --git a/app/Http/Controllers/ApiController.php b/app/Http/Controllers/ApiController.php
@@ -86,7 +86,13 @@ public function getModpackIndex()
 
     public function getModpack($slug)
     {
-        return response()->json($this->fetchModpack($slug));
+        $response = $this->fetchModpack($slug);
+
+        if (! $response) {
+            return response()->json(['error' => 'Modpack does not exist'], 404);
+        }
+
+        return response()->json($response);
     }
 
     public function getModpackBuild($modpackSlug, $buildName)
@@ -138,7 +144,7 @@ public function getMod($modSlug = null, $version = null)
             $modVersion = $mod->versions()->where('version', $version)->first();
 
             if (! $modVersion) {
-                return response()->json(['error' => 'Mod version does not exist']);
+                return response()->json(['error' => 'Mod version does not exist'], 404);
             }
 
             $response = $modVersion->only([
@@ -155,13 +161,13 @@ public function getMod($modSlug = null, $version = null)
     public function getVerify($key = null)
     {
         if (! $key) {
-            return response()->json(['error' => 'No API key provided.']);
+            return response()->json(['error' => 'No API key provided.'], 400);
         }
 
         $key = Key::where('api_key', $key)->first();
 
         if (! $key) {
-            return response()->json(['error' => 'Invalid key provided.']);
+            return response()->json(['error' => 'Invalid key provided.'], 403);
         }
 
         return response()->json([
@@ -222,7 +228,7 @@ private function fetchModpack($slug)
         }
 
         if (! $modpack) {
-            return ['error' => 'Modpack does not exist'];
+            return null;
         }
 
         return $modpack->toApiResponse($this->client, $this->key);

diff --git a/tests/Unit/ApiTest.php b/tests/Unit/ApiTest.php
@@ -46,8 +46,8 @@ public function test_mod()
     public function test_invalid_modpack()
     {
         $response = $this->get('api/modpack/bob');
-        $response->assertOk();
-        $response->assertJsonStructure(['error']);
+        $response->assertNotFound();
+        $response->assertJson(['error' => 'Modpack does not exist']);
     }
 
     public function test_modpack_slug()
@@ -76,7 +76,7 @@ public function test_invalid_mod()
     {
         $response = $this->get('api/mod/bob');
         $response->assertNotFound();
-        $response->assertJsonStructure(['error']);
+        $response->assertJson(['error' => 'Mod does not exist']);
     }
 
     public function test_mod_slug()
@@ -121,4 +121,19 @@ public function test_mod_version()
             'url',
         ]);
     }
+
+    public function test_modversion_with_invalid_mod()
+    {
+        $response = $this->get('api/mod/foo/bar');
+        $response->assertNotFound();
+        $response->assertJson(['error' => 'Mod does not exist']);
+    }
+
+    public function test_invalid_modversion()
+    {
+        $mod = Mod::find(1);
+        $response = $this->get('api/mod/'.$mod->name.'/invalid');
+        $response->assertNotFound();
+        $response->assertJson(['error' => 'Mod version does not exist']);
+    }
 }