- now using environment variables to set database connection.

-create project's dealing with levenshtein distance and metaphone code.

Author: DanielFillol

controllers/controller.go

@@ -3,8 +3,8 @@ package controllers
 import (
 	"errors"
 	"github.com/Darklabel91/API_Names/database"
-	"github.com/Darklabel91/API_Names/metaphone"
 	"github.com/Darklabel91/API_Names/models"
+	Metaphone "github.com/Darklabel91/metaphone-br"
 	"github.com/gin-gonic/gin"
 	"net/http"
 	"sort"
@@ -90,15 +90,14 @@ func GetName(c *gin.Context) {
 func SearchSimilarNames(c *gin.Context) {
 	//name to be searched
 	name := c.Params.ByName("name")
-	nameMetaphone := metaphone.Pack(name)
+	nameMetaphone := Metaphone.Pack(name)
 
 	//find all metaphoneNames matching metaphone
 	var metaphoneNames []models.NameType
-
 	database.Db.Raw("select * from name_types where metaphone = ?", nameMetaphone).Find(&metaphoneNames)
 	similarNames := findNames(metaphoneNames, name, levenshtein)
 
-	//for recall purposes we can't only search for metaphone exact match's if no similar word is found.
+	//for recall purposes we can't only search for metaphone exact match's if no similar word is found
 	if len(metaphoneNames) == 0 || len(similarNames) == 0 {
 		metaphoneNames = searchForAllSimilarMetaphone(nameMetaphone)
 		similarNames = findNames(metaphoneNames, name, levenshtein)
@@ -115,6 +114,7 @@ func SearchSimilarNames(c *gin.Context) {
 	}
 
 	//when the similar metaphoneNames result's in less than 5 we search for every similar name of all similar metaphoneNames founded previously
+	//this step can be ignored if you want to
 	if len(similarNames) < 5 {
 		for _, n := range similarNames {
 			similar := findNames(metaphoneNames, n.Name, levenshtein)
@@ -125,7 +125,7 @@ func SearchSimilarNames(c *gin.Context) {
 	//order all similar metaphoneNames from high to low Levenshtein
 	nameV := orderByLevenshtein(similarNames)
 
-	//build canonical
+	//finds a name to consider Canonical on the database
 	canonicalEntity, err := findCanonical(name, metaphoneNames, nameV)
 	if err != nil {
 		c.JSON(http.StatusNotFound, gin.H{"Not found": err.Error(), "metaphone": nameMetaphone})
@@ -155,7 +155,7 @@ func searchForAllSimilarMetaphone(mtf string) []models.NameType {
 
 	var rNames []models.NameType
 	for _, n := range names {
-		if metaphone.IsMetaphoneSimilar(mtf, n.Metaphone) {
+		if Metaphone.IsMetaphoneSimilar(mtf, n.Metaphone) {
 			rNames = append(rNames, n)
 		}
 	}
@@ -177,7 +177,7 @@ func findCanonical(name string, matchingMetaphoneNames []models.NameType, nameVa
 
 	//search for similar names on matchingMetaphoneNames
 	for _, similarName := range matchingMetaphoneNames {
-		if metaphone.SimilarityBetweenWords(name, similarName.Name) >= levenshtein {
+		if Metaphone.SimilarityBetweenWords(name, similarName.Name) >= levenshtein {
 			return similarName, nil
 		}
 	}
@@ -220,7 +220,7 @@ func findSimilarNames(name string, names []models.NameType, threshold float32) [
 	var similarNames []models.NameVar
 
 	for _, n := range names {
-		similarity := metaphone.SimilarityBetweenWords(strings.ToLower(name), strings.ToLower(n.Name))
+		similarity := Metaphone.SimilarityBetweenWords(strings.ToLower(name), strings.ToLower(n.Name))
 		if similarity >= threshold {
 			similarNames = append(similarNames, models.NameVar{Name: n.Name, Levenshtein: similarity})
 			varWords := strings.Split(n.NameVariations, "|")

database/db.go

@@ -3,16 +3,10 @@ package database
 import (
 	"fmt"
 	"github.com/Darklabel91/API_Names/models"
+	"github.com/joho/godotenv"
 	"gorm.io/driver/mysql"
 	"gorm.io/gorm"
-)
-
-const (
-	DbUsername = "root"
-	DbPassword = "root"
-	DbName     = "namesDatabase"
-	DbHost     = "127.0.0.1"
-	DbPort     = "3306"
+	"os"
 )
 
 var Db *gorm.DB
@@ -23,7 +17,21 @@ func InitDb() *gorm.DB {
 }
 
 func connectDB() *gorm.DB {
-	var err error
+	//load .env file
+	err := godotenv.Load()
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	//get .env variables
+	var (
+		DbUsername = os.Getenv("DB_USERNAME")
+		DbPassword = os.Getenv("DB_PASSWORD")
+		DbName     = os.Getenv("DB_NAME")
+		DbHost     = os.Getenv("DB_HOST")
+		DbPort     = os.Getenv("DB_PORT")
+	)
+
 	dsn := DbUsername + ":" + DbPassword + "@tcp" + "(" + DbHost + ":" + DbPort + ")/" + DbName + "?" + "parseTime=true&loc=Local"
 	fmt.Println("dsn : ", dsn)
 	db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})

go.mod

@@ -4,11 +4,14 @@ go 1.18
 
 require (
 	github.com/gin-gonic/gin v1.9.0
+	github.com/joho/godotenv v1.5.1
 	gorm.io/driver/mysql v1.4.7
 	gorm.io/gorm v1.24.6
 )
 
 require (
+	github.com/Darklabel91/Levenshtein v0.0.0-20230327182846-18e2b540c668 // indirect
+	github.com/Darklabel91/metaphone-br v0.0.0-20230327175255-f661f3ae637b // indirect
 	github.com/bytedance/sonic v1.8.5 // indirect
 	github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect
 	github.com/gin-contrib/sse v0.1.0 // indirect

go.sum

@@ -1,3 +1,9 @@
+github.com/Darklabel91/Levenshtein v0.0.0-20230327180915-520182aba65a h1:/nTBmKXehgl606NX4oqbKXMC5fVWPyjNBiSfnX9S2jM=
+github.com/Darklabel91/Levenshtein v0.0.0-20230327180915-520182aba65a/go.mod h1:8sU0Aii5Eog/JhC/LtRaSR4jSvgQyDN84rG2ihtm1iU=
+github.com/Darklabel91/Levenshtein v0.0.0-20230327182846-18e2b540c668 h1:F1VOn4ZXc8hBqtmNsSarRI/EwReb/TNDGGQt9tNWWDY=
+github.com/Darklabel91/Levenshtein v0.0.0-20230327182846-18e2b540c668/go.mod h1:8sU0Aii5Eog/JhC/LtRaSR4jSvgQyDN84rG2ihtm1iU=
+github.com/Darklabel91/metaphone-br v0.0.0-20230327175255-f661f3ae637b h1:ltrsS0rhJTqJqLHgULHSNSLBkht5tJ1tx7IJ12YRmXU=
+github.com/Darklabel91/metaphone-br v0.0.0-20230327175255-f661f3ae637b/go.mod h1:PkwZ63zIOXcukLDXhAKSDlAW+Fq/hK7u50bggIdu3TM=
 github.com/bytedance/sonic v1.5.0/go.mod h1:ED5hyg4y6t3/9Ku1R6dU/4KyJ48DZ4jPhfY1O2AihPM=
 github.com/bytedance/sonic v1.8.5 h1:kjX0/vo5acEQ/sinD/18SkA/lDDUk23F0RcaHvI7omc=
 github.com/bytedance/sonic v1.8.5/go.mod h1:i736AoUSYt75HyZLoJW9ERYxcy6eaN6h4BZXU064P/U=
@@ -31,6 +37,8 @@ github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkr
 github.com/jinzhu/now v1.1.4/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8=
 github.com/jinzhu/now v1.1.5 h1:/o9tlHleP7gOFmsnYNz3RGnqzefHA47wQpKrrdTIwXQ=
 github.com/jinzhu/now v1.1.5/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8=
+github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
+github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
 github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
 github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=