Merge pull request #3 from nao1215/nchika/add-public-apis

Add GetOrderBooks()

.gitignore

@@ -23,3 +23,4 @@ go.work.sum
 
 # Project coverage profile
 /coverage.*
+cli

README.md

@@ -85,14 +85,15 @@ If you want to execute the Private API, you need to create a client with the API
 
 | API | Method Name |Description |
 | :--- | :--- | :--- |
-| GET /api/ticker | GetTicker() | Check latest ticker information. |
-| GET /api/trades | GetTrades() | You can get current order transactions. |
+| GET /api/ticker | [GetTicker()](https://pkg.go.dev/github.com/nao1215/coincheck#Client.GetTicker) | Check latest ticker information. |
+| GET /api/trades | [GetTrades()](https://pkg.go.dev/github.com/nao1215/coincheck#Client.GetTrades) | You can get current order transactions. |
+| GET /api/order_books | [GetOrderBooks()](https://pkg.go.dev/github.com/nao1215/coincheck#Client.GetOrderBooks) | Fetch order book information. |
 
 ### Private API
 
 | API | Method Name |Description |
 | :--- | :--- | :--- |
-| GET /api/bank_accounts | GetBankAccounts() | Display list of bank account you registered (withdrawal).|
+| GET /api/bank_accounts | [GetBankAccounts()](https://pkg.go.dev/github.com/nao1215/coincheck#Client.GetBankAccounts) | Display list of bank account you registered (withdrawal).|
 
 ## License
 

order.go

@@ -1,5 +1,10 @@
 package coincheck
 
+import (
+	"context"
+	"net/http"
+)
+
 // OrderType represents the order type.
 type OrderType string
 
@@ -9,3 +14,40 @@ const (
 	// OrderTypeSell is the order type of sell.
 	OrderTypeSell OrderType = "sell"
 )
+
+// SellOrderStatus represents the sell order status.
+// It has the only two elements.
+// e.g.  [ "27330", "1.25" ]
+type SellOrderStatus []string
+
+// BuyOrderStatus represents the buy order status.
+// It has the only two elements.
+// e.g.  [ "12100", "0.12" ]
+type BuyOrderStatus []string
+
+// GetOrderBooksResponse represents the structure of the API response.
+type GetOrderBooksResponse struct {
+	// Asks is the sell order status.
+	Asks []SellOrderStatus `json:"asks"`
+	// Bids is the buy order status.
+	Bids []BuyOrderStatus `json:"bids"`
+}
+
+// GetOrderBooks fetch order book information.
+// API: GET /api/order_books
+// Visibility: Public
+func (c *Client) GetOrderBooks(ctx context.Context) (*GetOrderBooksResponse, error) {
+	req, err := c.createRequest(ctx, createRequestInput{
+		method: http.MethodGet,
+		path:   "/api/order_books",
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	var output GetOrderBooksResponse
+	if err := c.do(req, &output); err != nil {
+		return nil, err
+	}
+	return &output, nil
+}

order_test.go

@@ -0,0 +1,79 @@
+package coincheck
+
+import (
+	"context"
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+)
+
+func TestClientGetOrderBooksResponse(t *testing.T) {
+	t.Run("GetOrderBooksResponse returns a list of order books", func(t *testing.T) {
+		testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			wantMethod := http.MethodGet
+			if got := r.Method; got != wantMethod {
+				t.Errorf("Method: got %v, want %v", got, wantMethod)
+			}
+
+			wantEndpoint := "/api/order_books"
+			if got := r.URL.Path; got != wantEndpoint {
+				t.Errorf("Endpoint: got %v, want %v", got, wantEndpoint)
+			}
+
+			result := GetOrderBooksResponse{
+				Asks: []SellOrderStatus{
+					{"27330", "2.25"},
+					{"27340", "0.1"},
+				},
+				Bids: []BuyOrderStatus{
+					{"27320", "0.2"},
+				},
+			}
+			if err := json.NewEncoder(w).Encode(result); err != nil {
+				t.Fatal(err)
+			}
+		}))
+
+		// Create a new client
+		client, err := NewClient(WithBaseURL(testServer.URL))
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		got, err := client.GetOrderBooks(context.Background())
+		if err != nil {
+			t.Fatal(err)
+		}
+		want := &GetOrderBooksResponse{
+			Asks: []SellOrderStatus{
+				{"27330", "2.25"},
+				{"27340", "0.1"},
+			},
+			Bids: []BuyOrderStatus{
+				{"27320", "0.2"},
+			},
+		}
+		if diff := cmp.Diff(want, got); diff != "" {
+			printDiff(t, diff)
+		}
+	})
+
+	t.Run("GetOrderBooksResponse returns an error", func(t *testing.T) {
+		testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+			w.WriteHeader(http.StatusInternalServerError)
+		}))
+		defer testServer.Close()
+
+		client, err := NewClient(WithBaseURL(testServer.URL))
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		if _, err = client.GetOrderBooks(context.Background()); err == nil {
+			t.Error("want error, but got nil")
+		}
+	})
+}