Various improvement of documentation of members, classes, exceptions and events.

Author: linvi

.gitignore

@@ -1,6 +1,8 @@
 # My own ignores
 /tools/temp*
 /tools/TweetinviAPI/lib
+/tools/TweetinviAPI-Symbols/lib
+/tools/TweetinviAspNet/lib
 /tools/tweetinvi.certificate.p12
 /Examplinvi.Web/App_Data
 *.blob

Examples - Account Activity/Examplinvi.AccountActivityEvents/AccountActivityEventsManager.cs

@@ -24,7 +24,7 @@ public void RegisterAccountActivityStream(IAccountActivityStream accountActivity
 
             // Tweet events
             accountActivityStream.TweetCreated += TweetCreated;
-            accountActivityStream.TweetFavourited += TweetFavourited;
+            accountActivityStream.TweetFavorited += TweetFavorited;
             accountActivityStream.TweetDeleted += TweetDeleted;
 
              // Message events
@@ -61,7 +61,7 @@ public void UnregisterAccountActivityStream(IAccountActivityStream accountActivi
 
             // Tweet events
             accountActivityStream.TweetCreated -= TweetCreated;
-            accountActivityStream.TweetFavourited -= TweetFavourited;
+            accountActivityStream.TweetFavorited -= TweetFavorited;
             accountActivityStream.TweetDeleted -= TweetDeleted;
 
             // Message events
@@ -97,9 +97,9 @@ private void TweetDeleted(object sender, TweetDeletedEvent e)
             Console.WriteLine($">>> Tweet {e.TweetId} has been deleted at {e.EventDate}");
         }
 
-        private void TweetFavourited(object sender, TweetFavouritedEvent e)
+        private void TweetFavorited(object sender, TweetFavoritedEvent e)
         {
-            Console.WriteLine($">>> Tweet has been favourited by {e.FavouritedBy}:\n{e.Tweet}");
+            Console.WriteLine($">>> Tweet has been Favorited by {e.FavoritedBy}:\n{e.Tweet}");
         }
 
 
@@ -170,7 +170,7 @@ private void AccountActivityEvent(object sender, AccountActivityEvent args)
 
         private void UnmanagedEventReceived(object sender, UnsupportedMessageReceivedEvent e)
         {
-            Console.WriteLine(">>> An event that Tweetinvi is not yet capable of analyzing has been received. Please open a github issue with this message: " + e.JsonMessageReceived);
+            Console.WriteLine(">>> An event that Tweetinvi is not yet capable of analyzing has been received. Please open a github issue with this message: " + e.Message);
         }
     }
 }

Tests/xUnitinvi/EndToEnd/AccountActivityStreamEndToEndTests.cs

