Add example Apps in additional languages - Python

examples/python/README.md

@@ -0,0 +1,7 @@
+### Pre-requisite
+- have python installed , preferably `>=3.0`
+- install the requirements mentioned in the `requirement.txt`
+- make required changes in the `settings.json` to run the app on custom url & port
+
+#### RUN the app 
+* `python3 hello-world.py`

examples/python/requirements.txt

@@ -0,0 +1,2 @@
+requests
+flask

examples/python/settings.json

@@ -0,0 +1,5 @@
+{
+    "port": "8080",
+    "root_url": "https://6fe6-103-157-160-168.in.ngrok.io",
+    "host": "0.0.0.0"
+}

examples/python/src/hello-world.py

@@ -0,0 +1,212 @@
+import logging
+import os
+import json
+
+import requests
+from flask import Flask, request
+
+logging.basicConfig(level=logging.DEBUG)
+
+app = Flask(__name__, static_url_path='/static', static_folder='./static')
+
+DEFAULT_APP_PORT = 8080
+DEFAULT_APP_HOST = 'localhost'
+DEFAULT_ROOT_URL = 'http://localhost:8080'
+FORM = {
+    'title': 'I am a form!',
+    'icon': 'icon.png',
+    'fields': [
+        {
+            'type': 'text',
+            'name': 'message',
+            'label': 'message',
+            'position': 1,
+        }
+    ],
+    'submit': {
+        'path': '/submit',
+    },
+}
+
+
+@app.route('/manifest.json')
+def manifest() -> dict:
+    return {
+        'app_id': 'hello-world',
+        'display_name': 'Hello world app',
+        'homepage_url': 'https://github.com/mattermost/mattermost-plugin-apps/tree/master/examples/python/hello-world',
+        'app_type': 'http',
+        'icon': 'icon.png',
+        'requested_permissions': ['act_as_bot'],
+        'on_install': {
+            'path': '/install',
+            'expand': {
+                'app': 'all',
+            },
+        },
+        'bindings': {
+            'path': '/bindings',
+        },
+        'requested_locations': [
+            '/channel_header',
+            '/command'
+        ],
+        'root_url': os.environ.get('root_url', DEFAULT_ROOT_URL),
+    }
+
+
+@app.route('/submit', methods=['POST'])
+def on_form_submit():
+    print(request.json)
+    return {'type': 'ok', 'text': f'Hello form got submitted. Form data: {request.json["values"]}'}
+
+
+@app.route('/bindings', methods=['GET', 'POST'])
+def on_bindings() -> dict:
+    print(f'bindings called with {request.data}')
+    return {
+        'type': 'ok',
+        'data': [
+            {
+                # binding for a command
+                'location': '/command',
+                'bindings': [
+                    {
+                        'description': 'test command',
+                        'hint': '[This is testing command]',
+                        # this will be the command displayed to user as /first-command
+                        'label': 'first-command',
+                        'icon': 'icon.png',
+                        'submit': {
+                            'path': '/first_command',
+                            # expand block is optional. This is more of metadata like which channel, team this command
+                            # was called from
+                            'expand': {
+                                'app': 'all',
+                                # if you want to expand team & channel, ensure that bot is added to the team & channel
+                                # else command will fail to expand the context
+                                # 'team': 'all',
+                                # 'channel': 'all',
+                            },
+                        },
+                    }
+                ],
+            },
+            {
+                # binding for a command, command with embedded form
+                'location': '/command',
+                'bindings': [
+                    {
+                        'description': 'test command',
+                        'hint': '[This is testing command]',
+                        # this will be the command displayed to user as /second-command
+                        'label': 'second-command',
+                        'icon': 'icon.png',
+                        'bindings': [
+                            {
+                                'location': 'send',
+                                'label': 'send',
+                                'form': FORM
+                            },
+                        ],
+                    }
+                ],
+            },
+            {
+                'location': '/channel_header',
+                'bindings': [
+                    {
+                        'location': 'send-button',
+                        'icon': 'icon.png',
+                        'label': 'send hello message',
+                        'form': FORM,
+                    },
+                ],
+            },
+        ],
+    }
+
+
+@app.route('/ping', methods=['POST'])
+def on_ping() -> dict:
+    logging.debug('ping...')
+    return {'type': 'ok'}
+
+
+@app.route('/install', methods=['GET', 'POST'])
+def on_install() -> dict:
+    print(f'on_install called with payload , {request.args}, {request.data}', flush=True)
+    _subscribe_team_join(request.json['context'])
+    return {'type': 'ok', 'data': []}
+
+
+@app.route('/first_command', methods=['POST'])
+def on_first_command():
+    print(f'/first_command called ')
+    response_message = 'Hello! response from /first_command'
+    return {'type': 'ok', 'text': response_message}
+
+
+@app.route('/bot_joined_team', methods=['GET', 'POST'])
+def on_bot_joined_team() -> dict:
+    context = request.json['context']
+    logging.info(
+        f'bot_joined_team event received for site:{context["mattermost_site_url"]}, '
+        f'team:{context["team"]["id"]} name:{context["team"]["name"]} '
+        f'{request.args} {request.data}'
+    )
+    # Here one can subscribe to channel_joined/left events as these required team_id now to be subscribed,
+    # hence use the team_id received in the event and make a call for subscribing to channel_joined/left events.
+    # Also supply {'team_id': team_id} in the request body of the subscription
+    # {
+    #    'subject': 'bot_joined_team',
+    #    'call': {
+    #        'path': '/bot_joined_team',
+    #         'expand': {
+    #             'app': 'all',
+    #             'team': 'all'
+    #         }
+    #    },
+    #    'team_id': 'team_id'   # get this team_id when bot_joined_team event occurs
+    # }
+    return {'type': 'ok', 'data': []}
+
+
+# Subscribing to events. For example, Subscribe to 'bot_joined_team' event
+def _subscribe_team_join(context: dict) -> None:
+    site_url = context['mattermost_site_url']
+    bot_access_token = context['bot_access_token']
+    url = site_url + 'plugins/com.mattermost.apps/api/v1/subscribe'
+    logging.info(f'Subscribing to team_join for {site_url}')
+    headers = {'Authorization': f'BEARER {bot_access_token}'}
+    body = {
+        'subject': 'bot_joined_team',
+        'call': {
+            'path': '/bot_joined_team',
+            'expand': {
+                'app': 'all',
+                'team': 'all'
+            }
+        },
+    }
+    res = requests.post(url, headers=headers, json=body)
+    if res.status_code != 200:
+        logging.error(f'Could not subscribe to team_join event for {site_url}')
+    else:
+        logging.debug(f'subscribed to team_join event for {site_url}')
+
+
+if __name__ == '__main__':
+    # load settings
+    root_dir = os.path.dirname(os.path.dirname(__file__))
+    with open(f'{root_dir}/settings.json') as config_file:
+        settings = json.load(config_file)
+        for env_name, env_value in settings.items():
+            os.environ[env_name] = env_value
+
+    app.run(
+        debug=True,
+        host=os.environ.get('host', DEFAULT_APP_HOST),
+        port=int(os.environ.get('port', DEFAULT_APP_PORT)),
+        use_reloader=False,
+    )