Feature: add Tibia Forums Section details (v4/forum/section/{name})

New endpoint is added: `v3/forum/section/{name}` that returns all the data available on sites:
- https://www.tibia.com/forum/?subtopic=worldboards
- https://www.tibia.com/forum/?subtopic=tradeboards
- https://www.tibia.com/forum/?subtopic=communityboards
- https://www.tibia.com/forum/?subtopic=supportboards

Similar to TibiaData#215 but for v4

Author: simivar

src/TibiaDataUtils.go

@@ -37,7 +37,19 @@ func TibiaDataDatetime(date string) string {
 		loc, _ := time.LoadLocation("Europe/Berlin")
 
 		// format used in datetime on html: Jan 02 2007, 19:20:30 CET
-		formatting := "Jan 02 2006, 15:04:05 MST"
+		var formatting string
+
+		// parsing and setting format of return
+		switch dateLength := len(date); {
+		case dateLength > 19:
+			// format used in datetime on html: Jan 02 2007, 19:20:30 CET
+			formatting = "Jan 02 2006, 15:04:05 MST"
+		case dateLength == 19:
+			// format used in datetime on html: 03.06.2023 01:19:00
+			formatting = "02.01.2006 15:04:05"
+		default:
+			log.Printf("Weird format detected: %s", date)
+		}
 
 		// parsing html in time with location set in loc
 		returnDate, err = time.ParseInLocation(formatting, date, loc)
@@ -299,3 +311,19 @@ func TibiaDataGetNewsType(data string) string {
 		return "unknown"
 	}
 }
+
+// TibiaDataForumNameValidator func - return valid forum string
+func TibiaDataForumNameValidator(name string) string {
+	switch strings.ToLower(name) {
+	case "world boards", "world", "worldboards":
+		return "worldboards"
+	case "trade boards", "trade", "tradeboards":
+		return "tradeboards"
+	case "community boards", "community", "communityboards":
+		return "communityboards"
+	case "support boards", "support", "supportboards":
+		return "supportboards"
+	default:
+		return "worldboards"
+	}
+}

src/TibiaDataUtils_test.go

@@ -18,6 +18,10 @@ func TestTibiaUTCDateFormat(t *testing.T) {
 	assert.Equal(t, "2021-12-24T09:52:16Z", TibiaDataDatetime("Dec 24 2021, 09:52:16 UTC"))
 }
 
