implement User Followers API

closes #46

github/users_followers.go

@@ -0,0 +1,100 @@
+// Copyright 2013 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 "fmt"
+
+// ListFollowers lists the followers for a user.  Passing the empty string will
+// fetch followers for the authenticated user.
+//
+// GitHub API docs: http://developer.github.com/v3/users/followers/#list-followers-of-a-user
+func (s *UsersService) ListFollowers(user string) ([]User, *Response, error) {
+	var u string
+	if user != "" {
+		u = fmt.Sprintf("users/%v/followers", user)
+	} else {
+		u = "user/followers"
+	}
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	users := new([]User)
+	resp, err := s.client.Do(req, users)
+	return *users, resp, err
+}
+
+// ListFollowing lists the people that a user is following.  Passing the empty
+// string will list people the authenticated user is following.
+//
+// GitHub API docs: http://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
+func (s *UsersService) ListFollowing(user string) ([]User, *Response, error) {
+	var u string
+	if user != "" {
+		u = fmt.Sprintf("users/%v/following", user)
+	} else {
+		u = "user/following"
+	}
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	users := new([]User)
+	resp, err := s.client.Do(req, users)
+	return *users, resp, err
+}
+
+// IsFollowing checks if "user" is following "target".  Passing the empty
+// string for "user" will check if the authenticated user is following "target".
+//
+// GitHub API docs: http://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user
+func (s *UsersService) IsFollowing(user, target string) (bool, *Response, error) {
+	var u string
+	if user != "" {
+		u = fmt.Sprintf("users/%v/following/%v", user, target)
+	} else {
+		u = fmt.Sprintf("user/following/%v", target)
+	}
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return false, nil, err
+	}
+
+	resp, err := s.client.Do(req, nil)
+	following, err := parseBoolResponse(err)
+	return following, resp, err
+}
+
+// Follow will cause the authenticated user to follow the specified user.
+//
+// GitHub API docs: http://developer.github.com/v3/users/followers/#follow-a-user
+func (s *UsersService) Follow(user string) (*Response, error) {
+	u := fmt.Sprintf("user/following/%v", user)
+	req, err := s.client.NewRequest("PUT", u, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return s.client.Do(req, nil)
+}
+
+// Unfollow will cause the authenticated user to unfollow the specified user.
+//
+// GitHub API docs: http://developer.github.com/v3/users/followers/#unfollow-a-user
+func (s *UsersService) Unfollow(user string) (*Response, error) {
+	u := fmt.Sprintf("user/following/%v", user)
+	req, err := s.client.NewRequest("DELETE", u, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return s.client.Do(req, nil)
+}

github/users_followers_test.go

@@ -0,0 +1,218 @@
+// Copyright 2013 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 (
+	"fmt"
+	"net/http"
+	"reflect"
+	"testing"
+)
+
+func TestUsersService_ListFollowers_authenticatedUser(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/user/followers", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprint(w, `[{"id":1}]`)
+	})
+
+	users, _, err := client.Users.ListFollowers("")
+	if err != nil {
+		t.Errorf("Users.ListFollowers returned error: %v", err)
+	}
+
+	want := []User{{ID: Int(1)}}
+	if !reflect.DeepEqual(users, want) {
+		t.Errorf("Users.ListFollowers returned %+v, want %+v", users, want)
+	}
+}
+
+func TestUsersService_ListFollowers_specifiedUser(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/users/u/followers", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprint(w, `[{"id":1}]`)
+	})
+
+	users, _, err := client.Users.ListFollowers("u")
+	if err != nil {
+		t.Errorf("Users.ListFollowers returned error: %v", err)
+	}
+
+	want := []User{{ID: Int(1)}}
+	if !reflect.DeepEqual(users, want) {
+		t.Errorf("Users.ListFollowers returned %+v, want %+v", users, want)
+	}
+}
+
+func TestUsersService_ListFollowers_invalidUser(t *testing.T) {
+	_, _, err := client.Users.ListFollowers("%")
+	testURLParseError(t, err)
+}
+
+func TestUsersService_ListFollowing_authenticatedUser(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/user/following", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprint(w, `[{"id":1}]`)
+	})
+
+	users, _, err := client.Users.ListFollowing("")
+	if err != nil {
+		t.Errorf("Users.ListFollowing returned error: %v", err)
+	}
+
+	want := []User{{ID: Int(1)}}
+	if !reflect.DeepEqual(users, want) {
+		t.Errorf("Users.ListFollowing returned %+v, want %+v", users, want)
+	}
+}
+
+func TestUsersService_ListFollowing_specifiedUser(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/users/u/following", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprint(w, `[{"id":1}]`)
+	})
+
+	users, _, err := client.Users.ListFollowing("u")
+	if err != nil {
+		t.Errorf("Users.ListFollowing returned error: %v", err)
+	}
+
+	want := []User{{ID: Int(1)}}
+	if !reflect.DeepEqual(users, want) {
+		t.Errorf("Users.ListFollowing returned %+v, want %+v", users, want)
+	}
+}
+
+func TestUsersService_ListFollowing_invalidUser(t *testing.T) {
+	_, _, err := client.Users.ListFollowing("%")
+	testURLParseError(t, err)
+}
+
+func TestUsersService_IsFollowing_authenticatedUser(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/user/following/t", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		w.WriteHeader(http.StatusNoContent)
+	})
+
+	following, _, err := client.Users.IsFollowing("", "t")
+	if err != nil {
+		t.Errorf("Users.IsFollowing returned error: %v", err)
+	}
+	if want := true; following != want {
+		t.Errorf("Users.IsFollowing returned %+v, want %+v", following, want)
+	}
+}
+
+func TestUsersService_IsFollowing_specifiedUser(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/users/u/following/t", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		w.WriteHeader(http.StatusNoContent)
+	})
+
+	following, _, err := client.Users.IsFollowing("u", "t")
+	if err != nil {
+		t.Errorf("Users.IsFollowing returned error: %v", err)
+	}
+	if want := true; following != want {
+		t.Errorf("Users.IsFollowing returned %+v, want %+v", following, want)
+	}
+}
+
+func TestUsersService_IsFollowing_false(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/users/u/following/t", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		w.WriteHeader(http.StatusNotFound)
+	})
+
+	following, _, err := client.Users.IsFollowing("u", "t")
+	if err != nil {
+		t.Errorf("Users.IsFollowing returned error: %v", err)
+	}
+	if want := false; following != want {
+		t.Errorf("Users.IsFollowing returned %+v, want %+v", following, want)
+	}
+}
+
+func TestUsersService_IsFollowing_error(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/users/u/following/t", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		http.Error(w, "BadRequest", http.StatusBadRequest)
+	})
+
+	following, _, err := client.Users.IsFollowing("u", "t")
+	if err == nil {
+		t.Errorf("Expected HTTP 400 response")
+	}
+	if want := false; following != want {
+		t.Errorf("Users.IsFollowing returned %+v, want %+v", following, want)
+	}
+}
+
+func TestUsersService_IsFollowing_invalidUser(t *testing.T) {
+	_, _, err := client.Users.IsFollowing("%", "%")
+	testURLParseError(t, err)
+}
+
+func TestUsersService_Follow(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/user/following/u", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "PUT")
+	})
+
+	_, err := client.Users.Follow("u")
+	if err != nil {
+		t.Errorf("Users.Follow returned error: %v", err)
+	}
+}
+
+func TestUsersService_Follow_invalidUser(t *testing.T) {
+	_, err := client.Users.Follow("%")
+	testURLParseError(t, err)
+}
+
+func TestUsersService_Unfollow(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/user/following/u", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "DELETE")
+	})
+
+	_, err := client.Users.Unfollow("u")
+	if err != nil {
+		t.Errorf("Users.Follow returned error: %v", err)
+	}
+}
+
+func TestUsersService_Unfollow_invalidUser(t *testing.T) {
+	_, err := client.Users.Unfollow("%")
+	testURLParseError(t, err)
+}