search

jptrsn / zip-captions

Open source browser closed-caption generator
https://zipcaptions.app
GNU General Public License v3.0
45 stars 7 forks source link

Feature/patreon integration #122

Closed jptrsn closed 3 months ago

jptrsn commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@jptrsn has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 19 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 65eaca1dd5b6a4df88f1f46a8a5679ffe3316ddf and 59febfa2ff0604995965c6735627c7d8bf311836.

Walkthrough

This update integrates Patreon authentication into the application, enabling users to log in using their Patreon accounts. It features the addition of components, services, and routes to handle Patreon login, as well as backend enhancements for processing Patreon webhook events. Overall, this improves user authentication options and interaction with the Patreon platform.

Changes

Files Change Summary
package.json Added "passport-patreon": "^1.0.1" to dependencies for Patreon integration.
.../auth/auth.module.ts Added PatreonLoginComponent to declarations; minor formatting change in imports.
.../auth/components/login/login.component.html Commented out the <app-patreon-login> component.
.../auth/components/patreon-login/patreon-login.component.html New HTML file for the Patreon login UI with a clickable authentication link.
.../auth/components/patreon-login/patreon-login.component.scss New SCSS file for styling the PatreonLogin component.
.../auth/components/patreon-login/patreon-login.component.spec.ts New test suite for PatreonLoginComponent.
.../auth/components/patreon-login/patreon-login.component.ts New component for Patreon login functionality, with authLink property.
.../auth/services/auth.service.ts Added getPatreonLoginUrl() method to return the Patreon login URL.
.../app/app.controller.ts Introduced updatePatreonSupporters method to handle Patreon webhook events.
.../app/app.module.ts Registered new controllers and services related to Patreon functionality.
.../app/app.service.ts Added methods for managing Patreon pledges based on webhook events.
.../models/patreon.model.ts New file defining TypeScript interfaces for handling Patreon webhook data.
.../models/supporter.model.ts New Mongoose schema for Supporter entities.
.../user/models/user.model.ts Added patreonId and patreonRefreshToken properties to the User model.
.../user/services/user.service.ts Introduced patreonLogin method for handling authentication via Patreon.
.../user/user.controller.ts Updated to manage OAuth routes for Patreon login functionality.
.../user/user.module.ts Incorporated PatreonStrategy into the user module for authentication.
.../strategies/patreon.strategy.ts New class implementing a custom authentication strategy for Patreon using Passport.js.
.../main.ts Enhanced NestJS application bootstrap process to allow raw body access for webhook handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend
    participant AuthService
    participant AppController
    participant Patreon

    User->>Frontend: Clicks Login with Patreon
    Frontend->>AuthService: Requests Patreon Login URL
    AuthService-->>Frontend: Returns Login URL
    Frontend->>User: Redirects to Patreon Login
    User->>Patreon: Authenticates and Authorizes
    Patreon-->>User: Redirects back with code
    User->>AuthService: Sends code for token
    AuthService->>AppController: Verify token and retrieve user data
    AppController-->>AuthService: Returns user data
    AuthService-->>User: Logs in user and provides session

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 Configuration 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.