clients

README

Clients

High Level Clients To All Microservices

Documentation

Index

• type EmailVerificationClient
  • func NewEmailVerificationClient(service micro.Service) EmailVerificationClient
  • func (emailVerificationClient *EmailVerificationClient) Init(service micro.Service)
  • func (emailVerificationClient EmailVerificationClient) SendVerification(email string) error
  • func (emailVerificationClient EmailVerificationClient) Verify(code string) (string, error)
• type JWTClient
  • func NewJWTClient(service micro.Service) JWTClient
  • func (jwtClient JWTClient) AccessAndRefreshTokens(userIdentity string, scopes []string) (string, string, string, error)
  • func (jwtClient JWTClient) FreshToken(userIdentity string) string
  • func (jwtClient *JWTClient) Init(service micro.Service)
  • func (jwtClient JWTClient) RefreshTokens(refreshToken string) (string, string, string, error)
  • func (jwtClient JWTClient) ValidateToken(token, tokenType string) (bool, string, []string, error)
• type UsersClient
  • func NewUsersClient(service micro.Service) UsersClient
  • func (usersClient UsersClient) Activate(email string) string
  • func (usersClient UsersClient) Add(mainData config.UserMain, extraData config.UserExtra) (string, string)
  • func (usersClient UsersClient) Auth(username, password string) (string, string, error)
  • func (usersClient UsersClient) Get(userID string) (config.UserMain, error)
  • func (usersClient UsersClient) GetByUsernameOrEmail(username, email string) (config.UserMain, string)
  • func (usersClient UsersClient) GetExtra(userID string) (config.UserExtra, error)
  • func (usersClient *UsersClient) Init(service micro.Service)
  • func (usersClient UsersClient) Update(userID string, update config.UserMain)
  • func (usersClient UsersClient) UpdateExtra(userID string, update config.UserExtra)

Types

type EmailVerificationClient

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

EmailVerificationClient is jwt service client

func NewEmailVerificationClient

func NewEmailVerificationClient(service micro.Service) EmailVerificationClient

NewEmailVerificationClient is used to make a email verification Client

func (*EmailVerificationClient) Init

func (emailVerificationClient *EmailVerificationClient) Init(service micro.Service)

Init initializes cliet

func (EmailVerificationClient) SendVerification

func (emailVerificationClient EmailVerificationClient) SendVerification(email string) error

SendVerification is used to send verification email to a user

func (EmailVerificationClient) Verify

func (emailVerificationClient EmailVerificationClient) Verify(code string) (string, error)

Verify is used to verify verification code

type JWTClient

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

JWTClient is jwt service client

func NewJWTClient

func NewJWTClient(service micro.Service) JWTClient

NewJWTClient is used to make a JWT Client

func (JWTClient) AccessAndRefreshTokens

func (jwtClient JWTClient) AccessAndRefreshTokens(
	userIdentity string, scopes []string) (string, string, string, error)

AccessAndRefreshTokens is used create access and refresh tokens

func (JWTClient) FreshToken

func (jwtClient JWTClient) FreshToken(userIdentity string) string

FreshToken is used to create a fresh access token

func (*JWTClient) Init

func (jwtClient *JWTClient) Init(service micro.Service)

Init initializes cliet

func (JWTClient) RefreshTokens

func (jwtClient JWTClient) RefreshTokens(
	refreshToken string) (string, string, string, error)

RefreshTokens is used to create access and refresh token based on previous refresh token

func (JWTClient) ValidateToken

func (jwtClient JWTClient) ValidateToken(
	token, tokenType string) (bool, string, []string, error)

ValidateToken is used to validate a token

type UsersClient

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

UsersClient is used to communicate with users service

func NewUsersClient

func NewUsersClient(service micro.Service) UsersClient

NewUsersClient is used to get users client struct

func (UsersClient) Activate

func (usersClient UsersClient) Activate(email string) string

Activate is used to mark an account active

func (UsersClient) Add

func (usersClient UsersClient) Add(
	mainData config.UserMain, extraData config.UserExtra) (string, string)

Add is used to add a user

func (UsersClient) Auth

func (usersClient UsersClient) Auth(username, password string) (string, string, error)

Auth is used to authenticate a user

func (UsersClient) Get

func (usersClient UsersClient) Get(userID string) (config.UserMain, error)

Get is used to get user main data

func (UsersClient) GetByUsernameOrEmail

func (usersClient UsersClient) GetByUsernameOrEmail(
	username, email string) (config.UserMain, string)

GetByUsernameOrEmail is used to get a user based on username or email

func (UsersClient) GetExtra

func (usersClient UsersClient) GetExtra(userID string) (config.UserExtra, error)

GetExtra is used to get user extra data

func (*UsersClient) Init

func (usersClient *UsersClient) Init(service micro.Service)

Init is used to initialise client

func (UsersClient) Update

func (usersClient UsersClient) Update(userID string, update config.UserMain)

Update is used to update user data

func (UsersClient) UpdateExtra

func (usersClient UsersClient) UpdateExtra(userID string, update config.UserExtra)

UpdateExtra is used to update user's extra data