+func TestTibiaForumDateFormat(t *testing.T) {
+	assert.Equal(t, "2023-06-20T13:55:36Z", TibiaDataDatetime("20.06.2023 15:55:36"))
+}
+
 func TestEnvFunctions(t *testing.T) {
 	assert := assert.New(t)
 
@@ -72,6 +76,28 @@ func TestTibiaDataGetNewsType(t *testing.T) {
 	assert.Equal("unknown", TibiaDataGetNewsType("TibiaData"))
 }
 
+func TestTibiaDataForumNameValidator(t *testing.T) {
+	assert := assert.New(t)
+
+	assert.Equal("worldboards", TibiaDataForumNameValidator("world boards"))
+	assert.Equal("worldboards", TibiaDataForumNameValidator("world"))
+	assert.Equal("worldboards", TibiaDataForumNameValidator("worldboards"))
+
+	assert.Equal("tradeboards", TibiaDataForumNameValidator("trade boards"))
+	assert.Equal("tradeboards", TibiaDataForumNameValidator("trade"))
+	assert.Equal("tradeboards", TibiaDataForumNameValidator("tradeboards"))
+
+	assert.Equal("communityboards", TibiaDataForumNameValidator("community boards"))
+	assert.Equal("communityboards", TibiaDataForumNameValidator("community"))
+	assert.Equal("communityboards", TibiaDataForumNameValidator("communityboards"))
+
+	assert.Equal("supportboards", TibiaDataForumNameValidator("support boards"))
+	assert.Equal("supportboards", TibiaDataForumNameValidator("support"))
+	assert.Equal("supportboards", TibiaDataForumNameValidator("supportboards"))
+
+	assert.Equal("worldboards", TibiaDataForumNameValidator("def"))
+}
+
 func TestHTMLLineBreakRemover(t *testing.T) {
 	const str = "a\nb\nc\nd\ne\nf\ng\nh\n"
 

src/TibiaForumSection.go

@@ -0,0 +1,116 @@
+package main
+
+import (
+	"fmt"
+	"net/http"
+	"regexp"
+	"strings"
+
+	"github.com/PuerkitoBio/goquery"
+)
+
+type SectionBoardLastPost struct {
+	ID            int    `json:"id"`
+	PostedAt      string `json:"posted_at"`
+	CharacterName string `json:"character_name"`
+}
+
+type SectionBoard struct {
+	ID          int                  `json:"id"`
+	Name        string               `json:"name"`
+	Description string               `json:"description"`
+	Posts       int                  `json:"posts"`
+	Threads     int                  `json:"threads"`
+	LastPost    SectionBoardLastPost `json:"last_post"`
+}
+
+type ForumSectionResponse struct {
+	Boards      []SectionBoard `json:"boards"`
+	Information Information    `json:"information"`
+}
+
+var (
+	boardInformationRegex      = regexp.MustCompile(`.*boardid=(.*)">(.*)<\/a><br\/><font class="ff_info">(.*)<\/font><\/td><td class="TextRight">(.*)<\/td><td class="TextRight">(.*)<\/td><td><span class="LastPostInfo">`)
+	lastPostIdRegex            = regexp.MustCompile(`.*postid=(.*)#post`)
+	lastPostPostedAtRegex      = regexp.MustCompile(`.*height="9"\/><\/a>(.*)<\/span><span><font class="ff_info">`)
+	lastPostCharacterNameRegex = regexp.MustCompile(`.*subtopic=characters&amp;name=.*\">(.*)<\/a><\/span>`)
+)
+
+// TibiaForumSectionImpl func
+func TibiaForumSectionImpl(BoxContentHTML string) (*ForumSectionResponse, error) {
+	// Loading HTML data into ReaderHTML for goquery with NewReader
+	ReaderHTML, err := goquery.NewDocumentFromReader(strings.NewReader(BoxContentHTML))
+	if err != nil {
+		return nil, fmt.Errorf("[error] TibiaForumSectionImpl failed at goquery.NewDocumentFromReader, err: %s", err)
+	}
+
+	var (
+		BoardsData                              []SectionBoard
+		LastPostId                              int
+		LastPostPostedAt, LastPostCharacterName string
+
+		insideError error
+	)
+
+	// Running query over each div
+	ReaderHTML.Find(".TableContentContainer .TableContent tbody tr:not(.LabelH)").EachWithBreak(func(index int, s *goquery.Selection) bool {
+		// Storing HTML into CreatureDivHTML
+		BoardsDivHTML, err := s.Html()
+		if err != nil {
+			insideError = fmt.Errorf("[error] TibiaForumSectionImpl failed at BoardsDivHTML, err := s.Html(), err: %s", err)
+			return false
+		}
+
+		subma1 := boardInformationRegex.FindAllStringSubmatch(BoardsDivHTML, -1)
+		if len(subma1) == 0 {
+			return false
+		}
+
+		subma2 := lastPostIdRegex.FindAllStringSubmatch(BoardsDivHTML, -1)
+		if len(subma2) > 0 {
+			LastPostId = TibiaDataStringToInteger(subma2[0][1])
+		}
+
+		subma3 := lastPostPostedAtRegex.FindAllStringSubmatch(BoardsDivHTML, -1)
+		if len(subma3) > 0 {
+			LastPostPostedAt = TibiaDataDatetime(strings.Trim(TibiaDataSanitizeStrings(subma3[0][1]), " "))
+		}
+
+		subma4 := lastPostCharacterNameRegex.FindAllStringSubmatch(BoardsDivHTML, -1)
+		if len(subma4) > 0 {
+			LastPostCharacterName = TibiaDataSanitizeStrings(subma4[0][1])
+		}
+
+		BoardsData = append(BoardsData, SectionBoard{
+			ID:          TibiaDataStringToInteger(subma1[0][1]),
+			Name:        subma1[0][2],
+			Description: subma1[0][3],
+			Posts:       TibiaDataStringToInteger(subma1[0][4]),
+			Threads:     TibiaDataStringToInteger(subma1[0][5]),
+			LastPost: SectionBoardLastPost{
+				ID:            LastPostId,
+				PostedAt:      LastPostPostedAt,
+				CharacterName: LastPostCharacterName,
+			},
+		})
+
+		return true
+	})
+
+	if insideError != nil {
+		return nil, insideError
+	}
+
+	//
+	// Build the data-blob
+	return &ForumSectionResponse{
+		Boards: BoardsData,
+		Information: Information{
+			APIDetails: TibiaDataAPIDetails,
+			Timestamp:  TibiaDataDatetime(""),
+			Status: Status{
+				HTTPCode: http.StatusOK,
+			},
+		},
+	}, nil
+}

src/TibiaForumSection_test.go

@@ -0,0 +1,50 @@
+package main
+
+import (
+	"github.com/TibiaData/tibiadata-api-go/src/static"
+	"github.com/stretchr/testify/assert"
+	"io"
+	"testing"
+)
+
+func TestForumsSectionWorldboard(t *testing.T) {
+	file, err := static.TestFiles.Open("testdata/forums/section/worldboard.html")
+	if err != nil {
+		t.Fatalf("file opening error: %s", err)
+	}
+	defer file.Close()
+
+	data, err := io.ReadAll(file)
+	if err != nil {
+		t.Fatalf("File reading error: %s", err)
+	}
+
+	boardsJson, err := TibiaForumSectionImpl(string(data))
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	assert := assert.New(t)
+
+	assert.Equal(90, len(boardsJson.Boards))
+
+	adra := boardsJson.Boards[0]
+	assert.Equal(146482, adra.ID)
+	assert.Equal("Adra", adra.Name)
+	assert.Equal("This board is for general discussions related to the game world Adra.", adra.Description)
+	assert.Equal(388, adra.Threads)
+	assert.Equal(1158, adra.Posts)
+	assert.Equal(39395612, adra.LastPost.ID)
+	assert.Equal("Rcdohl", adra.LastPost.CharacterName)
+	assert.Equal("2023-06-02T23:19:00Z", adra.LastPost.PostedAt)
+
+	alumbra := boardsJson.Boards[1]
+	assert.Equal(147016, alumbra.ID)
+	assert.Equal("Alumbra", alumbra.Name)
+	assert.Equal("This board is for general discussions related to the game world Alumbra.", alumbra.Description)
+	assert.Equal(563, alumbra.Threads)
+	assert.Equal(1011, alumbra.Posts)
+	assert.Equal(39395777, alumbra.LastPost.ID)
+	assert.Equal("Mad Mustazza", alumbra.LastPost.CharacterName)
+	assert.Equal("2023-06-04T15:51:13Z", alumbra.LastPost.PostedAt)
+}

src/static/testdata/forums/section/worldboard.html

@@ -199,6 +199,9 @@ func runWebServer() {
 		// Tibia worlds
 		v4.GET("/world/:name", tibiaWorldsWorld)
 		v4.GET("/worlds", tibiaWorldsOverview)
+
+		// Tibia forums
+		v4.GET("/forum/section/:name", tibiaForumSection)
 	}
 
 	// Container version details endpoint
@@ -1061,6 +1064,36 @@ func tibiaWorldsWorld(c *gin.Context) {
 		"TibiaWorldsWorld")
 }
 
+// Forum godoc
+// @Summary      Show one section
+// @Description  Show all information about one section
+// @Tags         forums
+// @Accept       json
+// @Produce      json
+// @Param        name path string true "The name of section" extensions(x-example=worldboards)
+// @Success      200  {object}  ForumSectionResponse
+// @Failure      400  {object}  Information
+// @Failure      404  {object}  Information
+// @Failure      503  {object}  Information
+// @Router       /v4/forum/section/{name} [get]
+func tibiaForumSection(c *gin.Context) {
+	// getting params from URL
+	name := c.Param("name")
+
+	tibiadataRequest := TibiaDataRequestStruct{
+		Method: resty.MethodGet,
+		URL:    "https://www.tibia.com/forum/?subtopic=" + TibiaDataForumNameValidator(name),
+	}
+
+	tibiaDataRequestHandler(
+		c,
+		tibiadataRequest,
+		func(BoxContentHTML string) (interface{}, error) {
+			return TibiaForumSectionImpl(BoxContentHTML)
+		},
+		"TibiaForumSectionImpl")
+}
+
 func TibiaDataErrorHandler(c *gin.Context, err error, httpCode int) {
 	if err == nil {
 		panic(errors.New("TibiaDataErrorHandler called with nil err"))