Merge pull request #50 from kenzo0107/support_rate_limit_api

Support rate limit API

rate_limit.go

@@ -0,0 +1,46 @@
+package backlog
+
+import (
+	"context"
+)
+
+// LimitStatus : limit status
+type LimitStatus struct {
+	Limit     *int `json:"limit,omitempty"`
+	Remaining *int `json:"remaining,omitempty"`
+	Reset     *int `json:"reset,omitempty"`
+}
+
+// RateLimit : rate limit
+type RateLimit struct {
+	Read   *LimitStatus `json:"read,omitempty"`
+	Update *LimitStatus `json:"update,omitempty"`
+	Search *LimitStatus `json:"search,omitempty"`
+	Icon   *LimitStatus `json:"icon,omitempty"`
+}
+
+// ResponseRateLimit : rate limit API response
+type ResponseRateLimit struct {
+	RateLimit *RateLimit `json:"rateLimit,omitempty"`
+}
+
+// GetRateLimit returns the rate limit
+func (c *Client) GetRateLimit() (*RateLimit, error) {
+	return c.GetRateLimitContext(context.Background())
+}
+
+// GetRateLimitContext returns the rate limit
+func (c *Client) GetRateLimitContext(ctx context.Context) (*RateLimit, error) {
+	u := "/api/v2/rateLimit"
+
+	req, err := c.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	responseRateLimit := new(ResponseRateLimit)
+	if err := c.Do(ctx, req, &responseRateLimit); err != nil {
+		return nil, err
+	}
+	return responseRateLimit.RateLimit, nil
+}

rate_limit_test.go

@@ -0,0 +1,96 @@
+package backlog
+
+import (
+	"fmt"
+	"net/http"
+	"reflect"
+	"testing"
+)
+
+const testJSONRateLimit string = `{
+	"rateLimit": {
+	  "read": {
+		"limit": 600,
+		"remaining": 600,
+		"reset": 1603881873
+	  },
+	  "update": {
+		"limit": 150,
+		"remaining": 150,
+		"reset": 1603881873
+	  },
+	  "search": {
+		"limit": 150,
+		"remaining": 150,
+		"reset": 1603881873
+	  },
+	  "icon": {
+		"limit": 60,
+		"remaining": 60,
+		"reset": 1603881873
+	  }
+	}
+  }`
+
+func getTestRateLimit() *ResponseRateLimit {
+	return &ResponseRateLimit{
+		RateLimit: &RateLimit{
+			Read: &LimitStatus{
+				Limit:     Int(600),
+				Remaining: Int(600),
+				Reset:     Int(1603881873),
+			},
+			Update: &LimitStatus{
+				Limit:     Int(150),
+				Remaining: Int(150),
+				Reset:     Int(1603881873),
+			},
+			Search: &LimitStatus{
+				Limit:     Int(150),
+				Remaining: Int(150),
+				Reset:     Int(1603881873),
+			},
+			Icon: &LimitStatus{
+				Limit:     Int(60),
+				Remaining: Int(60),
+				Reset:     Int(1603881873),
+			},
+		},
+	}
+}
+
+func TestGetRateLimit(t *testing.T) {
+	client, mux, _, teardown := setup()
+	defer teardown()
+
+	mux.HandleFunc("/rateLimit", func(w http.ResponseWriter, r *http.Request) {
+		if _, err := fmt.Fprint(w, testJSONRateLimit); err != nil {
+			t.Fatal(err)
+		}
+	})
+
+	expected, err := client.GetRateLimit()
+	if err != nil {
+		t.Errorf("Unexpected error: %s", err)
+		return
+	}
+
+	r := getTestRateLimit()
+	want := r.RateLimit
+	if !reflect.DeepEqual(want, expected) {
+		t.Fatal(ErrIncorrectResponse)
+	}
+}
+
+func TestGetRateLimitFailed(t *testing.T) {
+	client, mux, _, teardown := setup()
+	defer teardown()
+
+	mux.HandleFunc("/rateLimit", func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusInternalServerError)
+	})
+
+	if _, err := client.GetRateLimit(); err == nil {
+		t.Fatal("expected an error but got none")
+	}
+}