Merging Teams in so far

libraries/botbuilder-core/botbuilder/core/bot_framework_adapter.py

@@ -12,8 +12,8 @@
     ConversationAccount,
     ConversationParameters,
     ConversationReference,
-    ResourceResponse,
     TokenResponse,
+    ResourceResponse,
 )
 from botframework.connector import Channels, EmulatorApiClient
 from botframework.connector.aio import ConnectorClient

libraries/botbuilder-core/botbuilder/core/teams/__init__.py

@@ -0,0 +1,10 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+from .teams_activity_handler import TeamsActivityHandler
+
+__all__ = ["TeamsActivityHandler"]

libraries/botbuilder-core/tests/teams/test_teams_activity_handler.py

@@ -0,0 +1,100 @@
+from typing import List
+
+import aiounittest
+from botbuilder.core import BotAdapter, TurnContext
+from botbuilder.core.teams import TeamsActivityHandler
+from botbuilder.schema import (
+    Activity,
+    ActivityTypes,
+    ChannelAccount,
+    ConversationReference,
+    MessageReaction,
+    ResourceResponse,
+)
+
+
+class TestingTeamsActivityHandler(TeamsActivityHandler):
+    def __init__(self):
+        self.record: List[str] = []
+
+    async def on_message_activity(self, turn_context: TurnContext):
+        self.record.append("on_message_activity")
+        return await super().on_message_activity(turn_context)
+
+    async def on_members_added_activity(
+        self, members_added: ChannelAccount, turn_context: TurnContext
+    ):
+        self.record.append("on_members_added_activity")
+        return await super().on_members_added_activity(members_added, turn_context)
+
+    async def on_members_removed_activity(
+        self, members_removed: ChannelAccount, turn_context: TurnContext
+    ):
+        self.record.append("on_members_removed_activity")
+        return await super().on_members_removed_activity(members_removed, turn_context)
+
+    async def on_message_reaction_activity(self, turn_context: TurnContext):
+        self.record.append("on_message_reaction_activity")
+        return await super().on_message_reaction_activity(turn_context)
+
+    async def on_reactions_added(
+        self, message_reactions: List[MessageReaction], turn_context: TurnContext
+    ):
+        self.record.append("on_reactions_added")
+        return await super().on_reactions_added(message_reactions, turn_context)
+
+    async def on_reactions_removed(
+        self, message_reactions: List[MessageReaction], turn_context: TurnContext
+    ):
+        self.record.append("on_reactions_removed")
+        return await super().on_reactions_removed(message_reactions, turn_context)
+
+    async def on_token_response_event(self, turn_context: TurnContext):
+        self.record.append("on_token_response_event")
+        return await super().on_token_response_event(turn_context)
+
+    async def on_event(self, turn_context: TurnContext):
+        self.record.append("on_event")
+        return await super().on_event(turn_context)
+
+    async def on_unrecognized_activity_type(self, turn_context: TurnContext):
+        self.record.append("on_unrecognized_activity_type")
+        return await super().on_unrecognized_activity_type(turn_context)
+
+
+class NotImplementedAdapter(BotAdapter):
+    async def delete_activity(
+        self, context: TurnContext, reference: ConversationReference
+    ):
+        raise NotImplementedError()
+
+    async def send_activities(
+        self, context: TurnContext, activities: List[Activity]
+    ) -> List[ResourceResponse]:
+        raise NotImplementedError()
+
+    async def update_activity(self, context: TurnContext, activity: Activity):
+        raise NotImplementedError()
+
+
+class TestTeamsActivityHandler(aiounittest.AsyncTestCase):
+    async def test_message_reaction(self):
+        # Note the code supports multiple adds and removes in the same activity though
+        # a channel may decide to send separate activities for each. For example, Teams
+        # sends separate activities each with a single add and a single remove.
+
+        # Arrange
+        activity = Activity(
+            type=ActivityTypes.message_reaction,
+            reactions_added=[MessageReaction(type="sad")],
+        )
+        turn_context = TurnContext(NotImplementedAdapter(), activity)
+
+        # Act
+        bot = TestingTeamsActivityHandler()
+        await bot.on_turn(turn_context)
+
+        # Assert
+        assert len(bot.record) == 2
+        assert bot.record[0] == "on_message_reaction_activity"
+        assert bot.record[1] == "on_reactions_added"

