track.getInfo. Also fixes #2 (track.getShouts failing for single shout, added properties to PageResponse to help)

This commit is contained in:
Rikki Tooley 2013-07-23 15:42:10 +01:00
parent 6cc8e916e6
commit 3565a10387
7 changed files with 140 additions and 25 deletions

View File

@ -0,0 +1,69 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using IF.Lastfm.Core.Api.Enums;
using IF.Lastfm.Core.Api.Helpers;
using IF.Lastfm.Core.Objects;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
namespace IF.Lastfm.Core.Api.Commands.TrackApi
{
internal class GetTrackInfoCommand : GetAsyncCommandBase<LastResponse<Track>>
{
public string TrackName { get; set; }
public string ArtistName { get; set; }
public string Username { get; set; }
public bool Autocorrect { get; set; }
public GetTrackInfoCommand(IAuth auth, string trackname, string artistname)
: base(auth)
{
Method = "track.getInfo";
TrackName = trackname;
ArtistName = artistname;
}
public async override Task<LastResponse<Track>> ExecuteAsync()
{
var parameters = new Dictionary<string, string>
{
{"track", TrackName},
{"artist", ArtistName},
{"autocorrect", Convert.ToInt32(Autocorrect).ToString()}
};
if (!string.IsNullOrWhiteSpace(Username))
{
parameters.Add("username", Username);
}
var apiUrl = LastFm.FormatApiUrl(Method, Auth.ApiKey, parameters);
Url = new Uri(apiUrl, UriKind.Absolute);
return await ExecuteInternal();
}
public async override Task<LastResponse<Track>> HandleResponse(HttpResponseMessage response)
{
string json = await response.Content.ReadAsStringAsync();
LastFmApiError error;
if (LastFm.IsResponseValid(json, out error) && response.IsSuccessStatusCode)
{
var jtoken = JsonConvert.DeserializeObject<JToken>(json);
var track = Track.ParseJToken(jtoken.SelectToken("track"));
return LastResponse<Track>.CreateSuccessResponse(track);
}
else
{
return LastResponse<Track>.CreateErrorResponse(error);
}
}
}
}

View File

