initial commit

Author: Lairon Acosta Guardias

.gitignore

@@ -1,3 +1,7 @@
+# Created by https://www.toptal.com/developers/gitignore/api/go
+# Edit at https://www.toptal.com/developers/gitignore?templates=go
+
+### Go ###
 # Binaries for programs and plugins
 *.exe
 *.exe~
@@ -13,3 +17,12 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+### Go Patch ###
+/vendor/
+/Godeps/
+
+### ide config ###
+.idea
+
+# End of https://www.toptal.com/developers/gitignore/api/go

Dockerfile

@@ -0,0 +1,42 @@
+# Start from golang base image
+FROM golang:alpine as builder
+
+# Add Maintainer info
+LABEL maintainer="Lairon Acosta <lairon14@gmail.com>"
+
+# Install git.
+# Git is required for fetching the dependencies.
+RUN apk update && apk add --no-cache git
+
+# Set the current working directory inside the container
+WORKDIR /app
+
+# Copy go mod and sum files
+COPY go.mod go.sum ./
+
+# Download all dependencies. Dependencies will be cached if the go.mod and the go.sum files are not changed
+RUN go mod download
+
+# Copy the source from the current directory to the working Directory inside the container
+COPY . .
+
+# Build the Go app
+RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o main .
+
+# Start a new stage from scratch
+FROM alpine:latest
+RUN apk --no-cache add ca-certificates
+
+WORKDIR /root/
+
+# Copy migrations folder
+COPY ./migrations ./migrations
+
+# Copy the Pre-built binary file from the previous stage. Observe we also copied the .env file
+COPY --from=builder /app/main .
+
+# Expose port 8080 to the outside world
+EXPOSE 8080
+
+#Command to run the executable
+CMD ["./main"]

README.md

