justgo

README

justgo

Simple Api Provider

usage:

custom config file

as default, justgo scan app folder for application.yml for config. use this command to override where to get the config file

justgo.Config.ConfigFile("./sample/anything.yml")

in code config

justgo.Config.Add("APP_NAME", "My Volatile Config")

http

http interface is enabled by default. if you only want to use http server only, simply add route and start justgo

justgo.AddRoute(http.MethodGet, "/with-middleware", headerPrinterHandler, middleWareDummyOne, otherAuthHandler)
justgo.AddRoute(http.MethodGet, "/no-middleware", headerPrinterHandler)
justgo.Start()

connecting to Database

// this is required for sql package to have registered database driver.
// corresponding driver will register it self to available driver in sql package
import _ "github.com/lib/pq"

// enable database
justgo.Config.Add("DB_DRIVER", "postgres")
justgo.Config.Add("DB_CONNECTION_STRING", "dbname=postgres user=postgres password=abcdef host=localhost sslmode=disable")

// get the db instance and inject it in your repository
// or you can simply call it anywhere in the app
// the db instance won't be initialized until justgo.Initialize() or justgo.Start()
db := &justgo.Storage.DB

Cli

adding another interface in same app

// add cli handler via telnet
cliInterface := &justgo.CliInterface{Address: ":12345"}

// add command on telnet command
cliInterface.AddCommand("test", echo)
cliInterface.AddCommand("panic", panicCommand)
cliInterface.AddCommand("fatal", fatalCommand)

// register interface
justgo.RegisterInterface(cliInterface)

justgo.Start()

Features:

• app interface
  • http
  • telnet
  • kafka
• metric
  • newrelic
  • custom hooks
  • StatsD integration
  • sentry reporting
• database
• i18n
• api client with hystrix

Documentation

Overview

Package justgo is a generated GoMock package.

Index

• Variables
• func AddRoute(method string, pattern string, handler http.HandlerFunc, ...)
• func AlwaysUseMiddleware(middleWares ...func(handler http.Handler) http.Handler)
• func GetInstrument() *instrument
• func GetLogger() *justGoLog
• func GetRouter() http.Handler
• func Initialise()
• func InstantiateNewRouter()
• func NewSentryHook(dsn string, level []logrus.Level) (*sentryHook, error)
• func RegisterInterface(appInterface AppInterface)
• func RunAppInterfaces()
• func Start()
• func WaitForShutdown()
• type AppInterface
• type CliCommand
• type CliInterface
  • func (cli *CliInterface) AddCommand(command string, function CliCommand)
  • func (cli *CliInterface) Serve()
  • func (cli *CliInterface) ShutDown()
• type DB
  • func GetDB() *DB
• type HttpInterface
  • func GetDefaultHttpInterface() *HttpInterface
  • func (httpInterface HttpInterface) Serve()
  • func (httpInterface HttpInterface) ShutDown()
• type Metric
• type MockAppInterface
  • func NewMockAppInterface(ctrl *gomock.Controller) *MockAppInterface
  • func (m *MockAppInterface) EXPECT() *MockAppInterfaceMockRecorder
  • func (m *MockAppInterface) Serve()
  • func (m *MockAppInterface) ShutDown()
• type MockAppInterfaceMockRecorder
  • func (mr *MockAppInterfaceMockRecorder) Serve() *gomock.Call
  • func (mr *MockAppInterfaceMockRecorder) ShutDown() *gomock.Call

Variables

var Config *config

var ConfigKey configKey

var DEFAULT_CONFIGS = map[string]string{}

Functions

func AddRoute

func AddRoute(method string, pattern string, handler http.HandlerFunc, middlewares ...func(http.Handler) http.Handler)

func AlwaysUseMiddleware

func AlwaysUseMiddleware(middleWares ...func(handler http.Handler) http.Handler)

func GetInstrument

func GetInstrument() *instrument

func GetLogger

func GetLogger() *justGoLog

func GetRouter

func GetRouter() http.Handler

func Initialise

func Initialise()

func InstantiateNewRouter

func InstantiateNewRouter()

func NewSentryHook

func NewSentryHook(dsn string, level []logrus.Level) (*sentryHook, error)

func RegisterInterface

func RegisterInterface(appInterface AppInterface)

func RunAppInterfaces

func RunAppInterfaces()

func Start

func Start()

func WaitForShutdown

func WaitForShutdown()

Types

type AppInterface

type AppInterface interface {
	Serve()
	ShutDown()
}

type CliCommand

type CliCommand func(string) string

type CliInterface

type CliInterface struct {
	Address string
	// contains filtered or unexported fields
}

func (*CliInterface) AddCommand

func (cli *CliInterface) AddCommand(command string, function CliCommand)

func (*CliInterface) Serve

func (cli *CliInterface) Serve()

func (*CliInterface) ShutDown

func (cli *CliInterface) ShutDown()

type DB

type DB struct {
	*sqlx.DB
}

func GetDB

func GetDB() *DB

type HttpInterface

type HttpInterface struct {
	Handler http.Handler
	// contains filtered or unexported fields
}

func GetDefaultHttpInterface

func GetDefaultHttpInterface() *HttpInterface

func (HttpInterface) Serve

func (httpInterface HttpInterface) Serve()

func (HttpInterface) ShutDown

func (httpInterface HttpInterface) ShutDown()

type Metric

type Metric interface {
	Increment(key string)
}

type MockAppInterface

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

MockAppInterface is a mock of AppInterface interface

func NewMockAppInterface

func NewMockAppInterface(ctrl *gomock.Controller) *MockAppInterface

NewMockAppInterface creates a new mock instance

func (*MockAppInterface) EXPECT

func (m *MockAppInterface) EXPECT() *MockAppInterfaceMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockAppInterface) Serve

func (m *MockAppInterface) Serve()

Serve mocks base method

func (*MockAppInterface) ShutDown

func (m *MockAppInterface) ShutDown()

ShutDown mocks base method

type MockAppInterfaceMockRecorder

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

MockAppInterfaceMockRecorder is the mock recorder for MockAppInterface

func (*MockAppInterfaceMockRecorder) Serve

func (mr *MockAppInterfaceMockRecorder) Serve() *gomock.Call

Serve indicates an expected call of Serve

func (*MockAppInterfaceMockRecorder) ShutDown

func (mr *MockAppInterfaceMockRecorder) ShutDown() *gomock.Call

ShutDown indicates an expected call of ShutDown