fix: corrected types and Gemfile contents

[brettchaldecott]

Description (required)

corrected the incorrect use of KindeApi, replaced it with KindeSdk were applicable, and updated the contents of the Gemfile as they used the github reference rather than the gem version.

Related issues & labels (optional)

• Closes #
• Suggested label:

Summary by CodeRabbit

• Documentation

  • Updated Ruby SDK guides and examples to reference a stable release version and ensure consistency.

• Refactor

  • Standardized naming for token operations (fetching, checking expiration, and refreshing) to improve clarity and usability.

[coderabbitai]

Walkthrough

The changes update the Ruby SDK documentation to use a stable released version of the Kinde SDK by specifying a version constraint (~> 1.6.1) in the Gemfile. Additionally, all references to the KindeApi namespace in method calls and documentation have been changed to KindeSdk to standardize the API surface.

Changes

File(s)	Change Summary
src/.../ruby-sdk.mdx	Updated Gem specification from a Git reference to version ~> 1.6.1; renamed method calls (fetch_tokens, token_expired?, refresh_token, etc.) from KindeApi to KindeSdk; updated comments and examples for consistency.

Possibly related PRs

• fix: updated the create or documentation #290: Updates related to documentation for creating organizations and users in the SDK, connecting through the standardized API surface.
• feat: support for multiple business setup documented #347: Modifications to method signatures for fetch_tokens, token_expired?, and refresh_token with added optional parameters, relating to the namespace update.

Suggested labels

sdk

Suggested reviewers

• clairekinde11
• marcosmartini

Poem

In a garden of code so neat,
I hop along each documented street.
KindeApi now takes a brand new kick,
Transformed to KindeSdk—so slick!
Hop on, dear devs, for a journey quick! 🐰
Cheers from a coding bunny with a gleeful click!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d3a8a84 and bb959da.

📒 Files selected for processing (1)

• src/content/docs/developer-tools/sdks/backend/ruby-sdk.mdx (5 hunks)

🔇 Additional comments (5)

src/content/docs/developer-tools/sdks/backend/ruby-sdk.mdx (5)

29-32: Gemfile Version Update:
The Gemfile now correctly specifies the stable release of the kinde_sdk gem using the version constraint ~> 1.6.1, replacing the previous GitHub repository reference. This aligns with the PR objective to move toward a stable version.

---

244-259: Updated Token Fetch Method:
The changes replace any prior namespace usage with KindeSdk.fetch_tokens(...) and provide a clear example return structure. This update ensures that token fetching now consistently uses the correct SDK naming.

🧰 Tools

🪛 Gitleaks (8.21.2)

252-252: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

---

264-267: Refined Client Session Initialization:
Session initialization has been updated to call KindeSdk.fetch_tokens(code) and then initialize the client via KindeSdk.client(session[:kinde_auth]). This change improves consistency across the documentation regarding SDK usage.

---

580-594: Token Expiration and Refresh Mechanism Update:
The methods KindeSdk.token_expired? and KindeSdk.refresh_token are now used instead of their previous counterparts. The example usage and inline comments clarify the expected behavior, ensuring that the token management routines align with the updated SDK conventions.

---

597-597: Documentation Note Clarification:
The added note now clearly states that KindeSdk#refresh_token returns a new token hash and that developers need to update their storage accordingly. This clarification improves the documentation’s usefulness.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.