CABPI-365::AdobeAdminIms to AdobeIms code migration-updated interface names to represent correct behaviour

Author: mahesh-singh-rajawat

app/code/Magento/AdminAdobeIms/Console/Command/AdminAdobeImsEnableCommand.php

@@ -10,7 +10,7 @@
 use Magento\AdminAdobeIms\Service\ImsCommandOptionService;
 use Magento\AdminAdobeIms\Service\ImsConfig;
 use Magento\AdminAdobeIms\Service\UpdateTokensService;
-use Magento\AdobeImsApi\Api\GetAuthorizationUrlInterface;
+use Magento\AdobeImsApi\Api\AuthorizationInterface;
 use Magento\Framework\App\Cache\Type\Config;
 use Magento\Framework\App\Cache\TypeListInterface;
 use Magento\Framework\Console\Cli;
@@ -68,30 +68,30 @@ class AdminAdobeImsEnableCommand extends Command
     private UpdateTokensService $updateTokensService;
 
     /**
-     * @var GetAuthorizationUrlInterface
+     * @var AuthorizationInterface
      */
-    private GetAuthorizationUrlInterface $authorizationUrl;
+    private AuthorizationInterface $authorization;
 
     /**
      * @param ImsConfig $adminImsConfig
      * @param ImsCommandOptionService $imsCommandOptionService
      * @param TypeListInterface $cacheTypeList
      * @param UpdateTokensService $updateTokensService
-     * @param GetAuthorizationUrlInterface $authorizationUrl
+     * @param AuthorizationInterface $authorization
      */
     public function __construct(
         ImsConfig $adminImsConfig,
         ImsCommandOptionService $imsCommandOptionService,
         TypeListInterface $cacheTypeList,
         UpdateTokensService $updateTokensService,
-        GetAuthorizationUrlInterface $authorizationUrl
+        AuthorizationInterface $authorization
     ) {
         parent::__construct();
         $this->adminImsConfig = $adminImsConfig;
         $this->imsCommandOptionService = $imsCommandOptionService;
         $this->cacheTypeList = $cacheTypeList;
         $this->updateTokensService = $updateTokensService;
-        $this->authorizationUrl = $authorizationUrl;
+        $this->authorization = $authorization;
 
         $this->setName('admin:adobe-ims:enable')
             ->setDescription('Enable Adobe IMS Module.')
@@ -198,7 +198,7 @@ private function enableModule(
         string $organizationId,
         bool $isTwoFactorAuthEnabled
     ): bool {
-        $testAuth = $this->authorizationUrl->testAuth($clientId);
+        $testAuth = $this->authorization->testAuth($clientId);
         if ($testAuth) {
             $this->adminImsConfig->enableModule($clientId, $clientSecret, $organizationId, $isTwoFactorAuthEnabled);
             $this->cacheTypeList->cleanType(Config::TYPE_IDENTIFIER);

app/code/Magento/AdminAdobeIms/Console/Command/AdminAdobeImsInfoCommand.php

@@ -8,7 +8,7 @@
 namespace Magento\AdminAdobeIms\Console\Command;
 
 use Magento\AdminAdobeIms\Service\ImsConfig;
-use Magento\AdobeImsApi\Api\GetAuthorizationUrlInterface;
+use Magento\AdobeImsApi\Api\AuthorizationInterface;
 use Magento\Framework\Console\Cli;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -40,21 +40,21 @@ class AdminAdobeImsInfoCommand extends Command
     private ImsConfig $adminImsConfig;
 
     /**
-     * @var GetAuthorizationUrlInterface
+     * @var AuthorizationInterface
      */
-    private GetAuthorizationUrlInterface $authorizationUrl;
+    private AuthorizationInterface $authorization;
 
     /**
      * @param ImsConfig $adminImsConfig
-     * @param GetAuthorizationUrlInterface $authorizationUrl
+     * @param AuthorizationInterface $authorization
      */
     public function __construct(
         ImsConfig $adminImsConfig,
-        GetAuthorizationUrlInterface $authorizationUrl
+        AuthorizationInterface $authorization
     ) {
         parent::__construct();
         $this->adminImsConfig = $adminImsConfig;
-        $this->authorizationUrl = $authorizationUrl;
+        $this->authorization = $authorization;
 
         $this->setName('admin:adobe-ims:info')
             ->setDescription('Information of Adobe IMS Module configuration');
@@ -68,7 +68,7 @@ protected function execute(InputInterface $input, OutputInterface $output): ?int
         try {
             if ($this->adminImsConfig->enabled()) {
                 $clientId = $this->adminImsConfig->getApiKey();
-                if ($this->authorizationUrl->testAuth($clientId)) {
+                if ($this->authorization->testAuth($clientId)) {
                     $clientSecret = $this->adminImsConfig->getPrivateKey() ? 'configured' : 'not configured';
                     $output->writeln(self::CLIENT_ID_NAME . ': ' . $clientId);
                     $output->writeln(self::ORGANIZATION_ID_NAME . ': ' . $this->adminImsConfig->getOrganizationId());

app/code/Magento/AdminAdobeIms/Test/Unit/Command/AdminAdobeImsEnableCommandTest.php

@@ -12,7 +12,7 @@
 use Magento\AdminAdobeIms\Service\UpdateTokensService;
 use Magento\AdminAdobeIms\Service\ImsCommandOptionService;
 use Magento\AdminAdobeIms\Service\ImsConfig;
-use Magento\AdobeImsApi\Api\GetAuthorizationUrlInterface;
+use Magento\AdobeImsApi\Api\AuthorizationInterface;
 use Magento\Framework\App\Cache\Type\Config;
 use Magento\Framework\App\Cache\TypeListInterface;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
@@ -39,7 +39,7 @@ class AdminAdobeImsEnableCommandTest extends TestCase
     private $adminImsConfigMock;
 
     /**
-     * @var GetAuthorizationUrlInterface
+     * @var AuthorizationInterface
      */
     private $authorizationUrlMock;
 
@@ -73,7 +73,7 @@ protected function setUp(): void
         $objectManagerHelper = new ObjectManagerHelper($this);
 
         $this->adminImsConfigMock = $this->createMock(ImsConfig::class);
-        $this->authorizationUrlMock = $this->createMock(GetAuthorizationUrlInterface::class);
+        $this->authorizationUrlMock = $this->createMock(AuthorizationInterface::class);
         $this->imsCommandOptionService = $this->createMock(ImsCommandOptionService::class);
         $this->typeListInterface = $this->createMock(TypeListInterface::class);
         $this->updateTokensService = $this->createMock(UpdateTokensService::class);

app/code/Magento/AdminAdobeIms/ViewModel/LinkViewModel.php

@@ -7,7 +7,7 @@
 
 namespace Magento\AdminAdobeIms\ViewModel;
 
-use Magento\AdobeImsApi\Api\GetAuthorizationUrlInterface;
+use Magento\AdobeImsApi\Api\AuthorizationInterface;
 use Magento\Framework\Exception\InvalidArgumentException;
 use Magento\Framework\Message\ManagerInterface as MessageManagerInterface;
 use Magento\Framework\View\Element\Block\ArgumentInterface;
@@ -31,20 +31,20 @@ class LinkViewModel implements ArgumentInterface
     private MessageManagerInterface $messageManager;
 
     /**
-     * @param GetAuthorizationUrlInterface $authorization
+     * @param AuthorizationInterface $authorization
      * @param LoggerInterface $logger
      * @param MessageManagerInterface $messageManager
      */
     public function __construct(
-        GetAuthorizationUrlInterface $authorization,
+        AuthorizationInterface  $authorization,
         LoggerInterface $logger,
         MessageManagerInterface $messageManager
     ) {
         $this->logger = $logger;
         $this->messageManager = $messageManager;
 
         try {
-            $this->authUrl = $authorization->auth();
+            $this->authUrl = $authorization->getAuthUrl();
         } catch (InvalidArgumentException $e) {
             $this->logger->error($e->getMessage());
             $this->authUrl = null;

app/code/Magento/AdobeIms/Model/GetAuthorizationUrl.php renamed to app/code/Magento/AdobeIms/Model/Authorization.php

@@ -8,12 +8,12 @@
 namespace Magento\AdobeIms\Model;
 
 use Magento\AdobeImsApi\Api\ConfigInterface;
-use Magento\AdobeImsApi\Api\GetAuthorizationUrlInterface;
+use Magento\AdobeImsApi\Api\AuthorizationInterface;
 use Magento\Framework\Exception\InvalidArgumentException;
 use Magento\Framework\HTTP\Client\Curl;
 use Magento\Framework\HTTP\Client\CurlFactory;
 
-class GetAuthorizationUrl implements GetAuthorizationUrlInterface
+class Authorization implements AuthorizationInterface
 {
     private const HTTP_REDIRECT_CODE = 302;
 
@@ -46,7 +46,7 @@ public function __construct(
      * @return string
      * @throws InvalidArgumentException
      */
-    public function auth(?string $clientId = null): string
+    public function getAuthUrl(?string $clientId = null): string
     {
         $authUrl = $this->imsConfig->getAdminAdobeImsAuthUrl($clientId);
         return $this->getAuthorizationLocation($authUrl);
@@ -61,7 +61,7 @@ public function auth(?string $clientId = null): string
      */
     public function testAuth(string $clientId): bool
     {
-        $location = $this->auth($clientId);
+        $location = $this->getAuthUrl($clientId);
         return $location !== '';
     }
 

app/code/Magento/AdobeIms/Model/Auth/TokenResponse.php renamed to app/code/Magento/AdobeIms/Model/OAuth/TokenResponse.php

@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Magento\AdobeIms\Model\Auth;
+namespace Magento\AdobeIms\Model\OAuth;
 
 use Magento\AdobeImsApi\Api\Data\TokenResponseInterface;
 use Magento\Framework\DataObject;

app/code/Magento/AdobeIms/Test/Unit/Model/GetAuthorizationUrlTest.php

@@ -7,7 +7,7 @@
 
 namespace Magento\AdobeIms\Test\Unit\Model;
 
-use Magento\AdobeIms\Model\GetAuthorizationUrl;
+use Magento\AdobeIms\Model\Authorization;
 use Magento\AdobeImsApi\Api\ConfigInterface;
 use Magento\Framework\Exception\InvalidArgumentException;
 use Magento\Framework\HTTP\Client\Curl;
@@ -32,7 +32,7 @@ class GetAuthorizationUrlTest extends TestCase
     private $curlFactory;
 
     /**
-     * @var GetAuthorizationUrl
+     * @var Authorization
      */
     private $authorizationUrl;
 
@@ -47,7 +47,7 @@ protected function setUp(): void
         $this->curlFactory = $this->createMock(CurlFactory::class);
 
         $this->authorizationUrl = $objectManagerHelper->getObject(
-            GetAuthorizationUrl::class,
+            Authorization::class,
             [
                 'curlFactory' => $this->curlFactory,
                 'imsConfig' => $imsConfigMock
@@ -68,7 +68,7 @@ public function testAuthThrowsExceptionWhenResponseCodeIs200(): void
 
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Could not get a valid response from Adobe IMS Service.');
-        $this->authorizationUrl->auth();
+        $this->authorizationUrl->getAuthUrl();
     }
 
     public function testAuthThrowsExceptionWhenResponseContainsError(): void
@@ -84,6 +84,6 @@ public function testAuthThrowsExceptionWhenResponseContainsError(): void
 
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Could not connect to Adobe IMS Service: invalid_scope.');
-        $this->authorizationUrl->auth();
+        $this->authorizationUrl->getAuthUrl();
     }
 }

app/code/Magento/AdobeIms/Test/Unit/Model/GetTokenTest.php

@@ -8,7 +8,7 @@
 namespace Magento\AdobeIms\Test\Unit\Model;
 
 use Magento\AdobeIms\Model\GetToken;
-use Magento\AdobeIms\Model\Auth\TokenResponse;
+use Magento\AdobeIms\Model\OAuth\TokenResponse;
 use Magento\AdobeImsApi\Api\ConfigInterface;
 use Magento\AdobeImsApi\Api\Data\TokenResponseInterfaceFactory;
 use Magento\Framework\HTTP\Client\Curl;

app/code/Magento/AdobeIms/etc/di.xml

@@ -9,7 +9,7 @@
     <preference for="Magento\AdobeImsApi\Api\UserProfileRepositoryInterface" type="Magento\AdobeIms\Model\UserProfileRepository"/>
     <preference for="Magento\AdobeImsApi\Api\Data\UserProfileInterface" type="Magento\AdobeIms\Model\UserProfile"/>
     <preference for="Magento\AdobeImsApi\Api\ConfigInterface" type="Magento\AdobeIms\Model\Config"/>
-    <preference for="Magento\AdobeImsApi\Api\Data\TokenResponseInterface" type="Magento\AdobeIms\Model\Auth\TokenResponse"/>
+    <preference for="Magento\AdobeImsApi\Api\Data\TokenResponseInterface" type="Magento\AdobeIms\Model\OAuth\TokenResponse"/>
     <preference for="Magento\AdobeImsApi\Api\GetTokenInterface" type="Magento\AdobeIms\Model\GetToken"/>
     <preference for="Magento\AdobeImsApi\Api\GetImageInterface" type="Magento\AdobeIms\Model\GetImage"/>
     <preference for="Magento\AdobeImsApi\Api\UserAuthorizedInterface" type="Magento\AdobeIms\Model\UserAuthorized"/>
@@ -19,7 +19,7 @@
     <preference for="Magento\AdobeImsApi\Api\FlushUserTokensInterface" type="Magento\AdobeIms\Model\FlushUserTokens"/>
     <preference for="Magento\AdobeImsApi\Api\OrganizationMembershipInterface" type="Magento\AdobeIms\Model\OrganizationMembership"/>
     <preference for="Magento\AdobeImsApi\Api\TokenReaderInterface" type="Magento\AdobeIms\Model\TokenReader"/>
-    <preference for="Magento\AdobeImsApi\Api\GetAuthorizationUrlInterface" type="Magento\AdobeIms\Model\GetAuthorizationUrl"/>
+    <preference for="Magento\AdobeImsApi\Api\AuthorizationInterface" type="Magento\AdobeIms\Model\Authorization"/>
     <preference for="Magento\AdobeImsApi\Api\IsTokenValidInterface" type="Magento\AdobeIms\Model\IsTokenValid"/>
     <preference for="Magento\AdobeImsApi\Api\GetProfileInterface" type="Magento\AdobeIms\Model\GetProfile" />
 </config>

app/code/Magento/AdobeImsApi/Api/GetAuthorizationUrlInterface.php renamed to app/code/Magento/AdobeImsApi/Api/AuthorizationInterface.php

@@ -14,7 +14,7 @@
  *
  * @api
  */
-interface GetAuthorizationUrlInterface
+interface AuthorizationInterface
 {
     /**
      * Get authorization url
@@ -23,7 +23,7 @@ interface GetAuthorizationUrlInterface
      * @return string
      * @throws InvalidArgumentException
      */
-    public function auth(?string $clientId = null): string;
+    public function getAuthUrl(?string $clientId = null): string;
 
     /**
      * Test if given ClientID is valid and is able to return an authorization URL