libraries/botbuilder-schema/botbuilder/schema/_connector_client_enums.py

@@ -27,6 +27,7 @@ class ActivityTypes(str, Enum):
     end_of_conversation = "endOfConversation"
     event = "event"
     invoke = "invoke"
+    invoke_response = "invokeResponse"
     delete_user_data = "deleteUserData"
     message_update = "messageUpdate"
     message_delete = "messageDelete"

libraries/botbuilder-schema/botbuilder/schema/teams/__init__.py

@@ -0,0 +1,15 @@
+from .team_info import TeamInfo
+from .notification_info import NotificationInfo
+from .tenant_info import TenantInfo
+from .channel_info import ChannelInfo
+from .teams_channel_data import TeamsChannelData
+from .teams_channel_account import TeamsChannelAccount
+
+__all__ = [
+    "TeamInfo",
+    "ChannelInfo",
+    "TeamsChannelData",
+    "TeamsChannelAccount",
+    "TenantInfo",
+    "NotificationInfo",
+]

libraries/botbuilder-schema/botbuilder/schema/teams/channel_info.py

@@ -0,0 +1,13 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+
+class ChannelInfo(object):
+    def __init__(self, id="", name=""):
+        self.id = id
+        self.name = name

libraries/botbuilder-schema/botbuilder/schema/teams/notification_info.py

@@ -0,0 +1,12 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+
+class NotificationInfo:
+    def __init__(self, alert: bool = False):
+        self.alert = alert

libraries/botbuilder-schema/botbuilder/schema/teams/team_info.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+
+class TeamInfo:
+    def __init__(self, id="", name="", aadGroupId=""):
+        self.id = id
+        self.name = name
+        self.aad_group_id = aadGroupId

libraries/botbuilder-schema/botbuilder/schema/teams/teams_channel_account.py

@@ -0,0 +1,31 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+from botbuilder.schema import ChannelAccount
+
+
+class TeamsChannelAccount(ChannelAccount):
+    def __init__(
+        self,
+        id="",
+        name="",
+        aad_object_id="",
+        role="",
+        given_name="",
+        surname="",
+        email="",
+        userPrincipalName="",
+    ):
+        super().__init__(
+            **{"id": id, "name": name, "aad_object_id": aad_object_id, "role": role}
+        )
+        self.given_name = given_name
+        self.surname = surname
+        self.email = email
+        # This isn't camel_cased because the JSON that makes this object isn't camel_case
+        self.user_principal_name = userPrincipalName

libraries/botbuilder-schema/botbuilder/schema/teams/teams_channel_data.py

@@ -0,0 +1,30 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+from botbuilder.schema.teams import ChannelInfo, TeamInfo, NotificationInfo, TenantInfo
+
+
+class TeamsChannelData:
+    def __init__(
+        self,
+        channel: ChannelInfo = None,
+        eventType="",
+        team: TeamInfo = None,
+        notification: NotificationInfo = None,
+        tenant: TenantInfo = None,
+    ):
+        self.channel = ChannelInfo(**channel) if channel is not None else ChannelInfo()
+        # This is not camel case because the JSON that makes this object isn't
+        self.event_type = eventType
+        self.team = TeamInfo(**team) if team is not None else TeamInfo()
+        self.notification = (
+            NotificationInfo(**notification)
+            if notification is not None
+            else NotificationInfo()
+        )
+        self.tenant = TenantInfo(**tenant) if tenant is not None else TenantInfo()

libraries/botbuilder-schema/botbuilder/schema/teams/tenant_info.py

@@ -0,0 +1,12 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+
+class TenantInfo:
+    def __init__(self, id=""):
+        self._id = id

scenarios/activity-update-and-delete/README.md

