WebexPythonSDK

The Python v2 & v3 compatibility changes made the v0.6 release introduced an issue where non-unicode strings would fail the API method's type-checking assertions. This issue slipped by the test suite because the test suite had been simultaneously updated to use the Python-Future module (which as used ensured unicode type consistency in both Python v2 & v3).

We have removed the Python-Future use from the test suite (so we are testing with more 'native' Python v2 and v3 code), and corrected the issue with the package's type-checking assertions.

Sorry for any headaches you might have had over the weekend (since the v0.6 package was released), upgrading to v0.6.1 should correct this issue.

As always, please do open an issue if you are experiencing any problems or challenges working with the ciscosparkapi package.

-Thank You!

v0.6 has several cool things in it...

• Python v2 and v3 compatibility was refactored to only depend upon the Python-Future package ( the six package dependency has been removed).
• @Deepar3292 removed the now lifted requirement on providing either a displayName and email parameter when searching for people (you can now list all of the people in your organization, by calling the people.list() method without providing any parameters).
• Several package-level updates to make it easier for contributors to setup their environment in preparation for contributing to the package (check out the Makefile and requirements.txt updates, contributor docs are coming soon).
• Several new and/or updated bot examples running on various Python web frameworks (now includes examples for web.py, Flask, and Pyramid) - thank you @jbogarin !

ciscosparkapi now has a full automated testing suite (using py.test)!! All on-line testable user-facing methods (API calls) have been thoroughly worked through their paces. :-) (issue #4)

The test suite uses a moderate array of py.text fixtures to align object and API dependencies, order test execution, cache results, and optimize API calls. All of this speeds up testing time by minimizing the number of API requests that must be completed to finish a test run. ...and the tests clean-up after themselves as well (though I still recommend using a dedicated test account when running the tests + it will need admin privileges).

Caught and fixed a couple of bugs in the process.

There are a couple of Cisco Spark APIs that are not responding properly (according to the API docs). I will investigate these and re-enable these tests shortly.

#20 Added wrappers for the new Admin API Endpoints:

• Organizations
• Licenses
• Roles
• people.create() and people.update()

Squashed some Bugs:

• #30 team_memberships.update() was using the wrong HTTP verb
• memberships.update() was also using the wrong HTTP verb

Updated package and file copyright references to specify ‘Cisco
Systems, Inc.’ as per recommendations from Cisco legal.

Thank you @brbester for the enhancement request and sharing your code on how you had solved this previously!

When creating a new message, the files argument now accepts either a valid HTTP/HTTPS Internet URL or a path to a local file that should be uploaded when the message is created.

Note that the files argument only accepts a list containing a single item (a string containing either a URL or a local file path). This is a Spark API limitation that may be lifted at a future date. We have implemented method consistent with the Spark API to provide for backwards compatibility if/when this enhancement is made in the future. This way, when Spark opens up support for attaching multiple files on a single message (and we update the package to support that capability), we will not change the method's API and break calls to this method from existing code leveraging the package.

Example of the new functionality:

from ciscosparkapi import CiscoSparkAPI


api = CiscoSparkAPI()


DEMO_ROOM_NAME = "ciscosparkapi Test Room"
DEMO_PEOPLE = ["[email protected]", "[email protected]"]
DEMO_TEXT = u"Cisco Spark rocks!  \ud83d\ude0e"
DEMO_FILE_URL = "https://developer.ciscospark.com/images/[email protected]"
MARKDOWN_TEXT = "**This was uploaded from a local file!**"
DEMO_LOCAL_FILE = "picture.jpg"


# Create a new test room
demo_room = api.rooms.create(DEMO_ROOM_NAME)

# Add people to the room
for person_email in DEMO_PEOPLE:
    api.memberships.create(test_room.id, personEmail=person_email)

# Post a plain-text message to the room, with an attachment from an Internet URL
message1 = api.messages.create(test_room.id, text=DEMO_TEXT, files=[DEMO_FILE_URL])
print(message1)

# Post a markdown-message to the room, with an attachment uploaded from a local file
message2 = api.messages.create(test_room.id, markdown=MARKDOWN_TEXT, files=[DEMO_LOCAL_FILE])
print(message2)

• Corrected an issue where a ciscosparkapiException was incorrectly being raised when a search for people (using CiscoSparkAPI.people.list()) returns an empty list.
• Corrected an issue that caused calls to CiscoSparkAPI.webhooks.update() to fail.

The package now supports Python v2 and v3! Please upgrade to this release to test the package with your v2 or v3 code, and report any issues via the issues page.

Upgrade also includes:

• Example / sample scripts (thank you @brbester !).
• Default / native support for retrieving your Spark access token from the SPARK_ACCESS_TOKEN environment variable (thank you @ObjectIsAdvantag !).

Added a patch to workaround issue #7, where the Cisco Spark cloud is returning an errant 'max=null' query parameter in the next URLs when paging requests where a max= parameter was not specified.

Fixed bug #8, where the files=[] parameter of the CiscoSparkAPI.messages.create() method was not correctly being treated as an list.

This package is now available on PyPI!

$ pip install ciscosparkapi

v0.1.1 - Fixed an issue where the API sub-package (ciscosparkapi.api) wasn't included in the source distribution package.

Beta release imminent.
We are preparing to release the first beta for this package. Please test out the package for your use cases, and raise issues for any problems you encounter. Also, PLEASE create new issues to provide feedback and foster discussion on the package API structure (names, method calls and etc.). The package APIs are still subject to change, and I would like to get these nailed down before we release v1 for the package.