Welcome to AFFO User Service’s documentation!¶
AFFO User Service is a simple User sending service. The main feature of this service is an ability to round-robin User gateways to retry the message.
AFFO User Service is Open Source and licensed under the BSD License.
Getting Started¶
If you’re new to AFFO User Service you can get started by following the first-steps tutorial.
Contents¶
Copyright¶
Copyright © 2019, Affo Ltd.
All rights reserved. This material may be copied or distributed only subject to the terms and conditions set forth in the Creative Commons Attribution-ShareAlike 4.0 International <https://creativecommons.org/licenses/by-sa/4.0/legalcode>`_ license.
You may share and adapt the material, even for commercial purposes, but you must give the original author credit. If you alter, transform, or build upon this work, you may distribute the resulting work only under the same license or a license compatible to this one.
Note
While the AFFO User Service documentation is offered under the Creative Commons Attribution-ShareAlike 4.0 International license the AFFO User Service software is offered under the BSD License (3 Clause)
Getting Started¶
Contributor’s Guide¶
Contributions are always welcome and greatly appreciated!
Code contributions¶
We love pull requests from everyone! Here’s a quick guide to improve the code:
Fork the repository and clone the fork.
Create a virtual environment using your tool of choice (e.g.
virtualenv,conda, etc).Install development dependencies:
pip install -r requirements.txt
pip install -r requirements-test.txt
Make sure all tests pass:
python setup.py test
Start making your changes to the master branch (or branch off of it).
Make sure all tests still pass:
python setup.py test
Add yourself to
AUTHORS.rst.Commit your changes and push your branch to GitHub.
Create a pull request through the GitHub website.
Documentation improvements¶
We could always use more documentation, whether as part of the introduction/examples/usage documentation or API documentation in docstrings.
Documentation is written in reStructuredText and use Sphinx to generate the HTML output.
Once you made the documentation changes locally, run the documentation generation:
python setup.py build_sphinx
Bug reports¶
When reporting a bug please include:
Operating system name and version.
affo-user-service version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
REST API¶
-
POST/auth/login/¶ Issues JWT token for the registered user from an email and a password
- Status Codes
200 OK – Success
-
POST/auth/logout/¶ Adds the specified JWT token into the blacklist
- Status Codes
204 No Content – Success
-
POST/user/¶ Register a new user
- Status Codes
201 Created – Success
-
GET/user/{user_id}/role/¶ Retrieves a user roles by an identifier.
- Parameters
user_id (string) – A user identifier
- Status Codes
200 OK – Success
-
PATCH/user/{user_id}/role/¶ Update user roles by an identifier.
- Parameters
user_id (string) – A user identifier
- Status Codes
200 OK – Success
-
POST/user/{user_id}/set_password/¶ Set a user password
- Parameters
user_id (string) – A user identifier
- Status Codes
200 OK – Success
-
GET/user/{user_id}/¶ Retrieves a user by an identifier.
- Parameters
user_id (string) – A user identifier
- Status Codes
200 OK – Success
-
PATCH/user/{user_id}/¶ Update a user by an identifier
- Parameters
user_id (string) – A user identifier
- Status Codes
200 OK – Success
-
DELETE/user/{user_id}/¶ Delete a user by an identifier
- Parameters
user_id (string) – A user identifier
- Status Codes
204 No Content – Success