http

package
v0.0.0-...-1676a5e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 19, 2020 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package http contains the main HTTP interface definition.

Index

Constants

View Source
const (
	CONST_HTTP_STATUS_MSG_500 = "UNEXPECTED INTERNAL ERROR, CHECK BACK LATER!"
	CONST_HTTP_STATUS_MSG_400 = "ONE OR MORE REQUIRED PARAMS ARE MISSING OR INVALID!"
	CONST_HTTP_STATUS_MSG_200 = "OK"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type MockRequest

type MockRequest struct {
	*parameters.Parameters

	sync.RWMutex
	// contains filtered or unexported fields
}

func (*MockRequest) Body

func (ti *MockRequest) Body(s string) interface{}

Body

func (*MockRequest) BodyArray

func (ti *MockRequest) BodyArray() []interface{}

BodyArray

func (*MockRequest) BodyObject

func (ti *MockRequest) BodyObject() map[string]interface{}

BodyObject

func (*MockRequest) Device

func (ti *MockRequest) Device() string

Device

func (*MockRequest) Fail

func (ti *MockRequest) Fail() *Status

Fail

func (*MockRequest) FullPath

func (ti *MockRequest) FullPath() string

FullPath

func (*MockRequest) GetRequestHeader

func (ti *MockRequest) GetRequestHeader(k string) string

GetRequestHeader

func (*MockRequest) GetResponseHeader

func (ti *MockRequest) GetResponseHeader(k string) string

GetResponseHeader

func (*MockRequest) HttpError

func (ti *MockRequest) HttpError(s string, x int)

HttrError

func (*MockRequest) IsTLS

func (ti *MockRequest) IsTLS() bool

IsTls

func (*MockRequest) Log

func (ti *MockRequest) Log() logging.Logger

Log

func (*MockRequest) Method

func (ti *MockRequest) Method() string

Method

func (*MockRequest) Param

func (ti *MockRequest) Param(k string) interface{}

Param

func (*MockRequest) Params

func (ti *MockRequest) Params() map[string]interface{}

Params

func (*MockRequest) R

func (ti *MockRequest) R() interface{}

R

func (*MockRequest) RawBody

func (ti *MockRequest) RawBody() (*Status, []byte)

RawBody

func (*MockRequest) ReadBodyArray

func (ti *MockRequest) ReadBodyArray() *Status

ReadBodyArray

func (*MockRequest) ReadBodyObject

func (ti *MockRequest) ReadBodyObject() *Status

ReadBodyObject

func (*MockRequest) Redirect

func (ti *MockRequest) Redirect(s string, x int) *Status

Redirect

func (*MockRequest) Res

func (ti *MockRequest) Res() http.ResponseWriter

Res

func (*MockRequest) Respond

func (ti *MockRequest) Respond(args ...interface{}) *Status

Respond

func (*MockRequest) ServeFile

func (ti *MockRequest) ServeFile(s string)

ServeFile

func (*MockRequest) SetBodyArray

func (self *MockRequest) SetBodyArray(array []interface{})

SetBodyArray

func (*MockRequest) SetBodyObject

func (self *MockRequest) SetBodyObject(obj map[string]interface{})

SetBodyObject

func (*MockRequest) SetRequestHeader

func (ti *MockRequest) SetRequestHeader(k, v string)

SetRequestHeader

func (*MockRequest) SetResponseHeader

func (ti *MockRequest) SetResponseHeader(k, v string)

SetResponseHeader

func (*MockRequest) Testing

func (req *MockRequest) Testing() bool

Testing

func (*MockRequest) UID

func (ti *MockRequest) UID() (string, error)

UID returns a UUID that has been generated randoomly for this request.

func (*MockRequest) Write

func (ti *MockRequest) Write(b []byte) (int, error)

Write

func (*MockRequest) WriteString

func (ti *MockRequest) WriteString(s string) (int, error)

WriteString

func (*MockRequest) Writer

func (ti *MockRequest) Writer() io.Writer

Writer

type Request

type Request interface {
	Testing() bool
	UID() (string, error)
	FullPath() string
	IsTLS() bool
	Method() string
	Device() string
	Body(string) interface{}
	// accesses the request params of the payload
	Param(string) interface{}
	Params() map[string]interface{}
	SetParam(string, interface{})
	SetParams(map[string]interface{})

	BodyParam(string) interface{}
	BodyParams() map[string]interface{}
	SetBodyParam(string, interface{})
	SetBodyParams(map[string]interface{})

	SetResponseHeader(string, string)
	GetResponseHeader(string) string

	SetRequestHeader(string, string)
	GetRequestHeader(string) string

	HeaderParam(string) interface{}
	HeaderParams() map[string]interface{}
	SetHeaderParam(string, interface{})
	SetHeaderParams(map[string]interface{})

	RawBody() (*Status, []byte)
	ReadBodyObject() *Status
	ReadBodyArray() *Status
	BodyArray() []interface{}
	BodyObject() map[string]interface{}
	SetBodyArray([]interface{})
	SetBodyObject(map[string]interface{})
	Redirect(string, int) *Status
	ServeFile(string)
	HttpError(string, int)
	Writer() io.Writer
	Write([]byte) (int, error)
	WriteString(string) (int, error)
	Fail() *Status
	Respond(args ...interface{}) *Status
	// logging
	Log() logging.Logger

	Res() http.ResponseWriter
	R() interface{}
}

func NewMockRequest

func NewMockRequest(method, path string) Request

NewMockRequest creates an implementation of the Request interface for testing or other.

type Status

type Status struct {
	Value   interface{} `json:"value,omitempty"`
	Code    int         `json:"code"`
	Message interface{} `json:"message"`
}

func Fail

func Fail() *Status

Fail returns a standard 500 http error status

func Respond

func Respond(args ...interface{}) (status *Status, contentType string)

Respond creates a Status object that can be served to the client.

func (*Status) MessageString

func (status *Status) MessageString() string

MessageString serialises the status to a string.

func (*Status) Respond

func (status *Status) Respond(req Request)

Respond executes the status on a HTTP level.

Jump to

Keyboard shortcuts

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