CABPI-365::AdobeAdminIms to AdobeIms code migration - updated class descriptions and fixed static test

Author: mahesh-singh-rajawat

app/code/Magento/AdminAdobeIms/Exception/AdobeImsOrganizationAuthorizationException.php

@@ -11,10 +11,13 @@
 
 /**
  * @api
+ *
+ * @deprecated
+ * @see \Magento\AdobeIms\Exception\AdobeImsOrganizationAuthorizationException
  */
 class AdobeImsOrganizationAuthorizationException extends AuthorizationException
 {
     public const ERROR_MESSAGE = 'The Adobe ID you\'re using does not belong to the organization ' .
-        'that controlling this Commerce instance. Contact your administrator so he can add your Adobe ID ' .
+        'that controls this Commerce instance. Contact your administrator so he can add your Adobe ID ' .
         'to the organization.';
 }

app/code/Magento/AdminAdobeIms/Service/ImsConfig.php

@@ -13,7 +13,6 @@
 
 class ImsConfig extends Config
 {
-    private const XML_PATH_ORGANIZATION_ID = 'adobe_ims/integration/organization_id';
     private const XML_PATH_LOGGING_ENABLED = 'adobe_ims/integration/logging_enabled';
     private const XML_PATH_NEW_ADMIN_EMAIL_TEMPLATE = 'adobe_ims/email/content_template';
 
@@ -69,14 +68,4 @@ public function getEmailTemplateForNewAdminUsers(): string
             self::XML_PATH_NEW_ADMIN_EMAIL_TEMPLATE
         );
     }
-
-    /**
-     * Retrieve Organization Id
-     *
-     * @return string
-     */
-    public function getOrganizationId(): string
-    {
-        return $this->scopeConfig->getValue(self::XML_PATH_ORGANIZATION_ID);
-    }
 }

app/code/Magento/AdminAdobeIms/composer.json

@@ -20,9 +20,6 @@
         "magento/module-jwt-user-token": "*",
         "magento/module-security": "*"
     },
-    "suggest": {
-        "magento/module-theme": "*"
-    },
     "type": "magento2-module",
     "license": [
         "OSL-3.0",

app/code/Magento/AdobeIms/Model/Authorization.php

@@ -13,6 +13,9 @@
 use Magento\Framework\HTTP\Client\Curl;
 use Magento\Framework\HTTP\Client\CurlFactory;
 
+/**
+ * Provide auth url and validate authorization
+ */
 class Authorization implements AuthorizationInterface
 {
     private const HTTP_REDIRECT_CODE = 302;

app/code/Magento/AdobeIms/Model/GetProfile.php

@@ -13,9 +13,11 @@
 use Magento\Framework\HTTP\Client\CurlFactory;
 use Magento\Framework\Serialize\Serializer\Json;
 
+/**
+ * Provide IMS user profile
+ */
 class GetProfile implements GetProfileInterface
 {
-
     /**
      * @var ConfigInterface
      */

app/code/Magento/AdobeIms/Model/GetToken.php

@@ -92,12 +92,6 @@ public function execute(string $code): TokenResponseInterface
      */
     public function getTokenResponse(string $code): TokenResponseInterface
     {
-        try {
-            return $this->execute($code);
-        } catch (AuthorizationException $exception) {
-            throw new AuthorizationException(
-                __($exception->getMessage())
-            );
-        }
+        return $this->execute($code);
     }
 }

app/code/Magento/AdobeIms/Model/LogOut.php

@@ -23,7 +23,6 @@
  */
 class LogOut implements LogOutInterface
 {
-
     /**
      * Successful result code.
      */
@@ -175,7 +174,7 @@ private function logoutAdminFromIms(string $accessToken): bool
     }
 
     /**
-     * Checks whether user profile could be got by the access token
+     * Check whether user profile could be retrieved by the access token
      *  - If the token is invalidated, profile information won't be returned
      *
      * @param string $accessToken

app/code/Magento/AdobeIms/Model/OrganizationMembership.php

@@ -10,12 +10,13 @@
 use Magento\AdobeIms\Exception\AdobeImsOrganizationAuthorizationException;
 use Magento\AdobeImsApi\Api\ConfigInterface;
 use Magento\AdobeImsApi\Api\OrganizationMembershipInterface;
-use Magento\Framework\Exception\AuthorizationException;
 use Magento\Framework\HTTP\Client\CurlFactory;
 
+/**
+ * Check if user is a member of Adobe Organization
+ */
 class OrganizationMembership implements OrganizationMembershipInterface
 {
-
     /**
      * @var ConfigInterface
      */

app/code/Magento/AdobeImsApi/Api/GetProfileInterface.php

@@ -19,7 +19,7 @@ interface GetProfileInterface
      * Get profile url
      *
      * @param string $code
-     * @return array|bool|float|int|mixed|string|null
+     * @return mixed
      * @throws AuthorizationException
      */
     public function getProfile(string $code);

app/code/Magento/AdobeImsApi/Api/IsTokenValidInterface.php

@@ -10,7 +10,7 @@
 use Magento\Framework\Exception\AuthorizationException;
 
 /**
- * Declare functionality for user login from the Adobe account
+ * Validate ims token
  *
  * @api
  */