dvkei/Pterodactyl-Panel
1
0
Fork 0
forked from Alex/Pterodactyl-Panel
Code Issues Pull Requests Projects Releases Wiki Activity

Rename APIKey to ApiKey

Browse Source
This commit is contained in:
Dane Everitt 2018-01-14 12:06:15 -06:00
parent 7aa540b895
commit ad3a954256
No known key found for this signature in database
GPG Key ID: EEA66103B3D71F53
14 changed files with 53 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
app/Contracts/Repository/ApiKeyRepositoryInterface.php
View File

@ -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;
}

6
app/Http/Middleware/Api/Admin/AuthenticateKey.php
View File

@ -4,7 +4,7 @@ namespace Pterodactyl\Http\Middleware\Api\Admin;
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 @@ class AuthenticateKey
}
$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]]);

6
app/Http/Requests/API/Admin/ApiAdminRequest.php
View File

@ -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 @@ abstract class ApiAdminRequest extends FormRequest
/**
* 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');
}

2
app/Models/APIKey.php → app/Models/ApiKey.php
View File

@ -10,7 +10,7 @@ use Illuminate\Contracts\Encryption\Encrypter;
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;

4
app/Providers/MacroServiceProvider.php
View File

@ -13,7 +13,7 @@ use File;
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 @@ class MacroServiceProvider extends ServiceProvider
'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();
});
}

10
app/Repositories/Eloquent/ApiKeyRepository.php
View File

@ -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');

6
app/Services/Acl/Api/AdminAcl.php
View File

@ -2,7 +2,7 @@
namespace Pterodactyl\Services\Acl\Api;
use Pterodactyl\Models\APIKey;
use Pterodactyl\Models\ApiKey;
class AdminAcl
{
@ -54,12 +54,12 @@ class AdminAcl
* 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);
}

10
app/Services/Api/KeyCreationService.php
View File

@ -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 @@ class KeyCreationService
* 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);

12
app/Transformers/Api/Admin/BaseTransformer.php
View File

@ -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 @@ abstract class BaseTransformer extends TransformerAbstract
/**
* 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;
}

4
database/factories/ModelFactory.php
View File

@ -223,11 +223,11 @@ $factory->define(Pterodactyl\Models\DaemonKey::class, function (Faker $faker) {
];
});
$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(),

4
tests/Unit/Http/Controllers/Base/APIControllerTest.php
View File

@ -4,7 +4,7 @@ namespace Tests\Unit\Http\Controllers\Base;
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 @@ class APIControllerTest extends ControllerTestCase
{
$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']);

10
tests/Unit/Http/Middleware/Api/Admin/AuthenticateIPAccessTest.php
View File

@ -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 @@ class AuthenticateIPAccessTest extends MiddlewareTestCase
*/
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 @@ class AuthenticateIPAccessTest extends MiddlewareTestCase
*/
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 @@ class AuthenticateIPAccessTest extends MiddlewareTestCase
*/
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');

6
tests/Unit/Http/Middleware/Api/Admin/AuthenticateKeyTest.php
View File

@ -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 @@ class AuthenticateKeyTest extends MiddlewareTestCase
*/
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 @@ class AuthenticateKeyTest extends MiddlewareTestCase
*/
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);

18
tests/Unit/Services/Api/KeyCreationServiceTest.php
View File

@ -5,7 +5,7 @@ namespace Tests\Unit\Services\Api;
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 @@ class KeyCreationServiceTest extends TestCase
*/
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);
}