Add support for deployment api

github/github.go

@@ -39,6 +39,9 @@ const (
 
 	// https://developer.github.com/changes/2014-08-05-team-memberships-api/
 	mediaTypeMembershipPreview = "application/vnd.github.the-wasp-preview+json"
+
+	// https://developer.github.com/changes/2014-01-09-preview-the-new-deployments-api/
+	mediaTypeDeploymentPreview = "application/vnd.github.cannonball-preview+json"
 )
 
 // A Client manages communication with the GitHub API.

github/repos_deployments.go

@@ -0,0 +1,174 @@
+// Copyright 2014 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"
+)
+
+// Deployment represents a deployment in a repo
+type Deployment struct {
+	Url         *string         `json:"url,omitempty"`
+	ID          *int            `json:"id,omitempty"`
+	SHA         *string         `json:"sha,omitempty"`
+	Ref         *string         `json:"ref,omitempty"`
+	Task        *string         `json:"task,omitempty"`
+	Payload     json.RawMessage `json:"payload,omitempty"`
+	Environment *string         `json:"environment,omitempty"`
+	Description *string         `json:"description,omitempty"`
+	Creator     *User           `json:"creator,omitempty"`
+	CreatedAt   *Timestamp      `json:"created_at,omitempty"`
+	UpdatedAt   *Timestamp      `json:"pushed_at,omitempty"`
+}
+
+// DeploymentRequest represents a deployment request
+type DeploymentRequest struct {
+	Ref              *string  `json:"ref,omitempty"`
+	Task             *string  `json:"task,omitempty"`
+	AutoMerge        *bool    `json:"auto_merge,omitempty"`
+	RequiredContexts []string `json:"required_contexts,omitempty"`
+	Payload          *string  `json:"payload,omitempty"`
+	Environment      *string  `json:"environment,omitempty"`
+	Description      *string  `json:"description,omitempty"`
+}
+
+// DeploymentsListOptions specifies the optional parameters to the
+// RepositoriesService.ListDeployments method.
+type DeploymentsListOptions struct {
+	// SHA of the Deployment.
+	SHA string `url:"sha,omitempty"`
+
+	// List deployments for a given ref.
+	Ref string `url:"ref,omitempty"`
+
+	// List deployments for a given task.
+	Task string `url:"task,omitempty"`
+
+	// List deployments for a given environment.
+	Environment string `url:"environment,omitempty"`
+
+	ListOptions
+}
+
+// ListDeployments lists the deployments of a repository.
+//
+// GitHub API docs: https://developer.github.com/v3/repos/deployments/#list-deployments
+func (s *RepositoriesService) ListDeployments(owner, repo string, opt *DeploymentsListOptions) ([]Deployment, *Response, error) {
+	u := fmt.Sprintf("repos/%v/%v/deployments", owner, repo)
+	u, err := addOptions(u, opt)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	// TODO: remove custom Accept header when this API fully launches
+	req.Header.Set("Accept", mediaTypeDeploymentPreview)
+
+	deployments := new([]Deployment)
+	resp, err := s.client.Do(req, deployments)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return *deployments, resp, err
+}
+
+// CreateDeployment creates a new deployment for a repository.
+//
+// GitHub API docs: https://developer.github.com/v3/repos/deployments/#create-a-deployment
+func (s *RepositoriesService) CreateDeployment(owner, repo string, request *DeploymentRequest) (*Deployment, *Response, error) {
+	u := fmt.Sprintf("repos/%v/%v/deployments", owner, repo)
+
+	req, err := s.client.NewRequest("POST", u, request)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	// TODO: remove custom Accept header when this API fully launches
+	req.Header.Set("Accept", mediaTypeDeploymentPreview)
+
+	d := new(Deployment)
+	resp, err := s.client.Do(req, d)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return d, resp, err
+}
+
+// DeploymentStatus represents the status of a
+// particular deployment.
+type DeploymentStatus struct {
+	ID          *int       `json:"id,omitempty"`
+	State       *string    `json:"state,omitempty"`
+	Creator     *User      `json:"creator,omitempty"`
+	Description *string    `json:"description,omitempty"`
+	TargetUrl   *string    `json:"target_url,omitempty"`
+	CreatedAt   *Timestamp `json:"created_at,omitempty"`
+	UpdatedAt   *Timestamp `json:"pushed_at,omitempty"`
+}
+
+// DeploymentRequest represents a deployment request
+type DeploymentStatusRequest struct {
+	State       *string `json:"state,omitempty"`
+	TargetUrl   *string `json:"target_url,omitempty"`
+	Description *string `json:"description,omitempty"`
+}
+
+// ListDeploymentStatuses lists the statuses of a given deployment of a repository.
+//
+// GitHub API docs: https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
+func (s *RepositoriesService) ListDeploymentStatuses(owner, repo string, deployment int, opt *ListOptions) ([]DeploymentStatus, *Response, error) {
+	u := fmt.Sprintf("repos/%v/%v/deployments/%v/statuses", owner, repo, deployment)
+	u, err := addOptions(u, opt)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	// TODO: remove custom Accept header when this API fully launches
+	req.Header.Set("Accept", mediaTypeDeploymentPreview)
+
+	statuses := new([]DeploymentStatus)
+	resp, err := s.client.Do(req, statuses)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return *statuses, resp, err
+}
+
+// CreateDeploymentStatus creates a new status for a deployment.
+//
+// GitHub API docs: https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
+func (s *RepositoriesService) CreateDeploymentStatus(owner, repo string, deployment int, request *DeploymentStatusRequest) (*DeploymentStatus, *Response, error) {
+	u := fmt.Sprintf("repos/%v/%v/deployments/%v/statuses", owner, repo, deployment)
+
+	req, err := s.client.NewRequest("POST", u, request)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	// TODO: remove custom Accept header when this API fully launches
+	req.Header.Set("Accept", mediaTypeDeploymentPreview)
+
+	d := new(DeploymentStatus)
+	resp, err := s.client.Do(req, d)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return d, resp, err
+}

