Add GetExchangeStatus()

[nao1215]

Summary by CodeRabbit

• New Features

  • Introduced a new API endpoint GET /api/exchange_status to check the operational status of the exchange.
  • Enhanced functionality allows users to retrieve the trading status of specific currency pairs or all tradable pairs.

• Bug Fixes

  • Improved error handling in the API response for the GetExchangeStatus method, ensuring proper handling of server errors.

• Documentation

  • Updated the README.md to include details about the new API endpoint and its usage.

• Tests

  • Added a set of unit tests to validate the functionality and error handling of the GetExchangeStatus method.

[coderabbitai]

Walkthrough

A significant enhancement has been made to the API by introducing a new endpoint, GET /api/exchange_status, allowing users to retrieve the current status of the cryptocurrency exchange. This update includes the implementation of related functions and comprehensive unit tests to ensure functionality and reliability, facilitating better decision-making for users.

Changes

Files	Change Summary
README.md	Added documentation for the new GET /api/exchange_status endpoint and its associated GetExchangeStatus() function.
exchange.go	Introduced GetExchangeStatus method, input/output structs, and availability types, enabling status retrieval for trading pairs.
exchange_test.go	Created unit tests for the GetExchangeStatus method, covering various scenarios including successful and error responses.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Client
    participant API

    User->>Client: Request exchange status
    Client->>API: GET /api/exchange_status
    API-->>Client: Return exchange status data
    Client-->>User: Provide exchange status

Loading

🐰 "With a hop and a skip, we check the exchange,
A new endpoint’s here, oh isn’t it strange?
From pairs to status, the data we glean,
In the world of crypto, we’re keen and serene!
So let’s celebrate this code, oh what fun,
For the rabbit's work is never done!" 🐇✨

---

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 037d90b and 51520cf.

Files selected for processing (3)

• README.md (1 hunks)
• exchange.go (1 hunks)
• exchange_test.go (1 hunks)

Additional comments not posted (10)

exchange.go (6)

8-14: LGTM!

The type definition GetExchangeStatusInput is well-documented and straightforward.

---

16-19: LGTM!

The type definition GetExchangeStatusResponse is well-documented and straightforward.

---

21-31: LGTM!

The type definition ExchangeStatus is comprehensive and well-documented.

---

33-48: LGTM!

The type definition ExchangeStatusAvailability is well-documented and straightforward.

---

50-58: LGTM!

The type definition Availability is well-documented and straightforward.

---

60-84: LGTM!

The function GetExchangeStatus is well-structured and handles errors appropriately.

exchange_test.go (3)

14-92: LGTM!

The test case for GetExchangeStatus (all exchange status) is well-structured and covers the expected behavior.

---

94-158: LGTM!

The test case for GetExchangeStatus (specific pair) is well-structured and covers the expected behavior.

---

160-175: LGTM!

The test case for GetExchangeStatus (error case) is well-structured and covers the expected behavior.

README.md (1)

93-93: LGTM!

The documentation for the new GET /api/exchange_status endpoint is clear and correctly placed.