core

Documentation

Index

• Constants
• Variables
• func AddMissingSlashToURL(baseUrl *string)
• func AllPlugins() map[string]Plugin
• func ConvertStringToTime(timeString string) (t time.Time, err error)
• func DecodeMapStruct(input map[string]interface{}, result interface{}) error
• func FindPluginNameBySubPkgPath(subPkgPath string) (string, error)
• func GetRateLimitPerSecond(options map[string]interface{}, defaultValue int) (int, error)
• func GetURIStringPointer(baseUrl string, relativePath string, queryParams *url.Values) (*string, error)
• func Iso8601TimeToTime(iso8601Time *Iso8601Time) *time.Time
• func RegisterPlugin(name string, plugin Plugin) error
• func RemoveStartingSlashFromPath(relativePath string) string
• func UnmarshalResponse(res *http.Response, v interface{}) error
• type ApiClient
  • func NewApiClient(endpoint string, headers map[string]string, timeout time.Duration, ...) *ApiClient
  • func (apiClient *ApiClient) Do(method string, path string, query *url.Values, body *map[string]interface{}, ...) (*http.Response, error)
  • func (apiClient *ApiClient) Get(path string, query *url.Values, headers *map[string]string) (*http.Response, error)
  • func (apiClient *ApiClient) GetEndpoint() string
  • func (apiClient *ApiClient) GetHeaders() map[string]string
  • func (apiClient *ApiClient) SetAfterFunction(callback ApiClientAfterResponse)
  • func (apiClient *ApiClient) SetBeforeFunction(callback ApiClientBeforeRequest)
  • func (apiClient *ApiClient) SetContext(ctx context.Context)
  • func (apiClient *ApiClient) SetEndpoint(endpoint string)
  • func (apiClient *ApiClient) SetHeaders(headers map[string]string)
  • func (ApiClient *ApiClient) SetMaxRetry(maxRetry int)
  • func (apiClient *ApiClient) SetProxy(proxyUrl string) error
  • func (ApiClient *ApiClient) SetTimeout(timeout time.Duration)
  • func (apiClient *ApiClient) Setup(endpoint string, headers map[string]string, timeout time.Duration, ...)
• type ApiClientAfterResponse
• type ApiClientBeforeRequest
• type ApiResourceHandler
• type ApiResourceInput
• type ApiResourceOutput
• type DateTimeFormatItem
• type Iso8601Time
  • func (jt Iso8601Time) MarshalJSON() ([]byte, error)
  • func (jt *Iso8601Time) String() string
  • func (jt *Iso8601Time) ToTime() time.Time
  • func (jt *Iso8601Time) UnmarshalJSON(b []byte) error
• type Plugin
  • func GetPlugin(name string) (Plugin, error)
• type TestResult
  • func ValidateParams(input *ApiResourceInput, requiredParams []string) *TestResult
  • func (testResult *TestResult) Set(success bool, message string)

Constants

const DNSResolveFailedError = "Failed to find ip address"

const InvalidConnectionError = "Your connection configuration is invalid."

const InvalidEndpointError = "Failed to parse endpoint"

const InvalidParams = "Failed to decode request params"

const InvalidSchema = "Failed to find port for schema"

const NetworkConnectError = "Failed to connect to endpoint"

const SchemaIsRequired = "Endpoint schema is required"

const SourceIdError = "Missing or Invalid sourceId"

const UnmarshallingError = "There was a problem unmarshalling the response"

const UnsetConnectionError = "Your connection configuration is not set."

Variables

var DateTimeFormats []DateTimeFormatItem

var TaskCanceled = fmt.Errorf("task got canceled")

Functions

func AddMissingSlashToURL

func AddMissingSlashToURL(baseUrl *string)

func AllPlugins

func AllPlugins() map[string]Plugin

func ConvertStringToTime

func ConvertStringToTime(timeString string) (t time.Time, err error)

func DecodeMapStruct

func DecodeMapStruct(input map[string]interface{}, result interface{}) error

mapstructure.Decode with time.Time and Iso8601Time support

func FindPluginNameBySubPkgPath

func FindPluginNameBySubPkgPath(subPkgPath string) (string, error)

func GetRateLimitPerSecond

func GetRateLimitPerSecond(options map[string]interface{}, defaultValue int) (int, error)

func GetURIStringPointer