@ -12,13 +12,13 @@
namespace IF.Lastfm.Core.Api.Commands.TrackApi namespace IF.Lastfm.Core.Api.Commands.TrackApi
{ {
internal class GetShoutsCommand : GetAsyncCommandBase<PageResponse<Shout>> internal class GetTrackShoutsCommand : GetAsyncCommandBase<PageResponse<Shout>>
{ {
public string TrackName { get; set; } public string TrackName { get; set; }
public string ArtistName { get; set; } public string ArtistName { get; set; }
public bool Autocorrect { get; set; } public bool Autocorrect { get; set; }
public GetShoutsCommand(IAuth auth, string trackname, string artistname) : base(auth) public GetTrackShoutsCommand(IAuth auth, string trackname, string artistname) : base(auth)
{ {
Method = "track.getShouts"; Method = "track.getShouts";
TrackName = trackname; TrackName = trackname;
@ -50,19 +50,26 @@ public async override Task<PageResponse<Shout>> HandleResponse(HttpResponseMessa
if (LastFm.IsResponseValid(json, out error) && response.IsSuccessStatusCode) if (LastFm.IsResponseValid(json, out error) && response.IsSuccessStatusCode)
{ {
JToken jtoken = JsonConvert.DeserializeObject<JToken>(json).SelectToken("shouts"); JToken jtoken = JsonConvert.DeserializeObject<JToken>(json).SelectToken("shouts");
var shoutsToken = jtoken.SelectToken("shout"); var shoutsToken = jtoken.SelectToken("shout");
var pageresponse = PageResponse<Shout>.CreateSuccessResponse();
pageresponse.AddPageInfoFromJToken(jtoken.SelectToken("@attr"));
var shouts = new List<Shout>(); var shouts = new List<Shout>();
if (shoutsToken != null) if (shoutsToken != null && pageresponse.TotalItems > 0)
{ {
shouts.AddRange(shoutsToken.Children().Select(Shout.ParseJToken)); if (pageresponse.TotalItems == 1)
{
// array notation isn't used on the api if there is only one shout.
shouts.Add(Shout.ParseJToken(shoutsToken));
}
else
{
shouts.AddRange(shoutsToken.Children().Select(Shout.ParseJToken));
}
} }
var pageresponse = PageResponse<Shout>.CreateSuccessResponse(shouts); pageresponse.Content = shouts;
var attrToken = jtoken.SelectToken("@attr");
pageresponse.AddPageInfoFromJToken(attrToken);
return pageresponse; return pageresponse;
} }

View File

@ -8,8 +8,11 @@ namespace IF.Lastfm.Core.Api.Helpers
{ {
public class PageResponse<T> : IEnumerable<T> public class PageResponse<T> : IEnumerable<T>
{ {
private int _page = 1; public PageResponse()
private int _totalPages = 1; {
Page = 1;
TotalPages = 1;
}
#region Properties #region Properties
@ -17,17 +20,9 @@ public class PageResponse<T> : IEnumerable<T>
public bool Success { get; set; } public bool Success { get; set; }
public LastFmApiError Error { get; set; } public LastFmApiError Error { get; set; }
public int Page public int Page { get; set; }
{ public int TotalPages { get; set; }
get { return _page; } public int TotalItems { get; set; }
set { _page = value; }
}
public int TotalPages
{
get { return _totalPages; }
set { _totalPages = value; }
}
#endregion #endregion
@ -61,6 +56,21 @@ IEnumerator IEnumerable.GetEnumerator()
#region Factory methods #region Factory methods
/// <summary>
/// Sometimes we need this object before we can set the content. Make sure to set the content!
/// </summary>
/// <returns></returns>
public static PageResponse<T> CreateSuccessResponse()
{
var r = new PageResponse<T>
{
Success = true,
Error = LastFmApiError.None
};
return r;
}
public static PageResponse<T> CreateSuccessResponse(IEnumerable<T> content) public static PageResponse<T> CreateSuccessResponse(IEnumerable<T> content)
{ {
var r = new PageResponse<T> var r = new PageResponse<T>
@ -99,6 +109,9 @@ public void AddPageInfoFromJToken(JToken attrToken)
var totalPages = attrToken.Value<string>("totalPages"); var totalPages = attrToken.Value<string>("totalPages");
TotalPages = !string.IsNullOrWhiteSpace(totalPages) ? Convert.ToInt32(totalPages) : 1; TotalPages = !string.IsNullOrWhiteSpace(totalPages) ? Convert.ToInt32(totalPages) : 1;
var totalItems = attrToken.Value<string>("total");
TotalItems = !string.IsNullOrWhiteSpace(totalItems) ? Convert.ToInt32(totalItems) : 1;
} }
// {"@attr": { // {"@attr": {

View File

@ -19,5 +19,8 @@ Task<PageResponse<Shout>> GetShoutsForTrackAsync(string trackname, string artist
Task<PageResponse<Shout>> GetShoutsForTrackWithMbidAsync(string mbid, Task<PageResponse<Shout>> GetShoutsForTrackWithMbidAsync(string mbid,
int page = 0, int page = 0,
int count = LastFm.DefaultPageLength); int count = LastFm.DefaultPageLength);
Task<LastResponse<Track>> GetInfoAsync(string trackname, string artistname, string username = "");
Task<LastResponse<Track>> GetInfoWithMbidAsynnc(string mbid, string username = "");
} }
} }

View File

@ -62,7 +62,7 @@ public Task<LastResponse> ScrobbleAsync(IEnumerable<Scrobble> scrobble)
public async Task<PageResponse<Shout>> GetShoutsForTrackAsync(string trackname, string artistname, int page = 0, int count = LastFm.DefaultPageLength) public async Task<PageResponse<Shout>> GetShoutsForTrackAsync(string trackname, string artistname, int page = 0, int count = LastFm.DefaultPageLength)
{ {
var command = new GetShoutsCommand(Auth, trackname, artistname) var command = new GetTrackShoutsCommand(Auth, trackname, artistname)
{ {
Page = page, Page = page,
Count = count, Count = count,
@ -74,5 +74,20 @@ public Task<PageResponse<Shout>> GetShoutsForTrackWithMbidAsync(string mbid, int
{ {
throw new NotImplementedException(); throw new NotImplementedException();
} }
public async Task<LastResponse<Track>> GetInfoAsync(string trackname, string artistname, string username = "")
{
var command = new GetTrackInfoCommand(Auth, trackname, artistname)
{
Username = username
};
return await command.ExecuteAsync();
}
public Task<LastResponse<Track>> GetInfoWithMbidAsynnc(string mbid, string username = "")
{
throw new NotImplementedException();
}
} }
} }

View File

@ -44,7 +44,8 @@
<Compile Include="Api\Commands\AlbumApi\GetAbumInfoCommand.cs" /> <Compile Include="Api\Commands\AlbumApi\GetAbumInfoCommand.cs" />
<Compile Include="Api\Commands\ArtistApi\GetArtistInfoCommand.cs" /> <Compile Include="Api\Commands\ArtistApi\GetArtistInfoCommand.cs" />
<Compile Include="Api\Commands\GetAsyncCommandBase.cs" /> <Compile Include="Api\Commands\GetAsyncCommandBase.cs" />
<Compile Include="Api\Commands\TrackApi\GetShoutsCommand.cs" /> <Compile Include="Api\Commands\TrackApi\GetTrackInfoCommand.cs" />
<Compile Include="Api\Commands\TrackApi\GetTrackShoutsCommand.cs" />
<Compile Include="Api\Commands\UserApi\GetRecentScrobblesCommand.cs" /> <Compile Include="Api\Commands\UserApi\GetRecentScrobblesCommand.cs" />
<Compile Include="Api\Commands\UserApi\GetTopAlbumsCommand.cs" /> <Compile Include="Api\Commands\UserApi\GetTopAlbumsCommand.cs" />
<Compile Include="Api\Helpers\ApiExtensions.cs" /> <Compile Include="Api\Helpers\ApiExtensions.cs" />

View File

@ -28,6 +28,7 @@ public class Track : ILastFmObject
public IEnumerable<Tag> TopTags { get; set; } public IEnumerable<Tag> TopTags { get; set; }
public DateTime? TimePlayed { get; set; } public DateTime? TimePlayed { get; set; }
public bool? IsLoved { get; set; }
#endregion #endregion
@ -78,6 +79,12 @@ internal static Track ParseJToken(JToken token)
t.Images = imageCollection; t.Images = imageCollection;
} }
var lovedToken = token.SelectToken("userloved");
if (lovedToken != null)
{
t.IsLoved = Convert.ToBoolean(lovedToken.Value<int>());
}
// api returns milliseconds when track.getInfo is called directly // api returns milliseconds when track.getInfo is called directly
var secs = token.Value<double>("duration"); var secs = token.Value<double>("duration");
if (Math.Abs(secs - default(double)) > double.Epsilon) if (Math.Abs(secs - default(double)) > double.Epsilon)