Adding Worlds unit tests (#53)

* Worlds Overview unit tests

* updating TibiadataDateV3
parsing date without regex and supporting long and short months

* changing WorldsBattleyeDate to be parsed correct
updating tests as well

Co-authored-by: Tobias Lindberg <tobias.ehlert@gmail.com>

Author: kamilon

src/TibiaDataUtils.go

@@ -92,24 +92,37 @@ func TibiadataQueryEscapeStringV3(data string) string {
 	return url.QueryEscape(data)
 }
 
-var dateRegex = regexp.MustCompile(`([a-zA-Z]{3}).*([0-9]{2}).*([0-9]{4})`)
-
 // TibiadataDateV3 func
 func TibiadataDateV3(date string) string {
-	// use regex to skip weird formatting on "spaces"
-	subma1 := dateRegex.FindAllStringSubmatch(date, -1)
-	date = (subma1[0][1] + " " + subma1[0][2] + " " + subma1[0][3])
+	// removing weird spacing and comma
+	date = TibiaDataSanitizeNbspSpaceString(strings.ReplaceAll(date, ",", ""))
+
+	// var time parser
+	var tmpDate time.Time
 
 	// parsing and setting format of return
-	tmpDate, _ := time.Parse("Jan 02 2006", date)
-	date = tmpDate.UTC().Format("2006-01-02")
+	switch dateLength := len(date); {
+	case dateLength == 5:
+		// date that contains special formatting only used in date a world was created
+		tmpDate, _ = time.Parse("01/06", date)
+		// we need to return earlier as well, since we don't have the day
+		return tmpDate.UTC().Format("2006-01")
+	case dateLength == 11:
+		// dates that contain first 3 letters in month
+		tmpDate, _ = time.Parse("Jan 02 2006", date)
+	case dateLength > 11:
+		// dates that contain month fully written
+		tmpDate, _ = time.Parse("January 02 2006", date)
+	default:
+		log.Printf("Weird format detected: %s", date)
+	}
 
-	return date
+	return tmpDate.UTC().Format("2006-01-02")
 }
 
 // TibiadataStringToIntegerV3 func
 func TibiadataStringToIntegerV3(data string) int {
-	returnData, err := strconv.Atoi(data)
+	returnData, err := strconv.Atoi(strings.ReplaceAll(data, ",", ""))
 	if err != nil {
 		log.Printf("[warning] TibiadataStringToIntegerV3: couldn't convert string into int. error: %s", err)
 	}

src/TibiaWorldsOverviewV3.go

@@ -10,46 +10,44 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
+// Child of Worlds
+type World struct {
+	Name                string `json:"name"`
+	Status              string `json:"status"`                // Online:
+	PlayersOnline       int    `json:"players_online"`        // Online:
+	Location            string `json:"location"`              // Location:
+	PvpType             string `json:"pvp_type"`              // PvP Type:
+	PremiumOnly         bool   `json:"premium_only"`          // Additional Information: premium = true / else: false
+	TransferType        string `json:"transfer_type"`         // Additional Information: regular (if not present) / locked / blocked
+	BattleyeProtected   bool   `json:"battleye_protected"`    // BattlEye Status: true if protected / false if "Not protected by BattlEye."
+	BattleyeDate        string `json:"battleye_date"`         // BattlEye Status: null if since release / else show date?
+	GameWorldType       string `json:"game_world_type"`       // BattlEye Status: regular / experimental / tournament (if Tournament World Type exists)
+	TournamentWorldType string `json:"tournament_world_type"` // BattlEye Status: null (default?) / regular / restricted
+}
+
+// Child of JSONData
+type Worlds struct {
+	PlayersOnline    int     `json:"players_online"` // Calculated value
+	RecordPlayers    int     `json:"record_players"` // Overall Maximum:
+	RecordDate       string  `json:"record_date"`    // Overall Maximum:
+	RegularWorlds    []World `json:"regular_worlds"`
+	TournamentWorlds []World `json:"tournament_worlds"`
+}
+
+//
+// The base includes two levels: Worlds and Information
+type WorldsOverviewResponse struct {
+	Worlds      Worlds      `json:"worlds"`
+	Information Information `json:"information"`
+}
+
 var (
 	worldPlayerRecordRegex           = regexp.MustCompile(`.*<\/b>...(.*) players \(on (.*)\)`)
 	worldInformationRegex            = regexp.MustCompile(`.*world=.*">(.*)<\/a><\/td>.*right;">(.*)<\/td><td>(.*)<\/td><td>(.*)<\/td><td align="center" valign="middle">(.*)<\/td><td>(.*)<\/td>`)
 	worldBattlEyeProtectedSinceRegex = regexp.MustCompile(`.*game world has been protected by BattlEye since (.*).&lt;\/p.*`)
 )
 
-// TibiaWorldsOverviewV3 func
 func TibiaWorldsOverviewV3(c *gin.Context) {
-
-	// Child of Worlds
-	type World struct {
-		Name                string `json:"name"`
-		Status              string `json:"status"`                // Online:
-		PlayersOnline       int    `json:"players_online"`        // Online:
-		Location            string `json:"location"`              // Location:
-		PvpType             string `json:"pvp_type"`              // PvP Type:
-		PremiumOnly         bool   `json:"premium_only"`          // Additional Information: premium = true / else: false
-		TransferType        string `json:"transfer_type"`         // Additional Information: regular (if not present) / locked / blocked
-		BattleyeProtected   bool   `json:"battleye_protected"`    // BattlEye Status: true if protected / false if "Not protected by BattlEye."
-		BattleyeDate        string `json:"battleye_date"`         // BattlEye Status: null if since release / else show date?
-		GameWorldType       string `json:"game_world_type"`       // BattlEye Status: regular / experimental / tournament (if Tournament World Type exists)
-		TournamentWorldType string `json:"tournament_world_type"` // BattlEye Status: null (default?) / regular / restricted
-	}
-
-	// Child of JSONData
-	type Worlds struct {
-		PlayersOnline    int     `json:"players_online"` // Calculated value
-		RecordPlayers    int     `json:"record_players"` // Overall Maximum:
-		RecordDate       string  `json:"record_date"`    // Overall Maximum:
-		RegularWorlds    []World `json:"regular_worlds"`
-		TournamentWorlds []World `json:"tournament_worlds"`
-	}
-
-	//
-	// The base includes two levels: Worlds and Information
-	type JSONData struct {
-		Worlds      Worlds      `json:"worlds"`
-		Information Information `json:"information"`
-	}
-
 	// Getting data with TibiadataHTMLDataCollectorV3
 	TibiadataRequest.URL = "https://www.tibia.com/community/?subtopic=worlds"
 	BoxContentHTML, err := TibiadataHTMLDataCollectorV3(TibiadataRequest)
@@ -60,6 +58,13 @@ func TibiaWorldsOverviewV3(c *gin.Context) {
 		return
 	}
 
+	jsonData := TibiaWorldsOverviewV3Impl(BoxContentHTML)
+
+	TibiaDataAPIHandleSuccessResponse(c, "TibiaWorldsOverviewV3", jsonData)
+}
+
+// TibiaWorldsOverviewV3 func
+func TibiaWorldsOverviewV3Impl(BoxContentHTML string) WorldsOverviewResponse {
 	// Loading HTML data into ReaderHTML for goquery with NewReader
 	ReaderHTML, err := goquery.NewDocumentFromReader(strings.NewReader(BoxContentHTML))
 	if err != nil {
@@ -102,23 +107,27 @@ func TibiaWorldsOverviewV3(c *gin.Context) {
 
 		// check if regex return length is over 0
 		if len(subma2) > 0 {
+			WorldsPlayersOnline := 0
+
+			if subma2[0][2] == "-" {
+				WorldsStatus = "unknown"
+			} else {
+				WorldsPlayersOnline = TibiadataStringToIntegerV3(subma2[0][2])
+
+				// Setting the players_online & overall players_online
+				WorldsAllOnlinePlayers += WorldsPlayersOnline
+
+				if WorldsPlayersOnline > 0 {
+					WorldsStatus = "online"
+				} else {
+					WorldsStatus = "offline"
+				}
+			}
 
 			// Creating better to use vars
-			WorldsPlayersOnline := TibiadataStringToIntegerV3(subma2[0][2])
 			WorldsBattlEye := subma2[0][5]
 			WorldsAdditionalInfo := subma2[0][6]
 
-			// Setting the players_online & overall players_online
-			WorldsAllOnlinePlayers += WorldsPlayersOnline
-			switch {
-			case WorldsPlayersOnline > 0:
-				WorldsStatus = "online"
-			case subma2[0][2] == "-":
-				WorldsStatus = "unknown"
-			default:
-				WorldsStatus = "offline"
-			}
-
 			// Setting the premium_only
 			if strings.Contains(WorldsAdditionalInfo, "premium") {
 				WorldsPremiumOnly = true
@@ -149,7 +158,7 @@ func TibiaWorldsOverviewV3(c *gin.Context) {
 					WorldsBattleyeDate = "release"
 				} else {
 					subma21 := worldBattlEyeProtectedSinceRegex.FindAllStringSubmatch(WorldsBattlEye, -1)
-					WorldsBattleyeDate = subma21[0][1]
+					WorldsBattleyeDate = TibiadataDateV3(subma21[0][1])
 				}
 			} else {
 				// This world is without protection..
@@ -196,7 +205,7 @@ func TibiaWorldsOverviewV3(c *gin.Context) {
 
 	//
 	// Build the data-blob
-	jsonData := JSONData{
+	return WorldsOverviewResponse{
 		Worlds{
 			PlayersOnline:    WorldsAllOnlinePlayers,
 			RecordPlayers:    WorldsRecordPlayers,
@@ -209,7 +218,4 @@ func TibiaWorldsOverviewV3(c *gin.Context) {
 			Timestamp:  TibiadataDatetimeV3(""),
 		},
 	}
-
-	// return jsonData
-	TibiaDataAPIHandleSuccessResponse(c, "TibiaWorldsOverviewV3", jsonData)
 }

src/TibiaWorldsOverviewV3_test.go

@@ -0,0 +1,64 @@
+package main
+
+import (
+	"io/ioutil"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestWorlds(t *testing.T) {
+	data, err := ioutil.ReadFile("../testdata/worlds/worlds.html")
+	if err != nil {
+		t.Errorf("File reading error: %s", err)
+		return
+	}
+
+	worldsJson := TibiaWorldsOverviewV3Impl(string(data))
+	assert := assert.New(t)
+
+	assert.Equal(8756, worldsJson.Worlds.PlayersOnline)
+	assert.Equal(64028, worldsJson.Worlds.RecordPlayers)
+	assert.Equal("2007-11-28T18:26:00Z", worldsJson.Worlds.RecordDate)
+	assert.Equal(76, len(worldsJson.Worlds.RegularWorlds))
+	assert.Equal(6, len(worldsJson.Worlds.TournamentWorlds))
+
+	adra := worldsJson.Worlds.RegularWorlds[0]
+	assert.Equal("Adra", adra.Name)
+	assert.Equal("online", adra.Status)
+	assert.Equal(18, adra.PlayersOnline)
+	assert.Equal("Europe", adra.Location)
+	assert.Equal("Open PvP", adra.PvpType)
+	assert.Equal(false, adra.PremiumOnly)
+	assert.Equal("blocked", adra.TransferType)
+	assert.Equal(true, adra.BattleyeProtected)
+	assert.Equal("release", adra.BattleyeDate)
+	assert.Equal("regular", adra.GameWorldType)
+	assert.Equal("", adra.TournamentWorldType)
+
+	astera := worldsJson.Worlds.RegularWorlds[4]
+	assert.Equal("Astera", astera.Name)
+	assert.Equal("online", astera.Status)
+	assert.Equal(222, astera.PlayersOnline)
+	assert.Equal("North America", astera.Location)
+	assert.Equal("Optional PvP", astera.PvpType)
+	assert.Equal(false, astera.PremiumOnly)
+	assert.Equal("regular", astera.TransferType)
+	assert.Equal(true, astera.BattleyeProtected)
+	assert.Equal("2017-09-12", astera.BattleyeDate)
+	assert.Equal("regular", astera.GameWorldType)
+	assert.Equal("", astera.TournamentWorldType)
+
+	endera := worldsJson.Worlds.TournamentWorlds[1]
+	assert.Equal("Endera", endera.Name)
+	assert.Equal("unknown", endera.Status)
+	assert.Equal(0, endera.PlayersOnline)
+	assert.Equal("North America", endera.Location)
+	assert.Equal("Optional PvP", endera.PvpType)
+	assert.Equal(true, endera.PremiumOnly)
+	assert.Equal("blocked", endera.TransferType)
+	assert.Equal(true, endera.BattleyeProtected)
+	assert.Equal("release", endera.BattleyeDate)
+	assert.Equal("tournament", endera.GameWorldType)
+	assert.Equal("restricted", endera.TournamentWorldType)
+}