@@ -0,0 +1,30 @@
+# EchoBot
+
+Bot Framework v4 echo bot sample.
+
+This bot has been created using [Bot Framework](https://dev.botframework.com), it shows how to create a simple bot that accepts input from the user and echoes it back.
+
+## Running the sample
+- Clone the repository
+```bash
+git clone https://github.com/Microsoft/botbuilder-python.git
+```
+- Activate your desired virtual environment
+- Bring up a terminal, navigate to `botbuilder-python\samples\02.echo-bot` folder
+- In the terminal, type `pip install -r requirements.txt`
+- In the terminal, type `python app.py`
+
+## Testing the bot using Bot Framework Emulator
+[Microsoft Bot Framework Emulator](https://github.com/microsoft/botframework-emulator) is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.
+
+- Install the Bot Framework emulator from [here](https://github.com/Microsoft/BotFramework-Emulator/releases)
+
+### Connect to bot using Bot Framework Emulator
+- Launch Bot Framework Emulator
+- Paste this URL in the emulator window - http://localhost:3978/api/messages
+
+## Further reading
+
+- [Bot Framework Documentation](https://docs.botframework.com)
+- [Bot Basics](https://docs.microsoft.com/azure/bot-service/bot-builder-basics?view=azure-bot-service-4.0)
+- [Activity processing](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-concept-activity-processing?view=azure-bot-service-4.0)

scenarios/activity-update-and-delete/app.py

@@ -0,0 +1,92 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import asyncio
+import sys
+from datetime import datetime
+from types import MethodType
+
+from flask import Flask, request, Response
+from botbuilder.core import (
+    BotFrameworkAdapterSettings,
+    TurnContext,
+    BotFrameworkAdapter,
+)
+from botbuilder.schema import Activity, ActivityTypes
+
+from bots import ActivitiyUpdateAndDeleteBot
+
+# Create the loop and Flask app
+LOOP = asyncio.get_event_loop()
+APP = Flask(__name__, instance_relative_config=True)
+APP.config.from_object("config.DefaultConfig")
+
+# Create adapter.
+# See https://aka.ms/about-bot-adapter to learn more about how bots work.
+SETTINGS = BotFrameworkAdapterSettings(APP.config["APP_ID"], APP.config["APP_PASSWORD"])
+ADAPTER = BotFrameworkAdapter(SETTINGS)
+
+
+# Catch-all for errors.
+async def on_error(  # pylint: disable=unused-argument
+    self, context: TurnContext, error: Exception
+):
+    # This check writes out errors to console log .vs. app insights.
+    # NOTE: In production environment, you should consider logging this to Azure
+    #       application insights.
+    print(f"\n [on_turn_error] unhandled error: {error}", file=sys.stderr)
+
+    # Send a message to the user
+    await context.send_activity("The bot encountered an error or bug.")
+    await context.send_activity(
+        "To continue to run this bot, please fix the bot source code."
+    )
+    # Send a trace activity if we're talking to the Bot Framework Emulator
+    if context.activity.channel_id == "emulator":
+        # Create a trace activity that contains the error object
+        trace_activity = Activity(
+            label="TurnError",
+            name="on_turn_error Trace",
+            timestamp=datetime.utcnow(),
+            type=ActivityTypes.trace,
+            value=f"{error}",
+            value_type="https://www.botframework.com/schemas/error",
+        )
+        # Send a trace activity, which will be displayed in Bot Framework Emulator
+        await context.send_activity(trace_activity)
+
+
+ADAPTER.on_turn_error = MethodType(on_error, ADAPTER)
+ACTIVITY_IDS = []
+# Create the Bot
+BOT = ActivitiyUpdateAndDeleteBot(ACTIVITY_IDS)
+
+# Listen for incoming requests on /api/messages.s
+@APP.route("/api/messages", methods=["POST"])
+def messages():
+    # Main bot message handler.
+    if "application/json" in request.headers["Content-Type"]:
+        body = request.json
+    else:
+        return Response(status=415)
+
+    activity = Activity().deserialize(body)
+    auth_header = (
+        request.headers["Authorization"] if "Authorization" in request.headers else ""
+    )
+
+    try:
+        task = LOOP.create_task(
+            ADAPTER.process_activity(activity, auth_header, BOT.on_turn)
+        )
+        LOOP.run_until_complete(task)
+        return Response(status=201)
+    except Exception as exception:
+        raise exception
+
+
+if __name__ == "__main__":
+    try:
+        APP.run(debug=False, port=APP.config["PORT"])  # nosec debug
+    except Exception as exception:
+        raise exception

scenarios/activity-update-and-delete/bots/__init__.py

@@ -0,0 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .activity_update_and_delete_bot import ActivitiyUpdateAndDeleteBot
+
+__all__ = ["ActivitiyUpdateAndDeleteBot"]