Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: AdonisJS + Unkey RBAC route protection #2492

Closed
wants to merge 1 commit into from

Conversation

Ionfinisher
Copy link
Contributor

@Ionfinisher Ionfinisher commented Oct 18, 2024

What does this PR do?

Protecting AdonisJS routes with Unkey

Github repo: https://github.com/Ionfinisher/unkey-adonisjs-template

Fixes #2150

Summary by CodeRabbit

  • New Features
    • Added a new project entry showcasing "AdonisJS + Unkey RBAC route protection" by Teddy ASSIH, complete with a link to the GitHub repository.
  • Documentation
    • Maintained the established format for documenting contributions, ensuring clarity and consistency.

Copy link

changeset-bot bot commented Oct 18, 2024

⚠️ No Changeset found

Latest commit: d89acf6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Oct 18, 2024

@Ionfinisher is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Oct 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 18, 2024 3:04pm

Copy link
Contributor

coderabbitai bot commented Oct 18, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request introduce a new entry to a project list showcasing the use of Unkey for API protection. Specifically, it adds a contribution by Teddy ASSIH titled "AdonisJS + Unkey RBAC route protection," including relevant details such as the contributor's name, date, and a link to the associated GitHub repository. The overall structure for documenting contributions remains unchanged.

Changes

Files Change Summary
oss.gg/7_create_a_template.md Added new entry: 18-October-2024 by Teddy ASSIH AdonisJS + Unkey RBAC route protection

Assessment against linked issues

Objective Addressed Explanation
Add new contributions to the project list (2150)

Possibly related PRs

Suggested labels

🕹️ oss.gg, :joystick: 750 points, hacktoberfest

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • MichaelUnkey

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented Oct 18, 2024

Thank you for following the naming conventions for pull request titles! 🙏

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
oss.gg/7_create_a_template.md (1)

57-57: Fix Markdown lint issue: Remove space inside link text.

There's an extra space at the end of the link text. Please remove it to resolve the Markdown lint issue.

Apply this change:

-» 18-October-2024 by Teddy ASSIH [AdonisJS + Unkey RBAC route protection ](https://github.com/Ionfinisher/unkey-adonisjs-template)
+» 18-October-2024 by Teddy ASSIH [AdonisJS + Unkey RBAC route protection](https://github.com/Ionfinisher/unkey-adonisjs-template)
🧰 Tools
🪛 Markdownlint

57-57: null
Spaces inside link text

(MD039, no-space-in-links)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d774a4c and d89acf6.

📒 Files selected for processing (1)
  • oss.gg/7_create_a_template.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
oss.gg/7_create_a_template.md

57-57: null
Spaces inside link text

(MD039, no-space-in-links)

@@ -54,4 +54,6 @@ Your turn 👇

» 12-October-2024 by Nazar Poshtarenko [Next.js Unkey Pay-as-you-Go Starter Kit](https://github.com/unrenamed/unkey-nextjs-pay-as-you-go)

» 18-October-2024 by Teddy ASSIH [AdonisJS + Unkey RBAC route protection ](https://github.com/Ionfinisher/unkey-adonisjs-template)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Missing MIT License

The repository unkey-adonisjs-template does not include an MIT license, which is required.

🔗 Analysis chain

LGTM! Please verify the repository meets all requirements.

The new entry for the AdonisJS + Unkey RBAC route protection template looks good and follows the correct format. However, please ensure that the linked repository meets all the requirements:

  1. It must be open source.
  2. It must be MIT licensed.
  3. It must have a README.md including a quickstart guide for running the example.

To verify these requirements, you can run the following script:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify repository requirements

# Clone the repository
git clone https://github.com/Ionfinisher/unkey-adonisjs-template.git temp_repo
cd temp_repo

# Check for MIT license
if grep -q "MIT" LICENSE; then
  echo "MIT license found"
else
  echo "MIT license not found"
fi

# Check for README.md
if [ -f README.md ]; then
  echo "README.md found"
  # Check for quickstart guide in README.md
  if grep -qi "quickstart" README.md; then
    echo "Quickstart guide found in README.md"
  else
    echo "Quickstart guide not found in README.md"
  fi
else
  echo "README.md not found"
fi

# Clean up
cd ..
rm -rf temp_repo

Length of output: 505

🧰 Tools
🪛 Markdownlint

57-57: null
Spaces inside link text

(MD039, no-space-in-links)

@chronark
Copy link
Collaborator

/award 750

@chronark chronark closed this Oct 29, 2024
Copy link

oss-gg bot commented Oct 29, 2024

Awarding Ionfinisher: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/Ionfinisher

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[🕹️] SIDE QUESTS: https://go.unkey.com/ossgg-challenges
2 participants