Pet Implementation Part 2

Completed implementation of battle pet api calls.

Author: mjdean94

Diff for: Explorers.Test/Explorers.Test.csproj

@@ -54,6 +54,7 @@
     <Compile Include="DataTests.cs" />
     <Compile Include="ItemTests.cs" />
     <Compile Include="GuildTests.cs" />
+    <Compile Include="PetTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="RealmTests.cs" />
     <Compile Include="TestStrings.Designer.cs">

Diff for: Explorers.Test/PetTests.cs

@@ -19,6 +19,36 @@ public static void ClassInit(TestContext context)
         [TestMethod]
         public void Get_Pet_List()
         {
+            var pets = explorer.GetPets();
+            Assert.IsTrue(pets.Any());
+        }
+
+        [TestMethod]
+        public void Get_Pet_Ability_Details()
+        {
+            var ability = explorer.GetPetAbilityDetails(640);
+            Assert.IsNotNull(ability);
+        }
+
+        [TestMethod]
+        public void Get_Pet_Species()
+        {
+            var species = explorer.GetPetSpeciesDetails(258);
+            Assert.IsNotNull(species);
+        }
+
+        [TestMethod]
+        public void Get_Pet_Stats()
+        {
+            var stats = explorer.GetPetStats(258, 25, 5, 4);
+            Assert.IsNotNull(stats);
+        }
+
+        [TestMethod]
+        public void Get_Pet_Types()
+        {
+            var types = explorer.GetPetTypes();
+            Assert.IsTrue(types.Any());
         }
     }
 }

Diff for: Explorers/Explorers.csproj

@@ -75,7 +75,6 @@
     <Compile Include="Models\CharacterFeed.cs" />
     <Compile Include="Models\CharacterPets.cs" />
     <Compile Include="Models\CharacterPetSlot.cs" />
-    <Compile Include="Models\CharacterPetStats.cs" />
     <Compile Include="Models\CharacterRatedBattleground.cs" />
     <Compile Include="Models\CharacterRatedBattlegrounds.cs" />
     <Compile Include="Models\CharacterPVP.cs" />
@@ -91,7 +90,6 @@
     <Compile Include="Models\Auctions.cs" />
     <Compile Include="Models\CharacterClassInfo.cs" />
     <Compile Include="Models\CharacterClassesData.cs" />
-    <Compile Include="Models\CharacterPet.cs" />
     <Compile Include="Models\CharacterRaceInfo.cs" />
     <Compile Include="Models\CharacterRacesData.cs" />
     <Compile Include="Models\GuildPerkInfo.cs" />
@@ -116,6 +114,14 @@
     <Compile Include="Models\ItemUpgrade.cs" />
     <Compile Include="Models\ItemWeaponDamage.cs" />
     <Compile Include="Models\ItemWeaponInfo.cs" />
+    <Compile Include="Models\Pet.cs" />
+    <Compile Include="Models\PetAbility.cs" />
+    <Compile Include="Models\PetAbilityDetails.cs" />
+    <Compile Include="Models\PetList.cs" />
+    <Compile Include="Models\PetSpecies.cs" />
+    <Compile Include="Models\PetStats.cs" />
+    <Compile Include="Models\PetType.cs" />
+    <Compile Include="Models\PetTypeData.cs" />
     <Compile Include="Models\PvpStats.cs" />
     <Compile Include="Models\Leaderboard.cs" />
     <Compile Include="Utilities\JsonUtility.cs" />

Diff for: Explorers/Models/PetAbilityDetails.cs

@@ -13,7 +13,7 @@ public class PetAbilityDetails
         public int AbilityId { get; set; }
 
         [DataMember(Name = "name")]
-        public int Name { get; set; }
+        public string Name { get; set; }
 
         [DataMember(Name = "icon")]
         public string Icon { get; set; }

Diff for: Explorers/Models/PetType.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.Serialization;
+using System.Text;
+
+namespace WowDotNetAPI.Models
+{
+    [DataContract]
+    public class PetType
+    {
+        [DataMember(Name = "id")]
+        public int PetTypeId { get; set; }
+
+        [DataMember(Name = "key")]
+        public string Key { get; set; }
+
+        [DataMember(Name = "name")]
+        public string Name { get; set; }
+
+        [DataMember(Name = "typeAbilityId")]
+        public int TypeAbilityId { get; set; }
+
+        [DataMember(Name = "strongAgainstId")]
+        public int StrongAgainstId { get; set; }
+
+        [DataMember(Name = "weakAgainstId")]
+        public int WeakAgainstId { get; set; }
+    }
+}

Diff for: Explorers/Models/PetTypeData.cs

@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.Serialization;
+using System.Text;
+
+namespace WowDotNetAPI.Models
+{
+    [DataContract]
+    public class PetTypeData
+    {
+        [DataMember(Name = "petTypes")]
+        public IEnumerable<PetType> PetTypes { get; set; } 
+    }
+}

Diff for: Explorers/WowExplorer.cs

@@ -182,14 +182,14 @@ public Guild GetGuild(Region region, string realm, string name, GuildOptions rea
         /// Gets a list of all battle pets
         /// </summary>
         /// <returns>PetList object containing an IEnumerable of Pet objects</returns>
-        public PetList GetPets()
+        public IEnumerable<Pet> GetPets()
         {
             PetList pets;
 
             TryGetData<PetList>(string.Format(@"{0}/wow/pet/?locale={1}&apikey={2}", Host, Locale, APIKey),
                 out pets);
 
-            return pets;
+            return pets.Pets;
         }
 
         /// <summary>
@@ -222,6 +222,38 @@ public PetSpecies GetPetSpeciesDetails(int id)
             return species;
         }
 
+        /// <summary>
+        /// Retrieve detailed information about a given species of pet.
+        /// </summary>
+        /// <param name="speciesId">The pet's species ID. This can be found by querying a users' list of pets via the Character Profile API.</param>
+        /// <param name="level">The pet's level. Pet levels max out at 25. If omitted the API assumes a default value of 1.</param>
+        /// <param name="breedId">The pet's breed. Retrievable via the Character Profile API. If omitted the API assumes a default value of 3.</param>
+        /// <param name="qualityId">The pet's quality. Retrievable via the Character Profile API. Pet quality can range from 0 to 5 (0 is poor quality and 5 is legendary). If omitted the API will assume a default value of 1.</param>
+        /// <returns></returns>
+        public PetStats GetPetStats(int speciesId, int level, int breedId, int qualityId)
+        {
+            PetStats stats;
+
+            TryGetData<PetStats>(string.Format(@"{0}/wow/pet/stats/{1}?level={2}&breedId={3}&qualityId={4}&locale={5}&apikey={6}", Host, speciesId, level, breedId, qualityId, Locale, APIKey),
+                out stats);
+
+            return stats;
+        }
+
+        /// <summary>
+        /// The different bat pet types (including what they are strong and weak against)
+        /// </summary>
+        /// <returns></returns>
+        public IEnumerable<PetType> GetPetTypes()
+        {
+            PetTypeData types;
+
+            TryGetData<PetTypeData>(string.Format(@"{0}/wow/data/pet/types?locale={1}&apikey={2}", Host, Locale, APIKey),
+                out types);
+
+            return types.PetTypes.Any() ? types.PetTypes : null;
+        } 
+
         #endregion
 
         #region Realms