Add support for rate_limit_status endpoint

Author: ltoussaint

twitter/rate_limits.go

@@ -0,0 +1,60 @@
+package twitter
+
+import (
+	"net/http"
+
+	"github.com/dghubble/sling"
+)
+
+// RateLimitService provides methods for accessing Twitter rate limits
+// API endpoints.
+type RateLimitService struct {
+	sling *sling.Sling
+}
+
+// newRateLimitService returns a new RateLimitService.
+func newRateLimitService(sling *sling.Sling) *RateLimitService {
+	return &RateLimitService{
+		sling: sling.Path("application/"),
+	}
+}
+
+// RateLimitStatusResponse response of rate limit status
+type RateLimitStatusResponse struct {
+	RateLimitContext *RateLimitContext   `json:"rate_limit_context,omitempty"`
+	Resources        *RateLimitResources `json:"resources,omitempty"`
+}
+
+// RateLimitContext contains auth context
+type RateLimitContext struct {
+	AccessToken string `json:"access_token,omitempty"`
+}
+
+// RateLimitResources contains all limit status data for endpoints group by resources
+type RateLimitResources struct {
+	Users    map[string]*RateLimitResource `json:"users,omitempty"`
+	Statuses map[string]*RateLimitResource `json:"statuses,omitempty"`
+	Help     map[string]*RateLimitResource `json:"help,omitempty"`
+	Search   map[string]*RateLimitResource `json:"search,omitempty"`
+}
+
+// RateLimitResource contains limit status data for a single endpoint
+type RateLimitResource struct {
+	Limit     int `json:"limit,omitempty"`
+	Remaining int `json:"remaining,omitempty"`
+	Reset     int `json:"reset,omitempty"`
+}
+
+// RateLimitStatusParams are the parameters for RateLimitService.Status.
+type RateLimitStatusParams struct {
+	Resources string `url:"resources,omitempty"`
+}
+
+// Status returns rate limits.
+// https://developer.twitter.com/en/docs/developer-utilities/rate-limit-status/api-reference/get-application-rate_limit_status
+func (s *RateLimitService) Status(params *RateLimitStatusParams) (RateLimitStatusResponse, *http.Response, error) {
+	rateLimitStatusResponse := new(RateLimitStatusResponse)
+	apiError := new(APIError)
+	resp, err := s.sling.New().Get("rate_limit_status.json").QueryStruct(params).Receive(rateLimitStatusResponse, apiError)
+	return *rateLimitStatusResponse, resp, relevantError(err, *apiError)
+}

twitter/rate_limits_test.go

@@ -0,0 +1,49 @@
+package twitter
+
+import (
+	"fmt"
+	"net/http"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRateLimitService_Status(t *testing.T) {
+	httpClient, mux, server := testServer()
+	defer server.Close()
+
+	mux.HandleFunc("/1.1/application/rate_limit_status.json", func(w http.ResponseWriter, r *http.Request) {
+		assertMethod(t, "GET", r)
+		assertQuery(t, map[string]string{"resources": "statuses,users,help"}, r)
+		w.Header().Set("Content-Type", "application/json")
+		fmt.Fprintf(w, `{"rate_limit_context":{"access_token":"786491-24zE39NUezJ8UTmOGOtLhgyLgCkPyY4dAcx6NA6sDKw"},"resources":{"users":{"/users/profile_banner":{"limit":180,"remaining":180,"reset":1403602426}},"statuses":{"/statuses/mentions_timeline":{"limit":75,"remaining":75,"reset":1403602426},"/statuses/lookup":{"limit":900,"remaining":900,"reset":1403602426}},"help":{"/help/privacy":{"limit":15,"remaining":15,"reset":1403602426}}}}`)
+	})
+
+	client := NewClient(httpClient)
+	tweets, _, err := client.RateLimits.Status(&RateLimitStatusParams{Resources: "statuses,users,help"})
+	expected := RateLimitStatusResponse{
+		RateLimitContext: &RateLimitContext{AccessToken: "786491-24zE39NUezJ8UTmOGOtLhgyLgCkPyY4dAcx6NA6sDKw"},
+		Resources: &RateLimitResources{
+			Users: map[string]*RateLimitResource{
+				"/users/profile_banner": &RateLimitResource{
+					Limit:     180,
+					Remaining: 180,
+					Reset:     1403602426}},
+			Statuses: map[string]*RateLimitResource{
+				"/statuses/mentions_timeline": &RateLimitResource{
+					Limit:     75,
+					Remaining: 75,
+					Reset:     1403602426},
+				"/statuses/lookup": &RateLimitResource{
+					Limit:     900,
+					Remaining: 900,
+					Reset:     1403602426}},
+			Help: map[string]*RateLimitResource{
+				"/help/privacy": &RateLimitResource{
+					Limit:     15,
+					Remaining: 15,
+					Reset:     1403602426}}}}
+
+	assert.Nil(t, err)
+	assert.Equal(t, expected, tweets)
+}

twitter/twitter.go

@@ -18,6 +18,7 @@ type Client struct {
 	Followers      *FollowerService
 	Friends        *FriendService
 	Friendships    *FriendshipService
+	RateLimits     *RateLimitService
 	Search         *SearchService
 	Statuses       *StatusService
 	Streams        *StreamService
@@ -37,6 +38,7 @@ func NewClient(httpClient *http.Client) *Client {
 		Followers:      newFollowerService(base.New()),
 		Friends:        newFriendService(base.New()),
 		Friendships:    newFriendshipService(base.New()),
+		RateLimits:     newRateLimitService(base.New()),
 		Search:         newSearchService(base.New()),
 		Statuses:       newStatusService(base.New()),
 		Streams:        newStreamService(httpClient, base.New()),