Merge pull request #37 from jbogarin/master

Changed the pyramid bot from Chuck Norris to Cat facts

Author: cmlccie

examples/pyramidSparkBot/README.rst

@@ -1,4 +1,32 @@
 Documentation
 =============
 
-Put a brief description of 'Pyramid Spark Bot application'.
+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`).
+
+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.
+
+Additional Spark webhook details can be found here:
+https://developer.ciscospark.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
+script.
+
+This script supports Python versions 2 and 3.
+
+Running the bot
+-------------------
+
+In order to execute the bot, you need to
+
+``python setup.py develop``
+``pserve --reload pyramidSparkBot``

examples/pyramidSparkBot/pyramidSparkBot/views.py

@@ -37,34 +37,34 @@
 
 
 # Module constants
-CHUCK_NORRIS_JOKES_URL = 'http://api.icndb.com/jokes/random'
+CAT_FACT_URL = 'http://catfacts-api.appspot.com/api/facts?number=1'
 
 
 # Initialize the environment
 spark_api = CiscoSparkAPI()             # Create the Cisco Spark API connection object
 
 
 # Helper functions
-def get_chuck_norris_joke():
-    """Get a Chuck Norris Joke from api.icndb.com and return it as a string.
+def get_catfact():
+    """Get a cat fact from catfacts-api.appspot.com and return it as a string.
     Functions for Soundhound, Google, IBM Watson, or other APIs can be added
     to create the desired functionality into this bot.
     """
-    response = requests.get(CHUCK_NORRIS_JOKES_URL, verify=False)
+    response = requests.get(CAT_FACT_URL, verify=False)
     response_dict = json.loads(response.text)
-    return response_dict['value']['joke']
+    return response_dict['facts'][0]
 
 
 sparkwebhook = Service(name='sparkwebhook', path='/sparkwebhook', description="Spark Webhook")
 
 
 @sparkwebhook.get()
 def get_sparkwebhook(request):
-    log.info(get_chuck_norris_joke())
-    return {"joke": get_chuck_norris_joke()}
+    log.info(get_catfact())
+    return {"fact": get_catfact()}
 
 @sparkwebhook.post()
-# Your Spark webhook should point to http://<serverip>:5000/sparkwebhook
+# Your Spark webhook should point to http://<serverip>:6543/sparkwebhook
 def post_sparkwebhook(request):
     """Respond to inbound webhook JSON HTTP POST from Cisco Spark."""
 
@@ -93,10 +93,10 @@ def post_sparkwebhook(request):
 
     else:
         # Message was sent by someone else; parse message and respond.
-        if "/CHUCKNORRIS" in message.text:
-            log.info("FOUND '/CHUCKNORRIS'")
-            chuck_norris_joke = get_chuck_norris_joke()                                       # Get a Chuck Norris Joke
-            log.info("SENDING CHUCK NORRIS JOKE '{}'".format(chuck_norris_joke))
-            spark_api.messages.create(room.id, text=chuck_norris_joke)              # Post the fact to the room where the request was received
+        if "/CAT" in message.text:
+            log.info("FOUND '/CAT'")
+            catfact = get_catfact()                                       # Get a cat fact
+            log.info("SENDING CAT FACT'{}'".format(catfact))
+            spark_api.messages.create(room.id, text=catfact)              # Post the fact to the room where the request was received
         return {'Message': 'OK'}
 

examples/pyramidSparkBot/setup.py

@@ -24,7 +24,7 @@
       packages=find_packages(),
       include_package_data=True,
       zip_safe=False,
-      install_requires=['cornice', 'waitress'],
+      install_requires=['cornice', 'waitress', 'ciscosparkapi'],
       entry_points="""\
       [paste.app_factory]
       main=pyramidSparkBot:main