Refactor Python Adaptive Cards

Author: cmlccie

webexteamssdk/__init__.py

@@ -32,6 +32,7 @@
 
 import logging
 
+import webexteamssdk.models.cards as cards
 from ._metadata import *
 from ._version import get_versions
 from .api import WebexTeamsAPI
@@ -41,11 +42,11 @@
 )
 from .models.dictionary import dict_data_factory
 from .models.immutable import (
-    AccessToken, AttachmentAction, Event, License, Membership, Message,
-    Organization, Person, Role, Room, Team, TeamMembership, Webhook,
-    WebhookEvent, immutable_data_factory,
+    AccessToken, AttachmentAction, Event, immutable_data_factory, License,
+    Membership, Message, Organization, Person, Role, Room, Team,
+    TeamMembership, Webhook, WebhookEvent,
 )
-from .models.simple import SimpleDataModel, simple_data_factory
+from .models.simple import simple_data_factory, SimpleDataModel
 from .utils import WebexTeamsDateTime
 
 
@@ -56,7 +57,3 @@
 # Initialize Package Logging
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
-
-from ._version import get_versions
-__version__ = get_versions()['version']
-del get_versions

webexteamssdk/api/messages.py

@@ -35,11 +35,12 @@
 from past.builtins import basestring
 from requests_toolbelt import MultipartEncoder
 
+from webexteamssdk.models.cards import AdaptiveCard
 from ..generator_containers import generator_container
 from ..restsession import RestSession
 from ..utils import (
     check_type, dict_from_items_with_values, is_local_file, is_web_url,
-    make_card_attachment, open_local_file,
+    make_attachment, open_local_file,
 )
 
 