func GetURIStringPointer(baseUrl string, relativePath string, queryParams *url.Values) (*string, error)

func Iso8601TimeToTime

func Iso8601TimeToTime(iso8601Time *Iso8601Time) *time.Time

func RegisterPlugin

func RegisterPlugin(name string, plugin Plugin) error

func RemoveStartingSlashFromPath

func RemoveStartingSlashFromPath(relativePath string) string

func UnmarshalResponse

func UnmarshalResponse(res *http.Response, v interface{}) error

Types

type ApiClient

type ApiClient struct {
	// contains filtered or unexported fields
}

func NewApiClient

func NewApiClient(
	endpoint string,
	headers map[string]string,
	timeout time.Duration,
	maxRetry int,
) *ApiClient

func (*ApiClient) Do

func (apiClient *ApiClient) Do(
	method string,
	path string,
	query *url.Values,
	body *map[string]interface{},
	headers *map[string]string,
) (*http.Response, error)

func (*ApiClient) Get

func (apiClient *ApiClient) Get(
	path string,
	query *url.Values,
	headers *map[string]string,
) (*http.Response, error)

func (*ApiClient) GetEndpoint

func (apiClient *ApiClient) GetEndpoint() string

func (*ApiClient) GetHeaders

func (apiClient *ApiClient) GetHeaders() map[string]string

func (*ApiClient) SetAfterFunction

func (apiClient *ApiClient) SetAfterFunction(callback ApiClientAfterResponse)

func (*ApiClient) SetBeforeFunction

func (apiClient *ApiClient) SetBeforeFunction(callback ApiClientBeforeRequest)

func (*ApiClient) SetContext

func (apiClient *ApiClient) SetContext(ctx context.Context)

func (*ApiClient) SetEndpoint

func (apiClient *ApiClient) SetEndpoint(endpoint string)

func (*ApiClient) SetHeaders

func (apiClient *ApiClient) SetHeaders(headers map[string]string)

func (*ApiClient) SetMaxRetry

func (ApiClient *ApiClient) SetMaxRetry(maxRetry int)

func (*ApiClient) SetProxy

func (apiClient *ApiClient) SetProxy(proxyUrl string) error

func (*ApiClient) SetTimeout

func (ApiClient *ApiClient) SetTimeout(timeout time.Duration)

func (*ApiClient) Setup

func (apiClient *ApiClient) Setup(
	endpoint string,
	headers map[string]string,
	timeout time.Duration,
	maxRetry int,
)

type ApiClientAfterResponse

type ApiClientAfterResponse func(res *http.Response) error

type ApiClientBeforeRequest

type ApiClientBeforeRequest func(req *http.Request) error

type ApiResourceHandler

type ApiResourceHandler func(input *ApiResourceInput) (*ApiResourceOutput, error)

type ApiResourceInput

type ApiResourceInput struct {
	Params map[string]string      // path variables
	Query  url.Values             // query string
	Body   map[string]interface{} // json body
}

type ApiResourceOutput

type ApiResourceOutput struct {
	Body   interface{} // response body
	Status int
}

type DateTimeFormatItem

type DateTimeFormatItem struct {
	Matcher *regexp.Regexp
	Format  string
}

type Iso8601Time

type Iso8601Time struct {
	// contains filtered or unexported fields
}

type Iso8601Time time.Time

func (Iso8601Time) MarshalJSON

func (jt Iso8601Time) MarshalJSON() ([]byte, error)

func (*Iso8601Time) String

func (jt *Iso8601Time) String() string

func (*Iso8601Time) ToTime

func (jt *Iso8601Time) ToTime() time.Time

func (*Iso8601Time) UnmarshalJSON

func (jt *Iso8601Time) UnmarshalJSON(b []byte) error

type Plugin

type Plugin interface {
	Description() string
	Init()
	Execute(options map[string]interface{}, progress chan<- float32, ctx context.Context) error
	// PkgPath information lost when compiled as plugin(.so)
	RootPkgPath() string
	ApiResources() map[string]map[string]ApiResourceHandler
}

func GetPlugin

func GetPlugin(name string) (Plugin, error)

type TestResult

type TestResult struct {
	Success bool
	Message string
}

func ValidateParams

func ValidateParams(input *ApiResourceInput, requiredParams []string) *TestResult

func (*TestResult) Set

func (testResult *TestResult) Set(success bool, message string)