search

kinde-oss / kinde-elixir-sdk

MIT License
9 stars 7 forks source link

Update/intialize the access token with elixir starter kit #12

Open Hammadkhan0034 opened 1 month ago

Hammadkhan0034 commented 1 month ago

Explain your changes

This Pull request introduces a more structured approach to handling authentication tokens within the application by adding three new functions: init_with_tokens/3, get_kinde_client/1, and authenticated_request/4. These changes improve how access and refresh tokens are managed within the connection (conn).

  1. init_with_tokens/3 stores the access_token and refresh_token in the conn.
  2. get_kinde_client/1 retrieves the token map from the conn.
  3. authenticated_request/4 utilizes the access_token from the map to set up the necessary headers for making an authenticated HTTP request.
coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@Hammadkhan0034 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 40 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 08c569eac16b0aa6f35b17c43dc71692e9067bea and c45e730f998112b3a108539d6e1229e9b1522118.

Walkthrough

The changes to the KindeClientSDK module enhance authentication token management. The new function init_with_tokens/3 initializes client structures with access and refresh tokens. The get_kinde_client/1 function retrieves these tokens, while the authenticated_request/4 function has been updated to use the access token for secure API interactions. These modifications streamline authentication processes within the SDK.

Changes

Files Change Summary
lib/kinde_sdk/kinde_client_sdk.ex Added init_with_tokens/3 for token initialization, introduced get_kinde_client/1 for token retrieval, and updated authenticated_request/4 to utilize the access token for secure requests.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant KindeClientSDK
    participant API

    Client->>KindeClientSDK: init_with_tokens(conn, access_token, refresh_token)
    KindeClientSDK-->>Client: Store tokens in assigns

    Client->>KindeClientSDK: authenticated_request(conn, method, url, params)
    KindeClientSDK->>KindeClientSDK: get_kinde_client(conn)
    KindeClientSDK-->>Client: Retrieve access token
    KindeClientSDK->>API: Make request with Bearer token
    API-->>KindeClientSDK: Response
    KindeClientSDK-->>Client: Return response

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 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](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.
mhtouseef9 commented 3 weeks ago

approved

tcoopman commented 3 weeks ago

To be honest, I'm not sure how this PR has to be used. I've tried it out but I'm kinda stuck.

In the light of #11, let's say I have the access and refresh tokens.

        conn =
          KindeClientSDK.init_with_tokens(
            conn,
            get_session(conn, :kinde_access_token),
            get_session(conn, :kinde_refresh_token)
          )

        dbg(KindeClientSDK.authenticated?(conn))

returns false??

How do I get that to return true? Or can you show me some code how to use init_with_tokens

tcoopman commented 3 weeks ago

Just to be clear, if the cache is still alive, I think I can get it working. But what if the cache is not available anymore?

DanielRivers commented 3 weeks ago

Thanks for your commends @tcoopman, are you able to address these please @Hammadkhan0034 ?

Hammadkhan0034 commented 1 week ago

Yes if the valid refresh token is available in cache, you can use it to obtain new token, if both cache and refresh token are unavailable or expires then user will need re-authentication.