@@ -191,11 +192,13 @@ def create(self, roomId=None, toPersonId=None, toPersonEmail=None,
         else:
             files = None
 
+        # Process and serialize attachments
         if attachments:
-            for attachment in attachments:
-                check_type(attachment, dict)
-        else:
-            attachments = None
+            for item, attachment in enumerate(attachments):
+                check_type(attachment, (dict, AdaptiveCard))
+
+                if isinstance(attachments, AdaptiveCard):
+                    attachments[item] = make_attachment(attachment)
 
         post_data = dict_from_items_with_values(
             request_parameters,
@@ -208,17 +211,6 @@ def create(self, roomId=None, toPersonId=None, toPersonEmail=None,
             attachments=attachments,
         )
 
-        # Add cards
-        if cards is not None:
-            cards_list = []
-
-            if isinstance(cards, list):
-                cards_list = [make_card_attachment(c) for c in cards]
-            else:
-                cards_list = [make_card_attachment(cards)]
-
-            post_data['attachments'] = cards_list
-
         # API request
         if not files or is_web_url(files[0]):
             # Standard JSON post

webexteamssdk/models/cards/__init__.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+"""Webex Teams Adaptive Cards data models.
+
+Copyright (c) 2016-2019 Cisco and/or its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from .adaptive_card_component import AdaptiveCardComponent
+from .card import AdaptiveCard
+from .components import (
+    Choice, Column, Fact, Image, Media, MediaSource,
+    TextBlock,
+)
+from .container import ColumnSet, Container, FactSet, ImageSet
+from .inputs import Choices, Date, Number, Text, Time, Toggle
+from .options import (
+    BlockElementHeight, ChoiceInputStyle, Colors,
+    ContainerStyle, FontSize, FontWeight, HorizontalAlignment, ImageSize,
+    ImageStyle, Spacing, TextInputStyle, VerticalContentAlignment,
+)

webexteamssdk/models/cards/abstract_components.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""Webex Teams Access-Tokens API wrapper.
+"""Webex Teams Adaptive Card actions.
 
 Copyright (c) 2016-2019 Cisco and/or its affiliates.
 
@@ -22,39 +22,48 @@
 SOFTWARE.
 """
 
-from .abstract_components import Serializable
+from .adaptive_card_component import AdaptiveCardComponent
 
-class OpenUrl(Serializable):
-    def __init__(self, url, title=None,
-                            iconURL=None):
-        self.type = "Action.OpenUrl"
+
+class OpenUrl(AdaptiveCardComponent):
+    """Open URL Action."""
+    type = "Action.OpenUrl"
+
+    def __init__(self, url, title=None, iconURL=None):
         self.title = title
         self.iconURL = iconURL
 
-        super().__init__(serializable_properties=[],
-                         simple_properties=['type', 'title', 'iconURL'])
+        super().__init__(
+            serializable_properties=[],
+            simple_properties=['type', 'title', 'iconURL'],
+        )
+
 
-class Submit(Serializable):
-    def __init__(self, data=None,
-                       title=None,
-                       iconURL=None,
-                       ):
-        self.type = "Action.Submit"
+class Submit(AdaptiveCardComponent):
+    """Submit Action."""
+    type = "Action.Submit"
+
+    def __init__(self, data=None, title=None, iconURL=None):
         self.data = data
         self.title = title
         self.iconURL = iconURL
 
-        super().__init__(serializable_properties=['data'],
-                         simple_properties=['title', 'iconURL', 'type'])
+        super().__init__(
+            serializable_properties=['data'],
+            simple_properties=['title', 'iconURL', 'type'],
+        )
+
+
+class ShowCard(AdaptiveCardComponent):
+    """Show Card Action."""
+    type = "Action.ShowCard"
 
-class ShowCard(Serializable):
-    def __init__(self, card=None,
-                       title=None,
-                       iconURL=None):
-        self.type = "Action.ShowCard"
+    def __init__(self, card=None, title=None, iconURL=None):
         self.card = card
         self.title = title
         self.iconURL = iconURL
 
-        super().__init__(serializable_properties=['card'],
-                         simple_properties=['title', 'type', 'iconURL'])
+        super().__init__(
+            serializable_properties=['card'],
+            simple_properties=['title', 'type', 'iconURL'],
+        )

webexteamssdk/models/cards/actions.py

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+"""Webex Teams Adaptive Card Component base class.
+
+Copyright (c) 2016-2019 Cisco and/or its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+import json
+
+
+class AdaptiveCardComponent:
+    """Base class for all Adaptive Card components.
+
+    Each component should inherit from this class and specify which of its
+    properties fall into the following two categories:
+
+    * Simple properties are basic types (int, float, str, etc.).
+
+    * Serializable properties are properties that can themselves be serialized.
+      This includes lists of items (i.e. the 'body' field of the adaptive card)
+      or single objects that also inherit from Serializable
+    """
+    def __init__(self, serializable_properties, simple_properties):
+        """Initialize a serializable object.
+
+        Args:
+            serializable_properties(list): List of all serializable properties
+            simple_properties(list): List of all simple properties.
+        """
+        self.serializable_properties = serializable_properties
+        self.simple_properties = simple_properties
+
+    def to_dict(self):
+        """Serialize the component into a Python dictionary.
+
+        The to_dict() method recursively serializes the object's data into
+        a Python dictionary.
+
+        Returns:
+            dict: Dictionary representation of this component.
+        """
+        serialized_data = {}
+
+        # Serialize simple properties
+        for property_name in self.simple_properties:
+            property_value = getattr(self, property_name, None)
+
+            if property_value is not None:
+                serialized_data[property_name] = str(property_value)
+
+        # Recursively serialize sub-components
+        for property_name in self.serializable_properties:
+            property_value = getattr(self, property_name, None)
+
+            if property_value is not None:
+                if isinstance(property_value, list):
+                    serialized_data[property_name] = [
+                        item.to_dict() for item in property_value
+                    ]
+                else:
+                    serialized_data[property_name] = property_value.to_dict()
+
+        return serialized_data
+
+    def to_json(self, **kwargs):
+        """Serialize the component into JSON text.
+
+        Any keyword arguments provided are passed through the Python JSON
+        encoder.
+        """
+        return json.dumps(self.to_dict(), **kwargs)