Merged headers branch

Author: JohnnyCrazy

SpotifyAPI.Example/WebControl.cs

@@ -4,7 +4,6 @@
 using SpotifyAPI.Web.Models;
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using System.Net;

SpotifyAPI.Tests/TestClass.cs

@@ -50,7 +50,7 @@ public void ShouldGetPrivateProfile_WithoutAuth()
         public void ShouldGetPrivateProfile_WithAuth()
         {
             PrivateProfile profile = GetFixture<PrivateProfile>("private-user.json");
-            _mock.Setup(client => client.DownloadJson<PrivateProfile>(It.IsAny<string>())).Returns(profile);
+            _mock.Setup(client => client.DownloadJson<PrivateProfile>(It.IsAny<string>())).Returns(new Tuple<ResponseInfo, PrivateProfile>(null, profile));
 
             _spotify.UseAuth = true;
             Assert.AreEqual(profile, _spotify.GetPrivateProfile());
@@ -61,7 +61,7 @@ public void ShouldGetPrivateProfile_WithAuth()
         public void ShouldGetPublicProfile()
         {
             PublicProfile profile = GetFixture<PublicProfile>("public-user.json");
-            _mock.Setup(client => client.DownloadJson<PublicProfile>(It.IsAny<string>())).Returns(profile);
+            _mock.Setup(client => client.DownloadJson<PublicProfile>(It.IsAny<string>())).Returns(new Tuple<ResponseInfo, PublicProfile>(null, profile));
 
             Assert.AreEqual(profile, _spotify.GetPublicProfile("wizzler"));
             _mock.Verify(client => client.DownloadJson<PublicProfile>(It.Is<string>(str => ContainsValues(str, "/users/wizzler"))), Times.Exactly(1));

SpotifyAPI/SpotifyAPI.csproj

@@ -92,6 +92,7 @@
     <Compile Include="Web\Models\Recommendations.cs" />
     <Compile Include="Web\Models\RecommendationSeed .cs" />
     <Compile Include="Web\Models\RecommendationSeedGenres.cs" />
+    <Compile Include="Web\Models\ResponseInfo.cs" />
     <Compile Include="Web\Models\SearchItem.cs" />
     <Compile Include="Web\Models\PrivateProfile.cs" />
     <Compile Include="Web\Models\GeneralModels.cs" />

SpotifyAPI/Web/IClient.cs

@@ -2,6 +2,7 @@
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
+using SpotifyAPI.Web.Models;
 
 namespace SpotifyAPI.Web
 {
@@ -14,44 +15,44 @@ public interface IClient : IDisposable
         /// </summary>
         /// <param name="url">An URL</param>
         /// <returns></returns>
-        string Download(string url);
+        Tuple<ResponseInfo, string> Download(string url);
 
         /// <summary>
         ///     Downloads data async from an URL and returns it
         /// </summary>
         /// <param name="url"></param>
         /// <returns></returns>
-        Task<string> DownloadAsync(string url);
+        Task<Tuple<ResponseInfo, string>> DownloadAsync(string url);
 
         /// <summary>
         ///     Downloads data from an URL and returns it
         /// </summary>
         /// <param name="url">An URL</param>
         /// <returns></returns>
-        byte[] DownloadRaw(string url);
+        Tuple<ResponseInfo, byte[]> DownloadRaw(string url);
 
         /// <summary>
         ///     Downloads data async from an URL and returns it
         /// </summary>
         /// <param name="url"></param>
         /// <returns></returns>
-        Task<byte[]> DownloadRawAsync(string url);
+        Task<Tuple<ResponseInfo, byte[]>> DownloadRawAsync(string url);
 
         /// <summary>
         ///     Downloads data from an URL and converts it to an object
         /// </summary>
         /// <typeparam name="T">The Type which the object gets converted to</typeparam>
         /// <param name="url">An URL</param>
         /// <returns></returns>
-        T DownloadJson<T>(string url);
+        Tuple<ResponseInfo, T> DownloadJson<T>(string url);
 
         /// <summary>
         ///     Downloads data async from an URL and converts it to an object
         /// </summary>
         /// <typeparam name="T">The Type which the object gets converted to</typeparam>
         /// <param name="url">An URL</param>
         /// <returns></returns>
-        Task<T> DownloadJsonAsync<T>(string url);
+        Task<Tuple<ResponseInfo, T>> DownloadJsonAsync<T>(string url);
 
         /// <summary>
         ///     Uploads data from an URL and returns the response
@@ -60,7 +61,7 @@ public interface IClient : IDisposable
         /// <param name="body">The Body-Data (most likely a JSON String)</param>
         /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
         /// <returns></returns>
-        string Upload(string url, string body, string method);
+        Tuple<ResponseInfo, string> Upload(string url, string body, string method);
 
         /// <summary>
         ///     Uploads data async from an URL and returns the response
@@ -69,7 +70,7 @@ public interface IClient : IDisposable
         /// <param name="body">The Body-Data (most likely a JSON String)</param>
         /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
         /// <returns></returns>
-        Task<string> UploadAsync(string url, string body, string method);
+        Task<Tuple<ResponseInfo, string>> UploadAsync(string url, string body, string method);
 
         /// <summary>
         ///     Uploads data from an URL and returns the response
@@ -78,7 +79,7 @@ public interface IClient : IDisposable
         /// <param name="body">The Body-Data (most likely a JSON String)</param>
         /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
         /// <returns></returns>
-        byte[] UploadRaw(string url, string body, string method);
+        Tuple<ResponseInfo, byte[]> UploadRaw(string url, string body, string method);
 
         /// <summary>
         ///     Uploads data async from an URL and returns the response
@@ -87,7 +88,7 @@ public interface IClient : IDisposable
         /// <param name="body">The Body-Data (most likely a JSON String)</param>
         /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
         /// <returns></returns>
-        Task<byte[]> UploadRawAsync(string url, string body, string method);
+        Task<Tuple<ResponseInfo, byte[]>> UploadRawAsync(string url, string body, string method);
 
         /// <summary>
         ///     Uploads data from an URL and converts the response to an object
@@ -97,7 +98,7 @@ public interface IClient : IDisposable
         /// <param name="body">The Body-Data (most likely a JSON String)</param>
         /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
         /// <returns></returns>
-        T UploadJson<T>(string url, string body, string method);
+        Tuple<ResponseInfo, T> UploadJson<T>(string url, string body, string method);
 
         /// <summary>
         ///     Uploads data async from an URL and converts the response to an object
@@ -107,7 +108,7 @@ public interface IClient : IDisposable
         /// <param name="body">The Body-Data (most likely a JSON String)</param>
         /// <param name="method">The Upload-method (POST,DELETE,PUT)</param>
         /// <returns></returns>
-        Task<T> UploadJsonAsync<T>(string url, string body, string method);
+        Task<Tuple<ResponseInfo, T>> UploadJsonAsync<T>(string url, string body, string method);
 
         /// <summary>
         ///     Sets a specific Header

SpotifyAPI/Web/Models/BasicModel.cs

@@ -1,5 +1,6 @@
 using Newtonsoft.Json;
 using System;
+using System.Net;
 
 namespace SpotifyAPI.Web.Models
 {
@@ -8,9 +9,14 @@ public abstract class BasicModel
         [JsonProperty("error")]
         public Error Error { get; set; }
 
-        public Boolean HasError()
-        {
-            return Error != null;
-        }
+        private WebHeaderCollection _headers;
+
+        public bool HasError() => Error != null;
+
+        public void AddResponseInfo(ResponseInfo info) => _headers = info.Headers;
+
+        public string Header(string key) => _headers?.Get(key);
+
+        public WebHeaderCollection Headers() => _headers;
     }
 }

SpotifyAPI/Web/Models/ResponseInfo.cs

@@ -0,0 +1,9 @@
+using System.Net;
+
+namespace SpotifyAPI.Web.Models
+{
+    public class ResponseInfo
+    {
+        public WebHeaderCollection Headers { get; set; }
+    }
+}