A few cleanup operations

[preritdas]

1. Improving Intellisense with proper class documentation, class-level vs. __init__
2. Standardizing abstract expected return type of an Analyzer, between the abstract _analyze, the log-wrapped analyze, and the PerLeadInsightGenerator's implemented _analyze

Summary by CodeRabbit

• New Features

  • Introduced a CallableValidator class to streamline phone number and DNC validation.
  • Added a retry mechanism for phone number validation using the Numverify API.

• Bug Fixes

  • Updated phone validation to raise an error if the API response is invalid.

• Documentation

  • Adjusted documentation for the analyze method to reflect new return types.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes enhance the functionality of the BaseAnalyzer and PhoneValidator classes. The analyze method's return type is modified to support either a string or a dictionary, allowing for more versatile outputs. The PhoneValidator class now incorporates a retry mechanism for API validation, while a new CallableValidator class is introduced to streamline the validation process for phone numbers and DNC status. These modifications improve the overall validation logic and robustness.

Changes

Files	Change Summary
real_intent/analyze/base.py	Updated analyze and _analyze methods to return a union type (str | dict[str, str]). Adjusted documentation accordingly.
real_intent/validate/phone.py	Added _validate_with_retry method for retries in PhoneValidator. Updated _validate_phone to raise ValueError on invalid API responses. Removed docstring from DNCValidator constructor. Introduced CallableValidator class to combine phone and DNC validation.

Possibly related PRs

• 115: This PR directly relates to the main PR as it also modifies the analyze method in the BaseAnalyzer class, changing its return type to a union type (str | dict[str, str]), which aligns with the changes made in the main PR.

Poem

🐰 In the meadow where bunnies play,
New features hop in, brightening the day!
With retries and checks, our code's now spry,
Validating numbers as clouds drift by.
Hooray for the changes, let’s dance and cheer,
For a smoother path, our goals are clear! 🌼✨

---

🪧 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 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 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.