Update examples

Update the example code with Cisco Spark to Webex Teams name changes, copyright and license headers, and PEP8 fixes.

Author: cmlccie

examples/bot-example-flask.py

@@ -10,18 +10,37 @@
 if your machine sits behind a firewall.
 
 You must create a Spark webhook that points to the URL where this script is
-hosted.  You can do this via the CiscoSparkAPI.webhooks.create() method.
+hosted.  You can do this via the WebexTeamsAPI.webhooks.create() method.
 
 Additional Spark webhook details can be found here:
-https://developer.ciscospark.com/webhooks-explained.html
+https://developer.webex.com/webhooks-explained.html
 
 A bot must be created and pointed to this server in the My Apps section of
-https://developer.ciscospark.com.  The bot's Access Token should be added as a
-'SPARK_ACCESS_TOKEN' environment variable on the web server hosting this
+https://developer.webex.com.  The bot's Access Token should be added as a
+'WEBEX_TEAMS_ACCESS_TOKEN' environment variable on the web server hosting this
 script.
 
 This script supports Python versions 2 and 3.
 
+Copyright (c) 2016-2018 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.
 """
 
 
@@ -53,8 +72,10 @@
 
 
 # Initialize the environment
-flask_app = Flask(__name__)             # Create the web application instance
-spark_api = WebexTeamsAPI()             # Create the Webex Teams API connection object
+# Create the web application instance
+flask_app = Flask(__name__)
+# Create the Webex Teams API connection object
+spark_api = WebexTeamsAPI()
 
 
 # Helper functions
@@ -72,7 +93,8 @@ def get_catfact():
 
 
 # Core bot functionality
-@flask_app.route('/sparkwebhook', methods=['GET', 'POST'])                     # Your Spark webhook should point to http://<serverip>:5000/sparkwebhook
+# Your Spark webhook should point to http://<serverip>:5000/sparkwebhook
+@flask_app.route('/sparkwebhook', methods=['GET', 'POST'])
 def sparkwebhook():
     """Processes incoming requests to the '/sparkwebhook' URI."""
     if request.method == 'GET':
@@ -96,16 +118,21 @@ def sparkwebhook():
     elif request.method == 'POST':
         """Respond to inbound webhook JSON HTTP POST from Webex Teams."""
 
-        json_data = request.json                                               # Get the POST data sent from Webex Teams
+        # Get the POST data sent from Webex Teams
+        json_data = request.json
         print("\n")
         print("WEBHOOK POST RECEIVED:")
         print(json_data)
         print("\n")
 
-        webhook_obj = Webhook(json_data)                                       # Create a Webhook object from the JSON data
-        room = spark_api.rooms.get(webhook_obj.data.roomId)                    # Get the room details
-        message = spark_api.messages.get(webhook_obj.data.id)                  # Get the message details
-        person = spark_api.people.get(message.personId)                        # Get the sender's details
+        # Create a Webhook object from the JSON data
+        webhook_obj = Webhook(json_data)
+        # Get the room details
+        room = spark_api.rooms.get(webhook_obj.data.roomId)
+        # Get the message details
+        message = spark_api.messages.get(webhook_obj.data.id)
+        # Get the sender's details
+        person = spark_api.people.get(message.personId)
 
         print("NEW MESSAGE IN ROOM '{}'".format(room.title))
         print("FROM '{}'".format(person.displayName))
@@ -123,9 +150,11 @@ def sparkwebhook():
             # Message was sent by someone else; parse message and respond.
             if "/CAT" in message.text:
                 print("FOUND '/CAT'")
-                cat_fact = get_catfact()                                       # Get a cat fact
+                # Get a cat fact
+                cat_fact = get_catfact()
                 print("SENDING CAT FACT '{}'".format(cat_fact))
-                spark_api.messages.create(room.id, text=cat_fact)              # Post the fact to the room where the request was received
+                # Post the fact to the room where the request was received
+                spark_api.messages.create(room.id, text=cat_fact)
             return 'OK'
 
 

examples/bot-example-webpy.py

@@ -8,20 +8,39 @@
 your server if you don't wish to expose your machine publicly to the Internet.
 
 You must create a Spark webhook that points to the URL where this script is
-hosted.  You can do this via the CiscoSparkAPI.webhooks.create() method.
+hosted.  You can do this via the WebexTeamsAPI.webhooks.create() method.
 
 Additional Spark webhook details can be found here:
-https://developer.ciscospark.com/webhooks-explained.html
+https://developer.webex.com/webhooks-explained.html
 
 A bot must be created and pointed to this server in the My Apps section of
-https://developer.ciscospark.com.  The bot's Access Token should be added as a
-'SPARK_ACCESS_TOKEN' environment variable on the web server hosting this
+https://developer.webex.com.  The bot's Access Token should be added as a
+'WEBEX_TEAMS_ACCESS_TOKEN' environment variable on the web server hosting this
 script.
 
 NOTE:  While this script is written to support Python versions 2 and 3, as of
 the time of this writing web.py (v0.38) only supports Python 2.
 Therefore this script only supports Python 2.
 
+Copyright (c) 2016-2018 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.
 """
 
 
@@ -53,9 +72,12 @@
 
 
 # Global variables
-urls = ('/sparkwebhook', 'webhook')                                             # Your Spark webhook should point to http://<serverip>:8080/sparkwebhook
-app = web.application(urls, globals())                                          # Create the web application instance
-api = WebexTeamsAPI()                                                           # Create the Webex Teams API connection object
+# Your Spark webhook should point to http://<serverip>:8080/sparkwebhook
+urls = ('/sparkwebhook', 'webhook')
+# Create the web application instance
+app = web.application(urls, globals())
+# Create the Webex Teams API connection object
+api = WebexTeamsAPI()
 
 
 def get_catfact():
