Merge pull request #260 from klassik2k16/master

Add new button types

Author: python273

examples/callback_bot.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+from flask import Flask
+import vk_api
+
+"""
+Пример бота для группы ВКонтакте использующего
+callback-api для получения сообщений.
+
+Подробнее: https://vk.com/dev/callback_api
+
+"""
+
+app = Flask(__name__)
+vk_session = vk_api.VkApi(token='your_group_token')
+vk = vk_session.get_api()
+
+access_code = "smthing code"
+
+@app.route('/my_bot', methods=['POST'])
+def bot():
+    # получаем данные из запроса
+    data = json.loads(request.data)
+    # ВКонтакте в своих запросах всегда отправляет поле type:
+    if 'type' not in data.keys():
+        return 'not ok'
+
+    # проверяем тип пришедшего события
+    if data['type'] == 'confirmation':
+        # если это запрос защитного кода
+        # отправляем его
+        return access_code
+    # если же это сообщение, отвечаем пользователю
+    elif data['type'] == 'message_new':
+        # получаем ID пользователя
+        from_id = data['object']['from_id']
+        # отправляем сообщение
+        vk.messages.send(message='Hello World!', random_id=0, peer_id=from_id)
+        # возвращаем серверу VK "ok" и код 200
+        return 'ok'
+
+# точка входа приложения
+if __name__ == '__main__':
+    # запускаем веб-сервер
+    app.run()

examples/keyboard.py

@@ -16,10 +16,17 @@ def main():
     keyboard.add_button('Зелёная кнопка', color=VkKeyboardColor.POSITIVE)
 
     keyboard.add_line()  # Переход на вторую строку
-    keyboard.add_button('Красная кнопка', color=VkKeyboardColor.NEGATIVE)
-
+    keyboard.add_location_button()
+    
+    keyboard.add_line()
+    keyboard.add_vkpay_button(hash="action=transfer-to-group&group_id=74030368&aid=6222115")
+    
     keyboard.add_line()
