Add GetAccountsBalance()

[nao1215]

Summary by CodeRabbit

• New Features

  • Added a new API endpoint GET /api/accounts/balance for retrieving user account balances.
  • Enhanced functionality for handling private API requests with new authentication logic.

• Bug Fixes

  • Improved error handling for API requests in various scenarios.

• Tests

  • Introduced unit tests for the GetAccountsBalance method to ensure accurate retrieval and error handling.

• Documentation

  • Updated API documentation to include details for the new account balance endpoint.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a new API endpoint for retrieving user account balances, enhancing documentation clarity and usability. The implementation includes a new balance.go file for accessing balance data, alongside unit tests to ensure functionality. Additionally, adjustments to request handling improve security by distinguishing between private and public requests. Overall, these changes collectively enhance the API's capability and reliability.

Changes

File(s)	Change Summary
README.md	Added documentation for GET /api/accounts/balance API endpoint.
balance.go, withdraw.go	Introduced GetAccountsBalanceResponse struct and GetAccountsBalance method. Updated request handling to differentiate between private and public requests.
balance_test.go	Added unit tests for GetAccountsBalance method, covering successful responses and error handling.
coincheck.go	Added private field to createRequestInput struct for request handling, ensuring authentication is applied only when needed.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    Client->>API: GET /api/accounts/balance
    API-->>Client: Balance data (success)
    Client->>Client: Parse response
    Client-->>Client: Return parsed balance data

Loading

sequenceDiagram
    participant Client
    participant API
    Client->>API: GET /api/accounts/balance
    API-->>Client: Error (e.g., 500)
    Client->>Client: Return error

Loading

🐇 "In the garden of code, where changes bloom,
New paths are forged, dispelling the gloom.
Balances danced in the digital air,
With tests to ensure they’re handled with care.
Hops of joy for each successful run,
Together we code, and together we’ve won!" 🌼

---

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.