api

Documentation

Index

• type API
  • func (api *API) Webhook(c echo.Context) error
• type Methods
• type Parameter
• type ScriptRunner
  • func (s ScriptRunner) CheckScriptPath(scriptPath string) (string, error)
  • func (s ScriptRunner) RunScript(scriptPath string) error
  • func (s ScriptRunner) VerifySecretKey(secretKeyFromCommandLine, secretKey string) (bool, error)

Types

type API

type API struct {
	ScriptRunner Methods
	Parameter    Parameter
}

API use to expose object

func (*API) Webhook

func (api *API) Webhook(c echo.Context) error

Webhook method use for serve webhook

type Methods

type Methods interface {
	RunScript(scriptPath string) error
	CheckScriptPath(scriptPath string) (string, error)
	VerifySecretKey(secretKeyFromCommandLine, secretKey string) (bool, error)
}

Methods interface use to help passing method

type Parameter

type Parameter struct {
	ScriptPath string
	SecretKey  string
}

Parameter is struct that we use to pass parameter from command line

type ScriptRunner

type ScriptRunner struct {
}

ScriptRunner struct for run script

func (ScriptRunner) CheckScriptPath

func (s ScriptRunner) CheckScriptPath(scriptPath string) (string, error)

CheckScriptPath use to check user specify path is legal

func (ScriptRunner) RunScript

func (s ScriptRunner) RunScript(scriptPath string) error

RunScript for starting shellÎ

func (ScriptRunner) VerifySecretKey

func (s ScriptRunner) VerifySecretKey(secretKeyFromCommandLine, secretKey string) (bool, error)

VerifySecretKey use to verify hooking is legal