-    keyboard.add_button('Синяя кнопка', color=VkKeyboardColor.PRIMARY)
+    keyboard.add_vkapps_button(app_id=6979558, 
+                               owner_id=-181108510, 
+                               label="Отправить клавиатуру",
+                               hash="sendKeyboard")
+                               
 
     vk.messages.send(
         peer_id=123456,

vk_api/keyboard.py

@@ -1,8 +1,7 @@
 # -*- coding: utf-8 -*-
 """
-:authors: python273, Helow19274
+:authors: python273, Helow19274, klassik2k16
 :license: Apache License, Version 2.0, see LICENSE file
-
 :copyright: (c) 2019 python273
 """
 
@@ -13,6 +12,9 @@
 from .utils import sjson_dumps
 
 
+
+
+
 class VkKeyboardColor(Enum):
     """ Возможные цвета кнопок """
 
@@ -28,10 +30,25 @@ class VkKeyboardColor(Enum):
     #: Зелёная
     POSITIVE = 'positive'
 
+class VkKeyboardButton(Enum):
+    """ Возможные типы кнопки """
+
+    #: Кнопка с текстом
+    TEXT = "text"
+
+    #: Кнопка с местоположением
+    LOCATION = "location"
+
+    #: Кнопка с оплатой через VKPay
+    VKPAY = "vkpay"
+
+    #: Кнопка с приложением VK Apps
+    VKAPPS = "open_app"
+
+
 
 class VkKeyboard(object):
     """ Класс для создания клавиатуры для бота (https://vk.com/dev/bots_docs_3)
-
     :param one_time: Если True, клавиатура исчезнет после нажатия на кнопку
     :type one_time: bool
     """
@@ -61,14 +78,13 @@ def get_empty_keyboard(cls):
         return keyboard.get_keyboard()
 
     def add_button(self, label, color=VkKeyboardColor.DEFAULT, payload=None):
-        """ Добавить кнопку. Максимальное количество кнопок на строке - 4
+        """ Добавить кнопку с текстом.
+            Максимальное количество кнопок на строке - 4
 
         :param label: Надпись на кнопке и текст, отправляющийся при её нажатии.
         :type label: str
-
         :param color: цвет кнопки.
         :type color: VkKeyboardColor or str
-
         :param payload: Параметр для callback api
         :type payload: str or list or dict
         """
@@ -86,17 +102,118 @@ def add_button(self, label, color=VkKeyboardColor.DEFAULT, payload=None):
         if payload is not None and not isinstance(payload, six.string_types):
             payload = sjson_dumps(payload)
 
+        button_type = VkKeyboardButton.TEXT.value
+
         current_line.append({
             'color': color_value,
             'action': {
-                'type': 'text',
+                'type': button_type,
                 'payload': payload,
                 'label': label,
             }
         })
 
+    def add_location_button(self, payload=None):
+        """ Добавить кнопку с местоположением.
+            Всегда занимает всю ширину линии.
+
+        :param payload: Параметр для callback api
+        :type payload: str or list or dict
+        """
+
+        current_line = self.lines[-1]
+
+        if len(current_line) != 0:
+            raise ValueError(
+                    'This type of button takes the entire width of the line'
+                    )
+
+        if payload is not None and not isinstance(payload, six.string_types):
+            payload = sjson_dumps(payload)
+
+        button_type = VkKeyboardButton.LOCATION.value
+
+        current_line.append({
+            'action': {
+                'type': button_type,
+                'payload': payload
+            }
+        })
+
+    def add_vkpay_button(self, hash, payload=None):
+        """ Добавить кнопку с оплатой с помощью VKPay.
+            Всегда занимает всю ширину линии.
+
+        :param hash: Параметры платежа VKPay и ID приложения
+        (в поле aid) разделённые &
+        :type hash: str
+        :param payload: Параметр для совместимости со старыми клиентами
+        :type payload: str or list or dict
+        """
+
+        current_line = self.lines[-1]
+
+        if len(current_line) != 0:
+            raise ValueError(
+                    'This type of button takes the entire width of the line'
+                    )
+
+        if payload is not None and not isinstance(payload, six.string_types):
+            payload = sjson_dumps(payload)
+
+        button_type = VkKeyboardButton.VKPAY.value
+
+        current_line.append({
+            'action': {
+                'type': button_type,
+                'payload': payload,
+                'hash': hash
+            }
+        })
+
+    def add_vkapps_button(self, app_id, owner_id, label, hash, payload=None):
+        """ Добавить кнопку с приложением VK Apps.
+            Всегда занимает всю ширину линии.
+
+        :param app_id: Идентификатор вызываемого приложения с типом VK Apps
+        :type app_id: int
+        :param owner_id: Идентификатор сообщества, в котором установлено
+        приложение, если требуется открыть в контексте сообщества
+        :type owner_id: int
+        :param label: Название приложения, указанное на кнопке
+        :type label: str
+        :param hash: хэш для навигации в приложении, будет передан в строке
+        параметров запуска после символа #
+        :type hash: str
+        :param payload: Параметр для совместимости со старыми клиентами
+        :type payload: str or list or dict
+        """
+
+        current_line = self.lines[-1]
+
+        if len(current_line) != 0:
+            raise ValueError(
+                    'This type of button takes the entire width of the line'
+                    )
+
+        if payload is not None and not isinstance(payload, six.string_types):
+            payload = sjson_dumps(payload)
+
+        button_type = VkKeyboardButton.VKAPPS.value
+
+        current_line.append({
+            'action': {
+                'type': button_type,
+                'app_id': app_id,
+                'owner_id': owner_id,
+                'label': label,
+                'payload': payload,
+                'hash': hash
+            }
+        })
+
     def add_line(self):
-        """ Создаёт новую строчку, на которой можно размещать кнопки.
+        """ Создаёт новую строку, на которой можно размещать кнопки.
         Максимальное количество строк - 10.
         """