Использование центров уведомлений из Python

Вы можете получить доступ ко всем функциям Центров уведомлений из серверной части на Java/PHP/Python/Ruby с помощью REST-интерфейса Центров уведомлений, как описано в статье MSDN Notification Hubs REST APIs.

Из этой статьи вы узнаете, как выполнять следующие задачи:

• Создание клиента REST для функций Центров уведомлений в Python.
• Отправляйте уведомления с помощью интерфейса Python в REST API Notification Hub.
• Получите дамп HTTP-запроса REST/ответа для отладки или образовательных целей.

Вы можете следовать руководству по началу работы с выбранной мобильной платформой, реализуя серверную часть в Python.

Клиентский интерфейс

Основной клиентский интерфейс может предоставлять те же методы, которые доступны в пакете SDK для центров уведомлений .NET. Этот интерфейс позволяет непосредственно переводить все учебники и примеры, доступные на этом сайте, и созданные сообществом в интернете.

Вы можете найти весь код, доступный в примере оболочки REST Python.

Например, чтобы создать клиент, выполните приведенные ниже действия.

isDebug = True
hub = NotificationHub("myConnectionString", "myNotificationHubName", isDebug)

Чтобы отправить уведомление Windows, выполните приведенные действия.

wns_payload = """<toast><visual><binding template=\"ToastText01\"><text id=\"1\">Hello world!</text></binding></visual></toast>"""
hub.send_windows_notification(wns_payload)

Внедрение

Если вы еще не сделали этого, следуйте руководству по началу работы до последнего раздела, где необходимо реализовать внутренний интерфейс.

Все сведения о реализации полной оболочки REST можно найти на сайте MSDN. В этом разделе описывается реализация Python основных шагов, необходимых для доступа к конечным точкам REST Центров уведомлений и отправке уведомлений.

1. Анализ строки подключения
2. Сгенерировать токен авторизации
3. Отправка уведомления с помощью REST API HTTP

Анализ строки подключения

Ниже приведен основной класс, реализуемый клиентом, конструктор которого анализирует строку подключения:

class NotificationHub:
    API_VERSION = "?api-version=2013-10"
    DEBUG_SEND = "&test"

    def __init__(self, connection_string=None, hub_name=None, debug=0):
        self.HubName = hub_name
        self.Debug = debug

        # Parse connection string
        parts = connection_string.split(';')
        if len(parts) != 3:
            raise Exception("Invalid ConnectionString.")

        for part in parts:
            if part.startswith('Endpoint'):
                self.Endpoint = 'https' + part[11:].lower()
            if part.startswith('SharedAccessKeyName'):
                self.SasKeyName = part[20:]
            if part.startswith('SharedAccessKey'):
                self.SasKeyValue = part[16:]

Создание маркера безопасности

Подробные сведения о создании маркера безопасности доступны здесь. Добавьте следующие методы в класс NotificationHub для создания токена на основе URI текущей запроса и учетных данных, извлечённых из строки подключения.

@staticmethod
def get_expiry():
    # By default returns an expiration of 5 minutes (=300 seconds) from now
    return int(round(time.time() + 300))


@staticmethod
def encode_base64(data):
    return base64.b64encode(data)


def sign_string(self, to_sign):
    key = self.SasKeyValue.encode('utf-8')
    to_sign = to_sign.encode('utf-8')
    signed_hmac_sha256 = hmac.HMAC(key, to_sign, hashlib.sha256)
    digest = signed_hmac_sha256.digest()
    encoded_digest = self.encode_base64(digest)
    return encoded_digest


def generate_sas_token(self):
    target_uri = self.Endpoint + self.HubName
    my_uri = urllib.parse.quote(target_uri, '').lower()
    expiry = str(self.get_expiry())
    to_sign = my_uri + '\n' + expiry
    signature = urllib.parse.quote(self.sign_string(to_sign))
    auth_format = 'SharedAccessSignature sig={0}&se={1}&skn={2}&sr={3}'
    sas_token = auth_format.format(signature, expiry, self.SasKeyName, my_uri)
    return sas_token

Отправка уведомления с помощью REST API HTTP

Сначала давайте определим класс, представляющий уведомление.

class Notification:
    def __init__(self, notification_format=None, payload=None, debug=0):
        valid_formats = ['template', 'apple', 'gcm',
                         'windows', 'windowsphone', "adm", "baidu"]
        if not any(x in notification_format for x in valid_formats):
            raise Exception(
                "Invalid Notification format. " +
                "Must be one of the following - 'template', 'apple', 'gcm', 'windows', 'windowsphone', 'adm', 'baidu'")

        self.format = notification_format
        self.payload = payload

        # array with keynames for headers
        # Note: Some headers are mandatory: Windows: X-WNS-Type, WindowsPhone: X-NotificationType
        # Note: For Apple you can set Expiry with header: ServiceBusNotification-ApnsExpiry
        # in W3C DTF, YYYY-MM-DDThh:mmTZD (for example, 1997-07-16T19:20+01:00).
        self.headers = None

