Add new LoginUrl entity and login_url field for InlineKeyboard.

Author: noplanman

CHANGELOG.md

@@ -5,6 +5,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 
 ## [Unreleased]
 ### Added
+- Bot API 4.3 (Seamless Telegram Login, `LoginUrl`)
 ### Changed
 ### Deprecated
 ### Removed

src/Entities/InlineKeyboardButton.php

@@ -20,6 +20,7 @@
  *
  * @method string       getText()                         Label text on the button
  * @method string       getUrl()                          Optional. HTTP url to be opened when button is pressed
+ * @method LoginUrl     getLoginUrl()                     Optional. An HTTP URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
  * @method string       getCallbackData()                 Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes
  * @method string       getSwitchInlineQuery()            Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot’s username will be inserted.
  * @method string       getSwitchInlineQueryCurrentChat() Optional. If set, pressing the button will insert the bot‘s username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot’s username will be inserted.
@@ -28,6 +29,7 @@
  *
  * @method $this setText(string $text)                                                     Label text on the button
  * @method $this setUrl(string $url)                                                       Optional. HTTP url to be opened when button is pressed
+ * @method $this setLoginUrl(LoginUrl $login_url)                                                       Optional. HTTP url to be opened when button is pressed
  * @method $this setCallbackData(string $callback_data)                                    Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes
  * @method $this setSwitchInlineQuery(string $switch_inline_query)                         Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot’s username will be inserted.
  * @method $this setSwitchInlineQueryCurrentChat(string $switch_inline_query_current_chat) Optional. If set, pressing the button will insert the bot‘s username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot’s username will be inserted.
@@ -48,6 +50,7 @@ public static function couldBe($data)
         return is_array($data) &&
                array_key_exists('text', $data) && (
                    array_key_exists('url', $data) ||
+                   array_key_exists('login_url', $data) ||
                    array_key_exists('callback_data', $data) ||
                    array_key_exists('switch_inline_query', $data) ||
                    array_key_exists('switch_inline_query_current_chat', $data) ||
@@ -67,7 +70,7 @@ protected function validate()
 
         $num_params = 0;
 
-        foreach (['url', 'callback_data', 'callback_game', 'pay'] as $param) {
+        foreach (['url', 'login_url', 'callback_data', 'callback_game', 'pay'] as $param) {
             if ($this->getProperty($param, '') !== '') {
                 $num_params++;
             }
@@ -80,7 +83,7 @@ protected function validate()
         }
 
         if ($num_params !== 1) {
-            throw new TelegramException('You must use only one of these fields: url, callback_data, switch_inline_query, switch_inline_query_current_chat, callback_game, pay!');
+            throw new TelegramException('You must use only one of these fields: url, login_url, callback_data, switch_inline_query, switch_inline_query_current_chat, callback_game, pay!');
         }
     }
 
@@ -90,8 +93,8 @@ protected function validate()
     public function __call($method, $args)
     {
         // Only 1 of these can be set, so clear the others when setting a new one.
-        if (in_array($method, ['setUrl', 'setCallbackData', 'setSwitchInlineQuery', 'setSwitchInlineQueryCurrentChat', 'setCallbackGame', 'setPay'], true)) {
-            unset($this->url, $this->callback_data, $this->switch_inline_query, $this->switch_inline_query_current_chat, $this->callback_game, $this->pay);
+        if (in_array($method, ['setUrl', 'setLoginUrl', 'setCallbackData', 'setSwitchInlineQuery', 'setSwitchInlineQueryCurrentChat', 'setCallbackGame', 'setPay'], true)) {
+            unset($this->url, $this->login_url, $this->callback_data, $this->switch_inline_query, $this->switch_inline_query_current_chat, $this->callback_game, $this->pay);
         }
 
         return parent::__call($method, $args);

src/Entities/LoginUrl.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Longman\TelegramBot\Entities;
+
+/**
+ * Class LoginUrl
+ *
+ * This object represents a parameter of the inline keyboard button used to automatically authorize a user.
+ *
+ * @link https://core.telegram.org/bots/api#loginurl
+ *
+ * @method string getUrl()                An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.
+ * @method string getForwardText()        Optional. New text of the button in forwarded messages.
+ * @method string getBotUsername()        Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.
+ * @method bool   getRequestWriteAccess() Optional. Pass True to request the permission for your bot to send messages to the user.
+ */
+class LoginUrl extends Entity
+{
+
+}

tests/unit/Entities/InlineKeyboardButtonTest.php

@@ -33,7 +33,7 @@ public function testInlineKeyboardButtonNoTextFail()
 
     /**
      * @expectedException \Longman\TelegramBot\Exception\TelegramException
-     * @expectedExceptionMessage You must use only one of these fields: url, callback_data, switch_inline_query, switch_inline_query_current_chat, callback_game, pay!
+     * @expectedExceptionMessage You must use only one of these fields: url, login_url, callback_data, switch_inline_query, switch_inline_query_current_chat, callback_game, pay!
      */
     public function testInlineKeyboardButtonNoParameterFail()
     {
@@ -42,7 +42,7 @@ public function testInlineKeyboardButtonNoParameterFail()
 
     /**
      * @expectedException \Longman\TelegramBot\Exception\TelegramException
-     * @expectedExceptionMessage You must use only one of these fields: url, callback_data, switch_inline_query, switch_inline_query_current_chat, callback_game, pay!
+     * @expectedExceptionMessage You must use only one of these fields: url, login_url, callback_data, switch_inline_query, switch_inline_query_current_chat, callback_game, pay!
      */
     public function testInlineKeyboardButtonTooManyParametersFail()
     {