Skip to content

Conversation

@rosscooperman
Copy link

@rosscooperman rosscooperman commented Jul 8, 2025

This adds a call to the PATCH endpoint for subscriber credentials to upsert instead of update.

Summary by CodeRabbit

  • Documentation

    • Updated the README to include usage instructions and an example for managing subscriber credentials with a new upsert method.
  • New Features

    • Introduced a method for upserting (inserting or updating) subscriber credentials, enabling flexible management of delivery methods like Slack and push tokens.
  • Tests

    • Added tests to verify correct behavior of the new upsert subscriber credentials functionality.

@coderabbitai
Copy link

coderabbitai bot commented Jul 8, 2025

Walkthrough

A new method, upsert_subscriber_credentials, has been introduced for managing subscriber credentials using a PATCH request. The method is documented in the README, implemented in the subscribers API module, and covered by a new test that validates its behavior.

Changes

File(s) Change Summary
README.md Documented the new upsert_subscriber_credentials method with usage instructions and code sample.
lib/novu/api/subscribers.rb Added upsert_subscriber_credentials method to perform PATCH upsert on subscriber credentials.
spec/subscribers_spec.rb Added tests for the new method, verifying correct PATCH request and response handling.

Poem

A patch for credentials, swift as a hare,
Now upserts with care, no need to despair!
The docs hop ahead, with a snippet to show,
And tests keep it tidy, as all rabbits know.
Credentials now managed, with PATCH in the air! 🐇


📜 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 2b93ba4 and e5f8d6b.

📒 Files selected for processing (2)
  • lib/novu/api/subscribers.rb (2 hunks)
  • spec/subscribers_spec.rb (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • lib/novu/api/subscribers.rb
  • spec/subscribers_spec.rb
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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

@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

🧹 Nitpick comments (2)
lib/novu/api/subscribers.rb (1)

106-106: Fix line length violation.

The comment line exceeds the maximum line length (150/120 characters) as flagged by RuboCop.

-      # Upsert subscriber credentials from the Novu platform. Subscriber credentials associated to the delivery methods such as slack and push tokens.
+      # Upsert subscriber credentials from the Novu platform. Subscriber credentials 
+      # associated to the delivery methods such as slack and push tokens.
spec/subscribers_spec.rb (1)

163-163: Consider more accurate test description.

The description "appends the subscriber credentials" might be misleading since upsert operations can both insert and update. Consider using "upserts" for clarity.

-    it "appends the subscriber credentials" do
+    it "upserts the subscriber credentials" do
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8f45047 and 31624de.

📒 Files selected for processing (3)
  • README.md (1 hunks)
  • lib/novu/api/subscribers.rb (1 hunks)
  • spec/subscribers_spec.rb (1 hunks)
🧰 Additional context used
🪛 RuboCop (1.75.5)
lib/novu/api/subscribers.rb

[convention] 106-106: Line is too long. [150/120]

(Layout/LineLength)

🪛 LanguageTool
README.md

[grammar] ~668-~668: Use proper spacing conventions.
Context: ...Upsert (append) subscriber credentials: upsert_subscriber_credentials(subscriber_id, body) ruby body = { 'providerId' => '<insert-provider-id>', 'credentials' => { # Insert all fields here } } client.upsert_subscriber_credentials('<insert-subscriber-id>', body) ` - Delete subscriber credentials by providerId: `delete_subscriber_credentials(subscriberId, providerId)` ruby client.delete_subscriber_credentials('', '') ``` - Update subscriber online status: `update...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)

🔇 Additional comments (2)
lib/novu/api/subscribers.rb (1)

106-120: Good implementation of upsert functionality.

The method correctly uses PATCH for upsert operations and follows the established documentation patterns. The implementation is consistent with the existing codebase.

spec/subscribers_spec.rb (1)

162-182: Well-structured test with accurate validation.

The test correctly validates the PATCH request behavior and follows the established testing patterns. The implementation properly tests both the request format and expected response.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants