Add initial support for Twitter V2 Timelines

Author: josiasalexandre

src/Tweetinvi.Controllers/Timeline/TimelinesV2Controller.cs

@@ -0,0 +1,71 @@
+using System;
+using System.Threading.Tasks;
+using Tweetinvi.Core.Iterators;
+using Tweetinvi.Core.Controllers.V2;
+using Tweetinvi.Core.Web;
+using Tweetinvi.Models;
+using Tweetinvi.Models.V2;
+using Tweetinvi.Parameters.V2;
+
+namespace Tweetinvi.Controllers.Timeline
+{
+    public class TimelinesV2Controller : ITimelinesV2Controller
+    {
+        private readonly ITimelinesV2QueryExecutor _queryExecutor;
+
+        public TimelinesV2Controller(ITimelinesV2QueryExecutor queryExecutor)
+        {
+            _queryExecutor = queryExecutor;
+        }
+
+        private ITwitterPageIterator<ITwitterResult<TimelinesV2Response>, string> GetIterator(
+            Func<IGetTimelinesV2Parameters, ITwitterRequest, Task<ITwitterResult<TimelinesV2Response>>> Method,
+            IGetTimelinesV2Parameters parameters,
+            ITwitterRequest request)
+        {
+            Func<string, Task<ITwitterResult<TimelinesV2Response>>> getNext = nextToken =>
+            {
+                var cursoredParameters = new GetTimelinesV2Parameters(parameters)
+                {
+                    PaginationToken = nextToken
+                };
+
+                return Method(cursoredParameters, request);
+            };
+
+            var twitterCursorResult = new TwitterPageIterator<ITwitterResult<TimelinesV2Response>, string>(
+                parameters.PaginationToken,
+                getNext,
+                page =>
+                {
+                    if (page.Model.Tweets.Length == 0)
+                    {
+                        return null;
+                    }
+
+                    return page.Model.Meta.NextToken;
+                },
+                page =>
+                {
+                    if (page.Model.Tweets.Length == 0)
+                    {
+                        return true;
+                    }
+
+                    return page.Model.Meta.NextToken == null;
+                });
+
+            return twitterCursorResult;
+        }
+
+        public ITwitterPageIterator<ITwitterResult<TimelinesV2Response>, string> GetUserTweetsTimelineIterator(IGetTimelinesV2Parameters parameters, ITwitterRequest request)
+        {
+            return GetIterator(_queryExecutor.GetUserTweetsTimelineAsync, parameters, request);
+        }
+
+        public ITwitterPageIterator<ITwitterResult<TimelinesV2Response>, string> GetUserMentionedTimelineIterator(IGetTimelinesV2Parameters parameters, ITwitterRequest request)
+        {
+            return GetIterator(_queryExecutor.GetUserMentionedTimelineAsync, parameters, request);
+        }
+    }
+}

src/Tweetinvi.Controllers/Timeline/TimelinesV2QueryExecutor.cs

@@ -0,0 +1,44 @@
+using System.Threading.Tasks;
+using Tweetinvi.Core.QueryGenerators.V2;
+using Tweetinvi.Core.Web;
+using Tweetinvi.Models;
+using Tweetinvi.Models.V2;
+using Tweetinvi.Parameters.V2;
+
+namespace Tweetinvi.Controllers.Timeline
+{
+    public interface ITimelinesV2QueryExecutor
+    {
+        Task<ITwitterResult<TimelinesV2Response>> GetUserTweetsTimelineAsync(IGetTimelinesV2Parameters parameters, ITwitterRequest request);
+        Task<ITwitterResult<TimelinesV2Response>> GetUserMentionedTimelineAsync(IGetTimelinesV2Parameters parameters, ITwitterRequest request);
+    }
+
+    public class TimelinesV2QueryExecutor : ITimelinesV2QueryExecutor
+    {
+        private readonly JsonContentFactory _jsonContentFactory;
+        private readonly ITimelinesV2QueryGenerator _timelinesQueryGenerator;
+        private readonly ITwitterAccessor _twitterAccessor;
+
+        public TimelinesV2QueryExecutor(
+            JsonContentFactory jsonContentFactory,
+            ITimelinesV2QueryGenerator timelinesQueryGenerator,
+            ITwitterAccessor twitterAccessor)
+        {
+            _jsonContentFactory = jsonContentFactory;
+            _timelinesQueryGenerator = timelinesQueryGenerator;
+            _twitterAccessor = twitterAccessor;
+        }
+
+        public Task<ITwitterResult<TimelinesV2Response>> GetUserTweetsTimelineAsync(IGetTimelinesV2Parameters parameters, ITwitterRequest request)
+        {
+            request.Query.Url = _timelinesQueryGenerator.GetTimelineQuery(parameters);
+            request.Query.HttpMethod = HttpMethod.GET;
+            return _twitterAccessor.ExecuteRequestAsync<TimelinesV2Response>(request);
+        }
+        public Task<ITwitterResult<TimelinesV2Response>> GetUserMentionedTimelineAsync(IGetTimelinesV2Parameters parameters, ITwitterRequest request)
+        {
+            request.Query.Url = _timelinesQueryGenerator.GetMentionTimelineQuery(parameters);
+            return _twitterAccessor.ExecuteRequestAsync<TimelinesV2Response>(request);
+        }
+    }
+}

src/Tweetinvi.Controllers/Timeline/TimelinesV2QueryGenerator.cs

@@ -0,0 +1,46 @@
+using System.Text;
+using Tweetinvi.Controllers.Properties;
+using Tweetinvi.Core.Extensions;
+using Tweetinvi.Core.QueryGenerators.V2;
+using Tweetinvi.Parameters.V2;
+
+namespace Tweetinvi.Controllers.Timeline
+{
+    public class TimelinesV2QueryGenerator : ITimelinesV2QueryGenerator
+    {
+        public string GetTimelineQuery(IGetTimelinesV2Parameters parameters)
+        {
+            var query = new StringBuilder($"{Resources.UserV2_Get}/{parameters.UserId}/tweets");
+            AddTimelineFieldsParameters(parameters, query);
+            query.AddFormattedParameterToQuery(parameters.FormattedCustomQueryParameters);
+            return query.ToString();
+        }
+
+        public string GetMentionTimelineQuery(IGetTimelinesV2Parameters parameters)
+        {
+            var query = new StringBuilder($"{Resources.UserV2_Get}/{parameters.UserId}/mentions");
+            AddTimelineFieldsParameters(parameters, query);
+            query.AddFormattedParameterToQuery(parameters.FormattedCustomQueryParameters);
+            return query.ToString();
+        }
+
+        public void AddTimelineFieldsParameters(IGetTimelinesV2Parameters parameters, StringBuilder query)
+        {
+            // IBaseTweetsV2Parameters
+            query.AddParameterToQuery("expansions", parameters.Expansions);
+            query.AddParameterToQuery("media.fields", parameters.MediaFields);
+            query.AddParameterToQuery("place.fields", parameters.PlaceFields);
+            query.AddParameterToQuery("poll.fields", parameters.PollFields);
+            query.AddParameterToQuery("tweet.fields", parameters.TweetFields);
+            query.AddParameterToQuery("user.fields", parameters.UserFields);
+
+            query.AddParameterToQuery("exclude", parameters.Exclude);
+            query.AddParameterToQuery("max_results", parameters.MaxResults);
+            query.AddParameterToQuery("pagination_token", parameters.PaginationToken);
+            query.AddParameterToQuery("since_id", parameters.SinceId);
+            query.AddParameterToQuery("start_time", parameters.StartTime?.ToString("yyy-MM-ddThh:mm:ssZ"));
+            query.AddParameterToQuery("end_time", parameters.EndTime?.ToString("yyy-MM-ddThh:mm:ssZ"));
+            query.AddParameterToQuery("until_id", parameters.UntilId);
+        }
+    }
+}

src/Tweetinvi.Controllers/TweetinviControllersModule.cs

@@ -52,6 +52,7 @@ private void InitializeControllers(ITweetinviContainer container)
             container.RegisterType<ISearchV2Controller, SearchV2Controller>(RegistrationLifetime.InstancePerApplication);
             container.RegisterType<ITweetsV2Controller, TweetsV2Controller>(RegistrationLifetime.InstancePerApplication);
             container.RegisterType<IUsersV2Controller, UsersV2Controller>(RegistrationLifetime.InstancePerApplication);
+            container.RegisterType<ITimelinesV2Controller, TimelinesV2Controller>(RegistrationLifetime.InstancePerApplication);
 
             container.RegisterType<IStreamsV2Controller, StreamsV2Controller>(RegistrationLifetime.InstancePerApplication);
         }
@@ -77,6 +78,7 @@ private void InitializeQueryExecutors(ITweetinviContainer container)
             container.RegisterType<ISearchV2QueryExecutor, SearchV2QueryExecutor>();
             container.RegisterType<ITweetsV2QueryExecutor, TweetsV2QueryExecutor>();
             container.RegisterType<IUsersV2QueryExecutor, UsersV2QueryExecutor>();
+            container.RegisterType<ITimelinesV2QueryExecutor, TimelinesV2QueryExecutor>();
 
             container.RegisterType<IStreamsV2QueryExecutor, StreamsV2QueryExecutor>(RegistrationLifetime.InstancePerApplication);
         }
