api

package

v0.0.0-...-0b0b839 Latest Latest Go to latest Published: Jun 19, 2020 License: GPL-3.0 Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ckeyer/sloth

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AddSettings(ctx *gin.Context)
func CorsHandle(ctx *gin.Context)
func GHAuthCallback(ctx *gin.Context)
func GHBindCallback(ctx *gin.Context)
func GetAccessURL(ctx *gin.Context)
func GetBindURL(ctx *gin.Context)
func GetProject(ctx *gin.Context)
func GetSettings(ctx *gin.Context)
func GetStatus(ctx *gin.Context)
func GetUser(ctx *gin.Context)
func GinError(ctx *gin.Context, status int, err ...interface{})
func GinH(h interface{}) gin.HandlerFunc
func GinLogger(ctx *gin.Context)
func GinMessage(ctx *gin.Context, status int, msg ...interface{})
func GithubWebhooks(rw http.ResponseWriter, req *http.Request)
func ListProjects(ctx *gin.Context)
func Login(ctx *gin.Context)
func Logout(ctx *gin.Context)
func MWAuthGithubServer(rw http.ResponseWriter, req *http.Request)
func MWLoadGithubApp(ctx *gin.Context)
func MWRequireAdmin(ctx *gin.Context)
func MWRequireGithubCli(ctx *gin.Context)
func MWRequireLogin(ctx *gin.Context)
func NewGin() *gin.Engine
func NewProject(ctx *gin.Context)
func NotFound(rw http.ResponseWriter, req *http.Request)
func Registry(ctx *gin.Context)
func RemoveProject(ctx *gin.Context)
func Serve(listenAddr string, db *mgo.Database)
func SetMgoDB(db *mgo.Database) gin.HandlerFunc
func TODO(ctx *gin.Context)
func UpdateProject(ctx *gin.Context)
func WebhookRouter(r *gin.RouterGroup)

Constants ¶

View Source

const (
	// royter prefix
	API_PREFIX = "/api"
	WEB_HOOKS  = "/webhooks"

	// gin.Context.Set key
	CtxKeyMgoDB     = "mgodb"
	CtxKeyUserAuth  = "userauth"
	CtxKeyUser      = "user"
	CtxKeyGithubApp = "githubapp"
	CtxKeyGithubCli = "githubclient"
)

Variables ¶

This section is empty.

Functions ¶

func AddSettings ¶

func AddSettings(ctx *gin.Context)

POST /settings body: ["key": "value"]

func CorsHandle ¶

func CorsHandle(ctx *gin.Context)

CorsHandle: set http response header

func GHAuthCallback ¶

func GHAuthCallback(ctx *gin.Context)

GET /github/auth

func GHBindCallback ¶

func GHBindCallback(ctx *gin.Context)

GET /github/bind

func GetAccessURL ¶

func GetAccessURL(ctx *gin.Context)

GET /github/access_url

func GetBindURL ¶

func GetBindURL(ctx *gin.Context)

GET /github/bind_url

func GetProject ¶

func GetProject(ctx *gin.Context)

func GetSettings ¶

func GetSettings(ctx *gin.Context)

GET /settings/:key

func GetStatus ¶

func GetStatus(ctx *gin.Context)

GetStatus GET /status

func GetUser ¶

func GetUser(ctx *gin.Context)

GetUser: GET /user/:id

func GinError ¶

func GinError(ctx *gin.Context, status int, err ...interface{})

GinError: ...

func GinH ¶

func GinH(h interface{}) gin.HandlerFunc

transform (http).Handler to Gin HandleFunc

func GinLogger ¶

func GinLogger(ctx *gin.Context)

GinLogger

func GinMessage ¶

func GinMessage(ctx *gin.Context, status int, msg ...interface{})

GinMessage: ...

func GithubWebhooks ¶

func GithubWebhooks(rw http.ResponseWriter, req *http.Request)

GithubWebhooks

func ListProjects ¶

func ListProjects(ctx *gin.Context)

func Login(ctx *gin.Context)

Login: POST /login

func Logout ¶

func Logout(ctx *gin.Context)

Logout: DELETE /logout

func MWAuthGithubServer ¶

func MWAuthGithubServer(rw http.ResponseWriter, req *http.Request)

MWAuthGithubServer webhook的来源验证

func MWLoadGithubApp ¶

func MWLoadGithubApp(ctx *gin.Context)

MWLoadGithubApp 加载 Github App 配置

func MWRequireAdmin ¶

func MWRequireAdmin(ctx *gin.Context)

MWRequireAdmin 需要管理员权限，需要在使用 MWRequireLogin 之后

func MWRequireGithubCli ¶

func MWRequireGithubCli(ctx *gin.Context)

MWRequireGithubAuth 需要 github 账号的授权认证

func MWRequireLogin ¶

func MWRequireLogin(ctx *gin.Context)

MWRequireLogin

func NewGin ¶

func NewGin() *gin.Engine

func NewProject ¶

func NewProject(ctx *gin.Context)

func NotFound ¶

func NotFound(rw http.ResponseWriter, req *http.Request)

NotFound no router matched.

func Registry ¶

func Registry(ctx *gin.Context)

Registry: POST /signup

func RemoveProject ¶

func RemoveProject(ctx *gin.Context)

func Serve ¶

func Serve(listenAddr string, db *mgo.Database)

Serve: main serve.

func SetMgoDB ¶

func SetMgoDB(db *mgo.Database) gin.HandlerFunc

SetMgoDB: ...

func TODO ¶

func TODO(ctx *gin.Context)

TODO ...

func UpdateProject ¶

func UpdateProject(ctx *gin.Context)

func WebhookRouter ¶

func WebhookRouter(r *gin.RouterGroup)

WebhookRouter: /webhooks/...

Types ¶