Add GetOrderBooks()

[nao1215]

Summary by CodeRabbit

• New Features

  • Added a new API method to fetch order book information, enhancing data retrieval capabilities.
  • Improved API documentation with hyperlinks for easier navigation and accessibility of method details.

• Bug Fixes

  • Updated error handling for the new API method to ensure robust responses.

• Tests

  • Introduced unit tests for the new order book functionality, covering both successful responses and error scenarios.

• Chores

  • Updated .gitignore to exclude unnecessary files from version control for cleaner repository management.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update enhances the coincheck package by introducing a new method for retrieving order books, improving API documentation with hyperlinks, and adding unit tests to ensure robust functionality. A new .gitignore entry prevents unnecessary files from being tracked, while changes in order.go provide clearer data structures for handling order statuses. Overall, these enhancements improve usability, maintainability, and test coverage.

Changes

Files	Change Summary
.gitignore	Added entry to ignore cli directory.
README.md	Enhanced API documentation with hyperlinks for methods: GetTicker(), GetTrades(), GetOrderBooks(), and GetBankAccounts().
order.go	Introduced new imports, defined SellOrderStatus and BuyOrderStatus, added GetOrderBooksResponse struct, and implemented GetOrderBooks method.
order_test.go	Added unit tests for GetOrderBooks functionality, including scenarios for successful and erroneous responses.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    Client->>API: GET /order_books
    API->>Client: 200 OK (Order Books JSON)
    Client->>Client: Process Order Books

Loading

🐰 "In the code where orders flow,
New links and tests help knowledge grow.
With every method, clean and bright,
Our project hops into the light!
So gather 'round, let's cheer and play,
For better code is here to stay!" 🐇

---

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.