LlmKira / Openaibot

⚡️ Build Your Own chatgpt Bot|🧀 Discord/Slack/Kook/Telegram |⛓ ToolCall|🔖 Plugin Support | 🌻 out-of-box | gpt-4o
https://llmkira.github.io/Docs
Apache License 2.0
1.93k stars 229 forks source link

(feat): add `logout` Command #414

Closed sudoskys closed 3 months ago

sudoskys commented 3 months ago

/logout - clear credential

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes primarily introduce a logout functionality across different messaging platforms (Discord, Kook, Slack, Telegram) within the application. This involves adding new commands to clear user credentials, enhancing user authentication and security. Various files were updated to incorporate the /logout command, ensuring consistent behavior across all platforms.

Changes

Files Change Summary
app/sender/discord/__init__.py Added listen_logout_command function to handle logout functionality.
app/sender/discord/event.py Updated /login command to set credential and introduced /logout command.
app/sender/kook/__init__.py Added logout function and listen_logout_command to handle logout functionality.
app/sender/kook/event.py Updated /login command to set credentials and introduced /logout command.
app/sender/slack/__init__.py Added listen_logout_command function to handle /logout command.
app/sender/slack/event.py Added /logout command in the help message.
app/sender/telegram/__init__.py Added listen_logout_command and updated listen_help_command for better formatting.
app/sender/telegram/event.py Updated command list structure and added /logout command.
app/sender/util_func.py Added logout function to handle user logout by updating credentials and sending success message.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant DiscordBot
    participant KookBot
    participant SlackBot
    participant TelegramBot
    participant AuthService

    User ->> DiscordBot: /logout
    DiscordBot ->> AuthService: clear credentials
    AuthService -->> DiscordBot: success
    DiscordBot -->> User: Logout success

    User ->> KookBot: /logout
    KookBot ->> AuthService: clear credentials
    AuthService -->> KookBot: success
    KookBot -->> User: Logout success

    User ->> SlackBot: /logout
    SlackBot ->> AuthService: clear credentials
    AuthService -->> SlackBot: success
    SlackBot -->> User: Logout success

    User ->> TelegramBot: /logout
    TelegramBot ->> AuthService: clear credentials
    AuthService -->> TelegramBot: success
    TelegramBot -->> User: Logout success

This sequence diagram illustrates the interaction between the user and the different bots (Discord, Kook, Slack, Telegram) when the /logout command is issued, showing the flow of clearing credentials and confirming the logout success.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.