Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Ales Verbic <[email protected]>
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "log" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| ) | ||
|
|
||
| type API interface { | ||
| Start() error | ||
| AddRoute(method, path string, handler gin.HandlerFunc) | ||
| } | ||
|
|
||
| type APIv1 struct { | ||
| engine *gin.Engine | ||
| apiGroup *gin.RouterGroup | ||
| host string | ||
| port string | ||
| } | ||
|
|
||
| type APIRouteRegistrar interface { | ||
| RegisterRoutes() | ||
| } | ||
|
|
||
| type APIOption func(*APIv1) | ||
|
|
||
| func WithGroup(group string) APIOption { | ||
| // Expects '/v1' as the group | ||
| return func(a *APIv1) { | ||
| a.apiGroup = a.engine.Group(group) | ||
| } | ||
| } | ||
|
|
||
| func WithHost(host string) APIOption { | ||
| return func(a *APIv1) { | ||
| a.host = host | ||
| } | ||
| } | ||
|
|
||
| func WithPort(port string) APIOption { | ||
| return func(a *APIv1) { | ||
| a.port = port | ||
| } | ||
| } | ||
|
|
||
| var apiInstance *APIv1 | ||
| var once sync.Once | ||
|
|
||
| func NewAPI(debug bool, options ...APIOption) *APIv1 { | ||
| once.Do(func() { | ||
| apiInstance = &APIv1{ | ||
| engine: ConfigureRouter(debug), | ||
| host: "localhost", | ||
| port: "8080", | ||
| } | ||
| for _, opt := range options { | ||
| opt(apiInstance) | ||
| } | ||
| }) | ||
| return apiInstance | ||
| } | ||
|
|
||
| func GetInstance() *APIv1 { | ||
| return apiInstance | ||
| } | ||
|
|
||
| func (a *APIv1) Engine() *gin.Engine { | ||
| return a.engine | ||
| } | ||
|
|
||
| func (a *APIv1) Start() error { | ||
| address := a.host + ":" + a.port | ||
| go a.engine.Run(address) | ||
| return nil | ||
| } | ||
|
|
||
| func (a *APIv1) AddRoute(method, path string, handler gin.HandlerFunc) { | ||
| // Inner function to add routes to a given target | ||
| //(either gin.Engine or gin.RouterGroup) | ||
| addRouteToTarget := func(target gin.IRoutes) { | ||
| switch method { | ||
| case "GET": | ||
| target.GET(path, handler) | ||
| case "POST": | ||
| target.POST(path, handler) | ||
| case "PUT": | ||
| target.PUT(path, handler) | ||
| case "DELETE": | ||
| target.DELETE(path, handler) | ||
| case "PATCH": | ||
| target.PATCH(path, handler) | ||
| case "HEAD": | ||
| target.HEAD(path, handler) | ||
| case "OPTIONS": | ||
| target.OPTIONS(path, handler) | ||
| default: | ||
| log.Printf("Unsupported HTTP method: %s", method) | ||
| } | ||
| } | ||
|
|
||
| // Check if a specific apiGroup is set | ||
| // If so, add the route to it. Otherwise, add to the main engine. | ||
| if a.apiGroup != nil { | ||
| addRouteToTarget(a.apiGroup) | ||
| } else { | ||
| addRouteToTarget(a.engine) | ||
| } | ||
| } | ||
|
|
||
| func ConfigureRouter(debug bool) *gin.Engine { | ||
| if !debug { | ||
| gin.SetMode(gin.ReleaseMode) | ||
| } | ||
| gin.DisableConsoleColor() | ||
| g := gin.New() | ||
| g.Use(gin.Recovery()) | ||
| // Custom access logging | ||
| g.Use(gin.LoggerWithFormatter(accessLogger)) | ||
| // Healthcheck endpoint | ||
| g.GET("/healthcheck", handleHealthcheck) | ||
| // No-op API endpoint for testing | ||
| g.GET("/ping", func(c *gin.Context) { | ||
| c.String(200, "pong") | ||
| }) | ||
| // Swagger UI | ||
| // TODO: add swagger UI | ||
| // g.Static("/swagger-ui", "swagger-ui") | ||
| return g | ||
| } | ||
|
|
||
| func accessLogger(param gin.LogFormatterParams) string { | ||
| logEntry := gin.H{ | ||
| "type": "access", | ||
| "client_ip": param.ClientIP, | ||
| "timestamp": param.TimeStamp.Format(time.RFC1123), | ||
| "method": param.Method, | ||
| "path": param.Path, | ||
| "proto": param.Request.Proto, | ||
| "status_code": param.StatusCode, | ||
| "latency": param.Latency, | ||
| "user_agent": param.Request.UserAgent(), | ||
| "error_message": param.ErrorMessage, | ||
| } | ||
| ret, _ := json.Marshal(logEntry) | ||
| return string(ret) + "\n" | ||
| } | ||
|
|
||
| func handleHealthcheck(c *gin.Context) { | ||
| // TODO: add some actual health checking here | ||
| c.JSON(200, gin.H{"failed": false}) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| package api_test | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/blinklabs-io/snek/api" | ||
| "github.com/blinklabs-io/snek/output/push" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestRouteRegistration(t *testing.T) { | ||
| // Initialize the API and set it to debug mode for testing | ||
| apiInstance := api.NewAPI(true) | ||
|
|
||
| // Check if Fcm implements APIRouteRegistrar and register its routes | ||
| // TODO: update this with actual plugin | ||
| fcmPlugin := &push.Fcm{} | ||
| if registrar, ok := interface{}(fcmPlugin).(api.APIRouteRegistrar); ok { | ||
| registrar.RegisterRoutes() | ||
| } else { | ||
| t.Fatal("push.Fcm does NOT implement APIRouteRegistrar") | ||
| } | ||
|
|
||
| // Create a test request to one of the registered routes | ||
| req, err := http.NewRequest(http.MethodGet, "/v1/fcm/someToken", nil) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| // Record the response | ||
| rr := httptest.NewRecorder() | ||
| apiInstance.Engine().ServeHTTP(rr, req) | ||
|
|
||
| // Check the status code | ||
| assert.Equal(t, http.StatusNotFound, rr.Code, "Expected status not found") | ||
|
|
||
| // You can also check the response body, headers, etc. | ||
| // TODO check for JSON response | ||
| // assert.Equal(t, `{"fcmToken":"someToken"}`, rr.Body.String()) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.