kvCORE deliverer integration

preritdas commented 3 months ago

Closes #64.

[x] Integrate
[ ] Test locally and write unit tests
[ ] Add keys to GitHub Actions

This pull request implements the kvCORE integration for the BigDBM Python SDK. The integration allows for seamless delivery of lead data to the kvCORE CRM system.

What happened:

Created a new KvCoreDeliverer class that inherits from BaseOutputDeliverer
Implemented methods to create contacts and add notes in kvCORE
Added support for multiple email addresses and phone numbers
Integrated with the existing PII schema

Why:

To expand the SDK's capabilities and support integration with kvCORE CRM
To provide a standardized way of delivering lead data to kvCORE

How:

Utilized the kvCORE API documentation to implement the necessary endpoints
Followed the existing pattern of other deliverers in the project for consistency
Implemented proper error handling and logging
Used type annotations for improved code quality and maintainability

Effect:

Users of the BigDBM Python SDK can now easily deliver lead data to kvCORE CRM
The integration supports creating contacts with multiple email addresses and phone numbers
Notes with intent information are automatically added to created contacts
The implementation is consistent with other deliverers in the project, making it easy for developers to understand and maintain

This integration enhances the functionality of the BigDBM Python SDK, allowing for more versatile lead data management across different CRM systems.

Summary by CodeRabbit

New Features
- Introduced KvCoreDeliverer class for enhanced integration with the kvCORE API, allowing for efficient delivery of personally identifiable information (PII).
- Added a new module for interacting with kvCORE, streamlining the process of managing contacts and notes.
Bug Fixes
- Improved error handling during data delivery to ensure robust performance and logging of issues encountered.

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes introduce a new integration with the kvCORE system, allowing for the delivery of personally identifiable information (PII) without AI field mapping. A new KvCoreDeliverer class is implemented to manage the creation of contacts and the addition of notes via the kvCORE API. This update enhances the existing data handling capabilities within the module.

Changes

Files	Change Summary
`bigdbm/deliver/__init__.py`	Added import for `KvCoreDeliverer` class.
`bigdbm/deliver/kvcore/__init__.py`	Introduced new module for kvCORE interaction; imported `KvCoreDeliverer` from `vanilla.py`.
`bigdbm/deliver/kvcore/vanilla.py`	Implemented `KvCoreDeliverer` class with methods for delivering PII data to kvCORE.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant KvCoreDeliverer
    participant kvCORE API

    User->>KvCoreDeliverer: Prepare PII Data
    KvCoreDeliverer->>kvCORE API: POST /contact
    kvCORE API-->>KvCoreDeliverer: Return Contact ID
    KvCoreDeliverer->>kvCORE API: PUT /contact/{{contact_id}}/action/note
    kvCORE API-->>KvCoreDeliverer: Confirm Note Added

Assessment against linked issues

Objective	Addressed	Explanation
Create Contact (64)	✅
Add Note (64)	✅
Standardize integration (64)	❌	No separate module for integration was created.

Poem

In fields of code, I hop and play,
With kvCORE now, we’ll save the day!
PII flows like a gentle stream,
Notes added swiftly, like a dream.
Oh, what joy, this change brings near,
A rabbit's cheer, let’s give a cheer! 🐇✨

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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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.

preritdas commented 2 months ago

Overhaul it and do it by email instead.

Subject: Add Contact

First Name: Tester
Last Name: Testman
Email: [bigtestingman@gmail.com](mailto:bigtestingman@gmail.com)
Hashtag: realintent

Input: delivery email, hashtag

preritdas commented 2 months ago

Closing and re-doing with inbound mailbox method.

Standard-Labs / real-intent