search

Standard-Labs / real-intent

Python SDK and abstracted interface for BigDBM's API.
0 stars 0 forks source link

Create a DNCRemover #88

Closed preritdas closed 1 month ago

preritdas commented 1 month ago

Does not remove DNC leads, instead strips leads of DNC phone numbers in-place.

Useful for the FUB integration, as no DNC phone numbers are included without reducing the lead count.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce a new class, DNCPhoneRemover, which extends BaseValidator. This class is responsible for filtering out mobile phone numbers from a list of MD5WithPII objects that are marked as "do not call" (DNC). Additionally, a new test function, test_dnc_phone_remover, has been added to validate the functionality of the DNCPhoneRemover class, ensuring that it correctly handles various DNC statuses.

Changes

File Change Summary
real_intent/validate/phone.py Added DNCPhoneRemover class and _validate method to filter out DNC mobile phone numbers.
tests/test_validation.py Added test_dnc_phone_remover function to validate the functionality of the DNCPhoneRemover class.

Possibly related PRs

Poem

In the meadow, phones do roam,
DNC whispers, "Leave them home."
A rabbit hops with glee and cheer,
Filtering calls, the path is clear.
With every number, we comply,
In the fields, our spirits fly! 🐇✨

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 04247ee01bc1970b2554d99971c02e96c8b045a0 and ed3b9f32248e25b5d28664b1e4439726b36b8034.
Files selected for processing (2) * real_intent/validate/phone.py (1 hunks) * tests/test_validation.py (2 hunks)
Additional comments not posted (2)
real_intent/validate/phone.py (1)
`145-167`: **LGTM!** The `DNCPhoneRemover` class is a valuable addition that removes DNC phone numbers in-place without affecting the lead count. The implementation is clean, well-documented, and aligns with the stated purpose. Some key observations: - The class extends `BaseValidator`, following the existing validation pattern. - The `_validate` method correctly filters out phone numbers with `do_not_call` set to `True`. - The in-place modification of the `mobile_phones` attribute is an efficient approach. - The method returns the modified list of `MD5WithPII` objects, maintaining the original lead count. Overall, this class enhances the validation process by providing a mechanism to handle DNC compliance while preserving the lead data integrity.
tests/test_validation.py (1)
`208-240`: **LGTM!** The `test_dnc_phone_remover` function provides comprehensive test coverage for the `DNCPhoneRemover` class. It covers various scenarios of DNC phone statuses and checks that the remover correctly retains or removes phones based on their DNC status. The test aligns with the PR objective of removing DNC phone numbers while retaining the leads. Great job!
---
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 , 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 generate interesting stats about this repository and render them as a table.` -- `@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.