client

package

v0.1.3 Latest Latest Go to latest Published: Dec 27, 2017 License: MIT Imports: 9 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fitzy101/light-man

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func BuildReq(body *[]byte, url string, method string, auth bool) (*http.Request, error)
func CheckToken() (bool, error)
func GetToken() (string, error)
func GetURL(uri string, params ...Parameters) (string, error)
func ParseReq(resp *http.Response) ([]byte, error)
type Client
- func Decorate(c Client, d ...Decorator) Client
- func HTTPClient() Client
type Decorator
type Func
- func (f Func) Do(r *http.Request) (*http.Response, error)
type Parameters

Constants ¶

View Source

const (
	LOGDEBUG = iota
	LOGINFO
	LOGERROR
)

Constants for the request log level. Currently ignored if not LOGINFO.

Variables ¶

View Source

var (
	LhAddress  string // LhAddress: The address of Lighthouse instance (FQDN or IP)
	LhUsername string // LhUsername: The username for auth.
	LhPassword string // LhPassword: The password for auth.
	LhToken    string // LhToken: The auth token.
	LogLevel   int    // LogLevel: The loglevel, for request logging.
)

All variables are retrieved from the config file and set in main routine.

Functions ¶

func BuildReq ¶

func BuildReq(body *[]byte, url string, method string, auth bool) (*http.Request, error)

BuildReq is a wrapper around the http.NewRequest function that ensures authenticated requests have the expected auth headers, and any http client has the fault tolerance etc added to it.

func CheckToken ¶ added in v0.1.3

func CheckToken() (bool, error)

CheckToken checks if a token is still valid with the lighthouse instance. Returns true if it's invalid.

func GetToken ¶ added in v0.1.3

func GetToken() (string, error)

GetToken logs into the lighthouse instance and creates an Auth token for subsequent requests.

func GetURL ¶

func GetURL(uri string, params ...Parameters) (string, error)

GetURL returns a formatted and percent encoded URL from the lhaddress in config. Expects that version, and uri start with / and do not end with a /.

func ParseReq ¶

func ParseReq(resp *http.Response) ([]byte, error)

ParseReq checks error codes, and returns the body of a successful request.

Types ¶

type Client ¶

type Client interface {
	Do(r *http.Request) (*http.Response, error)
}

Client is an interface with the idea of wrapping an http.Client with extra functionality.

func Decorate ¶

func Decorate(c Client, d ...Decorator) Client

Decorate takes a Client and wraps it with the provided decorators.

func HTTPClient ¶ added in v0.1.3

func HTTPClient() Client

HTTPClient returns a decorated http client.

type Decorator ¶

type Decorator func(Client) Client

Decorator wraps a Client with extra behaviour. Inspired by Tomas Senart (https://www.youtube.com/watch?v=xyDkyFjzFVc)

func IgnoreTLSErr ¶ added in v0.1.3

func IgnoreTLSErr() Decorator

IgnoreTLSErr is a that will prevent http client certificate errors when making an http request with a self-signed cert.

func Retry ¶

func Retry(attempts int, backoff time.Duration) Decorator

Retry is a will retry an http request up to 'attempts' number of times, gradually increasing the retry wait time the more failed attempts.

func WriteLog ¶ added in v0.1.3

func WriteLog() Decorator

WriteLog will print basic information for the current request. TODO: Improve logging capabilities.

type Func ¶ added in v0.1.3

type Func func(*http.Request) (*http.Response, error)

Func is the implementation of the Client interface.

func (Func) Do ¶ added in v0.1.3

func (f Func) Do(r *http.Request) (*http.Response, error)

Do performs the http request.

type Parameters ¶

type Parameters struct {
	Name  string
	Value string
}

Parameters can be passed to the getURL function if query params are needed. These will be added and the percent-encoded URL will be returned.

Source Files ¶

View all Source files

client.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL