add rich menu sample code (#346)

Author: 4geru

examples/rich-menu/README.md

@@ -0,0 +1,11 @@
+# rich menu
+
+[Using rich menus](https://developers.line.biz/en/docs/messaging-api/using-rich-menus/)
+
+## Getting started
+
+```
+$ export LINE_CHANNEL_ACCESS_TOKEN=YOUR_LINE_CHANNEL_ACCESS_TOKEN
+$ pip install -r requirements.txt
+$ python app.py
+```

examples/rich-menu/app.py

@@ -0,0 +1,193 @@
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+
+from linebot import (
+    LineBotApi,
+)
+
+from linebot.models import (
+    RichMenu,
+    RichMenuArea,
+    RichMenuSize,
+    RichMenuBounds,
+    URIAction
+)
+from linebot.models.actions import RichMenuSwitchAction
+from linebot.models.rich_menu import RichMenuAlias
+
+channel_access_token = os.getenv('LINE_CHANNEL_ACCESS_TOKEN', None)
+if channel_access_token is None:
+    print('Specify LINE_CHANNEL_ACCESS_TOKEN as environment variable.')
+    sys.exit(1)
+
+line_bot_api = LineBotApi(channel_access_token)
+
+
+def rich_menu_object_a_json():
+    return {
+        "size": {
+            "width": 2500,
+            "height": 1686
+        },
+        "selected": False,
+        "name": "richmenu-a",
+        "chatBarText": "Tap to open",
+        "areas": [
+            {
+                "bounds": {
+                    "x": 0,
+                    "y": 0,
+                    "width": 1250,
+                    "height": 1686
+                },
+                "action": {
+                    "type": "uri",
+                    "uri": "https://www.line-community.me/"
+                }
+            },
+            {
+                "bounds": {
+                    "x": 1251,
+                    "y": 0,
+                    "width": 1250,
+                    "height": 1686
+                },
+                "action": {
+                    "type": "richmenuswitch",
+                    "richMenuAliasId": "richmenu-alias-b",
+                    "data": "richmenu-changed-to-b"
+                }
+            }
+        ]
+    }
+
+
+def rich_menu_object_b_json():
+    return {
+        "size": {
+            "width": 2500,
+            "height": 1686
+        },
+        "selected": False,
+        "name": "richmenu-b",
+        "chatBarText": "Tap to open",
+        "areas": [
+            {
+                "bounds": {
+                    "x": 0,
+                    "y": 0,
+                    "width": 1250,
+                    "height": 1686
+                },
+                "action": {
+                    "type": "richmenuswitch",
+                    "richMenuAliasId": "richmenu-alias-a",
+                    "data": "richmenu-changed-to-a"
+                }
+            },
+            {
+                "bounds": {
+                    "x": 1251,
+                    "y": 0,
+                    "width": 1250,
+                    "height": 1686
+                },
+                "action": {
+                    "type": "uri",
+                    "uri": "https://www.line-community.me/"
+                }
+            }
+        ]
+    }
+
+
+def create_action(action):
+    if action['type'] == 'uri':
+        return URIAction(type=action['type'], uri=action.get('uri'))
+    else:
+        return RichMenuSwitchAction(
+            type=action['type'],
+            rich_menu_alias_id=action.get('richMenuAliasId'),
+            data=action.get('data')
+        )
+
+
+def main():
+    # 2. Create rich menu A (richmenu-a)
+    rich_menu_object_a = rich_menu_object_a_json()
+    areas = [
+        RichMenuArea(
+            bounds=RichMenuBounds(
+                x=info['bounds']['x'],
+                y=info['bounds']['y'],
+                width=info['bounds']['width'],
+                height=info['bounds']['height']
+            ),
+            action=create_action(info['action'])
+        ) for info in rich_menu_object_a['areas']
+    ]
+
+    rich_menu_to_a_create = RichMenu(
+        size=RichMenuSize(width=rich_menu_object_a['size']['width'], height=rich_menu_object_a['size']['height']),
+        selected=rich_menu_object_a['selected'],
+        name=rich_menu_object_a['name'],
+        chat_bar_text=rich_menu_object_a['name'],
+        areas=areas
+    )
+
+    rich_menu_a_id = line_bot_api.create_rich_menu(rich_menu=rich_menu_to_a_create)
+
+    # 3. Upload image to rich menu A
+    with open('./public/richmenu-a.png', 'rb') as f:
+        line_bot_api.set_rich_menu_image(rich_menu_a_id, 'image/png', f)
+
+    # 4. Create rich menu B (richmenu-b)
+    rich_menu_object_b = rich_menu_object_b_json()
+    areas = [
+        RichMenuArea(
+            bounds=RichMenuBounds(
+                x=info['bounds']['x'],
+                y=info['bounds']['y'],
+                width=info['bounds']['width'],
+                height=info['bounds']['height']
+            ),
+            action=create_action(info['action'])
+        ) for info in rich_menu_object_b['areas']
+    ]
+
+    rich_menu_to_b_create = RichMenu(
+        size=RichMenuSize(width=rich_menu_object_b['size']['width'], height=rich_menu_object_b['size']['height']),
+        selected=rich_menu_object_b['selected'],
+        name=rich_menu_object_b['name'],
+        chat_bar_text=rich_menu_object_b['name'],
+        areas=areas
+    )
+
+    rich_menu_b_id = line_bot_api.create_rich_menu(rich_menu=rich_menu_to_b_create)
+
+    # 5. Upload image to rich menu B
+    with open('./public/richmenu-b.png', 'rb') as f:
+        line_bot_api.set_rich_menu_image(rich_menu_b_id, 'image/png', f)
+
+    # 6. Set rich menu A as the default rich menu
+    line_bot_api.set_default_rich_menu(rich_menu_b_id)
+
+    # 7. Create rich menu alias A
+    alias_a = RichMenuAlias(
+        rich_menu_alias_id='richmenu-alias-a',
+        rich_menu_id=rich_menu_a_id
+    )
+    line_bot_api.create_rich_menu_alias(alias_a)
+
+    # 8. Create rich menu alias B
+    alias_b = RichMenuAlias(
+        rich_menu_alias_id='richmenu-alias-b',
+        rich_menu_id=rich_menu_b_id
+    )
+    line_bot_api.create_rich_menu_alias(alias_b)
+    print('success')
+
+
+main()

examples/rich-menu/public/richmenu-a.png

@@ -0,0 +1 @@
+line-bot-sdk