Add support to new boostable bosses page (#152)

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

Author: tiagomartines11

README.md

@@ -97,6 +97,7 @@ Those are the current existing endpoints.
 
 - GET `/ping`
 - GET `/health`
+- GET `/v3/boostablebosses`
 - GET `/v3/character/:name`
 - GET `/v3/creature/:race`
 - GET `/v3/creatures`

src/TibiaBoostableBossesOverviewV3.go

@@ -0,0 +1,117 @@
+package main
+
+import (
+	"log"
+	"regexp"
+	"strings"
+
+	"github.com/PuerkitoBio/goquery"
+)
+
+// Child of BoostableBoss (used for list of boostable bosses and boosted boss section)
+type OverviewBoostableBoss struct {
+	Name     string `json:"name"`
+	ImageURL string `json:"image_url"`
+	Featured bool   `json:"featured"`
+}
+
+// Child of JSONData
+type BoostableBossesContainer struct {
+	Boosted         OverviewBoostableBoss   `json:"boosted"`
+	BoostableBosses []OverviewBoostableBoss `json:"boostable_boss_list"`
+}
+
+//
+// The base includes two levels: BoostableBosses and Information
+type BoostableBossesOverviewResponse struct {
+	BoostableBosses BoostableBossesContainer `json:"boostable_bosses"`
+	Information     Information              `json:"information"`
+}
+
+var (
+	BoostedBossNameRegex          = regexp.MustCompile(`<b>(.*)</b>`)
+	BoostedBossImageRegex         = regexp.MustCompile(`<img[^>]+\bsrc=["']([^"']+)["']`)
+	BoostableBossInformationRegex = regexp.MustCompile(`<img src="(.*)" border.*div>(.*)<\/div>`)
+)
+
+func TibiaBoostableBossesOverviewV3Impl(BoxContentHTML string) BoostableBossesOverviewResponse {
+	var (
+		BoostedBossName, BoostedBossImage string
+	)
+
+	// Loading HTML data into ReaderHTML for goquery with NewReader
+	ReaderHTML, err := goquery.NewDocumentFromReader(strings.NewReader(BoxContentHTML))
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Getting data from div.InnerTableContainer and then first p
+	InnerTableContainerTMPB, err := ReaderHTML.Find(".InnerTableContainer p").First().Html()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Regex to get data for name for boosted boss
+	subma1b := BoostedBossNameRegex.FindAllStringSubmatch(InnerTableContainerTMPB, -1)
+
+	if len(subma1b) > 0 {
+		// Settings vars for usage in JSONData
+		BoostedBossName = subma1b[0][1]
+	}
+
+	// Regex to get image of boosted boss
+	subma2b := BoostedBossImageRegex.FindAllStringSubmatch(InnerTableContainerTMPB, -1)
+
+	if len(subma2b) > 0 {
+		// Settings vars for usage in JSONData
+		BoostedBossImage = subma2b[0][1]
+	}
+
+	// Creating empty BoostableBossesData var
+	var BoostableBossesData []OverviewBoostableBoss
+
+	// Running query over each div
+	ReaderHTML.Find(".BoxContent div div").Each(func(index int, s *goquery.Selection) {
+
+		// Storing HTML into BoostableBossDivHTML
+		BoostableBossDivHTML, err := s.Html()
+		if err != nil {
+			log.Fatal(err)
+		}
+
+		// Regex to get data for name, race and img src param for creature
+		subma1 := BoostableBossInformationRegex.FindAllStringSubmatch(BoostableBossDivHTML, -1)
+
+		// check if regex return length is over 0 and the match of name is over 1
+		if len(subma1) > 0 && len(subma1[0][2]) > 1 {
+			// Adding bool to indicate features in boostable_boss_list
+			FeaturedRace := false
+			if subma1[0][2] == BoostedBossName {
+				FeaturedRace = true
+			}
+
+			// Creating data block to return
+			BoostableBossesData = append(BoostableBossesData, OverviewBoostableBoss{
+				Name:     TibiaDataSanitizeEscapedString(subma1[0][2]),
+				ImageURL: subma1[0][1],
+				Featured: FeaturedRace,
+			})
+		}
+	})
+
+	// Build the data-blob
+	return BoostableBossesOverviewResponse{
+		BoostableBossesContainer{
+			Boosted: OverviewBoostableBoss{
+				Name:     BoostedBossName,
+				ImageURL: BoostedBossImage,
+				Featured: true,
+			},
+			BoostableBosses: BoostableBossesData,
+		},
+		Information{
+			APIVersion: TibiaDataAPIversion,
+			Timestamp:  TibiaDataDatetimeV3(""),
+		},
+	}
+}

src/TibiaBoostableBossesOverviewV3_test.go

@@ -0,0 +1,34 @@
+package main
+
+import (
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestBoostableBossesOverview(t *testing.T) {
+	data, err := os.ReadFile("../testdata/boostablebosses/boostablebosses.html")
+	if err != nil {
+		t.Errorf("File reading error: %s", err)
+		return
+	}
+
+	boostableBossesJson := TibiaBoostableBossesOverviewV3Impl(string(data))
+	assert := assert.New(t)
+
+	assert.Equal("The Pale Worm", boostableBossesJson.BoostableBosses.Boosted.Name)
+	assert.Equal("https://static.tibia.com/images/global/header/monsters/paleworm.gif", boostableBossesJson.BoostableBosses.Boosted.ImageURL)
+
+	assert.Equal(88, len(boostableBossesJson.BoostableBosses.BoostableBosses))
+
+	gnomevil := boostableBossesJson.BoostableBosses.BoostableBosses[18]
+	assert.Equal("Gnomevil", gnomevil.Name)
+	assert.Equal("https://static.tibia.com/images/library/gnomehorticulist.gif", gnomevil.ImageURL)
+	assert.False(gnomevil.Featured)
+
+	paleworm := boostableBossesJson.BoostableBosses.BoostableBosses[72]
+	assert.Equal("The Pale Worm", paleworm.Name)
+	assert.Equal("https://static.tibia.com/images/library/paleworm.gif", paleworm.ImageURL)
+	assert.True(paleworm.Featured)
+}

src/webserver.go

@@ -82,6 +82,9 @@ func runWebServer() {
 	// TibiaData API version 3
 	v3 := router.Group("/v3")
 	{
+		// Tibia characters
+		v3.GET("/boostablebosses", tibiaBoostableBossesV3)
+
 		// Tibia characters
 		v3.GET("/character/:name", tibiaCharactersCharacterV3)
 
@@ -169,6 +172,29 @@ func runWebServer() {
 	}
 }
 
+// BoostableBosses godoc
+// @Summary      List of boostable bosses
+// @Description  Show all boostable bosses listed
+// @Tags         boostable bosses
+// @Accept       json
+// @Produce      json
+// @Success      200  {object}  BoostableBossesOverviewResponse
+// @Router       /v3/boostablebosses [get]
+func tibiaBoostableBossesV3(c *gin.Context) {
+	tibiadataRequest := TibiaDataRequestStruct{
+		Method: resty.MethodGet,
+		URL:    "https://www.tibia.com/library/?subtopic=boostablebosses",
+	}
+
+	tibiaDataRequestHandler(
+		c,
+		tibiadataRequest,
+		func(BoxContentHTML string) (interface{}, int) {
+			return TibiaBoostableBossesOverviewV3Impl(BoxContentHTML), http.StatusOK
+		},
+		"TibiaBoostableBossesV3")
+}
+
 // Character godoc
 // @Summary      Show one character
 // @Description  Show all information about one character available