@@ -1 +1,75 @@
-# ms-echo-go
+# Microservice: Echo Framework Example
+This project shows the use of Echo Framework in Golang.  
+
+This repository runs a simple main daemon (main) that implements a REST API for users. The daemon uses a postgres database to persist data and after creation uses migrations to create the user schema.
+
+## Table of Contents
+
+- [Running](#running)
+    - [Dependencies](#dependencies)
+    - [Environment Variables](#environment-variables)
+    - [Make Rule](#make-rule)
+- [Testing](#testing)
+    - Coming soon
+
+## Running
+
+### Dependencies 
+
+The only dependencies to run the services in this repository are:
+
+- `docker`
+- `docker-compose`
+
+### Environment Variables
+
+The program looks for the following environment variables:
+
+- `DB_USER`: The postgres database username that gets used within the postgres connection
+string (Default: `root`).
+- `DB_PASS`: The postgres database password that gets used within the postgres connection
+string (Default: `root`).
+- `DB_NAME`: The postgres database name that gets used within the postgres connection string
+(Default: `user`).
+- `DB_HOST`: The postgres database host name that gets used within the postgres connection
+string (Default `db`).
+- `DB_PORT`: The postgres database port that gets used within the postgres connection string
+(Default: `5432`).
+
+If the environment variable has a supplied default and none are set within the context of the host
+machine, then the default will be used.
+ 
+To set any given environment variable, simply execute the following
+pattern, replacing `[ENV_NAME]` with the name of the environment variable and `[ENV_VALUE]` with the
+desired value of the environment variable: `export [ENV_NAME]=[ENV_VALUE]`. To unset any set environment
+variable, simply execute the following pattern, replacing `[ENV_NAME]` with the name of the environment
+variable: `unset [ENV_NAME]`.
+
+### Make Rule
+
+To run the services simply execute the following command:
+
+```shell
+make run
+```
+
+This will stop any containers defined by the compose file if already running
+and then rebuild the containers using the compose file. The main daemon (`main`)
+will be available at `localhost:8080` and the postgres instance will be available
+at `localhost:5432`.
+
+To stop the services simply execute the following command:
+
+```shell
+make stop
+```
+
+To down the services simply execute the following command:
+
+```shell
+make down
+```
+
+## Testing
+
+Coming soon

controllers/dto/create_user_request.go

@@ -0,0 +1,6 @@
+package dto
+
+type CreateUserRequest struct {
+	Name  string `json:"name" binding:"required"`
+	Email string `json:"email" binding:"required,email"`
+}

controllers/dto/response.go

@@ -0,0 +1,5 @@
+package dto
+
+type Response struct {
+	Message string `json:"message"`
+}

controllers/dto/update_user_request.go

@@ -0,0 +1,5 @@
+package dto
+
+type UpdateUserRequest struct {
+	Name string `json:"name" binding:"required"`
+}

controllers/dto/user_dto.go

@@ -0,0 +1,6 @@
+package dto
+
+type User struct {
+	Name  string `json:"name" binding:"required"`
+	Email string `json:"email" binding:"required,email"`
+}

controllers/health_controller.go

@@ -0,0 +1,13 @@
+package controllers
+
+import (
+	"github.com/labstack/echo"
+	"github.com/laironacosta/ms-echo-go/controllers/dto"
+	"net/http"
+)
+
+func Health(c echo.Context) error {
+	return c.JSON(http.StatusOK, dto.Response{
+		Message: "ok",
+	})
+}

controllers/users_controller.go

@@ -0,0 +1,86 @@
+package controllers
+
+import (
+	"context"
+	"fmt"
+	"github.com/labstack/echo"
+	"github.com/laironacosta/ms-echo-go/controllers/dto"
+	"github.com/laironacosta/ms-echo-go/services"
+	"net/http"
+)
+
+type UserControllerInterface interface {
+	Create(c echo.Context) error
+	GetByEmail(c echo.Context) error
+	UpdateByEmail(c echo.Context) error
+	DeleteByEmail(c echo.Context) error
+}
+
+type UserController struct {
+	userService services.UserServiceInterface
+}
+
+func NewUserController(userService services.UserServiceInterface) UserControllerInterface {
+	return &UserController{
+		userService,
+	}
+}
+
+func (ctr *UserController) Create(c echo.Context) error {
+	u := dto.CreateUserRequest{}
+	if err := c.Bind(&u); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, err.Error())
+	}
+
+	if err := ctr.userService.Create(context.Background(), u); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, err.Error())
+	}
+
+	fmt.Printf("Request received: %+v \n", u)
+	return c.JSON(http.StatusOK, dto.Response{
+		Message: "created",
+	})
+}
+
+func (ctr *UserController) GetByEmail(c echo.Context) error {
+	e := c.Param("email")
+	fmt.Printf("Path param received: %+v \n", e)
+
+	u, err := ctr.userService.GetByEmail(context.Background(), e)
+	if err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, err.Error())
+	}
+	return c.JSON(http.StatusOK, u)
+}
+
+func (ctr *UserController) UpdateByEmail(c echo.Context) error {
+	u := dto.UpdateUserRequest{}
+	if err := c.Bind(&u); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, err.Error())
+	}
+
+	e := c.Param("email")
+
+	fmt.Printf("Request received: %+v \n", u)
+	fmt.Printf("Path param received: %+v \n", e)
+
+	if err := ctr.userService.UpdateByEmail(context.Background(), u, e); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, err.Error())
+	}
+	return c.JSON(http.StatusOK, dto.Response{
+		Message: "updated",
+	})
+}
+
+func (ctr *UserController) DeleteByEmail(c echo.Context) error {
+	e := c.Param("email")
+
+	fmt.Printf("Path param received: %+v \n", e)
+
+	if err := ctr.userService.DeleteByEmail(context.Background(), e); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, err.Error())
+	}
+	return c.JSON(http.StatusOK, dto.Response{
+		Message: "deleted",
+	})
+}

docker-compose.yml

@@ -0,0 +1,31 @@
+version: '3'
+
+networks:
+  ms-go-network:
+    driver: bridge
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    ports:
+      - "8080:8080"
+    depends_on:
+      - db
+    restart: on-failure
+    networks:
+      - ms-go-network
+  db:
+    image: postgres:13.2
+    ports:
+      - "5432:5432"
+    expose:
+      - "5432"
+    environment:
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: root
+      POSTGRES_DB: user
+    restart: on-failure
+    networks:
+      - ms-go-network

go.mod

@@ -0,0 +1,18 @@
+module github.com/laironacosta/ms-echo-go
+
+go 1.16
+
+require (
+	github.com/dropbox/godropbox v0.0.0-20200228041828-52ad444d3502 // indirect
+	github.com/facebookgo/stack v0.0.0-20160209184415-751773369052 // indirect
+	github.com/facebookgo/stackerr v0.0.0-20150612192056-c2fcf88613f4 // indirect
+	github.com/go-pg/migrations/v8 v8.1.0
+	github.com/go-pg/pg/v10 v10.9.0
+	github.com/juju/errors v0.0.0-20200330140219-3fe23663418f // indirect
+	github.com/kelseyhightower/envconfig v1.4.0
+	github.com/labstack/echo v3.3.10+incompatible
+	github.com/labstack/gommon v0.3.0 // indirect
+	github.com/laironacosta/kit-go v1.0.0
+	github.com/signalfx/golib v2.5.1+incompatible
+	github.com/smartystreets/goconvey v1.6.4 // indirect
+)