Move API to use JSON:API standards and fractal serializer

Makes the data slightly more complex, but forces a standard and can
always be changed down the road simply by changing the default
serializer.

app/Http/Controllers/API/Admin/ServerController.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Pterodactyl - Panel
+ * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace Pterodactyl\Http\Controllers\API\Admin;
+
+use Fractal;
+use Illuminate\Http\Request;
+use Pterodactyl\Models\Server;
+use Pterodactyl\Http\Controllers\Controller;
+use Pterodactyl\Transformers\Admin\ServerTransformer;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+
+class ServerController extends Controller
+{
+    /**
+     * Controller to handle returning all servers on the system.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    public function index(Request $request)
+    {
+        $servers = Server::paginate(20);
+
+        return Fractal::create()
+            ->collection($servers)
+            ->transformWith(new ServerTransformer)
+            ->paginateWith(new IlluminatePaginatorAdapter($servers))
+            ->withResourceName('server')
+            ->toArray();
+    }
+
+    /**
+     * Controller to handle returning information on a single server.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    public function view(Request $request, $id)
+    {
+        $server = Server::findOrFail($id);
+
+        $fractal = Fractal::create()->item($server);
+
+        if ($request->input('include')) {
+            $fractal->parseIncludes(collect(explode(',', $request->input('include')))->intersect([
+                'allocations', 'subusers', 'user',
+                'pack', 'service', 'option',
+            ])->toArray());
+        }
+
+        return $fractal->transformWith(new ServerTransformer)
+            ->withResourceName('server')
+            ->toArray();
+    }
+}

app/Http/Controllers/API/User/CoreController.php

@@ -27,7 +27,7 @@ namespace Pterodactyl\Http\Controllers\API\User;
 use Fractal;
 use Illuminate\Http\Request;
 use Pterodactyl\Http\Controllers\Controller;
-use Pterodactyl\Transformers\User\ServerTransformer;
+use Pterodactyl\Transformers\User\OverviewTransformer;
 
 class CoreController extends Controller
 {
@@ -41,6 +41,9 @@ class CoreController extends Controller
     {
         $servers = $request->user()->access('service', 'node', 'allocation', 'option')->get();
 
-        return Fractal::collection($servers)->transformWith(new ServerTransformer)->toArray();
+        return Fractal::collection($servers)
+            ->transformWith(new OverviewTransformer)
+            ->withResourceName('server')
+            ->toArray();
     }
 }

app/Http/Controllers/API/User/ServerController.php

@@ -46,13 +46,15 @@ class ServerController extends Controller
         $server = Server::byUuid($uuid);
         $fractal = Fractal::create()->item($server);
 
-        if ($request->input('with')) {
-            $fractal->parseIncludes(collect(explode(',', $request->input('with')))->intersect([
+        if ($request->input('include')) {
+            $fractal->parseIncludes(collect(explode(',', $request->input('include')))->intersect([
                 'allocations', 'subusers', 'stats',
             ])->toArray());
         }
 
-        return $fractal->transformWith(new ServerTransformer)->toArray();
+        return $fractal->transformWith(new ServerTransformer)
+            ->withResourceName('server')
+            ->toArray();
     }
 
     /**

app/Transformers/Admin/AllocationTransformer.php

@@ -22,22 +22,20 @@
  * SOFTWARE.
  */
 
-namespace Pterodactyl\Extensions;
+namespace Pterodactyl\Transformers\Admin;
 
-use League\Fractal\Serializer\ArraySerializer;
+use Pterodactyl\Models\Allocation;
+use League\Fractal\TransformerAbstract;
 
-class NoDataSerializer extends ArraySerializer
+class AllocationTransformer extends TransformerAbstract
 {
     /**
-     * Serialize a collection and don't insert as a member of `data`
-     *
-     * @param string $resourceKey
-     * @param array  $data
+     * Return a generic transformed server array.
      *
      * @return array
      */
-    public function collection($resourceKey, array $data)
+    public function transform(Allocation $allocation)
     {
-        return $data;
+        return $allocation->toArray();
     }
 }

app/Transformers/Admin/ServerTransformer.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * Pterodactyl - Panel
+ * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace Pterodactyl\Transformers\Admin;
+
+use Pterodactyl\Models\Server;
+use League\Fractal\TransformerAbstract;
+
+class ServerTransformer extends TransformerAbstract
+{
+    /**
+     * List of resources that can be included.
+     *
+     * @var array
+     */
+    protected $availableIncludes = [
+        'allocations',
+        'user',
+        'subusers',
+    ];
+
+    /**
+     * Return a generic transformed server array.
+     *
+     * @return array
+     */
+    public function transform(Server $server)
+    {
+        return $server->toArray();
+    }
+
+    /**
+     * Return a generic array of allocations for this server.
+     *
+     * @return \Leauge\Fractal\Resource\Collection
+     */
+    public function includeAllocations(Server $server)
+    {
+        return $this->collection($server->allocations, new AllocationTransformer, 'allocation');
+    }
+
+    /**
+     * Return a generic array of data about subusers for this server.
+     *
+     * @return \Leauge\Fractal\Resource\Collection
+     */
+    public function includeSubusers(Server $server)
+    {
+        return $this->collection($server->subusers, new SubuserTransformer, 'subuser');
+    }
+
+    /**
+     * Return a generic array of data about subusers for this server.
+     *
+     * @return \Leauge\Fractal\Resource\Item
+     */
+    public function includeUser(Server $server)
+    {
+        return $this->item($server->user, new UserTransformer, 'user');
+    }
+}

app/Transformers/Admin/SubuserTransformer.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Pterodactyl - Panel
+ * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace Pterodactyl\Transformers\Admin;
+
+use Pterodactyl\Models\Subuser;
+use Pterodactyl\Models\Permission;
+use League\Fractal\TransformerAbstract;
+
+class SubuserTransformer extends TransformerAbstract
+{
+    /**
+     * Return a generic transformed subuser array.
+     *
+     * @return array
+     */
+    public function transform(Subuser $subuser)
+    {
+        return [
+            'id' => $subuser->id,
+            'username' => $subuser->user->username,
+            'email' => $subuser->user->email,
+            '2fa' => (bool) $subuser->user->use_totp,
+            'permissions' => $subuser->permissions->pluck('permission'),
+            'created_at' => $subuser->created_at,
+            'updated_at' => $subuser->updated_at,
+        ];
+    }
+}

app/Transformers/Admin/UserTransformer.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Pterodactyl - Panel
+ * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace Pterodactyl\Transformers\Admin;
+
+use Pterodactyl\Models\User;
+use League\Fractal\TransformerAbstract;
+
+class UserTransformer extends TransformerAbstract
+{
+    /**
+     * Return a generic transformed subuser array.
+     *
+     * @return array
+     */
+    public function transform(User $user)
+    {
+        return $user->toArray();
+    }
+}

app/Transformers/User/AllocationTransformer.php

@@ -55,6 +55,7 @@ class AllocationTransformer extends TransformerAbstract
     public function transform(Allocation $allocation)
     {
         return [
+            'id' => $allocation->id,
             'ip' => $allocation->alias,
             'port' => $allocation->port,
             'default' => ($allocation->id === $this->server->allocation_id),

app/Transformers/User/OverviewTransformer.php

@@ -37,7 +37,7 @@ class OverviewTransformer extends TransformerAbstract
     public function transform(Server $server)
     {
         return [
-            'uuidShort' => $server->uuidShort,
+            'id' => $server->uuidShort,
             'uuid' => $server->uuid,
             'name' => $server->name,
             'node' => $server->node->name,

app/Transformers/User/ServerTransformer.php

@@ -48,7 +48,7 @@ class ServerTransformer extends TransformerAbstract
     public function transform(Server $server)
     {
         return [
-            'uuidShort' => $server->uuidShort,
+            'id' => $server->uuidShort,
             'uuid' => $server->uuid,
             'name' => $server->name,
             'description' => $server->description,
@@ -73,7 +73,7 @@ class ServerTransformer extends TransformerAbstract
     {
         $allocations = $server->allocations;
 
-        return $this->collection($allocations, new AllocationTransformer($server));
+        return $this->collection($allocations, new AllocationTransformer($server), 'allocation');
     }
 
     /**
@@ -85,7 +85,7 @@ class ServerTransformer extends TransformerAbstract
     {
         $server->load('subusers.permissions', 'subusers.user');
 
-        return $this->collection($server->subusers, new SubuserTransformer);
+        return $this->collection($server->subusers, new SubuserTransformer, 'subuser');
     }
 
     /**
@@ -95,6 +95,6 @@ class ServerTransformer extends TransformerAbstract
      */
     public function includeStats(Server $server)
     {
-        return $this->item($server->guzzleClient(), new StatsTransformer);
+        return $this->item($server->guzzleClient(), new StatsTransformer, 'stat');
     }
 }

app/Transformers/User/StatsTransformer.php

@@ -49,6 +49,7 @@ class StatsTransformer extends TransformerAbstract
             $json = json_decode($res->getBody());
 
             return [
+                'id' => 1,
                 'status' => $json->status,
                 'resources' => $json->proc,
             ];

app/Transformers/User/SubuserTransformer.php

@@ -38,6 +38,7 @@ class SubuserTransformer extends TransformerAbstract
     public function transform(Subuser $subuser)
     {
         return [
+            'id' => $subuser->id,
             'username' => $subuser->user->username,
             'email' => $subuser->user->email,
             '2fa' => (bool) $subuser->user->use_totp,

config/laravel-fractal.php

@@ -13,6 +13,6 @@ return [
     |
     */
 
-    'default_serializer' => Pterodactyl\Extensions\NoDataSerializer::class,
+    'default_serializer' => League\Fractal\Serializer\JsonApiSerializer::class,
 
 ];

database/migrations/2017_04_02_163232_DropDeletedAtColumnFromServers.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class DropDeletedAtColumnFromServers extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('servers', function (Blueprint $table) {
+            $table->dropColumn('deleted_at');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('servers', function (Blueprint $table) {
+            $table->timestamp('deleted_at')->nullable();
+        });
+    }
+}

routes/api-admin.php

@@ -24,11 +24,16 @@
 
 Route::get('/', 'CoreController@index')->name('api.admin');
 
+
 /*
 |--------------------------------------------------------------------------
-| Location Controller Routes
+| Server Controller Routes
 |--------------------------------------------------------------------------
 |
-| Endpoint: /api/admin
+| Endpoint: /api/admin/servers
 |
 */
+Route::group(['prefix' => '/servers'], function () {
+    Route::get('/', 'ServerController@index')->name('api.admin.servers.list');
+    Route::get('/{id}', 'ServerController@view')->name('api.admin.servers.view');
+});