Merge branch 'master' into add-vin

.github/workflows/hub.yml

@@ -1,45 +1,46 @@
-name: ci
+name: Build docker image
 
 on:
-  push:
-    branches: master
+  release:
+    types: [published]
 
 jobs:
   multi:
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v2
-      -
-        name: Set up QEMU
+      - name: Set up QEMU
+        id: qemu
         uses: docker/setup-qemu-action@v1
-      -
-        name: Set up Docker Buildx
+        with:
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+      - name: Available platforms
+        run: echo ${{ steps.qemu.outputs.platforms }}
+      - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
-      -
-        name: Set up build cache
+      - name: Set up build cache
         uses: actions/cache@v2
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-buildx-${{ github.sha }}
           restore-keys: |
             ${{ runner.os }}-buildx-
-      -
-        name: Login to DockerHub
-        uses: docker/login-action@v1 
+      - name: Parse the git tag
+        id: get_tag
+        run: echo ::set-output name=TAG::$(echo $GITHUB_REF | cut -d / -f 3)
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
-        name: Login to GitHub
+      - name: Login to GitHub
         uses: docker/login-action@v1
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.CR_PAT }}
-      -
-        name: Build and push
+      - name: Build and push
         uses: docker/build-push-action@v2
         with:
           context: .
@@ -48,10 +49,10 @@ jobs:
           #platforms: linux/amd64,linux/arm64,linux/arm/v6,linux/arm/v7
           platforms: linux/amd64,linux/arm64,linux/arm/v7
           push: true
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
+          # cache-from: type=local,src=/tmp/.buildx-cache
+          # cache-to: type=local,dest=/tmp/.buildx-cache
           tags: |
             akhilrex/hammond:latest
-            akhilrex/hammond:1.0.0
+            akhilrex/hammond:${{ steps.get_tag.outputs.TAG }}
             ghcr.io/akhilrex/hammond:latest
-            ghcr.io/akhilrex/hammond:1.0.0
+            ghcr.io/akhilrex/hammond:${{ steps.get_tag.outputs.TAG }}

.github/workflows/test-go.yml

@@ -0,0 +1,16 @@
+on: [push, pull_request]
+name: Test server
+jobs:
+  test:
+    strategy:
+      matrix:
+        go-version: [1.17.x, 1.18.x]
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/setup-go@v3
+      with:
+        go-version: ${{ matrix.go-version }}
+    - uses: actions/checkout@v3
+    - run: go test ./...
+      working-directory: server

.github/workflows/test-npm.yml

@@ -0,0 +1,22 @@
+name: Test UI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x, 15.x]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+        working-directory: ui
+      - run: npm run build --if-present
+        working-directory: ui
+      - run: npm test
+        working-directory: ui

Dockerfile

@@ -9,7 +9,7 @@ RUN go mod download
 COPY ./server .
 RUN go build -o ./app ./main.go
 
-FROM node:latest as build-stage
+FROM node:14 as build-stage
 WORKDIR /app
 COPY ./ui/package*.json ./
 RUN npm install
@@ -36,4 +36,4 @@ COPY --from=builder /api/app .
 #COPY dist ./dist
 COPY --from=build-stage /app/dist ./dist
 EXPOSE 3000
-ENTRYPOINT ["./app"]
+ENTRYPOINT ["./app"]

README.md

@@ -8,7 +8,7 @@
   </a> -->
 
   <h1 align="center" style="margin-bottom:0">Hammond</h1>
-  <p align="center">Current Version - 2021.09.20</p>
+  <p align="center">Current Version - 2022.07.06</p>
 
   <p align="center">
     A self-hosted vehicle expense tracking system with support for multiple users.