Этот класс представляет собой контейнер для собственного текста уведомлений или набора свойств уведомления шаблона, набора заголовков, содержащих формат (собственную платформу или шаблон) и свойства конкретной платформы (например, свойства срока действия Apple и заголовки WNS).

Ознакомьтесь с документацией по REST API Центров уведомлений и форматами конкретных платформ уведомлений для всех доступных параметров.

Теперь в этом классе напишите методы отправки уведомлений внутри класса NotificationHub.

def make_http_request(self, url, payload, headers):
    parsed_url = urllib.parse.urlparse(url)
    connection = http.client.HTTPSConnection(
        parsed_url.hostname, parsed_url.port)

    if self.Debug > 0:
        connection.set_debuglevel(self.Debug)
        # adding this querystring parameter gets detailed information about the PNS send notification outcome
        url += self.DEBUG_SEND
        print("--- REQUEST ---")
        print("URI: " + url)
        print("Headers: " + json.dumps(headers, sort_keys=True,
                                       indent=4, separators=(' ', ': ')))
        print("--- END REQUEST ---\n")

    connection.request('POST', url, payload, headers)
    response = connection.getresponse()

    if self.Debug > 0:
        # print out detailed response information for debugging purpose
        print("\n\n--- RESPONSE ---")
        print(str(response.status) + " " + response.reason)
        print(response.msg)
        print(response.read())
        print("--- END RESPONSE ---")

    elif response.status != 201:
        # Successful outcome of send message is HTTP 201 - Created
        raise Exception(
            "Error sending notification. Received HTTP code " + str(response.status) + " " + response.reason)

    connection.close()


def send_notification(self, notification, tag_or_tag_expression=None):
    url = self.Endpoint + self.HubName + '/messages' + self.API_VERSION

    json_platforms = ['template', 'apple', 'gcm', 'adm', 'baidu']

    if any(x in notification.format for x in json_platforms):
        content_type = "application/json"
        payload_to_send = json.dumps(notification.payload)
    else:
        content_type = "application/xml"
        payload_to_send = notification.payload

    headers = {
        'Content-type': content_type,
        'Authorization': self.generate_sas_token(),
        'ServiceBusNotification-Format': notification.format
    }

    if isinstance(tag_or_tag_expression, set):
        tag_list = ' || '.join(tag_or_tag_expression)
    else:
        tag_list = tag_or_tag_expression

    # add the tags/tag expressions to the headers collection
    if tag_list != "":
        headers.update({'ServiceBusNotification-Tags': tag_list})

    # add any custom headers to the headers collection that the user may have added
    if notification.headers is not None:
        headers.update(notification.headers)

    self.make_http_request(url, payload_to_send, headers)


def send_apple_notification(self, payload, tags=""):
    nh = Notification("apple", payload)
    self.send_notification(nh, tags)


def send_google_notification(self, payload, tags=""):
    nh = Notification("gcm", payload)
    self.send_notification(nh, tags)


def send_adm_notification(self, payload, tags=""):
    nh = Notification("adm", payload)
    self.send_notification(nh, tags)


def send_baidu_notification(self, payload, tags=""):
    nh = Notification("baidu", payload)
    self.send_notification(nh, tags)


def send_mpns_notification(self, payload, tags=""):
    nh = Notification("windowsphone", payload)

    if "<wp:Toast>" in payload:
        nh.headers = {'X-WindowsPhone-Target': 'toast',
                      'X-NotificationClass': '2'}
    elif "<wp:Tile>" in payload:
        nh.headers = {'X-WindowsPhone-Target': 'tile',
                      'X-NotificationClass': '1'}

    self.send_notification(nh, tags)


def send_windows_notification(self, payload, tags=""):
    nh = Notification("windows", payload)

    if "<toast>" in payload:
        nh.headers = {'X-WNS-Type': 'wns/toast'}
    elif "<tile>" in payload:
        nh.headers = {'X-WNS-Type': 'wns/tile'}
    elif "<badge>" in payload:
        nh.headers = {'X-WNS-Type': 'wns/badge'}

    self.send_notification(nh, tags)


def send_template_notification(self, properties, tags=""):
    nh = Notification("template", properties)
    self.send_notification(nh, tags)

Эти методы отправляют HTTP-запрос POST в конечную точку /messages центра уведомлений с правильным текстом и заголовками для отправки уведомления.

Использование свойства debug для включения подробного логирования

