SearchKit updated.

Author: syslogic

src/SearchKit/SearchKit.php

@@ -1,15 +1,18 @@
 <?php
 namespace HMS\SearchKit;
 
+use HMS\AccountKit\AccountKit;
 use HMS\Core\Wrapper;
 use InvalidArgumentException;
 use stdClass;
 
 /**
  * Class HMS SearchKit Wrapper
  *
+ * Note: This API requires an "App-level client ID" & "Enable app-level client API".
+ *
+ * @see <a href="https://developer.huawei.com/consumer/en/doc/development/HMSCore-Guides/app-gallery-connect-0000001057712438">Configuring App Information in AppGallery Connect</a>
  * @see <a href="https://developer.huawei.com/consumer/en/doc/development/HMSCore-References/overview-0000001057087079">SearchKit</a>
- * @see <a href="https://developer.huawei.com/consumer/en/doc/development/HMSCore-Guides/open-platform-oauth-0000001053629189#section1022911426469">Authorization Code</a>
  * @author Martin Zeitler
  */
 class SearchKit extends Wrapper {
@@ -47,11 +50,10 @@ class SearchKit extends Wrapper {
 
     public function __construct( array|string $config ) {
         parent::__construct( $config );
-        if (is_array($config) && isset($config['access_token'])) {
-            $this->access_token = $config['access_token'];
-        } else {
-            throw new InvalidArgumentException('SearchKit requires an user access token.');
-        }
+
+        /* Obtain an access-token. */
+        $account_kit = new AccountKit( $config );
+        $this->access_token = $account_kit->get_access_token();
 
         // $this->base_url = Constants::SEARCH_KIT_BASE_URL;
         $this->base_url = Constants::SEARCH_KIT_BASE_URL_EU;
@@ -65,7 +67,7 @@ protected function post_init(): void {
         if (! in_array($this->base_url, $urls)) {
             throw new InvalidArgumentException('SearchKit permits these base_url values: '. implode(', ', $urls));
         }
-        unset($this->oauth2_client_secret, $this->oauth2_api_scope, $this->oauth2_api_scope, $this->oauth2_redirect_url);
+        unset($this->oauth2_client_secret, $this->oauth2_api_scope, $this->oauth2_redirect_url);
         unset($this->token_expiry, $this->refresh_token, $this->id_token, $this->package_name, $this->product_id);
         unset($this->agc_client_id, $this->agc_client_secret);
         unset($this->developer_id, $this->project_id);
@@ -79,7 +81,7 @@ protected function auth_header(): array {
             "Content-Type" => "application/json; charset=utf-8",
             "Authorization" => "Bearer $this->access_token",
             "X-Kit-AppID" => $this->oauth2_client_id,
-            // "X-Kit-ClientIP" => $this->client_ip,
+            "X-Kit-ClientIP" => $this->client_ip,
             "X-Kit-RequestID" => $this->request_id
         ];
     }

tests/BaseTestCase.php

@@ -35,6 +35,8 @@ abstract class BaseTestCase extends TestCase {
     protected static ?string $agc_gateway             = 'https://connect-drcn.dbankcloud.cn/';
     private const ENV_VAR_OAUTH2_CLIENT_ID            = 'Variable HUAWEI_OAUTH2_CLIENT_ID is not set.';
     private const ENV_VAR_OAUTH2_CLIENT_SECRET        = 'Variable HUAWEI_OAUTH2_CLIENT_SECRET is not set.';
+    private const ENV_VAR_APP_LEVEL_CLIENT_ID         = 'Variable HUAWEI_APP_LEVEL_CLIENT_ID is not set.'; // TODO
+    private const ENV_VAR_APP_LEVEL_CLIENT_SECRET     = 'Variable HUAWEI_APP_LEVEL_CLIENT_SECRET is not set.'; // TODO
     protected const ENV_VAR_CONNECT_API_CLIENT_ID     = 'Variable HUAWEI_CONNECT_API_CLIENT_ID is not set.';
     protected const ENV_VAR_CONNECT_API_CLIENT_SECRET = 'Variable HUAWEI_CONNECT_API_CLIENT_SECRET is not set.';
     protected const ENV_VAR_CONNECT_PRODUCT_ID        = 'Variable HUAWEI_CONNECT_PRODUCT_ID is not set.';
@@ -118,12 +120,12 @@ protected static function load_user_access_token() {
                         file_put_contents(self::$oauth2_token_path, json_encode($token_response));
                     }
                     $remaining = $token_response->token_expiry - time();
-                    echo sprintf('The cached token expires in %02d:%02d:%02d.', ($remaining / 3600), ($remaining / 60 % 60), $remaining % 60);
+                    echo sprintf('The cached user access token expires in %02d:%02d:%02d.', ($remaining / 3600), ($remaining / 60 % 60), $remaining % 60);
                 }
             }
             self::$user_access_token = $token_response->access_token;
         } else {
-            self::markTestSkipped( "Cannot read cached token: " . self::$oauth2_token_path);
+            self::markTestSkipped( "Cannot read cached user access token: " . self::$oauth2_token_path);
         }
     }
     protected static function format_filesize(int $bytes, int $decimals=2): string {

tests/SearchKitTest.php

@@ -21,8 +21,11 @@ class SearchKitTest extends BaseTestCase {
     /** This method is called before the first test of this test class is run. */
     public static function setUpBeforeClass(): void {
         parent::setUpBeforeClass();
+        self::$oauth2_client_id = getenv('HUAWEI_APP_LEVEL_CLIENT_ID');
+        self::$oauth2_client_secret = getenv('HUAWEI_APP_LEVEL_CLIENT_SECRET');
         self::$client = new SearchKit( array_merge(self::get_user_config(), [
             'oauth2_client_id' => self::$oauth2_client_id,
+            'oauth2_client_secret' => self::$oauth2_client_secret,
             'debug_mode' => false
         ] ));
         self::assertTrue( self::$client->is_ready(), self::CLIENT_NOT_READY );