feat: Unkey Spring Boot rate limiting example

[harshsbhat]

What does this PR do?

Showcases Cost-based ratelimiting using Unkey and Spring Boot. This can help showcase Unkey's power using Java and Spring

Fixes: #2150

Github repo: https://github.com/harshsbhat/UnkeySpringBootExample

Summary by CodeRabbit

• New Features

  • Added a side quest for creating templates using Unkey with various frameworks or languages.
  • Introduced a new entry for a Spring Boot project demonstrating rate limiting with Unkey.

• Documentation

  • Updated submission requirements, including originality, open-source licensing, and the inclusion of a README.md with a quickstart guide.
  • Specified participation points and proof of completion process.

[changeset-bot]

⚠️ No Changeset found

Latest commit: b7e8985

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

[vercel]

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 17, 2024 1:02am

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the documentation for a side quest related to creating a template for using Unkey with various frameworks or languages to build an API. It specifies submission requirements, including originality, open-source licensing, and the inclusion of a README.md file. It also details the points awarded for participation and includes a new entry for a Spring Boot project implementing rate limiting with Unkey, credited to Harsh Bhat.

Changes

Files	Change Summary
oss.gg/7_create_a_template.md	Added a new entry for a side quest related to creating a template for Unkey with frameworks.
	Specified submission requirements and points awarded for participation.
	Included a new entry for a Spring Boot project implementing rate limiting with Unkey.

Assessment against linked issues

Objective	Addressed	Explanation
Submission requirements for side quests (#2150)	✅
Documenting completed submissions (#2150)	✅

Possibly related PRs

• feat: Unkey-flask template [SIDE QUEST] #2174: Adds a new entry for a project by Harsh Bhat related to using Unkey with Flask.
• chore: Unkey PDF Viewer template [SIDE QUEST] #2191: Introduces new entries related to projects using Unkey, including one by Harsh Bhat.
• feat: Example app showcasing cost based unkey ratelimiting #2231: Features a new entry for a project by Harsh Bhat that implements rate limiting.
• feat: Create a template with Unkey #2272: Expands the list of contributions, including multiple projects by Harsh Bhat.
• feat: Unkey FastAPI boilerplate [SIDE QUEST] #2307: Adds a new entry for a FastAPI boilerplate by Harsh Bhat, showcasing another framework using Unkey.
• chore: Next.js Pay-as-you-Go starter kit [SIDE QUEST] #2358: Introduces a new entry for a Next.js project by Nazar Poshtarenko, relevant to Unkey implementations.

Suggested labels

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

Suggested reviewers

• mcstepp
• chronark
• perkinsjr
• MichaelUnkey

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a8b7cd6 and 2d7a3d7.

📒 Files selected for processing (1)

• oss.gg/7_create_a_template.md (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

oss.gg/7_create_a_template.md (1)

42-42: New entry looks good, but let's verify a few things.

The new entry for the Spring Boot rate limiting example with Unkey follows the correct format and aligns with the side quest requirements. However, let's verify a few points:

1. The entry is unique and doesn't duplicate any existing submissions.
2. The linked repository meets all the requirements (open-source, MIT license, README.md with quickstart guide).

Let's run a script to verify these points:

This script will help us confirm that the entry is unique and that the linked repository meets the side quest requirements.

---

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
• Mastodon
• Reddit
• LinkedIn

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

[vercel]

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

A member of the Team first needs to authorize it.

[github-actions]

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

[chronark]

not sure about this one, ratelimiting in stateful applications is pretty easy already, why would you use unkey?

[harshsbhat]

Why would I write complex algorithms to manage time/requests when there is an easier highly abstracted option like Unkey? Still if you feel like rate limiting feature won't be used with Java, I am happy to make changes to this and make it a RBAC middleware

[chronark]

just install a package to do it in memory, the only added value unkey provides is the overrides tbh