Merge pull request #120 from CiscoDevNet/f-rename-spark-to-webex

annegentle · web-flow · commit 5d8914ddc60a · 2022-10-27T07:30:58.000-05:00
F rename spark to webex
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ Within this repository are several files and folders covering different topics a
 |  File / Folder  |  Description  | 
 |  ---  |  ---  | 
 |  [`env_lab.py`](env_lab.py)  |  A Python file containing lab infrastructure details for routers, switches and appliances leveraged in the different labs.  This file provides a centralized  Python `import` that is used in  other code samples to retrieve IPs, usernames, and passwords for connections  | 
-|  [`env_user.template`](env_user.template)  |  Similar to `env_lab.py`, this is a template for end users to copy within their own code repo as `env_user.py` where they can provide unique details for their own accounts.  For example, their Webex Teams (formerly Cisco Spark) authentication token.  Not all labs require this file, if one does it will be specified in setup.  | 
+|  [`env_user.template`](env_user.template)  |  Similar to `env_lab.py`, this is a template for end users to copy within their own code repo as `env_user.py` where they can provide unique details for their own accounts.  For example, their Webex authentication token.  Not all labs require this file, if one does it will be specified in setup.  | 
 |  [`requirements.txt`](requirements.txt)  |  Global Python requirements file containing the requirements for **all** labs within this repository.  Each folder also contains a local `requirements.txt` file.  | 
 |  [`intro-python/`](intro-python/)  |  Sample code and exercises for the [Python Fundamentals Learning Labs](https://developer.cisco.com/learning/modules/programming-fundamentals/intro-python-part1/step/1) <br> | 
 |  [`rest-api/`](rest-api/)  |  Sample code and exercises for the [REST API Fundamentals Learning Labs](https://developer.cisco.com/learning/modules/rest-api-fundamentals/hands-on-postman/step/1) <br>  | 
diff --git a/dev/python/template.py b/dev/python/template.py
@@ -46,7 +46,7 @@
 import env_user  # noqa
 
 
-spark = ciscosparkapi.CiscoSparkAPI(access_token=env_user.SPARK_ACCESS_TOKEN)
+spark = ciscosparkapi.CiscoSparkAPI(access_token=env_user.WEBEX_ACCESS_TOKEN)
 
 
 print(
@@ -63,8 +63,8 @@
 )
 
 
-print("Oh yeah... I'm also connected to Cisco Spark as:")
+print("Oh yeah... I'm also connected to Webex as:")
 print(spark.people.me())
 
 print("...and I'm posting things to the following Spark Room:")
-print(spark.rooms.get(env_user.SPARK_ROOM_ID))
+print(spark.rooms.get(env_user.WEBEX_ROOM_ID))
diff --git a/env_user.template b/env_user.template
@@ -34,8 +34,8 @@ SOFTWARE.
 
 # User Input
 
-SPARK_ACCESS_TOKEN = ""
-SPARK_ROOM_ID = ""
+WEBEX_ACCESS_TOKEN = ""
+WEBEX_ROOM_ID = ""
 MERAKI_API_KEY = "6bec40cf957de430a6f1f2baa056b99a4fac9ea0"
 
 # End User Input
diff --git a/intro-ansible/group_vars/sandbox.yml b/intro-ansible/group_vars/sandbox.yml
@@ -2,4 +2,3 @@ ansible_user: 'developer'
 ansible_ssh_pass: 'C1sco12345'
 ansible_port: 22
 netconf_port: 830
-
diff --git a/intro-cmx/cmx-04-mission/cmxnotificationreceiver.py b/intro-cmx/cmx-04-mission/cmxnotificationreceiver.py
@@ -34,7 +34,7 @@
 import datetime
 import os
 import re
-import ciscosparkapi
+import webexteamsapi
 from pprint import pprint
 from flask import Flask
 from flask import json
@@ -54,8 +54,8 @@
 import env_user  # noqa
 
 
-# Create a Cisco Spark object
-spark = ciscosparkapi.CiscoSparkAPI(access_token=env_user.SPARK_ACCESS_TOKEN)
+# Create a Webex object
+spark = ciscosparkapi.CiscoSparkAPI(access_token=env_user.WEBEX_ACCESS_TOKEN)
 
 requests.packages.urllib3.disable_warnings()
 app = Flask(__name__)
@@ -66,8 +66,7 @@ def create_notification(msg):
     global username
     global password
 
-    # MISSION TODO
-    endpoint = "https://" + url + "CMX API ENDPOINT TO CREATE NOTIFICATIONS"
+    endpoint = "https://" + url + "/api/config/v1/notification"
 
     payload = \
     {
@@ -77,7 +76,7 @@ def create_notification(msg):
             {
                 "conditions":[
                     {
-                        "condition": "locationupdate.macAddressList == MAC ADDRESS TO BE FOUND;"
+                        "condition": "locationupdate.macAddressList == 00:00:2a:01:00:4e;"
                     }
                 ]
             }
@@ -102,7 +101,7 @@ def create_notification(msg):
         "macScramblingSalt": "learning",
         "notificationType": "LocationUpdate"
     }
-    # END MISSION TODO
+
     headers = {"Content-Type": "application/json"}
 
     print(json.dumps(payload))
@@ -120,7 +119,7 @@ def notification_handler():
     deviceId = r_json["notifications"][0]["deviceId"]
     location = r_json["notifications"][0]["locationMapHierarchy"]
     spark.messages.create(
-        env_user.SPARK_ROOM_ID,
+        env_user.WEBEX_ROOM_ID,
         text="CMX Mission Accomplished!  Device " \
         + deviceId + " found at location: " + location,
     )
diff --git a/intro-cmx/cmx-04-mission/requirements.txt b/intro-cmx/cmx-04-mission/requirements.txt
@@ -1,4 +1,4 @@
-ciscosparkapi==0.9.2
+webexteamsapi
 requests==2.18.4
 requests-toolbelt==0.8.0
 Flask==0.12.2
diff --git a/intro-guestshell/mission01/mission.py b/intro-guestshell/mission01/mission.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-"""Sends configuration difference to Webex Teams, formerly Spark.
+"""Sends configuration difference to Webex Teams.
 
 Compares the current running configuration and the saved running
 configuration, creates diff and sends it to a Webex Teams room.
@@ -31,7 +31,7 @@
 import re
 
 from cli import cli, clip
-from ciscosparkapi import CiscoSparkAPI
+from webexteamssdk import WebexTeamsAPI
 
 
 BACKUP_CONFIG_IOS_PATH = 'flash:/running-config.bak'
@@ -127,15 +127,15 @@ def get_config_diff(backup_config_ios_path):
         return config_diff_lines
 
 
-def form_spark_message(config_diff_lines):
-    """Creates a Spark message formatted in markdown based on config diff
+def form_webex_message(config_diff_lines):
+    """Creates a Webex message formatted in markdown based on config diff
 
     Args:
         config_diff_lines (list): list of lines containing config
             difference
 
     Returns:
-        str: markdown Spark message as a string
+        str: markdown Webex message as a string
     """
     message = (
         'Configuration differences between '
@@ -150,7 +150,7 @@ def form_spark_message(config_diff_lines):
 
 
 def main():
-    spark_api = CiscoSparkAPI()
+    api = WebexTeamsAPI()
 
     # MISSION TODO 4: use the function that converts IOS path to
     # linux, which is defined in this file
@@ -177,12 +177,12 @@ def main():
         # END MISSION SECTION 6
         if config_diff_lines is not None:
             print('Changes have been found')
-            message = form_spark_message(config_diff_lines)
-            spark_api.messages.create(
-                roomId=os.environ.get('SPARK_ROOM_ID'),
+            message = form_webex_message(config_diff_lines)
+            api.messages.create(
+                roomId=os.environ.get('WEBEX_ROOM_ID'),
                 markdown=message,
             )
-            message = 'Spark message has been sent'
+            message = 'Webex message has been sent'
             print(message)
             send_syslog(message)
         else:
diff --git a/intro-mdp/mission01/netconf_configure_ips.py b/intro-mdp/mission01/netconf_configure_ips.py
@@ -27,7 +27,7 @@
 import sys
 from netconf_functions import check_ip, set_ip
 
-import ciscosparkapi
+from webexteamssdk import WebexTeamsAPI
 
 # Get the absolute path for the directory where this file is located "here"
 here = os.path.abspath(os.path.dirname(__file__))
@@ -41,8 +41,8 @@
 import env_lab  # noqa
 import env_user  # noqa
 
-# Create a Cisco Spark object
-spark = ciscosparkapi.CiscoSparkAPI(access_token=env_user.SPARK_ACCESS_TOKEN)
+# Create a Webex object
+webex = WebexTeamsAPI(access_token=env_user.WEBEX_ACCESS_TOKEN)
 
 # Create message list
 messages = [
@@ -79,4 +79,4 @@
     messages.append("Device {} IP set to {}".format(result[0], result[1]))
 
 # Post message to Spark
-spark.messages.create(roomId=env_user.SPARK_ROOM_ID, text="\n".join(messages))
+webex.messages.create(roomId=env_user.WEBEX_ROOM_ID, text="\n".join(messages))
diff --git a/intro-nfvis/mission01/mission.py b/intro-nfvis/mission01/mission.py
@@ -57,7 +57,7 @@
 
 requests.packages.urllib3.disable_warnings()
 
-spark = ciscosparkapi.CiscoSparkAPI(access_token=env_user.SPARK_ACCESS_TOKEN)
+spark = ciscosparkapi.CiscoSparkAPI(access_token=env_user.WEBEX_ACCESS_TOKEN)
 
 def nvfis_getgcred():
     login = NFVIS_USERNAME
@@ -202,6 +202,6 @@ def nfv_delete_vm(s, url, data):
     print (json.dumps(r_vm_device_deployment, indent=4, sort_keys=True))
 
     print ("STEP 6 - Send Spark message")
-    message = spark.messages.create(env_user.SPARK_ROOM_ID,
+    message = spark.messages.create(env_user.WEBEX_ROOM_ID,
             text='NFVIS mission completed')
     print (message)
diff --git a/intro-nfvis/requirements.txt b/intro-nfvis/requirements.txt
@@ -1,3 +1,4 @@
 ciscosparkapi==0.9.2
 requests==2.18.4
 urllib3==1.22
+webexteamssdk
diff --git a/requirements.txt b/requirements.txt
@@ -1,9 +1,9 @@
-ciscosparkapi==0.9.2
+webexteamssdk
 ncclient==0.6.0
 netmiko==1.4.2
 pyang==1.7.4
 requests==2.20.0
 urllib3==1.24.2
 xmltodict==0.11.0
 ansible==2.5.4
-PrettyTable==0.7.2
+PrettyTable==0.7.2
diff --git a/verify/backend/cmx.py b/verify/backend/cmx.py
@@ -3,7 +3,7 @@
 
 
 
-Copyright (c) 2018 Cisco and/or its affiliates.
+Copyright (c) 2018-2021 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
@@ -33,7 +33,7 @@ def verify() -> bool:
 
 
 
-    # Verify the Spark Room exists and is accessible via the access token
+    # Verify the Webex Room exists and is accessible via the access token
     try:
         r = requests.get(
             "https://cmxlocationsandbox.cisco.com/api/location/v2/clients",
diff --git a/verify/backend/iosxe.py b/verify/backend/iosxe.py
@@ -1,8 +1,8 @@
 #!/usr/bin/env python
 """Verify the IOS XE Devices are accessible and responding.
 
-Verify that user's provide SPARK_ACCESS_TOKEN is valid and that calls to the
-Cisco Spark APIs complete successfully.
+Verify that user's provide WEBEX_ACCESS_TOKEN is valid and that calls to the
+Webex APIs complete successfully.
 
 
 Copyright (c) 2018 Cisco and/or its affiliates.
diff --git a/verify/backend/meraki.py b/verify/backend/meraki.py
@@ -3,7 +3,7 @@
 
 
 
-Copyright (c) 2018 Cisco and/or its affiliates.
+Copyright (c) 2018-2021 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
@@ -32,7 +32,7 @@ def verify() -> bool:
 
 
 
-    # Verify the Spark Room exists and is accessible via the access token
+    # Verify the Webex Room exists and is accessible via the access token
     try:
         r = requests.get(
             "https://api.meraki.com/api/v0/organizations",
diff --git a/verify/backend/webex.py b/verify/backend/webex.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 """Verify the Cisco Webex APIs are accessible and responding.
 
-Verify that user's provide SPARK_ACCESS_TOKEN is valid and that calls to the
+Verify that user's provide WEBEX_ACCESS_TOKEN is valid and that calls to the
 Cisco Webex (formerly Spark) APIs complete successfully. Uses SPARK_
 for variable names; the product name is Cisco Webex.
 
@@ -31,7 +31,7 @@
 import os
 import sys
 
-import ciscosparkapi
+import webexteamssdk
 
 
 # Get the absolute path for the directory where this file is located "here"
@@ -53,21 +53,21 @@ def verify() -> bool:
     print("==> Verifying access to the Cisco Webex APIs")
 
     # Check to ensure the user has provided their Webex Access Token
-    if not env_user.SPARK_ACCESS_TOKEN:
+    if not env_user.WEBEX_ACCESS_TOKEN:
         print(
-            "\nFAILED: You must provide your SPARK_ACCESS_TOKEN in the "
+            "\nFAILED: You must provide your WEBEX_ACCESS_TOKEN in the "
             "env_user.py file.\n"
         )
         return False
 
-    spark = ciscosparkapi.CiscoSparkAPI(
-        access_token=env_user.SPARK_ACCESS_TOKEN
+    webexapi = webexteamssdk.WebexTeamsAPI(
+        access_token=env_user.WEBEX_ACCESS_TOKEN
     )
 
     # Verify the Cisco Webex APIs are accessible and responding
     try:
-        me = spark.people.me()
-    except ciscosparkapi.SparkApiError as e:
+        me = webexapi.people.me()
+    except webexapi.WebexApiError as e:
         print(
             "\nFAILED: The API call to Cisco Webex returned the following "
             "error:\n{}\n".format(e)
@@ -76,24 +76,24 @@ def verify() -> bool:
 
     else:
         print(
-            "\nYou are connected to Cisco Webex (formerly Cisco Spark) as: {}\n".format(me.emails[0])
+            "\nYou are connected to Cisco Webex (formerly Webex) as: {}\n".format(me.emails[0])
         )
 
     # Check to ensure the user has provided a Webex Room ID
-    if not env_user.SPARK_ROOM_ID:
+    if not env_user.WEBEX_ROOM_ID:
         print(
-            "\nFAILED: You must provide the SPARK_ROOM_ID of the room you "
+            "\nFAILED: You must provide the WEBEX_ROOM_ID of the room you "
             "want to work with in the env_user.py file.\n"
         )
         return False
 
     # Verify the Webex Room exists and is accessible via the access token
     try:
-        room = spark.rooms.get(env_user.SPARK_ROOM_ID)
-    except ciscosparkapi.SparkApiError as e:
+        room = webexapi.rooms.get(env_user.WEBEX_ROOM_ID)
+    except webexapi.WebexApiError as e:
         print(
             "\nFAILED: There was an error accessing the Webex Room using the "
-            "SPARK_ROOM_ID you provided; error details:\n{}\n".format(e)
+            "WEBEX_ROOM_ID you provided; error details:\n{}\n".format(e)
         )
         return False
     else:
diff --git a/verify/requirements.txt b/verify/requirements.txt
@@ -1,4 +1,4 @@
-ciscosparkapi==0.9.2
+webexteamsapi
 ncclient==0.6.2
 netmiko==1.4.2
 requests==2.18.4
diff --git a/verify/verify.py b/verify/verify.py
@@ -81,8 +81,8 @@
     print(f"ERROR: env_lab.py - Invalid ENVIRONMENT_IN_USE: {env_lab.ENVIRONMENT_IN_USE}")
     fail_bit = 1
 
-print(f"env_user.py - SPARK_ACCESS_TOKEN: {env_user.SPARK_ACCESS_TOKEN}")
-print(f"env_user.py - SPARK_ROOM_ID: {env_user.SPARK_ROOM_ID}")
+print(f"env_user.py - WEBEX_ACCESS_TOKEN: {env_user.WEBEX_ACCESS_TOKEN}")
+print(f"env_user.py - WEBEX_ROOM_ID: {env_user.WEBEX_ROOM_ID}")
 print(f"env_user.py - MERAKI_API_KEY: {env_user.MERAKI_API_KEY}\n")
 
 # Verify backend lab environments
