Add server mode

[nao1215]

Summary by CodeRabbit

• New Features
  • Introduced a server mode for the cic command, allowing users to start a local server for compound interest calculations.
  • Added a new RESTful API endpoint to accept investment parameters and return calculated results in JSON format.
• Documentation
  • Updated README to include usage instructions for the new server mode and examples for sending requests.
• Bug Fixes
  • Improved error handling in the investment calculation process on the server.
• Chores
  • Enhanced command-line interface for better usability and modularity.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update enhances a Rust project's functionality by introducing an HTTP server for investment calculations, adding a new dependency, and restructuring the existing command-line interface. Key changes include the transition to asynchronous processing, improved error handling, and expanded usage documentation. These modifications collectively aim to provide users with a more robust tool for computing compound interest through both command-line operations and a web API.

Changes

Files	Change Summary
.github/workflows/test.yml	Step name changed from "Build" to "Test", maintaining the existing command.
Cargo.toml	Added actix-web dependency (version 4.8.0) for web functionalities.
README.md	Updated usage instructions to include cic server command; added examples for server mode functionality.
src/args.rs, src/lib.rs	Introduced args and server modules; implemented build_cli and get_port functions for CLI handling.
src/calculations.rs	Added from_params method in Investment struct for creating instances from parameters, including validation.
src/main.rs	Modified run and main functions to be asynchronous, enhancing modularity and error handling.
src/server.rs	New file implementing an HTTP server with a /compound-interests endpoint to handle investment calculations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Server
    participant Calculation

    User->>CLI: Invoke cic server
    CLI->>Server: Start server on specified port
    Server->>User: Server running
    User->>Server: POST /compound-interests with parameters
    Server->>Calculation: Process investment parameters
    Calculation-->>Server: Return investment summary
    Server-->>User: Respond with JSON summary

Loading

🐰 In gardens green, I hop with glee,
New features bloom like leaves on a tree!
Investment tales in JSON do flow,
A server mode to help you grow!
So gather round, let numbers dance,
With every change, give progress a chance! 🌼

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 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.