@@ -74,14 +96,19 @@ def get_catfact():
 class webhook(object):
     def POST(self):
         """Respond to inbound webhook JSON HTTP POSTs from Webex Teams."""
-        json_data = web.data()                                                  # Get the POST data sent from Spark
+        # Get the POST data sent from Spark
+        json_data = web.data()
         print("\nWEBHOOK POST RECEIVED:")
         print(json_data, "\n")
 
-        webhook_obj = Webhook(json_data)                                        # Create a Webhook object from the JSON data
-        room = api.rooms.get(webhook_obj.data.roomId)                           # Get the room details
-        message = api.messages.get(webhook_obj.data.id)                         # Get the message details
-        person = api.people.get(message.personId)                               # Get the sender's details
+        # Create a Webhook object from the JSON data
+        webhook_obj = Webhook(json_data)
+        # Get the room details
+        room = api.rooms.get(webhook_obj.data.roomId)
+        # Get the message details
+        message = api.messages.get(webhook_obj.data.id)
+        # Get the sender's details
+        person = api.people.get(message.personId)
 
         print("NEW MESSAGE IN ROOM '{}'".format(room.title))
         print("FROM '{}'".format(person.displayName))
@@ -98,9 +125,11 @@ def POST(self):
             # Message was sent by someone else; parse message and respond.
             if "/CAT" in message.text:
                 print("FOUND '/CAT'")
-                cat_fact = get_catfact()                                        # Get a cat fact
+                # Get a cat fact
+                cat_fact = get_catfact()
                 print("SENDING CAT FACT '{}'".format(cat_fact))
-                api.messages.create(room.id, text=cat_fact)                     # Post the fact to the room where the request was received
+                # Post the fact to the room where the request was received
+                api.messages.create(room.id, text=cat_fact)
         return 'OK'
 
 

examples/ngrokwebhook.py

@@ -13,6 +13,25 @@
 To use script simply launch ngrok, and then launch this script.  After ngrok is
 killed, run this script a second time to remove webhook from Webex Teams.
 
+Copyright (c) 2016-2018 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.
 """
 
 

examples/people.py

@@ -3,9 +3,28 @@
 """ Script to demonstrate the use of webexteamssdk for the people API
 
 The package natively retrieves your Spark access token from the
-SPARK_ACCESS_TOKEN environment variable.  You must have this environment
+WEBEX_TEAMS_ACCESS_TOKEN environment variable.  You must have this environment
 variable set to run this script.
 
+Copyright (c) 2016-2018 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.
 """
 
 
@@ -27,7 +46,9 @@
 from webexteamssdk import WebexTeamsAPI
 
 
-api = WebexTeamsAPI()                           # Create a CiscoSparkAPI connection object; uses your SPARK_ACCESS_TOKEN environment variable
+# Create a WebexTeamsAPI connection object; uses your WEBEX_TEAMS_ACCESS_TOKEN
+# environment variable
+api = WebexTeamsAPI()
 
 
 # Get my user information
@@ -44,6 +65,8 @@
 
 # Get my user information using id
 print("Get the list of people I know...")
-people = api.people.list(displayName="Jose")    # Creates a generator container (iterable) that lists the people I know
+# Creates a generator container (iterable) that lists the people I know
+people = api.people.list(displayName="Jose")
+# Return the displayName of every person found
 for person in people:
-    print(person.displayName)                   # Return the displayName of every person found
+    print(person.displayName)

examples/pyramidSparkBot/pyramidSparkBot/__init__.py

@@ -1,25 +1,25 @@
 Documentation
 =============
 
-A simple bot script, built on Pyramid using Cornice
+A simple bot script, built on Pyramid using Cornice.
 
 This sample script leverages the Pyramid web framework https://trypyramid.com/
 with Cornice https://cornice.readthedocs.io.  By default the web server will be
 reachable at port 6543 you can change this default if desired
-(see `pyramidSparkBot.ini`).
+(see `pyramidWebexTeamsBot.ini`).
 
 ngrok (https://ngrok.com/) can be used to tunnel traffic back to your server
 if your machine sits behind a firewall.
 
-You must create a Spark webhook that points to the URL where this script is
-hosted.  You can do this via the CiscoSparkAPI.webhooks.create() method.
+You must create a Webex Teams webhook that points to the URL where this script is
+hosted.  You can do this via the WebexTeamsAPI.webhooks.create() method.
 
-Additional Spark webhook details can be found here:
-https://developer.ciscospark.com/webhooks-explained.html
+Additional Webex Teams webhook details can be found here:
+https://developer.webex.com/webhooks-explained.html
 
 A bot must be created and pointed to this server in the My Apps section of
-https://developer.ciscospark.com.  The bot's Access Token should be added as a
-'SPARK_ACCESS_TOKEN' environment variable on the web server hosting this
+https://developer.webex.com.  The bot's Access Token should be added as a
+'WEBEX_TEAMS_ACCESS_TOKEN' environment variable on the web server hosting this
 script.
 
 This script supports Python versions 2 and 3.
@@ -30,4 +30,4 @@ Running the bot
 In order to execute the bot, you need to
 
 ``python setup.py develop``
-``pserve --reload pyramidSparkBot``
+``pserve --reload pyramidWebexTeamsBot``