Support for contact vcards (#157)

* Add vcard parameter in send_contact function

* Add docs for send_contact

* Add attribute vcard in Contact class and related docs

* Fix PEP-8

* Fix documentation

* Fix documentation

* Add myself to project contributors

Author: ceri01

AUTHORS

@@ -15,6 +15,7 @@ Contributors:
     Ilya Otyutskiy <ilya.otyutskiy@icloud.com>
     Stefano Teodorani <s.teodorani@gmail.com>
     Francesco Zimbolo <dtrandom@randomdev.tk>
+    Daniele Ceribelli <danieleceribelli@gmail.com>
 
 Original author:
 

botogram/objects/media.py

@@ -247,6 +247,7 @@ class Contact(BaseObject):
     optional = {
         "last_name": str,
         "user_id": int,
+        "vcard": str,
     }
     _check_equality_ = "phone_number"
 

botogram/objects/mixins.py

@@ -355,7 +355,8 @@ def send_sticker(self, sticker=None, reply_to=None, extra=None,
                               expect=_objects().Message)
 
     @_require_api
-    def send_contact(self, phone, first_name, last_name=None, *, reply_to=None,
+    def send_contact(self, phone, first_name, last_name=None,
+                     vcard=None, *, reply_to=None,
                      extra=None, attach=None, notify=True):
         """Send a contact"""
         args = self._get_call_args(reply_to, extra, attach, notify)
@@ -364,6 +365,8 @@ def send_contact(self, phone, first_name, last_name=None, *, reply_to=None,
 
         if last_name is not None:
             args["last_name"] = last_name
+        if vcard is not None:
+            args["vcard"] = vcard
 
         return self._api.call("sendContact", args, expect=_objects().Message)
 

docs/api/telegram.rst

@@ -557,7 +557,7 @@ about its business.
 
          Now the method returns the sent message
 
-   .. py:method:: send_contact(phone, first_name, [last_name=None, reply_to=None, attach=None, extra=None, notify=True])
+   .. py:method:: send_contact(phone, first_name, [last_name=None, vcard=None, reply_to=None, attach=None, extra=None, notify=True])
 
       Send a contact to the user. A Telegram contact is made of its phone
       number (with the international prefix), its first name and optionally its
@@ -577,6 +577,7 @@ about its business.
       :param str phone: The phone number of the contact
       :param str first_name: The first name of the contact
       :param str last_name: The last name of the contact
+      :param str vcard: The contact vcard
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach
@@ -1438,7 +1439,7 @@ about its business.
 
          Now the method returns the sent message
 
-   .. py:method:: send_contact(phone, first_name, [last_name=None, reply_to=None, attach=None, extra=None, notify=True])
+   .. py:method:: send_contact(phone, first_name, [last_name=None, vcard=None, reply_to=None, attach=None, extra=None, notify=True])
 
       Send a contact to the chat. A Telegram contact is made of its phone
       number (with the international prefix), its first name and optionally its
@@ -1455,6 +1456,7 @@ about its business.
       :param str phone: The phone number of the contact
       :param str first_name: The first name of the contact
       :param str last_name: The last name of the contact
+      :param str vcard: The contact vcard
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach
@@ -2425,7 +2427,7 @@ about its business.
 
          Now the method returns the sent message
 
-   .. py:method:: reply_with_contact(phone, first_name, [last_name=None, attach=None, extra=None, notify=True])
+   .. py:method:: reply_with_contact(phone, first_name, [last_name=None, vcard=None, attach=None, extra=None, notify=True])
 
       Reply to this message with a contact. A Telegram contact is made of its
       phone number (with the international prefix), its first name and
@@ -2442,6 +2444,7 @@ about its business.
       :param str phone: The phone number of the contact
       :param str first_name: The first name of the contact
       :param str last_name: The last name of the contact
+      :param str vcard: The contact vcard
       :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach
       :param bool notify: If you want to trigger a notification on the client
@@ -2981,6 +2984,11 @@ about its business.
 
       *This attribute can be None if it's not provided by Telegram.*
 
+   .. py:attribute:: vcard
+
+      The vcard of the contact.
+
+      *This attribute can be None if it's not provided by Telegram.*
 
 .. py:class:: botogram.Location
 

docs/changelog/0.7.rst

@@ -71,6 +71,12 @@ New features
   * New method :py:meth:`Chat.remove_photo`
   * New attribute :py:attr:`Chat.photo`
 
+* Added support for vcards in contacts
+  * New argument ``vcard`` in :py:meth:`botogram.Chat.send_contact`
+  * New argument ``vcard`` in :py:meth:`botogram.User.send_contact`
+  * New argument ``vcard`` in :py:meth:`botogram.Message.reply_with_contact`
+  * New attribute :py:attr:`Contact.vcard`
+
 Bug fixes
 ---------