github/repos_deployments_test.go

@@ -0,0 +1,87 @@
+// Copyright 2014 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 TestRepositoriesService_ListDeployments(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/repos/o/r/deployments", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		testFormValues(t, r, values{"environment": "test"})
+		fmt.Fprint(w, `[{"id":1}, {"id":2}]`)
+	})
+
+	opt := &DeploymentsListOptions{Environment: "test"}
+	deployments, _, err := client.Repositories.ListDeployments("o", "r", opt)
+	if err != nil {
+		t.Errorf("Repositories.ListDeployments returned error: %v", err)
+	}
+
+	want := []Deployment{{ID: Int(1)}, {ID: Int(2)}}
+	if !reflect.DeepEqual(deployments, want) {
+		t.Errorf("Repositories.ListDeployments returned %+v, want %+v", deployments, want)
+	}
+}
+
+func TestRepositoriesService_CreateDeployment(t *testing.T) {
+	setup()
+	defer teardown()
+
+	input := &DeploymentRequest{Ref: String("1111"), Task: String("deploy")}
+
+	mux.HandleFunc("/repos/o/r/deployments", func(w http.ResponseWriter, r *http.Request) {
+		v := new(DeploymentRequest)
+		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, `{"ref": "1111", "task": "deploy"}`)
+	})
+
+	deployment, _, err := client.Repositories.CreateDeployment("o", "r", input)
+	if err != nil {
+		t.Errorf("Repositories.CreateDeployment returned error: %v", err)
+	}
+
+	want := &Deployment{Ref: String("1111"), Task: String("deploy")}
+	if !reflect.DeepEqual(deployment, want) {
+		t.Errorf("Repositories.CreateDeployment returned %+v, want %+v", deployment, want)
+	}
+}
+
+func TestRepositoriesService_ListDeploymentStatuses(t *testing.T) {
+	setup()
+	defer teardown()
+
+	mux.HandleFunc("/repos/o/r/deployments/1/statuses", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		testFormValues(t, r, values{"page": "2"})
+		fmt.Fprint(w, `[{"id":1}, {"id":2}]`)
+	})
+
+	opt := &ListOptions{Page: 2}
+	statutses, _, err := client.Repositories.ListDeploymentStatuses("o", "r", 1, opt)
+	if err != nil {
+		t.Errorf("Repositories.ListDeploymentStatuses returned error: %v", err)
+	}
+
+	want := []DeploymentStatus{{ID: Int(1)}, {ID: Int(2)}}
+	if !reflect.DeepEqual(statutses, want) {
+		t.Errorf("Repositories.ListDeploymentStatuses returned %+v, want %+v", statutses, want)
+	}
+}