add support for user keys

github/users_keys.go

@@ -0,0 +1,104 @@
+// 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"
+
+// Key represents a public SSH key used to authenticate a user or deploy script.
+type Key struct {
+	ID    *int    `json:"id,omitempty"`
+	Key   *string `json:"key,omitempty"`
+	URL   *string `json:"url,omitempty"`
+	Title *string `json:"title,omitempty"`
+}
+
+func (k Key) String() string {
+	return Stringify(k)
+}
+
+// ListKeys lists the verified public keys for a user.  Passing the empty
+// string will fetch keys for the authenticated user.
+//
+// GitHub API docs: http://developer.github.com/v3/users/keys/#list-public-keys-for-a-user
+func (s *UsersService) ListKeys(user string) ([]Key, *Response, error) {
+	var u string
+	if user != "" {
+		u = fmt.Sprintf("users/%v/keys", user)
+	} else {
+		u = "user/keys"
+	}
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	keys := new([]Key)
+	resp, err := s.client.Do(req, keys)
+	return *keys, resp, err
+}
+
+// GetKey fetches a single public key.
+//
+// GitHub API docs: http://developer.github.com/v3/users/keys/#get-a-single-public-key
+func (s *UsersService) GetKey(id int) (*Key, *Response, error) {
+	u := fmt.Sprintf("user/keys/%v", id)
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	key := new(Key)
+	resp, err := s.client.Do(req, key)
+	return key, resp, err
+}
+
+// CreateKey adds a public key for the authenticated user.
+//
+// GitHub API docs: http://developer.github.com/v3/users/keys/#create-a-public-key
+func (s *UsersService) CreateKey(key *Key) (*Key, *Response, error) {
+	u := "user/keys"
+
+	req, err := s.client.NewRequest("POST", u, key)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	k := new(Key)
+	resp, err := s.client.Do(req, k)
+	return k, resp, err
+}
+
+// EditKey edits a public key.
+//
+// GitHub API docs: http://developer.github.com/v3/users/keys/#update-a-public-key
+func (s *UsersService) EditKey(id int, key *Key) (*Key, *Response, error) {
+	u := fmt.Sprintf("user/keys/%v", id)
+
+	req, err := s.client.NewRequest("PATCH", u, key)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	k := new(Key)
+	resp, err := s.client.Do(req, k)
+	return k, resp, err
+}
+
+// DeleteKey deletes a public key.
+//
+// GitHub API docs: http://developer.github.com/v3/users/keys/#delete-a-public-key
+func (s *UsersService) DeleteKey(id int) (*Response, error) {
+	u := fmt.Sprintf("user/keys/%v", id)
+
+	req, err := s.client.NewRequest("DELETE", u, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return s.client.Do(req, nil)
+}

github/users_keys_test.go

@@ -0,0 +1,151 @@
+// 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 (
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"reflect"
+	"testing"
+)
+
+func TestUsersService_ListKeys_authenticatedUser(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/user/keys", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprint(w, `[{"id":1}]`)
+	})
+
+	keys, _, err := client.Users.ListKeys("")
+	if err != nil {
+		t.Errorf("Users.ListKeys returned error: %v", err)
+	}
+
+	want := []Key{{ID: Int(1)}}
+	if !reflect.DeepEqual(keys, want) {
+		t.Errorf("Users.ListKeys returned %+v, want %+v", keys, want)
+	}
+}
+
+func TestUsersService_ListKeys_specifiedUser(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/users/u/keys", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprint(w, `[{"id":1}]`)
+	})
+
+	keys, _, err := client.Users.ListKeys("u")
+	if err != nil {
+		t.Errorf("Users.ListKeys returned error: %v", err)
+	}
+
+	want := []Key{{ID: Int(1)}}
+	if !reflect.DeepEqual(keys, want) {
+		t.Errorf("Users.ListKeys returned %+v, want %+v", keys, want)
+	}
+}
+
+func TestUsersService_ListKeys_invalidUser(t *testing.T) {
+	_, _, err := client.Users.ListKeys("%")
+	testURLParseError(t, err)
+}
+
+func TestUsersService_GetKey(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/user/keys/1", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprint(w, `{"id":1}`)
+	})
+
+	key, _, err := client.Users.GetKey(1)
+	if err != nil {
+		t.Errorf("Users.GetKey returned error: %v", err)
+	}
+
+	want := &Key{ID: Int(1)}
+	if !reflect.DeepEqual(key, want) {
+		t.Errorf("Users.GetKey returned %+v, want %+v", key, want)
+	}
+}
+
+func TestUsersService_CreateKey(t *testing.T) {
+	setup()
+	defer teardown()
+
+	input := &Key{Key: String("k"), Title: String("t")}
+
+	mux.HandleFunc("/user/keys", func(w http.ResponseWriter, r *http.Request) {
+		v := new(Key)
+		json.NewDecoder(r.Body).Decode(v)
+
+		testMethod(t, r, "POST")
+		if !reflect.DeepEqual(v, input) {
+			t.Errorf("Request body = %+v, want %+v", v, input)
+		}
+
+		fmt.Fprint(w, `{"id":1}`)
+	})
+
+	key, _, err := client.Users.CreateKey(input)
+	if err != nil {
+		t.Errorf("Users.GetKey returned error: %v", err)
+	}
+
+	want := &Key{ID: Int(1)}
+	if !reflect.DeepEqual(key, want) {
+		t.Errorf("Users.GetKey returned %+v, want %+v", key, want)
+	}
+}
+
+func TestUsersService_EditKey(t *testing.T) {
+	setup()
+	defer teardown()
+
+	input := &Key{Key: String("k"), Title: String("t")}
+
+	mux.HandleFunc("/user/keys/1", func(w http.ResponseWriter, r *http.Request) {
+		v := new(Key)
+		json.NewDecoder(r.Body).Decode(v)
+
+		testMethod(t, r, "PATCH")
+		if !reflect.DeepEqual(v, input) {
+			t.Errorf("Request body = %+v, want %+v", v, input)
+		}
+
+		fmt.Fprint(w, `{"id":1}`)
+	})
+
+	key, _, err := client.Users.EditKey(1, input)
+	if err != nil {
+		t.Errorf("Users.EditKey returned error: %v", err)
+	}
+
+	want := &Key{ID: Int(1)}
+	if !reflect.DeepEqual(key, want) {
+		t.Errorf("Users.EditKey returned %+v, want %+v", key, want)
+	}
+}
+
+func TestUsersService_DeleteKey(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/user/keys/1", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "DELETE")
+	})
+
+	_, err := client.Users.DeleteKey(1)
+	if err != nil {
+		t.Errorf("Users.DeleteKey returned error: %v", err)
+	}
+}