Rename APIKey to ApiKey

DaneEveritt · DaneEveritt · commit ad3a954256f4 · 2018-01-14T12:06:15.000-06:00
diff --git a/app/Contracts/Repository/ApiKeyRepositoryInterface.php b/app/Contracts/Repository/ApiKeyRepositoryInterface.php
@@ -9,17 +9,17 @@
 
 namespace Pterodactyl\Contracts\Repository;
 
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 
 interface ApiKeyRepositoryInterface extends RepositoryInterface
 {
     /**
      * Load permissions for a key onto the model.
      *
-     * @param \Pterodactyl\Models\APIKey $model
+     * @param \Pterodactyl\Models\ApiKey $model
      * @param bool                       $refresh
      * @deprecated
-     * @return \Pterodactyl\Models\APIKey
+     * @return \Pterodactyl\Models\ApiKey
      */
-    public function loadPermissions(APIKey $model, bool $refresh = false): APIKey;
+    public function loadPermissions(ApiKey $model, bool $refresh = false): ApiKey;
 }
diff --git a/app/Http/Middleware/Api/Admin/AuthenticateKey.php b/app/Http/Middleware/Api/Admin/AuthenticateKey.php
@@ -4,7 +4,7 @@
 
 use Closure;
 use Illuminate\Http\Request;
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Illuminate\Auth\AuthManager;
 use Illuminate\Contracts\Encryption\Encrypter;
 use Symfony\Component\HttpKernel\Exception\HttpException;
@@ -61,8 +61,8 @@ public function handle(Request $request, Closure $next)
         }
 
         $raw = $request->bearerToken();
-        $identifier = substr($raw, 0, APIKey::IDENTIFIER_LENGTH);
-        $token = substr($raw, APIKey::IDENTIFIER_LENGTH);
+        $identifier = substr($raw, 0, ApiKey::IDENTIFIER_LENGTH);
+        $token = substr($raw, ApiKey::IDENTIFIER_LENGTH);
 
         try {
             $model = $this->repository->findFirstWhere([['identifier', '=', $identifier]]);
diff --git a/app/Http/Requests/API/Admin/ApiAdminRequest.php b/app/Http/Requests/API/Admin/ApiAdminRequest.php
@@ -2,7 +2,7 @@
 
 namespace Pterodactyl\Http\Requests\API\Admin;
 
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Illuminate\Foundation\Http\FormRequest;
 use Pterodactyl\Exceptions\PterodactylException;
 use Pterodactyl\Services\Acl\Api\AdminAcl as Acl;
@@ -66,9 +66,9 @@ public function rules(): array
     /**
      * Return the API key being used for the request.
      *
-     * @return \Pterodactyl\Models\APIKey
+     * @return \Pterodactyl\Models\ApiKey
      */
-    public function key(): APIKey
+    public function key(): ApiKey
     {
         return $this->attributes->get('api_key');
     }
diff --git a/app/Models/ApiKey.php b/app/Models/ApiKey.php
@@ -10,7 +10,7 @@
 use Sofa\Eloquence\Contracts\CleansAttributes;
 use Sofa\Eloquence\Contracts\Validable as ValidableContract;
 
-class APIKey extends Model implements CleansAttributes, ValidableContract
+class ApiKey extends Model implements CleansAttributes, ValidableContract
 {
     use Eloquence, Validable;
 
diff --git a/app/Providers/MacroServiceProvider.php b/app/Providers/MacroServiceProvider.php
@@ -13,7 +13,7 @@
 use Cache;
 use Carbon;
 use Request;
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Illuminate\Support\ServiceProvider;
 use Pterodactyl\Services\ApiKeyService;
 
@@ -51,7 +51,7 @@ public function boot()
                     'ApiKeyMacro',
                     'ApiKeyMacro:Key:' . $parts[0],
                 ])->remember('ApiKeyMacro.' . $parts[0], Carbon::now()->addMinutes(15), function () use ($parts) {
-                    return APIKey::where('public', $parts[0])->first();
+                    return ApiKey::where('public', $parts[0])->first();
                 });
             }
 
diff --git a/app/Repositories/Eloquent/ApiKeyRepository.php b/app/Repositories/Eloquent/ApiKeyRepository.php
@@ -2,7 +2,7 @@
 
 namespace Pterodactyl\Repositories\Eloquent;
 
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface;
 
 class ApiKeyRepository extends EloquentRepository implements ApiKeyRepositoryInterface