@@ -107,6 +109,7 @@ private void InitializeQueryGenerators(ITweetinviContainer container)
             container.RegisterType<ISearchV2QueryGenerator, SearchV2QueryGenerator>(RegistrationLifetime.InstancePerApplication);
             container.RegisterType<ITweetsV2QueryGenerator, TweetsV2QueryGenerator>(RegistrationLifetime.InstancePerApplication);
             container.RegisterType<IUsersV2QueryGenerator, UsersV2QueryGenerator>(RegistrationLifetime.InstancePerApplication);
+            container.RegisterType<ITimelinesV2QueryGenerator, TimelinesV2QueryGenerator>(RegistrationLifetime.InstancePerApplication);
 
             container.RegisterType<IStreamsV2QueryGenerator, StreamsV2QueryGenerator>(RegistrationLifetime.InstancePerApplication);
         }

src/Tweetinvi.Core/Core/Controllers/V2/ITimelinesV2Controller.cs

@@ -0,0 +1,14 @@
+using Tweetinvi.Core.Iterators;
+using Tweetinvi.Core.Web;
+using Tweetinvi.Models;
+using Tweetinvi.Models.V2;
+using Tweetinvi.Parameters.V2;
+
+namespace Tweetinvi.Core.Controllers.V2
+{
+    public interface ITimelinesV2Controller
+    {
+        ITwitterPageIterator<ITwitterResult<TimelinesV2Response>, string> GetUserTweetsTimelineIterator(IGetTimelinesV2Parameters parameters, ITwitterRequest request);
+        ITwitterPageIterator<ITwitterResult<TimelinesV2Response>, string> GetUserMentionedTimelineIterator(IGetTimelinesV2Parameters parameters, ITwitterRequest request);
+    }
+}

src/Tweetinvi.Core/Core/QueryGenerators/V2/ITimelinesV2QueryGenerator.cs

@@ -0,0 +1,12 @@
+using System.Text;
+using Tweetinvi.Parameters.V2;
+
+namespace Tweetinvi.Core.QueryGenerators.V2
+{
+    public interface ITimelinesV2QueryGenerator
+    {
+        string GetTimelineQuery(IGetTimelinesV2Parameters parameters);
+        string GetMentionTimelineQuery(IGetTimelinesV2Parameters parameters);
+        void AddTimelineFieldsParameters(IGetTimelinesV2Parameters parameters, StringBuilder query);
+    }
+}

src/Tweetinvi.Core/Public/Client/Clients/V2/ITimelinesV2Client.cs

@@ -0,0 +1,27 @@
+using Tweetinvi.Iterators;
+using Tweetinvi.Models.V2;
+using Tweetinvi.Parameters.V2;
+
+namespace Tweetinvi.Client.V2
+{
+    public interface ITimelinesV2Client
+    {
+        /// <summary>
+        /// Returns Tweets composed by a single user, specified by the requested user ID. By default,
+        /// the most recent ten Tweets are returned per request. Using pagination, the most recent
+        /// 3,200 Tweets can be retrieved.
+        /// <para>Read more : https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets </para>
+        /// </summary>
+        /// <returns>The Timeline</returns>
+        ITwitterRequestIterator<TimelinesV2Response, string> GetUserTweetsTimelineIterator(IGetTimelinesV2Parameters parameters);
+
+        /// <summary>
+        /// Returns Tweets mentioning a single user specified by the requested user ID. By default,
+        /// the most recent ten Tweets are returned per request. Using pagination, up to the most 
+        /// recent 800 Tweets can be retrieved.
+        /// <para>Read more : https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-mentions </para>
+        /// </summary>
+        ITwitterRequestIterator<TimelinesV2Response, string> GetUserMentionedTimelineIterator(IGetTimelinesV2Parameters parameters);
+
+    }
+}

src/Tweetinvi.Core/Public/Client/Requesters/V2/ITimelinesV2Requester.cs

@@ -0,0 +1,27 @@
+using Tweetinvi.Core.Iterators;
+using Tweetinvi.Core.Web;
+using Tweetinvi.Models.V2;
+using Tweetinvi.Parameters.V2;
+
+namespace Tweetinvi.Client.Requesters.V2
+{
+    public interface ITimelinesV2Requester
+    {
+        /// <summary>
+        /// Returns Tweets composed by a single user, specified by the requested user ID. By default,
+        /// the most recent ten Tweets are returned per request. Using pagination, the most recent
+        /// 3,200 Tweets can be retrieved.
+        /// <para>Read more : https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets </para>
+        /// </summary>
+        /// <returns>The Timeline</returns>
+        ITwitterPageIterator<ITwitterResult<TimelinesV2Response>, string> GetUserTweetsTimelineIterator(IGetTimelinesV2Parameters parameters);
+
+        /// <summary>
+        /// Returns Tweets mentioning a single user specified by the requested user ID. By default,
+        /// the most recent ten Tweets are returned per request. Using pagination, up to the most 
+        /// recent 800 Tweets can be retrieved.
+        /// <para>Read more : https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-mentions </para>
+        /// </summary>
+        ITwitterPageIterator<ITwitterResult<TimelinesV2Response>, string> GetUserMentionedTimelineIterator(IGetTimelinesV2Parameters parameters);
+    }
+}