Включение свойства отладки при инициализации Центра уведомлений записывает подробные сведения о журнале http-запроса и дамп ответа, а также подробные результаты отправки сообщений уведомления. Свойство центров уведомлений TestSend возвращает подробную информацию о результатах отправки уведомлений. Чтобы использовать его, инициализируйте с помощью следующего кода:

hub = NotificationHub("myConnectionString", "myNotificationHubName", isDebug)

URL-адрес HTTP-запроса центра уведомлений добавляется с помощью строки запроса test.

Пройдите учебный курс

Теперь вы можете завершить руководство «Начало работы», отправив уведомление из серверной части на Python.

Инициализировать клиент Центров уведомлений (замените строку подключения и имя концентратора, как описано в руководстве по началу работы):

hub = NotificationHub("myConnectionString", "myNotificationHubName")

Затем добавьте код отправки в зависимости от целевой мобильной платформы. В этом примере также добавляются методы более высокого уровня для отправки уведомлений в зависимости от платформы, например, send_windows_notification для Windows; send_apple_notification для Apple и т. д.

Магазин Windows и Windows Phone 8.1 (без поддержки Silverlight)

wns_payload = """<toast><visual><binding template=\"ToastText01\"><text id=\"1\">Test</text></binding></visual></toast>"""
hub.send_windows_notification(wns_payload)

Windows Phone 8.0 и 8.1 Silverlight

hub.send_mpns_notification(toast)

iOS

alert_payload = {
    'data':
        {
            'msg': 'Hello!'
        }
}
hub.send_apple_notification(alert_payload)

Андроид

gcm_payload = {
    'data':
        {
            'msg': 'Hello!'
        }
}
hub.send_google_notification(gcm_payload)

Kindle Fire

adm_payload = {
    'data':
        {
            'msg': 'Hello!'
        }
}
hub.send_adm_notification(adm_payload)

Baidu

baidu_payload = {
    'data':
        {
            'msg': 'Hello!'
        }
}
hub.send_baidu_notification(baidu_payload)

При выполнении кода Python на целевом устройстве должно появиться уведомление.

Примеры

Включение свойства debug

При включении флага отладки при инициализации NotificationHub вы увидите подробный http-запрос и дамп ответа, а также NotificationOutcome, как показано ниже, где можно понять, какие заголовки HTTP передаются в запросе, и какой HTTP-ответ был получен из Центра уведомлений:

Например, вы увидите подробный результат Центра уведомлений.

• При успешном отправке сообщения в службу push-уведомлений.

  <Outcome>The Notification was successfully sent to the Push Notification System</Outcome>
  

• Если для push-уведомлений не найдены целевые объекты, скорее всего, вы увидите приведенные ниже выходные данные в качестве ответа (что указывает на отсутствие регистраций, обнаруженных для доставки уведомления, вероятно, из-за того, что регистрация имела некоторые несовпадные теги).

  '<NotificationOutcome xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="https://www.w3.org/2001/XMLSchema-instance"><Success>0</Success><Failure>0</Failure><Results i:nil="true"/></NotificationOutcome>'
  

Рассылка всплывающего уведомления в Windows

Обратите внимание на заголовки, которые отправляются при рассылке всплывающего широковещательного уведомления клиенту Windows.

hub.send_windows_notification(wns_payload)

Отправка уведомления с указанием тега (или выражения тега)

Обратите внимание на заголовок тегов HTTP, который добавляется в HTTP-запрос (в приведенном ниже примере уведомление отправляется только к правильным регистрациям с payload 'sports').

hub.send_windows_notification(wns_payload, "sports")

Отправка уведомления с указанием нескольких тегов

Обратите внимание, что заголовок HTTP тегов изменяется при отправке нескольких тегов.

tags = {'sports', 'politics'}
hub.send_windows_notification(wns_payload, tags)

Уведомление с шаблоном

Обратите внимание, что заголовок Format HTTP изменяется и текст полезных данных отправляется в составе текста HTTP-запроса:

Клиентская сторона — зарегистрированный шаблон:

var template = @"<toast><visual><binding template=""ToastText01""><text id=""1"">$(greeting_en)</text></binding></visual></toast>";

Серверная сторона — отправка нагрузки:

template_payload = {'greeting_en': 'Hello', 'greeting_fr': 'Salut'}
hub.send_template_notification(template_payload)

Дальнейшие шаги

В этой статье показано, как создать клиент REST Python для центров уведомлений. Здесь вы сможете:

• Скачайте полный пример оболочки REST Python, содержащий весь код в этой статье.
• Продолжите изучать функцию тегов в Центрах уведомлений в руководстве Breaking News
• Продолжить изучение функций шаблонов Центров уведомлений в руководстве по локализации новостей