pkg

Documentation

Index

• type App
  • func (a *App) HomeController(c echo.Context) error
  • func (a *App) InitApp(cfg AppConfig)
  • func (a *App) InitFirebase(f FirebaseAuth)
  • func (a *App) LoginController(c echo.Context) error
  • func (a *App) PredictController(c echo.Context) error
  • func (a *App) Run()
• type AppConfig
• type FirebaseAuth
• type FirebaseAuthClient
  • func (f FirebaseAuthClient) AuthUser(request LoginBody) (LoginResp, error)
  • func (f FirebaseAuthClient) IsUserActive(response VerifyTokenResp) (bool, error)
  • func (f FirebaseAuthClient) VerifyUser(request VerifyTokenBody) (VerifyTokenResp, error)
• type FirebaseAuthMock
  • func (f FirebaseAuthMock) AuthUser(request LoginBody) (LoginResp, error)
  • func (f FirebaseAuthMock) IsUserActive(response VerifyTokenResp) (bool, error)
  • func (f FirebaseAuthMock) VerifyUser(request VerifyTokenBody) (VerifyTokenResp, error)
• type FirebaseConfig
• type FirebaseError
• type LoginBody
• type LoginResp
• type RegressionModel
  • func (r RegressionModel) Predict(x []float64) (float64, error)
  • func (r RegressionModel) PredictProbability(_ []float64) (float64, error)
  • func (r RegressionModel) ReadModel() error
• type VerifyTokenBody
• type VerifyTokenResp

Types

type App

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

App Application

func (*App) HomeController

func (a *App) HomeController(c echo.Context) error

HomeController Index controller TODO: Return usage instructions with this controller

func (*App) InitApp

func (a *App) InitApp(cfg AppConfig)

InitApp Initialize application

func (*App) InitFirebase

func (a *App) InitFirebase(f FirebaseAuth)

InitFirebase Initialize Firebase

func (*App) LoginController

func (a *App) LoginController(c echo.Context) error

LoginController Firebase login controller

func (*App) PredictController

func (a *App) PredictController(c echo.Context) error

PredictController Predict endpoint

func (*App) Run

func (a *App) Run()

Run application

type AppConfig

type AppConfig struct {
	Port string
}

AppConfig Struct for application Config

type FirebaseAuth

type FirebaseAuth interface {
	AuthUser(request LoginBody) (LoginResp, error)
	VerifyUser(request VerifyTokenBody) (VerifyTokenResp, error)
	IsUserActive(response VerifyTokenResp) (bool, error)
}

type FirebaseAuthClient

type FirebaseAuthClient struct {
	Config FirebaseConfig
}

func (FirebaseAuthClient) AuthUser

func (f FirebaseAuthClient) AuthUser(request LoginBody) (LoginResp, error)

func (FirebaseAuthClient) IsUserActive

func (f FirebaseAuthClient) IsUserActive(response VerifyTokenResp) (bool, error)

func (FirebaseAuthClient) VerifyUser

func (f FirebaseAuthClient) VerifyUser(request VerifyTokenBody) (VerifyTokenResp, error)

type FirebaseAuthMock

type FirebaseAuthMock struct {
}

func (FirebaseAuthMock) AuthUser

func (f FirebaseAuthMock) AuthUser(request LoginBody) (LoginResp, error)

func (FirebaseAuthMock) IsUserActive

func (f FirebaseAuthMock) IsUserActive(response VerifyTokenResp) (bool, error)

func (FirebaseAuthMock) VerifyUser

func (f FirebaseAuthMock) VerifyUser(request VerifyTokenBody) (VerifyTokenResp, error)

type FirebaseConfig

type FirebaseConfig struct {
	FbApiAddr string
	FbVerAddr string
	FbApiKey  string
}

FirebaseConfig Struct for Firebase config

type FirebaseError

type FirebaseError struct {
	Error struct {
		Errors  []interface{} `json:"errors"`
		Code    int           `json:"code"`
		Message string        `json:"message"`
	}
}

FirebaseError Firebase REST API Error structure

type LoginBody

type LoginBody struct {
	Email             string `json:"email"`
	Password          string `json:"password"`
	ReturnSecureToken string `json:"returnSecureToken"`
}

LoginBody Firebase Rest API Login request body

type LoginResp

type LoginResp struct {
	Kind         string
	LocalId      string
	Email        string
	DisplayName  string
	IdToken      string
	Registered   bool
	RefreshToken string
	ExpiresIn    string
}

LoginResp Firebase REST API Login response body (if successful)

type RegressionModel

type RegressionModel struct {
}

RegressionModel Regression model Implement your regression model here

func (RegressionModel) Predict

func (r RegressionModel) Predict(x []float64) (float64, error)

Predict Hardcoded - arbitrary predict function

func (RegressionModel) PredictProbability

func (r RegressionModel) PredictProbability(_ []float64) (float64, error)

PredictProbability Not used for RegressionModel

func (RegressionModel) ReadModel

func (r RegressionModel) ReadModel() error

ReadModel Not used for RegressionModel

type VerifyTokenBody

type VerifyTokenBody struct {
	IdToken string `json:"idToken"`
}

VerifyTokenBody Firebase Rest API Verify token request body

type VerifyTokenResp

type VerifyTokenResp struct {
	Kind  string
	Users []struct {
		LocalId           string
		Email             string
		PasswordHash      string
		EmailVerified     bool
		PasswordUpdatedAt int
		ProvidedUserInfo  []interface{}
		ValidSince        string
		Disabled          bool
		LastLoginAt       string
		CreatedAt         string
		LastRefreshAt     string
	}
}

VerifyTokenResp Firebase Rest API Verify token response body