117 lines
3.7 KiB
Go
Vendored
117 lines
3.7 KiB
Go
Vendored
// Copyright 2021 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 (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
)
|
|
|
|
// HookDelivery represents the data that is received from GitHub's Webhook Delivery API
|
|
//
|
|
// GitHub API docs:
|
|
// - https://docs.github.com/en/rest/reference/repos#list-deliveries-for-a-repository-webhook
|
|
// - https://docs.github.com/en/rest/reference/repos#get-a-delivery-for-a-repository-webhook
|
|
type HookDelivery struct {
|
|
ID *int64 `json:"id"`
|
|
GUID *string `json:"guid"`
|
|
DeliveredAt *Timestamp `json:"delivered_at"`
|
|
Redelivery *bool `json:"redelivery"`
|
|
Duration *float64 `json:"duration"`
|
|
Status *string `json:"status"`
|
|
StatusCode *int `json:"status_code"`
|
|
Event *string `json:"event"`
|
|
Action *string `json:"action"`
|
|
InstallationID *string `json:"installation_id"`
|
|
RepositoryID *int64 `json:"repository_id"`
|
|
|
|
// Request is populated by GetHookDelivery.
|
|
Request *HookRequest `json:"request,omitempty"`
|
|
// Response is populated by GetHookDelivery.
|
|
Response *HookResponse `json:"response,omitempty"`
|
|
}
|
|
|
|
func (d HookDelivery) String() string {
|
|
return Stringify(d)
|
|
}
|
|
|
|
// HookRequest is a part of HookDelivery that contains
|
|
// the HTTP headers and the JSON payload of the webhook request.
|
|
type HookRequest struct {
|
|
Headers map[string]string `json:"headers,omitempty"`
|
|
RawPayload *json.RawMessage `json:"payload,omitempty"`
|
|
}
|
|
|
|
func (r HookRequest) String() string {
|
|
return Stringify(r)
|
|
}
|
|
|
|
// HookResponse is a part of HookDelivery that contains
|
|
// the HTTP headers and the response body served by the webhook endpoint.
|
|
type HookResponse struct {
|
|
Headers map[string]string `json:"headers,omitempty"`
|
|
RawPayload *json.RawMessage `json:"payload,omitempty"`
|
|
}
|
|
|
|
func (r HookResponse) String() string {
|
|
return Stringify(r)
|
|
}
|
|
|
|
// ListHookDeliveries lists webhook deliveries for a webhook configured in a repository.
|
|
//
|
|
// GitHub API docs: https://docs.github.com/en/rest/reference/repos#list-deliveries-for-a-repository-webhook
|
|
func (s *RepositoriesService) ListHookDeliveries(ctx context.Context, owner, repo string, id int64, opts *ListCursorOptions) ([]*HookDelivery, *Response, error) {
|
|
u := fmt.Sprintf("repos/%v/%v/hooks/%v/deliveries", owner, repo, id)
|
|
u, err := addOptions(u, opts)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
req, err := s.client.NewRequest("GET", u, nil)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
deliveries := []*HookDelivery{}
|
|
resp, err := s.client.Do(ctx, req, &deliveries)
|
|
if err != nil {
|
|
return nil, resp, err
|
|
}
|
|
|
|
return deliveries, resp, nil
|
|
}
|
|
|
|
// GetHookDelivery returns a delivery for a webhook configured in a repository.
|
|
//
|
|
// GitHub API docs: https://docs.github.com/en/rest/reference/repos#get-a-delivery-for-a-repository-webhook
|
|
func (s *RepositoriesService) GetHookDelivery(ctx context.Context, owner, repo string, hookID, deliveryID int64) (*HookDelivery, *Response, error) {
|
|
u := fmt.Sprintf("repos/%v/%v/hooks/%v/deliveries/%v", owner, repo, hookID, deliveryID)
|
|
req, err := s.client.NewRequest("GET", u, nil)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
h := new(HookDelivery)
|
|
resp, err := s.client.Do(ctx, req, h)
|
|
if err != nil {
|
|
return nil, resp, err
|
|
}
|
|
|
|
return h, resp, nil
|
|
}
|
|
|
|
// ParseRequestPayload parses the request payload. For recognized event types,
|
|
// a value of the corresponding struct type will be returned.
|
|
func (d *HookDelivery) ParseRequestPayload() (interface{}, error) {
|
|
eType, ok := eventTypeMapping[*d.Event]
|
|
if !ok {
|
|
return nil, fmt.Errorf("unsupported event type %q", *d.Event)
|
|
}
|
|
|
|
e := &Event{Type: &eType, RawPayload: d.Request.RawPayload}
|
|
return e.ParsePayload()
|
|
}
|