Добавлен внутренний API для получения информации об аккаунте

api/modules/internal/controllers/AccountsController.php

@@ -9,6 +9,7 @@ use common\models\Account;
 use common\models\OauthScope as S;
 use Yii;
 use yii\helpers\ArrayHelper;
+use yii\web\BadRequestHttpException;
 use yii\web\NotFoundHttpException;
 
 class AccountsController extends Controller {
@@ -26,6 +27,11 @@ class AccountsController extends Controller {
                         'allow' => true,
                         'roles' => [S::ACCOUNT_BLOCK],
                     ],
+                    [
+                        'actions' => ['info'],
+                        'allow' => true,
+                        'roles' => [S::INTERNAL_ACCOUNT_INFO],
+                    ],
                 ],
             ],
         ]);
@@ -34,6 +40,7 @@ class AccountsController extends Controller {
     public function verbs() {
         return [
             'ban' => ['POST', 'DELETE'],
+            'info' => ['GET'],
         ];
     }
 
@@ -46,6 +53,29 @@ class AccountsController extends Controller {
         }
     }
 
+    public function actionInfo(int $id = null, string $username = null, string $uuid = null) {
+        if ($id !== null) {
+            $account = Account::findOne($id);
+        } elseif ($username !== null) {
+            $account = Account::findOne(['username' => $username]);
+        } elseif ($uuid !== null) {
+            $account = Account::findOne(['uuid' => $uuid]);
+        } else {
+            throw new BadRequestHttpException('One of the required get params must be presented.');
+        }
+
+        if ($account === null) {
+            throw new NotFoundHttpException('User by provided param not found.');
+        }
+
+        return [
+            'id' => $account->id,
+            'uuid' => $account->uuid,
+            'email' => $account->email,
+            'username' => $account->username,
+        ];
+    }
+
     private function banAccount(Account $account) {
         $model = new BanForm($account);
         $model->load(Yii::$app->request->post());

common/models/OauthScope.php

@@ -28,6 +28,11 @@ class OauthScope {
      * @owner machine
      */
     const ACCOUNT_BLOCK = 'account_block';
+    /**
+     * @internal
+     * @owner machine
+     */
+    const INTERNAL_ACCOUNT_INFO = 'internal_account_info';
 
     public static function find(): OauthScopeQuery {
         return new OauthScopeQuery(static::queryScopes());

tests/codeception/api/_pages/InternalRoute.php

@@ -18,4 +18,9 @@ class InternalRoute extends BasePage {
         $this->actor->sendDELETE($this->getUrl());
     }
 
+    public function info(string $param, string $value) {
+        $this->route = '/internal/accounts/info';
+        $this->actor->sendGET($this->getUrl(), [$param => $value]);
+    }
+
 }

tests/codeception/api/functional/internal/InfoCest.php

@@ -0,0 +1,74 @@
+<?php
+namespace tests\codeception\api\functional\internal;
+
+use common\models\OauthScope as S;
+use tests\codeception\api\_pages\InternalRoute;
+use tests\codeception\api\functional\_steps\OauthSteps;
+use tests\codeception\api\FunctionalTester;
+
+class InfoCest {
+
+    /**
+     * @var InternalRoute
+     */
+    private $route;
+
+    public function _before(FunctionalTester $I) {
+        $this->route = new InternalRoute($I);
+    }
+
+    public function testGetInfoById(OauthSteps $I) {
+        $accessToken = $I->getAccessTokenByClientCredentialsGrant([S::INTERNAL_ACCOUNT_INFO]);
+        $I->amBearerAuthenticated($accessToken);
+
+        $this->route->info('id', 1);
+        $this->expectSuccessResponse($I);
+    }
+
+    public function testGetInfoByUuid(OauthSteps $I) {
+        $accessToken = $I->getAccessTokenByClientCredentialsGrant([S::INTERNAL_ACCOUNT_INFO]);
+        $I->amBearerAuthenticated($accessToken);
+
+        $this->route->info('uuid', 'df936908-b2e1-544d-96f8-2977ec213022');
+        $this->expectSuccessResponse($I);
+    }
+
+    public function testGetInfoByUsername(OauthSteps $I) {
+        $accessToken = $I->getAccessTokenByClientCredentialsGrant([S::INTERNAL_ACCOUNT_INFO]);
+        $I->amBearerAuthenticated($accessToken);
+
+        $this->route->info('username', 'admin');
+        $this->expectSuccessResponse($I);
+    }
+
+    public function testInvalidParams(OauthSteps $I) {
+        $accessToken = $I->getAccessTokenByClientCredentialsGrant([S::INTERNAL_ACCOUNT_INFO]);
+        $I->amBearerAuthenticated($accessToken);
+
+        $this->route->info('', '');
+        $I->canSeeResponseCodeIs(400);
+    }
+
+    public function testAccountNotFound(OauthSteps $I) {
+        $accessToken = $I->getAccessTokenByClientCredentialsGrant([S::INTERNAL_ACCOUNT_INFO]);
+        $I->amBearerAuthenticated($accessToken);
+
+        $this->route->info('username', 'this-user-not-exists');
+        $I->canSeeResponseCodeIs(404);
+    }
+
+    /**
+     * @param OauthSteps $I
+     */
+    private function expectSuccessResponse(OauthSteps $I): void {
+        $I->canSeeResponseCodeIs(200);
+        $I->canSeeResponseIsJson();
+        $I->canSeeResponseContainsJson([
+            'id' => 1,
+            'uuid' => 'df936908-b2e1-544d-96f8-2977ec213022',
+            'email' => 'admin@ely.by',
+            'username' => 'Admin',
+        ]);
+    }
+
+}