endpoint

package

v0.0.0-...-08046e1 Latest Latest Go to latest Published: Nov 19, 2018 License: MIT Imports: 20 Imported by: 0

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/spolu/settle

Links

Open Source Insights

Documentation ¶

Index ¶

func HandlerFor(name EndPtName) func(http.ResponseWriter, *http.Request)
func ValidateEmail(ctx context.Context, email string) (*string, error)
func ValidateUsername(ctx context.Context, username string) (*string, error)
type CreateUser
- func (e *CreateUser) Execute(ctx context.Context) (*int, *svc.Resp, error)
- func (e *CreateUser) Validate(r *http.Request) error
type EmailData
type EndPtName
type Endpoint
type RetrieveUser
- func (e *RetrieveUser) Execute(ctx context.Context) (*int, *svc.Resp, error)
- func (e *RetrieveUser) Validate(r *http.Request) error
type RollUser
- func (e *RollUser) Execute(ctx context.Context) (*int, *svc.Resp, error)
- func (e *RollUser) Validate(r *http.Request) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func HandlerFor ¶

func HandlerFor(
	name EndPtName,
) func(
	http.ResponseWriter,
	*http.Request,
)

HandlerFor returns an handler for the given endpoint name.

func ValidateEmail ¶

func ValidateEmail(
	ctx context.Context,
	email string,
) (*string, error)

ValidateEmail vlaidates an email address.

func ValidateUsername ¶

func ValidateUsername(
	ctx context.Context,
	username string,
) (*string, error)

ValidateUsername vlaidates an email address.

Types ¶

type CreateUser ¶

type CreateUser struct {
	Username string
	Email    string
}

CreateUser a new user by username and email and send its secret over eail.

func (*CreateUser) Execute ¶

func (e *CreateUser) Execute(
	ctx context.Context,
) (*int, *svc.Resp, error)

Execute executes the endpoint.

func (*CreateUser) Validate ¶

func (e *CreateUser) Validate(
	r *http.Request,
) error

Validate validates the input parameters.

type EmailData ¶

type EmailData struct {
	Env      string
	From     string
	Username string
	Email    string
	Mint     string
	CredsURL string
	Secret   string
}

EmailData is the data required to execute the email template.

type EndPtName ¶

type EndPtName string

EndPtName reprensents an endpoint name.

const (
	// EndPtCreateUser creates a new offer.
	EndPtCreateUser EndPtName = "CreateUser"
)

const (
	// EndPtRetrieveUser creates a new offer.
	EndPtRetrieveUser EndPtName = "RetrieveUser"
)

const (
	// EndPtRollUser rolls a user password.
	EndPtRollUser EndPtName = "RollUser"
)

type Endpoint ¶

type Endpoint interface {
	Validate(
		r *http.Request,
	) error

	Execute(
		ctx context.Context,
	) (*int, *svc.Resp, error)
}

Endpoint is the interface that endpoints need to implement.

func NewCreateUser ¶

func NewCreateUser(
	r *http.Request,
) (Endpoint, error)

NewCreateUser constructs and initialiezes the endpoint.

func NewRetrieveUser ¶

func NewRetrieveUser(
	r *http.Request,
) (Endpoint, error)

NewRetrieveUser constructs and initialiezes the endpoint.

func NewRollUser ¶

func NewRollUser(
	r *http.Request,
) (Endpoint, error)

NewRollUser constructs and initialiezes the endpoint.

type RetrieveUser ¶

type RetrieveUser struct {
	Username string
	Secret   string
}

RetrieveUser a new user by username and email and send its secret over eail.

func (*RetrieveUser) Execute ¶

func (e *RetrieveUser) Execute(
	ctx context.Context,
) (*int, *svc.Resp, error)

Execute executes the endpoint.

func (*RetrieveUser) Validate ¶

func (e *RetrieveUser) Validate(
	r *http.Request,
) error

Validate validates the input parameters.

type RollUser ¶

type RollUser struct {
	Username string
	Secret   string
}

RollUser a new user by username and email and send its secret over eail.

func (*RollUser) Execute ¶

func (e *RollUser) Execute(
	ctx context.Context,
) (*int, *svc.Resp, error)

Execute executes the endpoint.

func (*RollUser) Validate ¶

func (e *RollUser) Validate(
	r *http.Request,
) error

Validate validates the input parameters.

Source Files ¶

View all Source files

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