@@ -35,6 +35,7 @@
   - [Built With](#built-with)
   - [Features](#features)
 - [Installation](#installation)
+- [Contributing](#contributing)
 - [License](#license)
 - [Roadmap](#roadmap)
 - [Contact](#contact)
@@ -157,6 +158,31 @@ Once done you will be taken to the login page.
 
 Go through the settings page once and change relevant settings before you start adding vehicles and expenses.
 
+## Contributing
+
+### Dev Setup
+
+If you want to contribute to the project you need to set it up
+for development first.
+
+Fork and clone the project. Once you have it on your own machine,
+open up a terminal and navigate to the `server/` directory.
+
+In the `server/` directory run the command `go run main.go`.
+After some initial
+setup, the server should be listening on at port `3000`.
+
+Next, open a new terminal. Navigate to the `ui/` directory and run `npm install`.
+This will install all the dependencies for the frontend.
+After the command is done running, run `npm run dev`. After some output, the
+frontend should be accessible at `http://localhost:8080`.
+
+If you are sent straight to the login screen, try closing the page and opening
+it again. You should be greeted with a setup wizard the first time you run the
+project.
+
+Now, simply follow the instructions in order to set up your fresh install.
+
 ## License
 
 Distributed under the GPL-3.0 License. See `LICENSE` for more information.

docker-compose.yml

@@ -4,7 +4,7 @@ services:
     image: akhilrex/hammond
     container_name: hammond
     environment:
-      - JWT_SECRET = somethingverystrong
+      - JWT_SECRET=somethingverystrong
     volumes:
       - /path/to/config:/config
       - /path/to/data:/assets

server/.gitignore

@@ -12,6 +12,10 @@
 *.out
 *.db
 
+# MS VSCode
+.vscode
+__debug_bin
+
 # Dependency directories (remove the comment below to include it)
 # vendor/
 assets/*

server/controllers/auth.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"net/http"
 	"os"
+	"strings"
 
 	"github.com/akhilrex/hammond/common"
 	"github.com/akhilrex/hammond/db"
@@ -91,20 +92,20 @@ func userLogin(c *gin.Context) {
 		c.JSON(http.StatusUnprocessableEntity, common.NewValidatorError(err))
 		return
 	}
-	user, err := db.FindOneUser(&db.User{Email: loginRequest.Email})
+	user, err := db.FindOneUser(&db.User{Email: strings.ToLower(loginRequest.Email)})
 
 	if err != nil {
-		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("Not Registered email or invalid password")))
+		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("not Registered email or invalid password")))
 		return
 	}
 
 	if user.CheckPassword(loginRequest.Password) != nil {
-		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("Not Registered email or invalid password")))
+		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("not Registered email or invalid password")))
 		return
 	}
 
 	if user.IsDisabled {
-		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("Your user has been disabled by the admin. Please contact them to get it re-enabled.")))
+		c.JSON(http.StatusForbidden, common.NewError("login", errors.New("your user has been disabled by the admin. Please contact them to get it re-enabled")))
 		return
 	}
 	UpdateContextUserModel(c, user.ID)
@@ -170,16 +171,16 @@ func changePassword(c *gin.Context) {
 	user, err := service.GetUserById(c.GetString("userId"))
 
 	if err != nil {
-		c.JSON(http.StatusForbidden, common.NewError("changePassword", errors.New("Not Registered email or invalid password")))
+		c.JSON(http.StatusForbidden, common.NewError("changePassword", errors.New("not Registered email or invalid password")))
 		return
 	}
 
 	if user.CheckPassword(request.OldPassword) != nil {
-		c.JSON(http.StatusForbidden, common.NewError("changePassword", errors.New("Incorrect old password")))
+		c.JSON(http.StatusForbidden, common.NewError("changePassword", errors.New("incorrect old password")))
 		return
 	}
 
 	user.SetPassword(request.NewPassword)
-	success, err := service.UpdatePassword(user.ID, request.NewPassword)
+	success, _ := service.UpdatePassword(user.ID, request.NewPassword)
 	c.JSON(http.StatusOK, success)
 }

server/controllers/middlewares.go

@@ -23,8 +23,8 @@ func stripBearerPrefixFromTokenString(tok string) (string, error) {
 // Extract  token from Authorization header
 // Uses PostExtractionFilter to strip "TOKEN " prefix from header
 var AuthorizationHeaderExtractor = &request.PostExtractionFilter{
-	request.HeaderExtractor{"Authorization"},
-	stripBearerPrefixFromTokenString,
+	Extractor: request.HeaderExtractor{"Authorization"},
+	Filter:    stripBearerPrefixFromTokenString,
 }
 
 // Extractor for OAuth2 access tokens.  Looks in 'Authorization'

server/controllers/setup.go

@@ -51,7 +51,7 @@ func migrate(c *gin.Context) {
 		canMigrate, _, _ := db.CanMigrate(request.Url)
 
 		if !canMigrate {
-			c.JSON(http.StatusBadRequest, fmt.Errorf("cannot migrate database. please check connection string."))
+			c.JSON(http.StatusBadRequest, fmt.Errorf("cannot migrate database. please check connection string"))
 			return
 		}
 

server/controllers/vehicle.go

@@ -397,7 +397,7 @@ func deleteVehicle(c *gin.Context) {
 			return
 		}
 		if !canDelete {
-			c.JSON(http.StatusUnprocessableEntity, common.NewError("shareVehicle", errors.New("You are not allowed to delete this vehicle.")))
+			c.JSON(http.StatusUnprocessableEntity, common.NewError("shareVehicle", errors.New("you are not allowed to delete this vehicle")))
 			return
 		}
 		err = service.DeleteVehicle(searchByIdQuery.Id)

server/db/dbModels.go

@@ -196,3 +196,50 @@ type VehicleAttachment struct {
 	VehicleID    string `gorm:"primaryKey" json:"vehicleId"`
 	Title        string `json:"title"`
 }
+
+type VehicleAlert struct {
+	Base
+	VehicleID       string         `json:"vehicleId"`
+	Vehicle         Vehicle        `json:"-"`
+	UserID          string         `json:"userId"`
+	User            User           `json:"user"`
+	Title           string         `json:"title"`
+	Comments        string         `json:"comments"`
+	StartDate       time.Time      `json:"date"`
+	StartOdoReading int            `json:"startOdoReading"`
+	DistanceUnit    DistanceUnit   `json:"distanceUnit"`
+	AlertFrequency  AlertFrequency `json:"alertFrequency"`
+	OdoFrequency    int            `json:"odoFrequency"`
+	DayFrequency    int            `json:"dayFrequency"`
+	AlertAllUsers   bool           `json:"alertAllUsers"`
+	IsActive        bool           `json:"isActive"`
+	EndDate         *time.Time     `json:"endDate"`
+	AlertType       AlertType      `json:"alertType"`
+}
+type AlertOccurance struct {
+	Base
+	VehicleID        string       `json:"vehicleId"`
+	Vehicle          Vehicle      `json:"-"`
+	VehicleAlertID   string       `json:"vehicleAlertId"`
+	VehicleAlert     VehicleAlert `json:"-"`
+	UserID           string       `json:"userId"`
+	User             User         `json:"-"`
+	OdoReading       int          `json:"odoReading"`
+	Date             *time.Time   `json:"date"`
+	ProcessDate      *time.Time   `json:"processDate"`
+	AlertProcessType AlertType    `json:"alertProcessType"`
+	CompleteDate     *time.Time   `json:"completeDate"`
+}
+
+type Notification struct {
+	Base
+	Title      string     `json:"title"`
+	Content    string     `json:"content"`
+	UserID     string     `json:"userId"`
+	VehicleID  string     `json:"vehicleId"`
+	User       User       `json:"-"`
+	Date       time.Time  `json:"date"`
+	ReadDate   *time.Time `json:"readDate"`
+	ParentID   string     `json:"parentId"`
+	ParentType string     `json:"parentType"`
+}