chore(surfshark): add package internal/provider/surshark/server

- Merge `internal/models/location.go` and `internal/constants/surfshark.go` into `internal/provider/surfshark/servers/locationdata.go`

internal/configuration/settings/surfshark_retro.go

@@ -3,15 +3,14 @@ package settings
 import (
 	"strings"
 
-	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/provider/surfshark/servers"
-	"github.com/qdm12/gluetun/internal/models"
 )
 
 func surfsharkRetroRegion(selection ServerSelection) (
 	updatedSelection ServerSelection) {
-	locationData := constants.SurfsharkLocationData()
+	locationData := servers.LocationData()
 
-	retroToLocation := make(map[string]models.SurfsharkLocationData, len(locationData))
+	retroToLocation := make(map[string]servers.ServerLocation, len(locationData))
 	for _, data := range locationData {
 		if data.RetroLoc == "" {
 			continue

internal/configuration/settings/validation/surfshark.go

@@ -1,12 +1,12 @@
 package validation
 
 import (
-	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/provider/surfshark/servers"
 )
 
 // TODO remove in v4.
 func SurfsharkRetroLocChoices() (choices []string) {
-	locationData := constants.SurfsharkLocationData()
+	locationData := servers.LocationData()
 	choices = make([]string, 0, len(locationData))
 	seen := make(map[string]struct{}, len(locationData))
 	for _, data := range locationData {

internal/models/location.go

@@ -1,12 +0,0 @@
-package models
-
-// SurfsharkLocationData is required to keep location data on Surfshark
-// servers that are not obtained through their API.
-type SurfsharkLocationData struct {
-	Region   string
-	Country  string
-	City     string
-	RetroLoc string // TODO remove in v4
-	Hostname string
-	MultiHop bool
-}

internal/provider/surfshark/servers/locationdata.go

@@ -1,13 +1,20 @@
-package constants
+package servers
 
-import (
+// LocationData is required to keep location data on Surfshark
-	"github.com/qdm12/gluetun/internal/models"
+// servers that are not obtained through their API.
-)
+type ServerLocation struct {
+	Region   string
+	Country  string
+	City     string
+	RetroLoc string // TODO remove in v4
+	Hostname string
+	MultiHop bool
+}
 
 // TODO remove retroRegion and servers from API in v4.
-func SurfsharkLocationData() (data []models.SurfsharkLocationData) {
+func LocationData() (data []ServerLocation) {
 	//nolint:lll
-	return []models.SurfsharkLocationData{
+	return []ServerLocation{
 		{Region: "Asia Pacific", Country: "Australia", City: "Adelaide", RetroLoc: "Australia Adelaide", Hostname: "au-adl.prod.surfshark.com", MultiHop: false},
 		{Region: "Asia Pacific", Country: "Australia", City: "Brisbane", RetroLoc: "Australia Brisbane", Hostname: "au-bne.prod.surfshark.com", MultiHop: false},
 		{Region: "Asia Pacific", Country: "Australia", City: "Melbourne", RetroLoc: "Australia Melbourne", Hostname: "au-mel.prod.surfshark.com", MultiHop: false},

internal/updater/providers/surfshark/api.go

@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"net/http"
 
-	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/provider/surfshark/servers"
 )
 
 // Note: no multi-hop and some servers are missing from their API.
@@ -18,7 +18,7 @@ func addServersFromAPI(ctx context.Context, client *http.Client,
 		return err
 	}
 
-	locationData := constants.SurfsharkLocationData()
+	locationData := servers.LocationData()
 	hostToLocation := hostToLocation(locationData)
 
 	const tcp, udp = true, true

internal/updater/providers/surfshark/location.go

@@ -4,15 +4,15 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/qdm12/gluetun/internal/models"
+	"github.com/qdm12/gluetun/internal/provider/surfshark/servers"
 )
 
 var (
 	errHostnameNotFound = errors.New("hostname not found in hostname to location mapping")
 )
 
-func getHostInformation(host string, hostnameToLocation map[string]models.SurfsharkLocationData) (
+func getHostInformation(host string, hostnameToLocation map[string]servers.ServerLocation) (
-	data models.SurfsharkLocationData, err error) {
+	data servers.ServerLocation, err error) {
 	locationData, ok := hostnameToLocation[host]
 	if !ok {
 		return locationData, fmt.Errorf("%w: %s", errHostnameNotFound, host)
@@ -21,9 +21,9 @@ func getHostInformation(host string, hostnameToLocation map[string]models.Surfsh
 	return locationData, nil
 }
 
-func hostToLocation(locationData []models.SurfsharkLocationData) (
+func hostToLocation(locationData []servers.ServerLocation) (
-	hostToLocation map[string]models.SurfsharkLocationData) {
+	hostToLocation map[string]servers.ServerLocation) {
-	hostToLocation = make(map[string]models.SurfsharkLocationData, len(locationData))
+	hostToLocation = make(map[string]servers.ServerLocation, len(locationData))
 	for _, data := range locationData {
 		hostToLocation[data.Hostname] = data
 	}

internal/updater/providers/surfshark/remaining.go

@@ -1,12 +1,12 @@
 package surfshark
 
 import (
-	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/provider/surfshark/servers"
 )
 
 // getRemainingServers finds extra servers not found in the API or in the ZIP file.
 func getRemainingServers(hts hostToServer) {
-	locationData := constants.SurfsharkLocationData()
+	locationData := servers.LocationData()
 	hostnameToLocationLeft := hostToLocation(locationData)
 	for _, hostnameDone := range hts.toHostsSlice() {
 		delete(hostnameToLocationLeft, hostnameDone)

internal/updater/providers/surfshark/zip.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"strings"
 
-	"github.com/qdm12/gluetun/internal/constants"
+	"github.com/qdm12/gluetun/internal/provider/surfshark/servers"
 	"github.com/qdm12/gluetun/internal/updater/openvpn"
 	"github.com/qdm12/gluetun/internal/updater/unzip"
 )
@@ -24,7 +24,7 @@ func addOpenVPNServersFromZip(ctx context.Context,
 		hostnamesDoneSet[hostname] = struct{}{}
 	}
 
-	locationData := constants.SurfsharkLocationData()
+	locationData := servers.LocationData()
 	hostToLocation := hostToLocation(locationData)
 
 	for fileName, content := range contents {