Add 'Link' Field to Information in API Responses (Fixes #381) #398

Kai-Animator · 2024-10-15T16:35:01Z

This pull request addresses Issue #381 by adding the Link field to the Information section in all API responses. The Link field provides a direct URL to the source data on the official Tibia website.

Changes Overview:

Updated Information Struct:

Added a new Link field to the Information struct in webserver.go:

type Information struct {
    APIDetails APIDetails `json:"api"`       // The API details.
    Timestamp  string     `json:"timestamp"` // The timestamp from when the data was processed.
    Link       string     `json:"link"`      // The link to the source of the data.
    Status     Status     `json:"status"`    // The response status information.
}

Modified API Handlers:

Updated all API endpoint handlers to populate the Link field with the appropriate URL pointing to the source data.

Example from TibiaWorldsWorld.go:

return WorldResponse{
    World: World{
        // ... existing fields ...
    },
    Information: Information{
        APIDetails: TibiaDataAPIDetails,
        Timestamp:  TibiaDataDatetime(""),
        Link:       "https://www.tibia.com/community/?subtopic=worlds&world=" + world,
        Status: Status{
            HTTPCode: http.StatusOK,
        },
    },
}, nil

Testing:

Tested all modified endpoints to ensure the Link field is correctly populated.
Verified that the URLs are accurate and lead to the correct pages on Tibia.com.

Notes:

NewsList was kind of tricky to handle the different patterns so I decided to sum all different URLs into only "https://www.tibia.com/news/?subtopic=newsarchive"
This is my first PR in the project so I am open to feedback and willing to make any necessary changes to meet the project's standards.

…s / Add test for information on characters test

…and guilds/:world endpoints

…ests

tobiasehlert

Thanks for the PR @Kai-Animator, this is a good start!
There are some things that I'd like to be adjusted.

One of them is that there is already a link for every endpoints source available, so hardcoding the line in the "Link" field is not optimal. It would be better to have it being populated by the value set in "tibiadataRequest.URL" before being sent to tibiaDataRequestHandler.

For instance here:

tibiadata-api-go/src/webserver.go

Lines 394 to 407 in a4afbe1

    
           func tibiaFansites(c *gin.Context) { 
        
           	tibiadataRequest := TibiaDataRequestStruct{ 
        
           		Method: resty.MethodGet, 
        
           		URL:    "https://www.tibia.com/community/?subtopic=fansites", 
        
           	} 
        
           	tibiaDataRequestHandler( 
        
           		c, 
        
           		tibiadataRequest, 
        
           		func(BoxContentHTML string) (interface{}, error) { 
        
           			return TibiaFansitesImpl(BoxContentHTML) 
        
           		}, 
        
           		"TibiaFansites") 
        
           }

I'd also like the "Link" to be named "TibiaURL" instead, since that's a slightly better description of that it is.
Also, we should probably want to have a []string as well, in case we add multi-upstream sources.

tobiasehlert · 2024-10-15T18:41:01Z

src/webserver.go

@@ -47,6 +47,7 @@ type OutInformation struct {
 type Information struct {
 	APIDetails APIDetails `json:"api"`       // The API details.
 	Timestamp  string     `json:"timestamp"` // The timestamp from when the data was processed.
+	Link       string     `json:"link"`      // The link to the source of the data.


Suggested change

Link string `json:"link"` // The link to the source of the data.

TibiaURL []string `json:"tibia_url"` // The links to the sources of the data on tibia.com.

tobiasehlert · 2024-10-15T18:44:17Z

src/webserver.go

@@ -121,6 +122,7 @@ func runWebServer() {
 		data := Information{
 			APIDetails: TibiaDataAPIDetails,
 			Timestamp:  TibiaDataDatetime(""),
+			Link:       "-",


Suggested change

Link: "-",

TibiaURL: []string{},

tobiasehlert · 2024-10-15T18:44:50Z

src/webserver.go

@@ -1089,6 +1091,7 @@ func TibiaDataErrorHandler(c *gin.Context, err error, httpCode int) {
 	info := Information{
 		APIDetails: TibiaDataAPIDetails,
 		Timestamp:  TibiaDataDatetime(""),
+		Link:       "-",


Suggested change

Link: "-",

TibiaURL: []string{},

Kai-Animator · 2024-10-15T22:05:19Z

Thanks for the review @tobiasehlert . I will work on it 👍

…rgument)

…args)

Kai-Animator · 2024-10-16T10:53:35Z

Hi @tobiasehlert 👋

I’ve implemented the changes you requested:

The "Link" field is now populated using the value from tibiadataRequest.URL before it's sent to tibiaDataRequestHandler, rather than hardcoding the URL. (Newslist and HousesOverview might need refactor)
Renamed "Link" to "TibiaURL".
I've also updated the field to support a []string for multi-upstream sources in the future (HousesOverview is using multiple URLs now).

Please let me know if there’s anything else :]

phenpessoa · 2024-10-23T02:57:29Z

Since this is now slice, I think it should probably be named TibiaURLs, plural.

tobiasehlert · 2024-10-24T22:12:03Z

Yeah good input @phenpessoa. 👍

phenpessoa · 2024-10-25T21:06:44Z

The field name was updated but the json is still called tibia_url. I think it should probably be tibia_urls.

Kai-Animator · 2024-10-26T14:30:00Z

The field name was updated but the json is still called tibia_url. I think it should probably be tibia_urls.

Hey @phenpessoa, thanks for looking at the code, is this the change that you mentioned?

phenpessoa · 2024-10-27T02:02:24Z

Yup! Looks good.

tobiasehlert

We are getting closer! 🚀
The news endpoints just need some adjustment, but then we should be really to rock.

src/TibiaNews.go

src/TibiaNews_test.go

src/TibiaNewslist.go

src/TibiaNewslist_test.go

… to TibiaURL)

sonarcloud · 2024-10-28T12:18:40Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

Kai-Animator · 2024-10-28T12:21:26Z

Thanks for the feedback @tobiasehlert, sorry search and replace all because I though you weren't using TibiaURL in other files. 🙇 Hope this revisions are satisfying.

Kai-Animator added 18 commits October 15, 2024 13:04

Added Link to Information struct / Modified both Characters and Guild…

e8c1f51

…s / Add test for information on characters test

Tibia Guild Test Case with Link on information

a3054fc

Added link to guilds/:world endpoint and tests for both guild/:guild …

e8314a0

…and guilds/:world endpoints

Adjust test for existing guild

0ee562b

Link added to fansites

53f757b

Added Link to Boostable bosses && Test

88b1524

Add Creature Link and Creature Test

c9cee1d

CreaturesOverall test and Link implementation

c61a43c

Highscores link implementation & test

22f7cb4

Fix Creature Links

6e25331

Fix link on creature single | swap name for race

b9d97e1

Highscores adjust

f777f18

Houses link implementation & Test

3cd9aed

Implement Killstatistics, TibiaNews, Spells and SpellsOverview With T…

b077803

…ests

Tibia Worlds link with tests

afc2064

Newslist and webserver Changes

01231fd

Tests for newslist

7476184

Swap Creature tests

9ce653c

tobiasehlert linked an issue Oct 15, 2024 that may be closed by this pull request

Feature: Add link Property for Character from tibia.com Website #381

Open

tobiasehlert self-requested a review October 15, 2024 18:11

tobiasehlert added enhancement New feature or request good first issue Good for newcomers go Pull requests that update Go code labels Oct 15, 2024

tobiasehlert requested changes Oct 15, 2024

View reviewed changes

Kai-Animator added 5 commits October 16, 2024 16:20

Replace Link to TibiaURL

b2e9660

TibiaBossesOverview URL test/func and webserver Updates

2e3edf9

TibiaCharactersCharacter test and func rewrite passing URL as argument

9655c0c

TibiaCreatures & CreaturesOverview func/test/server changes (url as a…

3bb6e81

…rgument)

TibiaFansites func/test/webserver updates (passing url argument)

f4d71a7

Kai-Animator added 8 commits October 16, 2024 17:37

Guilds & GuildsOverview func/test/server update (url as args)

1462f43

HousesHouse & Highscores func/webserver/test updates (passing url as …

dca7f4e

…args)

HousesOverview update (urls)

dfcfdfe

Update tests to read from slices instead of string

d26b74e

Killstatistics update (url as param)

d091fdf

news and Newslist func/test/webserver updates (pass url as args)

b249e30

Spells and SpellsOverview func/webserver/test update (pass url as args)

3c83ca8

Worlds & WorldsOverview func/test/webserver updates (pass url as args)

3160c00

Kai-Animator requested a review from tobiasehlert October 16, 2024 10:57

replace TibiaURL to TibiaURLs

22ebb8d

Fixed json:tibia_url reference to json:tibia_urls instead

7a1197d

tobiasehlert reviewed Oct 28, 2024

View reviewed changes

Revert changes made accidentally in TibiaNews and Newslist (TibiaURLs…

2545427

… to TibiaURL)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 'Link' Field to Information in API Responses (Fixes #381) #398

Add 'Link' Field to Information in API Responses (Fixes #381) #398

Kai-Animator commented Oct 15, 2024

tobiasehlert left a comment

tobiasehlert Oct 15, 2024

tobiasehlert Oct 15, 2024

tobiasehlert Oct 15, 2024

Kai-Animator commented Oct 15, 2024

Kai-Animator commented Oct 16, 2024

phenpessoa commented Oct 23, 2024

tobiasehlert commented Oct 24, 2024

phenpessoa commented Oct 25, 2024

Kai-Animator commented Oct 26, 2024

phenpessoa commented Oct 27, 2024

tobiasehlert left a comment

sonarcloud bot commented Oct 28, 2024

Kai-Animator commented Oct 28, 2024

	func tibiaFansites(c *gin.Context) {
	tibiadataRequest := TibiaDataRequestStruct{
	Method: resty.MethodGet,
	URL: "https://www.tibia.com/community/?subtopic=fansites",
	}

	tibiaDataRequestHandler(
	c,
	tibiadataRequest,
	func(BoxContentHTML string) (interface{}, error) {
	return TibiaFansitesImpl(BoxContentHTML)
	},
	"TibiaFansites")
	}

	Link string `json:"link"` // The link to the source of the data.
	TibiaURL []string `json:"tibia_url"` // The links to the sources of the data on tibia.com.

Add 'Link' Field to Information in API Responses (Fixes #381) #398

Are you sure you want to change the base?

Add 'Link' Field to Information in API Responses (Fixes #381) #398

Conversation

Kai-Animator commented Oct 15, 2024

tobiasehlert left a comment

Choose a reason for hiding this comment

tobiasehlert Oct 15, 2024

Choose a reason for hiding this comment

tobiasehlert Oct 15, 2024

Choose a reason for hiding this comment

tobiasehlert Oct 15, 2024

Choose a reason for hiding this comment

Kai-Animator commented Oct 15, 2024

Kai-Animator commented Oct 16, 2024

phenpessoa commented Oct 23, 2024

tobiasehlert commented Oct 24, 2024

phenpessoa commented Oct 25, 2024

Kai-Animator commented Oct 26, 2024

phenpessoa commented Oct 27, 2024

tobiasehlert left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Oct 28, 2024

Quality Gate passed

Kai-Animator commented Oct 28, 2024