Browse Source

Add support for Feeds API

Fixes #191.

Change-Id: I2fbcca9913cd20df75e9b5a5272a50879025d526
Glenn Lewis 10 years ago
parent
commit
b86f6fcb28
2 changed files with 183 additions and 0 deletions
  1. +55
    -0
      github/activity.go
  2. +128
    -0
      github/activity_test.go

+ 55
- 0
github/activity.go View File

@ -12,3 +12,58 @@ package github
type ActivityService struct {
client *Client
}
// FeedLink represents a link to a related resource.
type FeedLink struct {
HRef *string `json:"href,omitempty"`
Type *string `json:"type,omitempty"`
}
// Feeds represents timeline resources in Atom format.
type Feeds struct {
TimelineURL *string `json:"timeline_url,omitempty"`
UserURL *string `json:"user_url,omitempty"`
CurrentUserPublicURL *string `json:"current_user_public_url,omitempty"`
CurrentUserURL *string `json:"current_user_url,omitempty"`
CurrentUserActorURL *string `json:"current_user_actor_url,omitempty"`
CurrentUserOrganizationURL *string `json:"current_user_organization_url,omitempty"`
CurrentUserOrganizationURLs []string `json:"current_user_organization_urls,omitempty"`
Links *struct {
Timeline *FeedLink `json:"timeline,omitempty"`
User *FeedLink `json:"user,omitempty"`
CurrentUserPublic *FeedLink `json:"current_user_public,omitempty"`
CurrentUser *FeedLink `json:"current_user,omitempty"`
CurrentUserActor *FeedLink `json:"current_user_actor,omitempty"`
CurrentUserOrganization *FeedLink `json:"current_user_organization,omitempty"`
CurrentUserOrganizations []FeedLink `json:"current_user_organizations,omitempty"`
} `json:"_links,omitempty"`
}
// ListFeeds lists all the feeds available to the authenticated user.
//
// GitHub provides several timeline resources in Atom format:
// Timeline: The GitHub global public timeline
// User: The public timeline for any user, using URI template
// Current user public: The public timeline for the authenticated user
// Current user: The private timeline for the authenticated user
// Current user actor: The private timeline for activity created by the
// authenticated user
// Current user organizations: The private timeline for the organizations
// the authenticated user is a member of.
//
// Note: Private feeds are only returned when authenticating via Basic Auth
// since current feed URIs use the older, non revocable auth tokens.
func (s *ActivityService) ListFeeds() (*Feeds, *Response, error) {
req, err := s.client.NewRequest("GET", "feeds", nil)
if err != nil {
return nil, nil, err
}
f := &Feeds{}
resp, err := s.client.Do(req, f)
if err != nil {
return nil, resp, err
}
return f, resp, nil
}

+ 128
- 0
github/activity_test.go View File

@ -0,0 +1,128 @@
// Copyright 2016 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package github
import (
"net/http"
"reflect"
"testing"
)
func TestActivityService_List(t *testing.T) {
setup()
defer teardown()
mux.HandleFunc("/feeds", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
w.WriteHeader(http.StatusOK)
w.Write(feedsJSON)
})
got, _, err := client.Activity.ListFeeds()
if err != nil {
t.Errorf("Activity.ListFeeds returned error: %v", err)
}
if want := wantFeeds; !reflect.DeepEqual(got, want) {
t.Errorf("Activity.ListFeeds = %+v, want %+v", got, want)
}
}
var feedsJSON = []byte(`{
"timeline_url": "https://github.com/timeline",
"user_url": "https://github.com/{user}",
"current_user_public_url": "https://github.com/defunkt",
"current_user_url": "https://github.com/defunkt.private?token=abc123",
"current_user_actor_url": "https://github.com/defunkt.private.actor?token=abc123",
"current_user_organization_url": "",
"current_user_organization_urls": [
"https://github.com/organizations/github/defunkt.private.atom?token=abc123"
],
"_links": {
"timeline": {
"href": "https://github.com/timeline",
"type": "application/atom+xml"
},
"user": {
"href": "https://github.com/{user}",
"type": "application/atom+xml"
},
"current_user_public": {
"href": "https://github.com/defunkt",
"type": "application/atom+xml"
},
"current_user": {
"href": "https://github.com/defunkt.private?token=abc123",
"type": "application/atom+xml"
},
"current_user_actor": {
"href": "https://github.com/defunkt.private.actor?token=abc123",
"type": "application/atom+xml"
},
"current_user_organization": {
"href": "",
"type": ""
},
"current_user_organizations": [
{
"href": "https://github.com/organizations/github/defunkt.private.atom?token=abc123",
"type": "application/atom+xml"
}
]
}
}`)
var wantFeeds = &Feeds{
TimelineURL: String("https://github.com/timeline"),
UserURL: String("https://github.com/{user}"),
CurrentUserPublicURL: String("https://github.com/defunkt"),
CurrentUserURL: String("https://github.com/defunkt.private?token=abc123"),
CurrentUserActorURL: String("https://github.com/defunkt.private.actor?token=abc123"),
CurrentUserOrganizationURL: String(""),
CurrentUserOrganizationURLs: []string{
"https://github.com/organizations/github/defunkt.private.atom?token=abc123",
},
Links: &struct {
Timeline *FeedLink `json:"timeline,omitempty"`
User *FeedLink `json:"user,omitempty"`
CurrentUserPublic *FeedLink `json:"current_user_public,omitempty"`
CurrentUser *FeedLink `json:"current_user,omitempty"`
CurrentUserActor *FeedLink `json:"current_user_actor,omitempty"`
CurrentUserOrganization *FeedLink `json:"current_user_organization,omitempty"`
CurrentUserOrganizations []FeedLink `json:"current_user_organizations,omitempty"`
}{
Timeline: &FeedLink{
HRef: String("https://github.com/timeline"),
Type: String("application/atom+xml"),
},
User: &FeedLink{
HRef: String("https://github.com/{user}"),
Type: String("application/atom+xml"),
},
CurrentUserPublic: &FeedLink{
HRef: String("https://github.com/defunkt"),
Type: String("application/atom+xml"),
},
CurrentUser: &FeedLink{
HRef: String("https://github.com/defunkt.private?token=abc123"),
Type: String("application/atom+xml"),
},
CurrentUserActor: &FeedLink{
HRef: String("https://github.com/defunkt.private.actor?token=abc123"),
Type: String("application/atom+xml"),
},
CurrentUserOrganization: &FeedLink{
HRef: String(""),
Type: String(""),
},
CurrentUserOrganizations: []FeedLink{
{
HRef: String("https://github.com/organizations/github/defunkt.private.atom?token=abc123"),
Type: String("application/atom+xml"),
},
},
},
}

Loading…
Cancel
Save