src/Tweetinvi.Core/Public/Models/V2/Responses/TimelinesV2Response.cs

@@ -0,0 +1,29 @@
+using Newtonsoft.Json;
+
+namespace Tweetinvi.Models.V2
+{
+    public class TimelinesV2Response
+    {
+        /// <summary>
+        /// Tweets returned by the request
+        /// </summary>
+        [JsonProperty("data")] public TweetV2[] Tweets { get; set; } = new TweetV2[0];
+
+        /// <summary>
+        /// Contains all the requested expansions
+        /// </summary>
+        [JsonProperty("includes")] public TweetIncludesV2 Includes { get; set; }
+
+        /// <summary>
+        /// All errors that prevented Twitter to send some data,
+        /// but which did not prevent the request to be resolved.
+        /// </summary>
+        [JsonProperty("errors")] public ErrorV2[] Errors { get; set; }
+
+        /// <summary>
+        /// This object contains information about the number of users 
+        /// returned in the current request and pagination details.
+        /// </summary>
+        [JsonProperty("meta")] public TweetMetaV2 Meta { get; set; }
+    }
+}

src/Tweetinvi.Core/Public/Models/V2/TweetMetaV2.cs

@@ -0,0 +1,40 @@
+using System;
+using Newtonsoft.Json;
+
+namespace Tweetinvi.Models.V2
+{
+    /// <summary>
+    /// A Tweet
+    /// <para>Read more here : https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets</para>
+    /// </summary>
+    public class TweetMetaV2
+    {
+        /// <summary>
+        /// The Tweet ID of the oldest Tweet returned in the response.
+        /// </summary>
+        [JsonProperty("oldest_id")] public string OldestId { get; set; }
+
+        /// <summary>
+        /// The Tweet ID of the most recent Tweet returned in the response.
+        /// </summary>
+        [JsonProperty("newest_id")] public string NewestId { get; set; }
+
+        /// <summary>
+        /// The number of Tweet results returned in the response.
+        /// </summary>
+        [JsonProperty("count")] public int Count { get; set; }
+
+        /// <summary>
+        /// A value that encodes the next 'page' of results that can be requested,
+        /// via the pagination_token request parameter.
+        /// </summary>
+        [JsonProperty("next_token")] public string NextToken { get; set; }
+
+        /// <summary>
+        /// A value that encodes the previous 'page' of results that can be requested,
+        /// via the pagination_token request parameter.
+        /// </summary>
+        [JsonProperty("previous_token")] public string PreviousToken { get; set; }
+
+    }
+}

src/Tweetinvi.Core/Public/Parameters/V2/TimelinesClientV2/GetTimelinesV2Parameters.cs

@@ -0,0 +1,53 @@
+using System;
+using Tweetinvi.Core.Parameters;
+
+namespace Tweetinvi.Parameters.V2
+{
+    public interface IGetTimelinesV2Parameters : IBaseTweetsV2Parameters
+    {
+        string UserId { get; set; }
+        string Exclude { get; set; }
+        int? MaxResults { get; set; }
+        string PaginationToken { get; set; }
+        string SinceId { get; set; }
+        DateTime? StartTime { get; set; }
+        DateTime? EndTime { get; set; }
+        string UntilId { get; set; }
+    }
+
+    public class GetTimelinesV2Parameters : BaseTweetsV2Parameters, IGetTimelinesV2Parameters
+    {
+        public GetTimelinesV2Parameters(string userId)
+        {
+            UserId = userId;
+        }
+        public GetTimelinesV2Parameters(IGetTimelinesV2Parameters parameters)
+        {
+            UserId = parameters.UserId;
+            Exclude = parameters?.Exclude;
+            MaxResults = parameters?.MaxResults;
+            PaginationToken = parameters?.PaginationToken;
+            SinceId = parameters?.SinceId;
+            StartTime = parameters?.StartTime;
+            EndTime = parameters?.EndTime;
+            UntilId = parameters?.UntilId;
+
+            Expansions = parameters.Expansions;
+            MediaFields = parameters.MediaFields;
+            PlaceFields = parameters.PlaceFields;
+            PollFields = parameters.PollFields;
+            TweetFields = parameters.TweetFields;
+            UserFields = parameters.UserFields;
+
+        }
+
+        public string UserId { get; set; }
+        public string Exclude { get; set; }
+        public int? MaxResults { get; set; }
+        public string PaginationToken { get; set; }
+        public string SinceId { get; set; }
+        public DateTime? StartTime { get; set; }
+        public DateTime? EndTime { get; set; }
+        public string UntilId { get; set; }
+    }
+}