@@ -109,7 +109,7 @@ await userClient.Messages.PublishMessageAsync(new PublishMessageParameters("hell
 
                 Assert.Equal(state.TweetCreated.Count, 1);
                 Assert.Equal(state.TweetDeleted.Count, 1);
-                Assert.Equal(state.TweetFavourited.Count, 1);
+                Assert.Equal(state.TweetFavorited.Count, 1);
 
                 Assert.Equal(state.UserFollowed.Count, 1);
                 Assert.Equal(state.UserUnfollowed.Count, 1);
@@ -140,7 +140,7 @@ private static void RegisterEvents(IAccountActivityStream stream, AccountActivty
 
             stream.TweetCreated += (sender, args) => { state.TweetCreated.Add(args); };
             stream.TweetDeleted += (sender, args) => { state.TweetDeleted.Add(args); };
-            stream.TweetFavourited += (sender, args) => { state.TweetFavourited.Add(args); };
+            stream.TweetFavorited += (sender, args) => { state.TweetFavorited.Add(args); };
 
             stream.UserFollowed += (sender, args) => { state.UserFollowed.Add(args); };
             stream.UserUnfollowed += (sender, args) => { state.UserUnfollowed.Add(args); };
@@ -165,7 +165,7 @@ class AccountActivtyEventsState
             public List<string> EventsReceived { get; set; } = new List<string>();
             public List<TweetCreatedEvent> TweetCreated { get; set; } = new List<TweetCreatedEvent>();
             public List<TweetDeletedEvent> TweetDeleted { get; set; } = new List<TweetDeletedEvent>();
-            public List<TweetFavouritedEvent> TweetFavourited { get; set; } = new List<TweetFavouritedEvent>();
+            public List<TweetFavoritedEvent> TweetFavorited { get; set; } = new List<TweetFavoritedEvent>();
 
             public List<UserFollowedEvent> UserFollowed { get; } = new List<UserFollowedEvent>();
             public List<UserUnfollowedEvent> UserUnfollowed { get; set; } = new List<UserUnfollowedEvent>();

Tests/xUnitinvi/Streams/AccountActivityStreamTests.cs

@@ -88,27 +88,27 @@ public void FavouriteTweetRaised()
         {
             var activityStream = CreateAccountActivityStream();
 
-            var tweetFavouritedJson = @"{
+            var tweetFavoritedJson = @"{
 	            ""for_user_id"": ""100"",
 	            ""favorite_events"": [{
                   ""favorited_status"" : " + JsonTests.TWEET_TEST_JSON + @",
                   ""user"": " + JsonTests.USER_TEST_JSON(4242) + @"
 	            }]
             }";
 
-            var eventsReceived = new List<TweetFavouritedEvent>();
-            activityStream.TweetFavourited += (sender, args) =>
+            var eventsReceived = new List<TweetFavoritedEvent>();
+            activityStream.TweetFavorited += (sender, args) =>
             {
                 eventsReceived.Add(args);
             };
 
             // Act
-            activityStream.WebhookMessageReceived(new WebhookMessage(tweetFavouritedJson));
+            activityStream.WebhookMessageReceived(new WebhookMessage(tweetFavoritedJson));
 
             // Assert
             Assert.Equal(eventsReceived.Count, 1);
             Assert.Equal(eventsReceived[0].Tweet.CreatedBy.Id, 42);
-            Assert.Equal(eventsReceived[0].FavouritedBy.Id, 4242);
+            Assert.Equal(eventsReceived[0].FavoritedBy.Id, 4242);
         }
 
         [Fact]

Tests/xUnitinvi/Streams/FilteredStreamTests.cs

@@ -14,7 +14,7 @@ namespace xUnitinvi.Streams
 {
     public class FilteredStreamTests
     {
-        private Tuple<IFilteredStream, Func<Action<string>>> InitForCatchingJsonEvents()
+        private static Tuple<IFilteredStream, Func<Action<string>>> InitForCatchingJsonEvents()
         {
             // arrange
             var fakeStreamResultGenerator = A.Fake<IStreamResultGenerator>();

Tests/xUnitinvi/TestHelpers/TwitterAccessorSpy.cs

@@ -31,11 +31,6 @@ public Task<ITwitterResult<T>> ExecuteRequestAsync<T>(ITwitterRequest request) w
             return FakedObject.ExecuteRequestAsync<T>(request);
         }
 
-        public Task<byte[]> DownloadBinaryAsync(ITwitterRequest request)
-        {
-            throw new NotImplementedException();
-        }
-
         public Task PrepareTwitterRequestAsync(ITwitterRequest request)
         {
             throw new NotImplementedException();

src/Tweetinvi.Core/Core/Iterators/TwitterIteratorProxy.cs

@@ -1,4 +1,6 @@
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using System.Threading.Tasks;
 using Tweetinvi.Iterators;
 
@@ -22,6 +24,12 @@ public TwitterIteratorProxy(ITwitterPageIterator<TInput, TCursor> source, Func<T
             _transform = transform;
         }
 
+        public TwitterIteratorProxy(ITwitterPageIterator<TInput, TCursor> source, Func<TInput, IEnumerable<TOutput>> transform)
+        {
+            _source = source;
+            _transform = input => transform(input).ToArray();
+        }
+
         public TCursor NextCursor { get; private set; }
         public bool Completed { get; private set; }
 

src/Tweetinvi.Core/Core/Models/User.cs

@@ -243,7 +243,7 @@ public Task<Stream> GetProfileImageStreamAsync()
 
         public Task<Stream> GetProfileImageStreamAsync(ImageSize imageSize)
         {
-            return Client.Users.GetProfileImageStream(new GetProfileImageParameters(this)
+            return Client.Users.GetProfileImageStreamAsync(new GetProfileImageParameters(this)
             {
                 ImageSize = imageSize
             });

src/Tweetinvi.Core/Public/Client/Clients/IUsersClient.cs

@@ -526,19 +526,19 @@ public interface IUsersClient
         #region Profile Image
 
         /// <inheritdoc cref="IUsersClient.GetProfileImageStreamAsync(IGetProfileImageParameters)" />
-        Task<System.IO.Stream> GetProfileImageStream(string url);
+        Task<System.IO.Stream> GetProfileImageStreamAsync(string url);
 
         /// <inheritdoc cref="IUsersClient.GetProfileImageStreamAsync(IGetProfileImageParameters)" />
-        Task<System.IO.Stream> GetProfileImageStream(IUser user);
+        Task<System.IO.Stream> GetProfileImageStreamAsync(IUser user);
 
         /// <inheritdoc cref="IUsersClient.GetProfileImageStreamAsync(IGetProfileImageParameters)" />
-        Task<System.IO.Stream> GetProfileImageStream(IUserDTO user);
+        Task<System.IO.Stream> GetProfileImageStreamAsync(IUserDTO user);
 
         /// <summary>
         /// Get the profile image of a user
         /// </summary>
         /// <returns>A stream of the image file</returns>
-        Task<System.IO.Stream> GetProfileImageStream(IGetProfileImageParameters parameters);
+        Task<System.IO.Stream> GetProfileImageStreamAsync(IGetProfileImageParameters parameters);
 
         #endregion
 

src/Tweetinvi.Core/Public/Client/IRawExecutors.cs

@@ -4,16 +4,59 @@ namespace Tweetinvi.Client
 {
     public interface IRawExecutors
     {
+        /// <summary>
+        /// Client to execute all the actions related with webhooks
+        /// </summary>
         IAccountActivityRequester AccountActivity { get; }
+
+        /// <summary>
+        /// Client to execute all actions related with the account associated with the clients' credentials
+        /// </summary>
         IAccountSettingsRequester AccountSettings { get; }
+
+        /// <summary>
+        /// Client to execute all actions related with authentication
+        /// </summary>
         IAuthRequester Auth { get; }
+
+        /// <summary>
+        /// Client to execute all actions from the help path
+        /// </summary>
         IHelpRequester Help { get; }
+
+        /// <summary>
+        /// Client to execute all actions related with twitter lists
+        /// </summary>
+        ITwitterListsRequester Lists { get; }
+
+        /// <summary>
+        /// Client to execute all actions related with search
+        /// </summary>
         ISearchRequester Search { get; }
+
+        /// <summary>
+        /// Client to execute all actions related with timelines
+        /// </summary>
         ITimelinesRequester Timelines { get; }
+
+        /// <summary>
+        /// Client to execute all actions related with trends
+        /// </summary>
         ITrendsRequester Trends { get; }
+
+        /// <summary>
+        /// Client to execute all actions related with tweets
+        /// </summary>
         ITweetsRequester Tweets { get; }
-        ITwitterListsRequester Lists { get; }
+
+        /// <summary>
+        /// Client to execute all actions related with media upload
+        /// </summary>
         IUploadRequester Upload { get; }
+
+        /// <summary>
+        /// Client to execute all actions related with users
+        /// </summary>
         IUsersRequester Users { get; }
     }
 }

src/Tweetinvi.Core/Public/Client/Requesters/IExecuteRequester.cs

@@ -7,10 +7,28 @@ namespace Tweetinvi.Client.Requesters
 {
     public interface IExecuteRequester
     {
+        /// <summary>
+        /// Execute a custom request
+        /// </summary>
+        /// <returns>The raw response from twitter with the json parsed into a Data Transfer Object</returns>
         Task<ITwitterResult<T>> RequestAsync<T>(Action<ITwitterRequest> configureRequest) where T : class;
+
+        /// <summary>
+        /// Execute a custom request
+        /// </summary>
+        /// <returns>The raw response from Twitter</returns>
         Task<ITwitterResult> RequestAsync(Action<ITwitterRequest> configureRequest);
 
+        /// <summary>
+        /// Execute a custom query
+        /// </summary>
+        /// <returns>The raw response from twitter with the json parsed into a Data Transfer Object</returns>
         Task<ITwitterResult<T>> RequestAsync<T>(Action<ITwitterQuery> configureQuery) where T : class;
+
+        /// <summary>
+        /// Execute a custom query
+        /// </summary>
+        /// <returns>The raw response from Twitter</returns>
         Task<ITwitterResult> RequestAsync(Action<ITwitterQuery> configureQuery);
 
         Task<ITwitterRequest> PrepareTwitterRequestAsync(Action<ITwitterQuery> configureQuery);

src/Tweetinvi.Core/Public/Client/Requesters/IHelpRequester.cs

@@ -24,10 +24,32 @@ public interface IHelpRequester
         /// <returns>Twitter response containing the official configuration</returns>
         Task<ITwitterResult<ITwitterConfiguration>> GetTwitterConfigurationAsync(IGetTwitterConfigurationParameters parameters);
 
+        /// <summary>
+        /// Get Twitter supported languages
+        /// </summary>
+        /// <para> https://developer.twitter.com/en/docs/developer-utilities/supported-languages/api-reference/get-help-languages </para>
+        /// <returns>Twitter result containing the supported languages</returns>
         Task<ITwitterResult<SupportedLanguage[]>> GetSupportedLanguagesAsync(IGetSupportedLanguagesParameters parameters);
 
+        /// <summary>
+        /// Get a place information from place identifier.
+        /// </summary>
+        /// <para> https://developer.twitter.com/en/docs/geo/place-information/api-reference/get-geo-id-place_id </para>
+        /// <returns>Twitter result containing the requested Place</returns>
         Task<ITwitterResult<IPlace>> GetPlaceAsync(IGetPlaceParameters parameters);
+
+        /// <summary>
+        /// Search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name.
+        /// </summary>
+        /// <para> https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-search </para>
+        /// <returns>Twitter result containing the places matching search</returns>
         Task<ITwitterResult<SearchGeoSearchResultDTO>> SearchGeoAsync(IGeoSearchParameters parameters);
+
+        /// <summary>
+        /// Given a latitude and a longitude, searches for up to 20 places.
+        /// </summary>
+        /// <para> https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-reverse_geocode </para>
+        /// <returns>Twitter result containing the matching the search</returns>
         Task<ITwitterResult<SearchGeoSearchResultDTO>> SearchGeoReverseAsync(IGeoSearchReverseParameters parameters);
     }
 }

src/Tweetinvi.Core/Public/Client/Requesters/ITrendsRequester.cs

@@ -7,8 +7,25 @@ namespace Tweetinvi.Client.Requesters
 {
     public interface ITrendsRequester
     {
+        /// <summary>
+        /// Returns the top 50 trending topics for a specific WOEID
+        /// </summary>
+        /// <para>Read more : https://developer.twitter.com/en/docs/trends/trends-for-location/api-reference/get-trends-place </para>
+        /// <returns>Twitter result containing the place trends</returns>
         Task<ITwitterResult<IGetTrendsAtResult[]>> GetPlaceTrendsAtAsync(IGetTrendsAtParameters parameters);
+
+        /// <summary>
+        /// Returns the locations that Twitter has trending topic information for.
+        /// </summary>
+        /// <para>Read more : https://developer.twitter.com/en/docs/trends/locations-with-trending-topics/api-reference/get-trends-available </para>
+        /// <returns>Twitter result containing the trending locations</returns>
         Task<ITwitterResult<ITrendLocation[]>> GetTrendLocationsAsync(IGetTrendsLocationParameters parameters);
+
+        /// <summary>
+        /// Returns the locations that Twitter has trending topic information for, closest to a specified location.
+        /// </summary>
+        /// <para>Read more : https://developer.twitter.com/en/docs/trends/locations-with-trending-topics/api-reference/get-trends-closest </para>
+        /// <returns>Twitter result containing the trending locations</returns>
         Task<ITwitterResult<ITrendLocation[]>> GetTrendsLocationCloseToAsync(IGetTrendsLocationCloseToParameters parameters);
     }
 }

src/Tweetinvi.Core/Public/Client/Requesters/ITwitterListsRequester.cs

@@ -149,6 +149,5 @@ public interface ITwitterListsRequester
         /// </summary>
         /// <returns>An iterator to get through the tweets of a list</returns>
         ITwitterPageIterator<ITwitterResult<ITweetDTO[]>, long?> GetTweetsFromListIterator(IGetTweetsFromListParameters parameters);
-
     }
 }