@@ -14,18 +14,18 @@ class ApiKeyRepository extends EloquentRepository implements ApiKeyRepositoryInt
      */
     public function model()
     {
-        return APIKey::class;
+        return ApiKey::class;
     }
 
     /**
      * Load permissions for a key onto the model.
      *
-     * @param \Pterodactyl\Models\APIKey $model
+     * @param \Pterodactyl\Models\ApiKey $model
      * @param bool                       $refresh
      * @deprecated
-     * @return \Pterodactyl\Models\APIKey
+     * @return \Pterodactyl\Models\ApiKey
      */
-    public function loadPermissions(APIKey $model, bool $refresh = false): APIKey
+    public function loadPermissions(ApiKey $model, bool $refresh = false): ApiKey
     {
         if (! $model->relationLoaded('permissions') || $refresh) {
             $model->load('permissions');
diff --git a/app/Services/Acl/Api/AdminAcl.php b/app/Services/Acl/Api/AdminAcl.php
@@ -2,7 +2,7 @@
 
 namespace Pterodactyl\Services\Acl\Api;
 
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 
 class AdminAcl
 {
@@ -54,12 +54,12 @@ public static function can(int $permission, int $action = self::READ)
      * Determine if an API Key model has permission to access a given resource
      * at a specific action level.
      *
-     * @param \Pterodactyl\Models\APIKey $key
+     * @param \Pterodactyl\Models\ApiKey $key
      * @param string                     $resource
      * @param int                        $action
      * @return bool
      */
-    public static function check(APIKey $key, string $resource, int $action = self::READ)
+    public static function check(ApiKey $key, string $resource, int $action = self::READ)
     {
         return self::can(data_get($key, self::COLUMN_IDENTIFER . $resource, self::NONE), $action);
     }
diff --git a/app/Services/Api/KeyCreationService.php b/app/Services/Api/KeyCreationService.php
@@ -2,7 +2,7 @@
 
 namespace Pterodactyl\Services\Api;
 
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Illuminate\Contracts\Encryption\Encrypter;
 use Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface;
 
@@ -36,15 +36,15 @@ public function __construct(ApiKeyRepositoryInterface $repository, Encrypter $en
      * stored in the database.
      *
      * @param array $data
-     * @return \Pterodactyl\Models\APIKey
+     * @return \Pterodactyl\Models\ApiKey
      *
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
      */
-    public function handle(array $data): APIKey
+    public function handle(array $data): ApiKey
     {
         $data = array_merge($data, [
-            'identifier' => str_random(APIKey::IDENTIFIER_LENGTH),
-            'token' => $this->encrypter->encrypt(str_random(APIKey::KEY_LENGTH)),
+            'identifier' => str_random(ApiKey::IDENTIFIER_LENGTH),
+            'token' => $this->encrypter->encrypt(str_random(ApiKey::KEY_LENGTH)),
         ]);
 
         $instance = $this->repository->create($data, true, true);
diff --git a/app/Transformers/Api/Admin/BaseTransformer.php b/app/Transformers/Api/Admin/BaseTransformer.php
@@ -3,7 +3,7 @@
 namespace Pterodactyl\Transformers\Api\Admin;
 
 use Cake\Chronos\Chronos;
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Illuminate\Container\Container;
 use League\Fractal\TransformerAbstract;
 use Pterodactyl\Services\Acl\Api\AdminAcl;
@@ -13,17 +13,17 @@ abstract class BaseTransformer extends TransformerAbstract
     const RESPONSE_TIMEZONE = 'UTC';
 
     /**
-     * @var \Pterodactyl\Models\APIKey
+     * @var \Pterodactyl\Models\ApiKey
      */
     private $key;
 
     /**
      * Set the HTTP request class being used for this request.
      *
-     * @param \Pterodactyl\Models\APIKey $key
+     * @param \Pterodactyl\Models\ApiKey $key
      * @return $this
      */
-    public function setKey(APIKey $key)
+    public function setKey(ApiKey $key)
     {
         $this->key = $key;
 
@@ -33,9 +33,9 @@ public function setKey(APIKey $key)
     /**
      * Return the request instance being used for this transformer.
      *
-     * @return \Pterodactyl\Models\APIKey
+     * @return \Pterodactyl\Models\ApiKey
      */
-    public function getKey(): APIKey
+    public function getKey(): ApiKey
     {
         return $this->key;
     }
diff --git a/database/factories/ModelFactory.php b/database/factories/ModelFactory.php
@@ -223,11 +223,11 @@
     ];
 });
 
-$factory->define(Pterodactyl\Models\APIKey::class, function (Faker $faker) {
+$factory->define(Pterodactyl\Models\ApiKey::class, function (Faker $faker) {
     return [
         'id' => $faker->unique()->randomNumber(),
         'user_id' => $faker->randomNumber(),
-        'identifier' => str_random(Pterodactyl\Models\APIKey::IDENTIFIER_LENGTH),
+        'identifier' => str_random(Pterodactyl\Models\ApiKey::IDENTIFIER_LENGTH),
         'token' => 'encrypted_string',
         'memo' => 'Test Function Key',
         'created_at' => \Carbon\Carbon::now()->toDateTimeString(),
diff --git a/tests/Unit/Http/Controllers/Base/APIControllerTest.php b/tests/Unit/Http/Controllers/Base/APIControllerTest.php
@@ -4,7 +4,7 @@
 
 use Mockery as m;
 use Pterodactyl\Models\User;
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Prologue\Alerts\AlertsMessageBag;
 use Pterodactyl\Services\Api\KeyCreationService;
 use Tests\Unit\Http\Controllers\ControllerTestCase;
@@ -88,7 +88,7 @@ public function testStoreController($admin)
     {
         $this->setRequestMockClass(ApiKeyFormRequest::class);
         $model = $this->generateRequestUserModel(['root_admin' => $admin]);
-        $keyModel = factory(APIKey::class)->make();
+        $keyModel = factory(ApiKey::class)->make();
 
         if ($admin) {
             $this->request->shouldReceive('input')->with('admin_permissions', [])->once()->andReturn(['admin.permission']);
diff --git a/tests/Unit/Http/Middleware/Api/Admin/AuthenticateIPAccessTest.php b/tests/Unit/Http/Middleware/Api/Admin/AuthenticateIPAccessTest.php
@@ -2,7 +2,7 @@
 
 namespace Tests\Unit\Http\Middleware\Api\Admin;
 
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Tests\Unit\Http\Middleware\MiddlewareTestCase;
 use Pterodactyl\Http\Middleware\Api\Admin\AuthenticateIPAccess;
 
@@ -13,7 +13,7 @@ class AuthenticateIPAccessTest extends MiddlewareTestCase
      */
     public function testWithNoIPRestrictions()
     {
-        $model = factory(APIKey::class)->make(['allowed_ips' => []]);
+        $model = factory(ApiKey::class)->make(['allowed_ips' => []]);
         $this->setRequestAttribute('api_key', $model);
 
         $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
@@ -25,7 +25,7 @@ public function testWithNoIPRestrictions()
      */
     public function testWithValidIP()
     {
-        $model = factory(APIKey::class)->make(['allowed_ips' => ['127.0.0.1']]);
+        $model = factory(ApiKey::class)->make(['allowed_ips' => ['127.0.0.1']]);
         $this->setRequestAttribute('api_key', $model);
 
         $this->request->shouldReceive('ip')->withNoArgs()->once()->andReturn('127.0.0.1');
@@ -38,7 +38,7 @@ public function testWithValidIP()
      */
     public function testValidIPAganistCIDRRange()
     {
-        $model = factory(APIKey::class)->make(['allowed_ips' => ['192.168.1.1/28']]);
+        $model = factory(ApiKey::class)->make(['allowed_ips' => ['192.168.1.1/28']]);
         $this->setRequestAttribute('api_key', $model);
 
         $this->request->shouldReceive('ip')->withNoArgs()->once()->andReturn('192.168.1.15');
@@ -54,7 +54,7 @@ public function testValidIPAganistCIDRRange()
      */
     public function testWithInvalidIP()
     {
-        $model = factory(APIKey::class)->make(['allowed_ips' => ['127.0.0.1']]);
+        $model = factory(ApiKey::class)->make(['allowed_ips' => ['127.0.0.1']]);
         $this->setRequestAttribute('api_key', $model);
 
         $this->request->shouldReceive('ip')->withNoArgs()->once()->andReturn('127.0.0.2');
diff --git a/tests/Unit/Http/Middleware/Api/Admin/AuthenticateKeyTest.php b/tests/Unit/Http/Middleware/Api/Admin/AuthenticateKeyTest.php
@@ -3,7 +3,7 @@
 namespace Tests\Unit\Http\Middleware\Api;
 
 use Mockery as m;
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Illuminate\Auth\AuthManager;
 use Illuminate\Contracts\Encryption\Encrypter;
 use Tests\Unit\Http\Middleware\MiddlewareTestCase;
@@ -74,7 +74,7 @@ public function testInvalidIdentifier()
      */
     public function testValidToken()
     {
-        $model = factory(APIKey::class)->make();
+        $model = factory(ApiKey::class)->make();
 
         $this->request->shouldReceive('bearerToken')->withNoArgs()->twice()->andReturn($model->identifier . 'decrypted');
         $this->repository->shouldReceive('findFirstWhere')->with([['identifier', '=', $model->identifier]])->once()->andReturn($model);
@@ -93,7 +93,7 @@ public function testValidToken()
      */
     public function testInvalidTokenForIdentifier()
     {
-        $model = factory(APIKey::class)->make();
+        $model = factory(ApiKey::class)->make();
 
         $this->request->shouldReceive('bearerToken')->withNoArgs()->twice()->andReturn($model->identifier . 'asdf');
         $this->repository->shouldReceive('findFirstWhere')->with([['identifier', '=', $model->identifier]])->once()->andReturn($model);
diff --git a/tests/Unit/Services/Api/KeyCreationServiceTest.php b/tests/Unit/Services/Api/KeyCreationServiceTest.php
@@ -5,7 +5,7 @@
 use Mockery as m;
 use Tests\TestCase;
 use phpmock\phpunit\PHPMock;
-use Pterodactyl\Models\APIKey;
+use Pterodactyl\Models\ApiKey;
 use Illuminate\Contracts\Encryption\Encrypter;
 use Pterodactyl\Services\Api\KeyCreationService;
 use Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface;
@@ -40,48 +40,48 @@ public function setUp()
      */
     public function testKeyIsCreated()
     {
-        $model = factory(APIKey::class)->make();
+        $model = factory(ApiKey::class)->make();
 
         $this->getFunctionMock('\\Pterodactyl\\Services\\Api', 'str_random')
             ->expects($this->exactly(2))->willReturnCallback(function ($length) {
                 return 'str_' . $length;
             });
 
-        $this->encrypter->shouldReceive('encrypt')->with('str_' . APIKey::KEY_LENGTH)->once()->andReturn($model->token);
+        $this->encrypter->shouldReceive('encrypt')->with('str_' . ApiKey::KEY_LENGTH)->once()->andReturn($model->token);
 
         $this->repository->shouldReceive('create')->with([
             'test-data' => 'test',
-            'identifier' => 'str_' . APIKey::IDENTIFIER_LENGTH,
+            'identifier' => 'str_' . ApiKey::IDENTIFIER_LENGTH,
             'token' => $model->token,
         ], true, true)->once()->andReturn($model);
 
         $response = $this->getService()->handle(['test-data' => 'test']);
 
         $this->assertNotEmpty($response);
-        $this->assertInstanceOf(APIKey::class, $response);
+        $this->assertInstanceOf(ApiKey::class, $response);
         $this->assertSame($model, $response);
     }
 
     public function testIdentifierAndTokenAreOnlySetByFunction()
     {
-        $model = factory(APIKey::class)->make();
+        $model = factory(ApiKey::class)->make();
 
         $this->getFunctionMock('\\Pterodactyl\\Services\\Api', 'str_random')
             ->expects($this->exactly(2))->willReturnCallback(function ($length) {
                 return 'str_' . $length;
             });
 
-        $this->encrypter->shouldReceive('encrypt')->with('str_' . APIKey::KEY_LENGTH)->once()->andReturn($model->token);
+        $this->encrypter->shouldReceive('encrypt')->with('str_' . ApiKey::KEY_LENGTH)->once()->andReturn($model->token);
 
         $this->repository->shouldReceive('create')->with([
-            'identifier' => 'str_' . APIKey::IDENTIFIER_LENGTH,
+            'identifier' => 'str_' . ApiKey::IDENTIFIER_LENGTH,
             'token' => $model->token,
         ], true, true)->once()->andReturn($model);
 
         $response = $this->getService()->handle(['identifier' => 'customIdentifier', 'token' => 'customToken']);
 
         $this->assertNotEmpty($response);
-        $this->assertInstanceOf(APIKey::class, $response);
+        $this->assertInstanceOf(ApiKey::class, $response);
         $this->assertSame($model, $response);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -9,17 +9,17 @@`
`9`	`9`
`10`	`10`	`namespace Pterodactyl\Contracts\Repository;`
`11`	`11`
`12`		`-use Pterodactyl\Models\APIKey;`
	`12`	`+use Pterodactyl\Models\ApiKey;`
`13`	`13`
`14`	`14`	`interface ApiKeyRepositoryInterface extends RepositoryInterface`
`15`	`15`	`{`
`16`	`16`	`/**`
`17`	`17`	`* Load permissions for a key onto the model.`
`18`	`18`	`*`
`19`		`- * @param \Pterodactyl\Models\APIKey $model`
	`19`	`+ * @param \Pterodactyl\Models\ApiKey $model`
`20`	`20`	`* @param bool $refresh`
`21`	`21`	`* @deprecated`
`22`		`- * @return \Pterodactyl\Models\APIKey`
	`22`	`+ * @return \Pterodactyl\Models\ApiKey`
`23`	`23`	`*/`
`24`		`- public function loadPermissions(APIKey $model, bool $refresh = false): APIKey;`
	`24`	`+ public function loadPermissions(ApiKey $model, bool $refresh = false): ApiKey;`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Pterodactyl\Http\Requests\API\Admin;`
`4`	`4`
`5`		`-use Pterodactyl\Models\APIKey;`
	`5`	`+use Pterodactyl\Models\ApiKey;`
`6`	`6`	`use Illuminate\Foundation\Http\FormRequest;`
`7`	`7`	`use Pterodactyl\Exceptions\PterodactylException;`
`8`	`8`	`use Pterodactyl\Services\Acl\Api\AdminAcl as Acl;`
`@@ -66,9 +66,9 @@ public function rules(): array`
`66`	`66`	`/**`
`67`	`67`	`* Return the API key being used for the request.`
`68`	`68`	`*`
`69`		`- * @return \Pterodactyl\Models\APIKey`
	`69`	`+ * @return \Pterodactyl\Models\ApiKey`
`70`	`70`	`*/`
`71`		`- public function key(): APIKey`
	`71`	`+ public function key(): ApiKey`
`72`	`72`	`{`
`73`	`73`	`return $this->attributes->get('api_key');`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`use Sofa\Eloquence\Contracts\CleansAttributes;`
`11`	`11`	`use Sofa\Eloquence\Contracts\Validable as ValidableContract;`
`12`	`12`
`13`		`-class APIKey extends Model implements CleansAttributes, ValidableContract`
	`13`	`+class ApiKey extends Model implements CleansAttributes, ValidableContract`
`14`	`14`	`{`
`15`	`15`	`use Eloquence, Validable;`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Pterodactyl\Services\Acl\Api;`
`4`	`4`
`5`		`-use Pterodactyl\Models\APIKey;`
	`5`	`+use Pterodactyl\Models\ApiKey;`
`6`	`6`
`7`	`7`	`class AdminAcl`
`8`	`8`	`{`
`@@ -54,12 +54,12 @@ public static function can(int $permission, int $action = self::READ)`
`54`	`54`	`* Determine if an API Key model has permission to access a given resource`
`55`	`55`	`* at a specific action level.`
`56`	`56`	`*`
`57`		`- * @param \Pterodactyl\Models\APIKey $key`
	`57`	`+ * @param \Pterodactyl\Models\ApiKey $key`
`58`	`58`	`* @param string $resource`
`59`	`59`	`* @param int $action`
`60`	`60`	`* @return bool`
`61`	`61`	`*/`
`62`		`- public static function check(APIKey $key, string $resource, int $action = self::READ)`
	`62`	`+ public static function check(ApiKey $key, string $resource, int $action = self::READ)`
`63`	`63`	`{`
`64`	`64`	`return self::can(data_get($key, self::COLUMN_IDENTIFER . $resource, self::NONE), $action);`
`65`	`65`	`}`