improved achievement indexing

Author: aaantiii

achievements.go

@@ -12,51 +12,59 @@ type Achievement struct {
 	Village        string `json:"village"`
 }
 
-const (
-	AchievementIndexBiggerCoffers = iota
-	AchievementIndexGetThoseGoblins
-	AchievementIndexBiggerAndBetter
-	AchievementIndexNiceAndTidy
-	AchievementIndexDiscoverNewTroops
-	AchievementIndexGoldGrab
-	AchievementIndexElixirEscapade
-	AchievementIndexSweetVictory
-	AchievementIndexEmpireBuilder
-	AchievementIndexWallBuster
-	AchievementIndexHumiliator
-	AchievementIndexUnionBuster
-	AchievementIndexConqueror
-	AchievementIndexUnbreakable
-	AchievementIndexFriendInNeed
-	AchievementIndexMortarMauler
-	AchievementIndexHeroicHeist
-	AchievementIndexLeagueAllStar
-	AchievementIndexXbowExterminator
-	AchievementIndexFirefighter
-	AchievementIndexWarHero
-	AchievementIndexClanWarWealth
-	AchievementIndexAntiArtillery
-	AchievementIndexSharingIsCaring
-	AchievementIndexKeepYourAccountSafeOld
-	AchievementIndexMasterEngineering
-	AchievementIndexNextGenerationModel
-	AchievementIndexUnBuildIt
-	AchievementIndexChampionBuilder
-	AchievementIndexHighGear
-	AchievementIndexHiddenTreasures
-	AchievementIndexGamesChampion
-	AchievementIndexDragonSlayer
-	AchievementIndexWarLeagueLegend
-	AchievementIndexKeepYourAccountSafe
-	AchievementIndexWellSeasoned
-	AchievementIndexShatteredAndScattered
-	AchievementIndexNotSoEasyThisTime
-	AchievementIndexBustThis
-	AchievementIndexSuperbWork
-	AchievementIndexSiegeSharer
-	AchievementIndexAggressiveCapitalism
-	AchievementIndexMostValuableClanmate
-	AchievementIndexCounterspell
-	AchievementIndexMonolithMasher
-	AchievementIndexUngratefulChild
+// IndexedAchievement embeds Achievement and adds the index of the achievement in the Player.Achievements slice to it.
+type IndexedAchievement struct {
+	*Achievement
+	Index int
+}
+
+var (
+	AchievementBiggerCoffers           = &Achievement{Name: "Bigger Coffers"}
+	AchievementGetThoseGoblins         = &Achievement{Name: "Get those Goblins!"}
+	AchievementBiggerAndBetter         = &Achievement{Name: "Bigger & Better"}
+	AchievementNiceAndTidy             = &Achievement{Name: "Nice and Tidy"}
+	AchievementDiscoverNewTroops       = &Achievement{Name: "Discover New Troops"}
+	AchievementGoldGrab                = &Achievement{Name: "Gold Grab"}
+	AchievementElixirEscapade          = &Achievement{Name: "Elixir Escapade"}
+	AchievementSweetVictory            = &Achievement{Name: "Sweet Victory!"}
+	AchievementEmpireBuilder           = &Achievement{Name: "Empire Builder"}
+	AchievementWallBuster              = &Achievement{Name: "Wall Buster"}
+	AchievementHumiliator              = &Achievement{Name: "Humiliator"}
+	AchievementUnionBuster             = &Achievement{Name: "Union Buster"}
+	AchievementConqueror               = &Achievement{Name: "Conqueror"}
+	AchievementUnbreakable             = &Achievement{Name: "Unbreakable"}
+	AchievementFriendInNeed            = &Achievement{Name: "Friend in Need"}
+	AchievementMortarMauler            = &Achievement{Name: "Mortar Mauler"}
+	AchievementHeroicHeist             = &Achievement{Name: "Heroic Heist"}
+	AchievementLeagueAllStar           = &Achievement{Name: "League All-Star"}
+	AchievementXBowExterminator        = &Achievement{Name: "X-Bow Exterminator"}
+	AchievementFirefighter             = &Achievement{Name: "Firefighter"}
+	AchievementWarHero                 = &Achievement{Name: "War Hero"}
+	AchievementClanWarWealth           = &Achievement{Name: "Clan War Wealth"}
+	AchievementAntiArtillery           = &Achievement{Name: "Anti-Artillery"}
+	AchievementSharingIsCaring         = &Achievement{Name: "Sharing is caring"}
+	AchievementKeepYourAccountSafeOld  = &Achievement{Name: "Keep Your Account Safe!", Info: "Protect your village by connecting to a social network"}
+	AchievementMasterEngineering       = &Achievement{Name: "Master Engineering"}
+	AchievementNextGenerationModel     = &Achievement{Name: "Next Generation Model"}
+	AchievementUnBuildIt               = &Achievement{Name: "Un-Build It"}
+	AchievementChampionBuilder         = &Achievement{Name: "Champion Builder"}
+	AchievementHighGear                = &Achievement{Name: "High Gear"}
+	AchievementHiddenTreasures         = &Achievement{Name: "Hidden Treasures"}
+	AchievementGamesChampion           = &Achievement{Name: "Games Champion"}
+	AchievementDragonSlayer            = &Achievement{Name: "Dragon Slayer"}
+	AchievementWarLeagueLegend         = &Achievement{Name: "War League Legend"}
+	AchievementKeepYourAccountSafeSCID = &Achievement{Name: "Keep Your Account Safe!", Info: "Connect your account to Supercell ID for safe keeping."}
+	AchievementWellSeasoned            = &Achievement{Name: "Well Seasoned"}
+	AchievementShatteredAndScattered   = &Achievement{Name: "Shattered and Scattered"}
+	AchievementNotSoEasyThisTime       = &Achievement{Name: "Not So Easy This Time"}
+	AchievementBustThis                = &Achievement{Name: "Bust This"}
+	AchievementSuperbWork              = &Achievement{Name: "Superb Work"}
+	AchievementSiegeSharer             = &Achievement{Name: "Siege Sharer"}
+	AchievementCounterspell            = &Achievement{Name: "Counterspell"}
+	AchievementMonolithMasher          = &Achievement{Name: "Monolith Masher"}
+	AchievementGetThoseOtherGoblins    = &Achievement{Name: "Get those other Goblins!"}
+	AchievementGetEvenMoreGoblins      = &Achievement{Name: "Get even more Goblins!"}
+	AchievementUngratefulChild         = &Achievement{Name: "Ungrateful Child"}
+	AchievementAggressiveCapitalism    = &Achievement{Name: "Aggressive Capitalism"}
+	AchievementMostValuableClanmate    = &Achievement{Name: "Most Valuable Clanmate"}
 )

players.go

@@ -1,6 +1,7 @@
 package goclash
 
 import (
+	"errors"
 	"fmt"
 	"net/http"
 	"sync"
@@ -51,6 +52,19 @@ func (p *Player) InGameURL() string {
 	return "https://link.clashofclans.com?action=OpenPlayerProfile&tag=" + TagURLSafe(p.Tag)
 }
 
+// GetAchievement returns an IndexedAchievement by Achievement.Name and Achievement.Info. The index can be used to get the same achievement from other players, to make it more efficient.
+func (p *Player) GetAchievement(achievement *Achievement) (*IndexedAchievement, error) {
+	for i, a := range p.Achievements {
+		if a.Name == achievement.Name && a.Info == achievement.Info {
+			return &IndexedAchievement{
+				Achievement: &a,
+				Index:       i,
+			}, nil
+		}
+	}
+	return nil, errors.New("achievement not found")
+}
+
 type Players []*Player
 
 func (p Players) Tags() []string {
@@ -61,6 +75,23 @@ func (p Players) Tags() []string {
 	return tags
 }
 
+func (p Players) GetAchievement(achievement *Achievement) ([]*Achievement, error) {
+	if len(p) == 0 {
+		return nil, errors.New("no players were provided")
+	}
+
+	indexed, err := p[0].GetAchievement(achievement)
+	if err != nil {
+		return nil, err
+	}
+
+	achievements := make([]*Achievement, len(p))
+	for i, player := range p {
+		achievements[i] = &player.Achievements[indexed.Index]
+	}
+	return achievements, nil
+}
+
 type PlayerClan struct {
 	Tag       string    `json:"tag"`
 	Level     int       `json:"clanLevel"`