[FR] Optional TOTP

[ian-young]

Feature Name

Description

Added the ability to optionally include a TOTP so it is no longer required for all accounts.

Fixes #23

Type of change

• [x] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

This was tested by:

• [x] Authenticating and retrieving tokens, no action taken [base case]
• [x] Authenticating and retrieving tokens, requested all devices in an org with the tokens [real-world case]
• [x] Authenticating and retrieving tokens, requested all archives in an org (no archives present) [edge case]

Test Configuration:

• Firmware version: Python 3.9.6
• Hardware: MacOS
• SDK: Visual Studio

Checklist:

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes
• [x] Any dependent changes have been merged and published in downstream modules

Summary by Sourcery

Introduce optional TOTP support for authentication, refactor authentication functions to accommodate this change, and enhance error handling for better clarity.

New Features:

• Added optional TOTP (Time-based One-Time Password) support for authentication, making it no longer mandatory for all accounts.

Enhancements:

• Refactored authentication functions to support optional TOTP, improving flexibility in login processes.
• Improved error handling in various functions to provide more specific warnings and messages for different HTTP status codes.

Documentation:

• Updated documentation to reflect changes in the authentication process, including the optional TOTP feature.

[sourcery-ai[bot]]

Reviewer's Guide by Sourcery

This pull request introduces an optional TOTP (Time-based One-Time Password) feature, allowing users to authenticate without requiring TOTP for all accounts. The changes primarily involve refactoring the authentication logic to make TOTP optional and updating the relevant function calls across multiple files.

File-Level Changes

Files	Changes
VCE/delete_device.py VCE/gather_devices.py Demo_Org/delete_archives.py Demo_Org/list_archives.py Coding_Challenges/trigger_lockdown.py Coding_Challenges/schedule_override.py Coding_Challenges/open_door.py Coding_Challenges/Org_Management/inv_gather_devices.py QoL/authentication.py QoL/api_endpoints.py Coding_Challenges/command_login.py	Refactored the authentication logic to make TOTP optional. Removed redundant login and logout functions from multiple files and replaced them with a centralized implementation in QoL/authentication.py. Updated function calls to use the new optional TOTP parameter.

---

Tips

- Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.