client

Documentation

Overview

Copyright 2024 Chao Feng

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2024 Chao Feng

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func CollectReqFields(r *http.Request) *map[string]interface{}
• type Authenticate
• type Authentication
  • func (a *Authentication) Auth(w http.ResponseWriter, r *http.Request) error
• type EventHeader
• type EventPayload
• type GenericEvent
• type IssuePayload
• type PullRequestPayload
• type PushPayload
• type ReqLogging

Functions

func CollectReqFields

func CollectReqFields(r *http.Request) *map[string]interface{}

Types

type Authenticate

type Authenticate interface {
	Auth(w http.ResponseWriter, r *http.Request) error
	GetPayload() *bytes.Buffer
	GetEventType() *string
	GetEventGUID() *string
}

type Authentication

type Authentication struct {
	Authenticate
	Secret  []byte
	CodeHub string
}

func (*Authentication) Auth

func (a *Authentication) Auth(w http.ResponseWriter, r *http.Request) error

type EventHeader

type EventHeader struct {
	EventType    int    // dispatcher.go constants defined
	PlatformName string // "github", "gitee", "gitlab", "atomgit", "gitcode" etc
	EventName    string // "Push Hook" => PushEvent , "Issue Hook" => IssueEvent,
	// "Merge Request Hook" => PullRequestEvent, "Note Hook" => IssueCommentEvent & PullRequestCommentEvent
	EventGUID string // event id
}

type EventPayload

type EventPayload struct {
	Action  string
	Org     string
	Repo    string
	HtmlURL string
	PushPayload
	IssuePayload
	PullRequestPayload
}

type GenericEvent

type GenericEvent struct {
	EventHeader
	EventPayload
	MetaPayload []byte
}

type IssuePayload

type IssuePayload struct {
	IssueNumber    string
	IssueAuthor    string
	IssueComment   string
	IssueCommenter string
	IssueLabels    []string
}

type PullRequestPayload

type PullRequestPayload struct {
	PRNumber    string
	PRAuthor    string
	PRComment   string
	PRCommenter string
	PRLabels    []string
}

type PushPayload

type PushPayload struct {
	Base string
	Head string
}

PushPayload data come from PushEvent

type ReqLogging

type ReqLogging interface {
	// contains filtered or unexported methods
}