EventsService

github/events.go

@@ -0,0 +1,101 @@
+// Copyright 2013 Google. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file or at
+// https://developers.google.com/open-source/licenses/bsd
+
+package github
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/url"
+	"strconv"
+	"time"
+)
+
+// EventsService provides access to the event related functions
+// in the GitHub API.
+//
+// GitHub API docs: http://developer.github.com/v3/activity/events/
+type EventsService struct {
+	client *Client
+}
+
+// Event represents a GitHub event.
+type Event struct {
+	Type       string          `json:"type,omitempty"`
+	Public     bool            `json:"public"`
+	RawPayload json.RawMessage `json:"payload,omitempty"`
+	Repo       *Repository     `json:"repo,omitempty"`
+	Actor      User            `json:"actor,omitempty"`
+	Org        *Organization   `json:"org,omitempty"`
+	CreatedAt  *time.Time      `json:"created_at,omitempty"`
+	ID         string          `json:"id,omitempty"`
+}
+
+// Payload returns the parsed event payload. For recognized event types
+// (PushEvent), a value of the corresponding struct type will be returned.
+func (e *Event) Payload() (payload interface{}) {
+	switch e.Type {
+	case "PushEvent":
+		payload = &PushEvent{}
+	}
+	if err := json.Unmarshal(e.RawPayload, &payload); err != nil {
+		panic(err.Error())
+	}
+	return payload
+}
+
+// PushEvent represents a git push to a GitHub repository.
+//
+// GitHub API docs: http://developer.github.com/v3/activity/events/types/#pushevent
+type PushEvent struct {
+	PushID  int          `json:"push_id,omitempty"`
+	Head    string       `json:"head,omitempty"`
+	Ref     string       `json:"ref,omitempty"`
+	Size    int          `json:"ref,omitempty"`
+	Commits []PushCommit `json:"commits,omitempty"`
+}
+
+// PushCommit represents a git commit in a GitHub PushEvent.
+type PushCommit struct {
+	SHA      string           `json:"sha,omitempty"`
+	Message  string           `json:"message,omitempty"`
+	Author   PushCommitAuthor `json:"author,omitempty"`
+	URL      string           `json:"url,omitempty"`
+	Distinct bool             `json:"distinct"`
+}
+
+// PushCommitAuthor represents the author of a git commit in a GitHub
+// PushEvent.
+type PushCommitAuthor struct {
+	Name  string `json:"name,omitempty"`
+	Email string `json:"email,omitempty"`
+}
+
+// ListPerformedByUser lists the events performed by a user. If publicOnly is
+// true, only public events will be returned.
+//
+// GitHub API docs: http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user
+func (s *EventsService) ListPerformedByUser(user string, publicOnly bool, opt *ListOptions) ([]Event, error) {
+	url_ := fmt.Sprintf("users/%v/events", user)
+	if publicOnly {
+		url_ += "/public"
+	}
+	if opt != nil {
+		params := url.Values{
+			"page": []string{strconv.Itoa(opt.Page)},
+		}
+		url_ += "?" + params.Encode()
+	}
+
+	req, err := s.client.NewRequest("GET", url_, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	events := new([]Event)
+	_, err = s.client.Do(req, events)
+	return *events, err
+}

github/events_test.go

@@ -0,0 +1,88 @@
+// Copyright 2013 Google. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file or at
+// https://developers.google.com/open-source/licenses/bsd
+
+package github
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"reflect"
+	"testing"
+)
+
+func TestEventsService_ListPerformedByUser_all(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/users/u/events", func(w http.ResponseWriter, r *http.Request) {
+		if m := "GET"; m != r.Method {
+			t.Errorf("Request method = %v, want %v", r.Method, m)
+		}
+		fmt.Fprint(w, `[{"id":"1"},{"id":"2"}]`)
+	})
+
+	events, err := client.Events.ListPerformedByUser("u", false, nil)
+	if err != nil {
+		t.Errorf("Events.ListPerformedByUser returned error: %v", err)
+	}
+
+	want := []Event{Event{ID: "1"}, Event{ID: "2"}}
+	if !reflect.DeepEqual(events, want) {
+		t.Errorf("Events.ListPerformedByUser returned %+v, want %+v", events, want)
+	}
+}
+
+func TestEventsService_ListPerformedByUser_publicOnly(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/users/u/events/public", func(w http.ResponseWriter, r *http.Request) {
+		if m := "GET"; m != r.Method {
+			t.Errorf("Request method = %v, want %v", r.Method, m)
+		}
+		fmt.Fprint(w, `[{"id":"1"},{"id":"2"}]`)
+	})
+
+	events, err := client.Events.ListPerformedByUser("u", true, nil)
+	if err != nil {
+		t.Errorf("Events.ListPerformedByUser returned error: %v", err)
+	}
+
+	want := []Event{Event{ID: "1"}, Event{ID: "2"}}
+	if !reflect.DeepEqual(events, want) {
+		t.Errorf("Events.ListPerformedByUser returned %+v, want %+v", events, want)
+	}
+}
+
+func TestEvent_Payload_typed(t *testing.T) {
+	raw := []byte(`{"type": "PushEvent","payload":{"push_id": 1}}`)
+	var event *Event
+	if err := json.Unmarshal(raw, &event); err != nil {
+		t.Fatalf("Unmarshal Event returned error: %v", err)
+	}
+
+	want := &PushEvent{PushID: 1}
+	if !reflect.DeepEqual(event.Payload(), want) {
+		t.Errorf("Event Payload returned %+v, want %+v", event.Payload(), want)
+	}
+}
+
+// TestEvent_Payload_untyped checks that unrecognized events are parsed to an
+// interface{} value (instead of being discarded or throwing an error), for
+// forward compatibility with new event types.
+func TestEvent_Payload_untyped(t *testing.T) {
+	raw := []byte(`{"type": "UnrecognizedEvent","payload":{"field": "val"}}`)
+	var event *Event
+	if err := json.Unmarshal(raw, &event); err != nil {
+		t.Fatalf("Unmarshal Event returned error: %v", err)
+	}
+
+	want := map[string]interface{}{"field": "val"}
+	if !reflect.DeepEqual(event.Payload(), want) {
+		t.Errorf("Event Payload returned %+v, want %+v", event.Payload(), want)
+	}
+}

github/github.go

@@ -75,6 +75,7 @@ type Client struct {
 
 	// Services used for talking to different parts of the API
 
+	Events        *EventsService
 	Organizations *OrganizationsService
 	Repositories  *RepositoriesService
 	Users         *UsersService
@@ -98,6 +99,7 @@ func NewClient(httpClient *http.Client) *Client {
 	baseURL, _ := url.Parse(defaultBaseURL)
 
 	c := &Client{client: httpClient, BaseURL: baseURL, UserAgent: userAgent}
+	c.Events = &EventsService{client: c}
 	c.Organizations = &OrganizationsService{client: c}
 	c.Repositories = &RepositoriesService{client: c}
 	c.Users = &UsersService{client: c}