feat: common db driver

Author: dchebakov

README.md

@@ -1,6 +1,6 @@
 # Tracker app
 
-This app is intended to track user statistics of valid/invalid API calls.
+This app is intended to track users statistics of valid/invalid API calls.
 
 ## Install
 
@@ -12,7 +12,7 @@ API build on top of the Go, Echo, sqlx and Postgres. All infra tasks (start API,
 cp env.example.docker .env
 ```
 
-2. Start database:
+2.Start database (on Linux, you may need to use sudo for the following commands):
 
 ```bash
 docker-compose --env-file .env up -d postgres

cmd/migrate/main.go

@@ -13,11 +13,18 @@ import (
 )
 
 const databaseMigrationPath = "file://migrations/"
-const databaseDriverName = "postgres"
+const databaseDriverName = "pgx"
 
 func main() {
 	cfg := config.New()
-	dsn := fmt.Sprintf("%s://%s:%s/%s?user=%s&password=%s&sslmode=disable", databaseDriverName, cfg.Database.Host, cfg.Database.Port, cfg.Database.Name, cfg.Database.User, cfg.Database.Pass)
+	dsn := fmt.Sprintf(
+		"host=%s port=%s user=%s dbname=%s sslmode=disable password=%s",
+		cfg.Database.Host,
+		cfg.Database.Port,
+		cfg.Database.User,
+		cfg.Database.Name,
+		cfg.Database.Pass,
+	)
 	db, err := sql.Open(databaseDriverName, dsn)
 	if err != nil {
 		log.Fatalf("Error opening database: %v", err)

cmd/server/main.go

@@ -10,7 +10,7 @@ import (
 
 // @title Tracker
 // @version 0.1.0
-// @description Track user statistics of valid/invalid API calls
+// @description Track users statistics of valid/invalid API calls
 // @host localhost:6000
 // @BasePath /
 func main() {

examples/collector.md

@@ -59,9 +59,9 @@ curl --request POST \
 - Blocked IP so the request will be counted as invalid
 
 ```bash
-curl --request GET \
-  --url content-type:%20application/json \
-  --header 'user-agent: vscode-restclient' \
+curl --request POST \
+  --url http://localhost:6000/api/v1/collect/ \
+  --header 'content-type: application/json' \
   --data '{"customerID": 1,"tagID": 2,"userID": "aaaaaaaa-bbbb-cccc-1111-222222222222","remoteIP": "213.070.64.33","timestamp": 1500000000}'
 ```
 

examples/stats.md

@@ -9,7 +9,7 @@ curl --request GET \
   --url http://localhost:6000/api/v1/stats/
 ```
 
-- Filter stats for the customer
+- Filter stats for a given customer
 
 ```bash
 curl --request GET \

internal/health/repository/repository.go

@@ -2,14 +2,14 @@ package repository
 
 import "github.com/jmoiron/sqlx"
 
-type repository struct {
+type healthRepo struct {
 	db *sqlx.DB
 }
 
-func NewHealthRepository(db *sqlx.DB) *repository {
-	return &repository{db: db}
+func NewHealthRepository(db *sqlx.DB) *healthRepo {
+	return &healthRepo{db: db}
 }
 
-func (r *repository) Readiness() error {
+func (r *healthRepo) Readiness() error {
 	return r.db.Ping()
 }

internal/stats/handler/handler.go

@@ -17,15 +17,15 @@ func NewStatsHander(logger *zap.SugaredLogger, statsUC stats.UseCase) stats.Hand
 	return &statsHandler{logger: logger, statsUC: statsUC}
 }
 
-func (s *statsHandler) GetStats() echo.HandlerFunc {
+func (h *statsHandler) GetStats() echo.HandlerFunc {
 	return func(c echo.Context) error {
 		filter := &stats.Filter{}
 		if err := filter.Bind(c); err != nil {
 			return c.JSON(response.Error(httperrors.NewBadRequestError(err)))
 		}
 
 		ctx := c.Request().Context()
-		stats, err := s.statsUC.GetStats(ctx, filter)
+		stats, err := h.statsUC.GetStats(ctx, filter)
 		if err != nil {
 			return c.JSON(response.Error(err))
 		}

internal/stats/handler/register.go

@@ -2,7 +2,7 @@ package handler
 
 import "github.com/labstack/echo/v4"
 
-func (s *statsHandler) RegisterHTTPEndPoints(version *echo.Group) {
+func (h *statsHandler) RegisterHTTPEndPoints(version *echo.Group) {
 	group := version.Group("/stats")
-	group.GET("/", s.GetStats())
+	group.GET("/", h.GetStats())
 }