common

package

v0.0.0-...-48f0708 Latest Latest Go to latest Published: Jan 11, 2022 License: MPL-2.0 Imports: 17 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/khofesh/simple-go-api

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Bind(c *gin.Context, obj interface{}) error
func CompareData(c *gin.Context, authD *AccessDetails) (string, error)
func ExtractToken(r *http.Request) string
func GenToken(id primitive.ObjectID) string
func GetCollection(dbname string, collection string) *mongo.Collection
func GetMongoDB() *mongo.Client
func GetRedis() *redis.Client
func InitMongo(mongoURI string) error
func InitRedis() error
func RandString(n int) string
func ValidateToken(r *http.Request) error
func VerifyToken(r *http.Request) (*jwt.Token, error)
type AccessDetails
- func ExtractTokenMetadata(r *http.Request) (*AccessDetails, error)
type TokenDetails
- func CreateToken(userid primitive.ObjectID) (*TokenDetails, error)

Constants ¶

View Source

const NBRandomPassword = "A String Very Very Very Niubilty!!@##$!@#4"

NBRandomPassword : random password

View Source

const NBSecretPassword = "A String Very Very Very Strong!!@##$!@#$"

NBSecretPassword : secret password

Variables ¶

View Source

var MoDB *mongo.Client

MoDB : reference to mongodb client

View Source

var RedisClient *redis.Client

RedisClient ...

Functions ¶

func Bind ¶

func Bind(c *gin.Context, obj interface{}) error

Bind :

func CompareData ¶

func CompareData(c *gin.Context, authD *AccessDetails) (string, error)

CompareData : compare extracted token data with data stored in redis

func ExtractToken ¶

func ExtractToken(r *http.Request) string

ExtractToken ...

func GenToken ¶

func GenToken(id primitive.ObjectID) string

GenToken : generate jwt token (used in the request header)

func GetCollection ¶

func GetCollection(dbname string, collection string) *mongo.Collection

GetCollection : get collection

func GetMongoDB ¶

func GetMongoDB() *mongo.Client

GetMongoDB : get a connection to mongodb

func GetRedis ¶

func GetRedis() *redis.Client

GetRedis ...

func InitMongo ¶

func InitMongo(mongoURI string) error

InitMongo : initiate connection to mongodb

func InitRedis ¶

func InitRedis() error

InitRedis : initialize connection to redis

func RandString ¶

func RandString(n int) string

RandString : generate random string

func ValidateToken ¶

func ValidateToken(r *http.Request) error

ValidateToken ...

func VerifyToken ¶

func VerifyToken(r *http.Request) (*jwt.Token, error)

VerifyToken ...

Types ¶

type AccessDetails ¶

type AccessDetails struct {
	AccessUUID string
	UserID     string
}

AccessDetails ...

func ExtractTokenMetadata ¶

func ExtractTokenMetadata(r *http.Request) (*AccessDetails, error)

ExtractTokenMetadata ...

type TokenDetails ¶

type TokenDetails struct {
	AccessToken  string
	RefreshToken string
	AccessUUID   string
	RefreshUUID  string
	AtExpires    int64
	RtExpires    int64
}

TokenDetails ...

func CreateToken ¶

func CreateToken(userid primitive.ObjectID) (*TokenDetails, error)

CreateToken ...

Source Files ¶

View all Source files

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