Skip to content

Conversation

cmlccie
Copy link
Collaborator

@cmlccie cmlccie commented Mar 17, 2017

The initial automated test suite is complete!!

Caught and fixed a couple bugs in the process.

Correct formatting issues and simplify text.
Add examples and documentation sections and misc edits.
Delete old README.md and point setup.py to new README.rst
Create new ‘docs’ directory.  Run sphinx-quickstart in ‘docs’
Begin organizing .gitignore to identify used and unused entries.
Create initial index.rst and the the User-API documentation.
Rename and refactor helper.py to utils.py to make naming more
consistent with established practices.
The session attribute in an API object should not be ‘public’, and
therefore should be prefixed by an ‘_’.

Update API classes’ method docstrings to eliminate warnings and enable
proper auto-documentation by Sphinx autodoc extension.
The ‘pep440-post’ style better reflects post-release commits, and
enables building of installable dev-builds with sortable version
numbers.

Additionally, going forward, the package release tags will incorporate
a release status flag (a - alpha, b - beta, rc - release candidate) in
the format:  major.minor[flag]micro
Update docstrings and User API Doc for the main package __init__.py
module.
This copyright reference shows up in the footers of the HTML docs
generated by Sphinx.
The Quickstart guide / tutorial is now finished!!!
Report and needed corrections provided by @DJF3

-Thank you!
# Conflicts:
#	README.rst
#	docs/conf.py
#	docs/user/intro.rst
# Conflicts:
#	README.rst
Add a ACCESS_TOKEN_ENVIRONEMENT_VARIABLE package-level constant that
specifies the name of the environment variable that is referenced by
the package to retrieve a user’s Spark access token from the
environment.
cmlccie added 29 commits March 6, 2017 01:52
Add the new Organizations, Licenses and Roles API wrappers to the
CiscoSparkAPI class.
Verb should be PUT instead of POST
Add an test-account email address generating fixture to conftest.py
The emails parameter of the people.create() method should be of type
list (and len of 1) not of type string_types.
Revise method for generating test accounts; the test accounts need to
be ‘Messaging’ licensed users (to enable the moderator functionality).
Add a TestPeople class to create, manage and delete (when tests are
complete) test (person) accounts.
Add group_room, direct_rooms, and team_room to the use / dependency
list of fixture rooms_list; remove these dependencies from the tests
that depend on rooms_list
There is no need for each ‘page’ to contain more than a single item.
This may help minimize the number of test rooms created, which will
help minimize the number of API calls that must be made to create and
delete these test rooms.
Remove “group_room_” prefix from test account references to enable them
to be reused by the team_memberships tests.
Add group_room, team_room, and direct_rooms dependencies to
authenticated_user_memberships and remove them from tests that depend
on authenticated_user_memberships.
There is no need for each ‘page’ to contain more than a single item.
This may help minimize the number of rooms created, which will
help minimize the number of API calls that must be made to create and
delete these test rooms.
Use a generic / reusable ’named test account’ instead of a
temp_account.  This same test_account can be reused when testing team
memberships.
I don’t know how I missed this one…
Temporarily disabling test account deletion to work on account
capabilities issues.
@cmlccie cmlccie merged commit 7ceee94 into master Mar 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant