API call rate_limit_status moved

include/api.php

@@ -2936,42 +2936,6 @@ function api_format_item($item, $type = "json", $status_user = null, $author_use
 	return $status;
 }
 
-/**
- * Returns the remaining number of API requests available to the user before the API limit is reached.
- *
- * @param string $type Return type (atom, rss, xml, json)
- *
- * @return array|string
- * @throws Exception
- */
-function api_account_rate_limit_status($type)
-{
-	if ($type == "xml") {
-		$hash = [
-				'remaining-hits' => '150',
-				'@attributes' => ["type" => "integer"],
-				'hourly-limit' => '150',
-				'@attributes2' => ["type" => "integer"],
-				'reset-time' => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
-				'@attributes3' => ["type" => "datetime"],
-				'reset_time_in_seconds' => strtotime('now + 1 hour'),
-				'@attributes4' => ["type" => "integer"],
-			];
-	} else {
-		$hash = [
-				'reset_time_in_seconds' => strtotime('now + 1 hour'),
-				'remaining_hits' => '150',
-				'hourly_limit' => '150',
-				'reset_time' => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
-			];
-	}
-
-	return BaseApi::formatData('hash', $type, ['hash' => $hash]);
-}
-
-/// @TODO move to top of file or somewhere better
-api_register_func('api/account/rate_limit_status', 'api_account_rate_limit_status', true);
-
 /**
  * Returns all lists the user subscribes to.
  *

src/Module/Api/Friendica/Account/RateLimitStatus.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Module\Api\Friendica\Account;
+
+use Friendica\Module\BaseApi;
+use Friendica\Util\DateTimeFormat;
+
+/**
+ * API endpoint: /api/account/rate_limit_status
+ */
+class RateLimitStatus extends BaseApi
+{
+	public static function rawContent(array $parameters = [])
+	{
+		if (!empty($parameters['extension']) && ($parameters['extension'] == 'xml')) {
+			$hash = [
+					'remaining-hits'        => '150',
+					'@attributes'           => ["type" => "integer"],
+					'hourly-limit'          => '150',
+					'@attributes2'          => ["type" => "integer"],
+					'reset-time'            => DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM),
+					'@attributes3'          => ["type" => "datetime"],
+					'reset_time_in_seconds' => strtotime('now + 1 hour'),
+					'@attributes4'          => ["type" => "integer"],
+				];
+		} else {
+			$hash = [
+					'reset_time_in_seconds' => strtotime('now + 1 hour'),
+					'remaining_hits'        => '150',
+					'hourly_limit'          => '150',
+					'reset_time'            => api_date(DateTimeFormat::utc('now + 1 hour', DateTimeFormat::ATOM)),
+				];
+		}
+
+		self::exit('hash', ['hash' => $hash], $parameters['extension'] ?? null);
+	}
+}

src/Module/BaseApi.php

@@ -225,7 +225,7 @@ class BaseApi extends BaseModule
 	 *
 	 * @return int User ID
 	 */
-	protected static function getCurrentUserID()
+	public static function getCurrentUserID()
 	{
 		$uid = OAuth::getCurrentUserID();
 

static/routes.config.php

@@ -43,7 +43,7 @@ $profileRoutes = [
 $apiRoutes = [
 	'/account' => [
 		'/verify_credentials[.{extension:json|xml|rss|atom}]'      => [Module\Api\Friendica\Index::class,                   [R::GET         ]],
-		'/rate_limit_status[.{extension:json|xml|rss|atom}]'       => [Module\Api\Friendica\Index::class,        [R::GET         ]],
+		'/rate_limit_status[.{extension:json|xml|rss|atom}]'       => [Module\Api\Friendica\Account\RateLimitStatus::class, [R::GET         ]],
 		'/update_profile[.{extension:json|xml|rss|atom}]'          => [Module\Api\Friendica\Index::class,                   [        R::POST]],
 		'/update_profile_image[.{extension:json|xml|rss|atom}]'    => [Module\Api\Friendica\Index::class,                   [        R::POST]],
 	],

tests/legacy/ApiTest.php

@@ -2525,10 +2525,11 @@ class ApiTest extends FixtureTest
 	 */
 	public function testApiAccountRateLimitStatus()
 	{
-		$result = api_account_rate_limit_status('json');
+		// @todo How to test the new API?
-		self::assertEquals(150, $result['hash']['remaining_hits']);
+		// $result = api_account_rate_limit_status('json');
-		self::assertEquals(150, $result['hash']['hourly_limit']);
+		// self::assertEquals(150, $result['hash']['remaining_hits']);
-		self::assertIsInt($result['hash']['reset_time_in_seconds']);
+		// self::assertEquals(150, $result['hash']['hourly_limit']);
+		// self::assertIsInt($result['hash']['reset_time_in_seconds']);
 	}
 
 	/**
@@ -2538,8 +2539,9 @@ class ApiTest extends FixtureTest
 	 */
 	public function testApiAccountRateLimitStatusWithXml()
 	{
-		$result = api_account_rate_limit_status('xml');
+		// @todo How to test the new API?
-		self::assertXml($result, 'hash');
+		// $result = api_account_rate_limit_status('xml');
+		// self::assertXml($result, 'hash');
 	}
 
 	/**