Helper Python classes for handling and responding to Hangouts Chat events
Project description
Hangouts Chat Helper
Description
Helper Python classes for handling and responding to Hangouts Chat events.
Installation
Install with pip
:
pip install hangouts-helper
Message Components
This library contains several component classes to assist with constructing a Hangouts Chat message.
Message
Section
Card
CardAction
CardHeader
TextParagraph
KeyValue
Image
ButtonList
ImageButton
TextButton
Example
Using the Pizza Bot example from the official Hangouts Chat API documentation, this is how you'd construct the same message using the components above.
from hangouts_helper.message import (Message, Card, CardHeader, Section,
Image, KeyValue, ButtonList, TextButton)
message = Message()
message.add_card(
Card(
CardHeader(
title='Pizza Bot Customer Support',
subtitle='pizzabot@example.com',
image_url='https://goo.gl/aeDtrS'),
Section(
KeyValue(top_label='Order No.', content='12345'),
KeyValue(top_label='Status', content='In Delivery')),
Section(
'Location',
Image(image_url='https://maps.googleapis.com/...')),
Section(
ButtonList(
TextButton(text='OPEN ORDER').add_link(url='https://example.com/orders/...')))))
Calling message.output()
produces a dict
that can be converted to JSON... perfect for returning a response to a synchronous chat event, or sending a new message via the Hangouts Chat API.
{
"cards": [
{
"header": {
"imageUrl": "https://goo.gl/aeDtrS",
"subtitle": "pizzabot@example.com",
"title": "Pizza Bot Customer Support"
},
"sections": [
{
"widgets": [
{
"keyValue": {
"content": "12345",
"topLabel": "Order No."
}
},
{
"keyValue": {
"content": "In Delivery",
"topLabel": "Status"
}
}
]
},
{
"header": "Location",
"widgets": [
{
"image": {
"imageUrl": "https://maps.googleapis.com/..."
}
}
]
},
{
"widgets": [
{
"buttons": [
{
"textButton": {
"onClick": {
"openLink": {
"url": "https://example.com/orders/..."
}
},
"text": "OPEN ORDER"
}
}
]
}
]
}
]
}
]
}
Chat Handler
The library also includes a class to help with handling incoming chat events. The methods contained in HangoutsChatHandler
correspond to the different event types you can expect to receive. Each method should return a message response.
Example
from enum import Enum
from hangouts_helper.handler import HangoutsChatHandler, SpaceType
from hangouts_helper.message import Message
class ActionMethod(Enum):
BUTTON_CLICKED = 'BUTTON_CLICKED'
class MyHangoutsChatHandler(HangoutsChatHandler):
ActionMethod = ActionMethod
def handle_added_to_space(self, space_type, event):
if space_type == SpaceType.DM:
return Message(text="Thanks for DM'ing me!")
elif space_type == SpaceType.ROOM:
return Message(text="Thanks adding me to your room!")
def handle_message(self, message, event):
return Message(text="Thanks for your message!")
def handle_card_clicked(self, action_method, action_parameters, event):
if action_method == ActionMethod.BUTTON_CLICKED:
return Message(text="I've processed your button click!")
def handle_removed_from_space(self, event):
pass
A Flask app that repsonds to Hangouts Chat events might look like:
from flask import Flask, jsonify
app = Flask(__name__)
@app.route('/')
def bot_handler():
event = request.json
handler = MyHangoutsChatHandler()
response_message = handler.handle_event(event)
return jsonify(response_message.output())
TODO
- Add examples for each component type in README
- Document and add examples for adding OnClick events to widgets
- Document Enums (
SpaceType
,EventType
,ActionMethod
,Icon
,ImageStyle
,ResponseType
) - Document usage scenarios for
HangoutsChatHandler
- Add methods for interacting with Hangouts Chat API to
HangoutsChatHandler
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hangouts_helper-19.12.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 885c3e5f256c37d49bb0063c735cc31187b32268b020d99e49930b0e51f5c684 |
|
MD5 | c4afae8079b01d4beb50f5e6eb458a64 |
|
BLAKE2b-256 | f8322f133c8a5fce4760e0d68f655446184a597d96b47071c99a1363097b4f2a |