Merge pull request #19 from mrmurb/use_post_for_chat.postMessage

WebApi: Changed HTTP methods to POST where recommended by Slack

SlackNet.Tests/ApiLintTest.cs

@@ -140,6 +140,18 @@ public Task Post(string apiMethod, Args args, HttpContent content, CancellationT
                 return Task.FromResult(0);
             }
 
+            public Task Post(string apiMethod, Args args, CancellationToken? cancellationToken) =>
+                Post<object>(apiMethod, args, cancellationToken);
+
+            public Task<T> Post<T>(string apiMethod, Args args, CancellationToken? cancellationToken) where T : class
+            {
+                HttpMethod = "POST";
+                SlackMethod = apiMethod;
+                Args = args;
+                CancellationToken = cancellationToken;
+                return Task.FromResult(Activator.CreateInstance<T>());
+            }
+
             public Task<T> Post<T>(string apiMethod, Args args, HttpContent content, CancellationToken? cancellationToken) where T : class
             {
                 HttpMethod = "POST";

SlackNet/Http.cs

@@ -8,8 +8,7 @@ namespace SlackNet
 {
     public interface IHttp
     {
-        Task<T> Get<T>(string url, CancellationToken? cancellationToken = null);
-        Task<T> Post<T>(string url, HttpContent content, CancellationToken? cancellationToken = null);
+        Task<T> Execute<T>(HttpRequestMessage requestMessage, CancellationToken? cancellationToken = null);
     }
 
     class Http : IHttp
@@ -23,16 +22,9 @@ public Http(HttpClient client, SlackJsonSettings jsonSettings)
             _jsonSettings = jsonSettings;
         }
 
-        public async Task<T> Get<T>(string url, CancellationToken? cancellationToken = null)
+        public async Task<T> Execute<T>(HttpRequestMessage requestMessage, CancellationToken? cancellationToken = null)
         {
-            var response = await _client.SendAsync(new HttpRequestMessage(HttpMethod.Get, url), cancellationToken ?? CancellationToken.None).ConfigureAwait(false);
-            response.EnsureSuccessStatusCode();
-            return await Deserialize<T>(response).ConfigureAwait(false);
-        }
-
-        public async Task<T> Post<T>(string url, HttpContent content, CancellationToken? cancellationToken = null)
-        {
-            var response = await _client.PostAsync(url, content, cancellationToken ?? CancellationToken.None).ConfigureAwait(false);
+            var response = await _client.SendAsync(requestMessage, cancellationToken ?? CancellationToken.None).ConfigureAwait(false);
             response.EnsureSuccessStatusCode();
             return await Deserialize<T>(response).ConfigureAwait(false);
         }

SlackNet/SlackApiClient.cs

@@ -1,4 +1,6 @@
 using System.Net.Http;
+using System.Net.Http.Headers;
+using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
 using Newtonsoft.Json;
@@ -56,6 +58,23 @@ public interface ISlackApiClient
         /// <param name="cancellationToken"></param>
         Task<T> Get<T>(string apiMethod, Args args, CancellationToken? cancellationToken) where T : class;
 
+        /// <summary>
+        /// Calls a Slack API that requires POST content.
+        /// </summary>
+        /// <param name="apiMethod">Name of Slack method.</param>
+        /// <param name="args">Arguments to send to Slack. Authorization headers will be added automatically.</param>
+        /// <param name="cancellationToken"></param>
+        Task Post(string apiMethod, Args args, CancellationToken? cancellationToken);
+
+        /// <summary>
+        /// Calls a Slack API that requires POST content.
+        /// </summary>
+        /// <typeparam name="T">Type of response expected.</typeparam>
+        /// <param name="apiMethod">Name of Slack method.</param>
+        /// <param name="args">Arguments to send to Slack. Authorization headers will be added automatically.</param>
+        /// <param name="cancellationToken"></param>
+        Task<T> Post<T>(string apiMethod, Args args, CancellationToken? cancellationToken) where T : class;
+
         /// <summary>
         /// Calls a Slack API that requires POST content.
         /// </summary>
@@ -64,7 +83,7 @@ public interface ISlackApiClient
         /// <param name="content">POST body content. Should be either <see cref="FormUrlEncodedContent"/> or <see cref="MultipartFormDataContent"/>.</param>
         /// <param name="cancellationToken"></param>
         Task Post(string apiMethod, Args args, HttpContent content, CancellationToken? cancellationToken);
-
+        
         /// <summary>
         /// Calls a Slack API that requires POST content.
         /// </summary>
@@ -145,8 +164,37 @@ public Task Get(string apiMethod, Args args, CancellationToken? cancellationToke
         /// <param name="apiMethod">Name of Slack method.</param>
         /// <param name="args">Arguments to send to Slack. The "token" parameter will be filled in automatically.</param>
         /// <param name="cancellationToken"></param>
-        public async Task<T> Get<T>(string apiMethod, Args args, CancellationToken? cancellationToken) where T : class =>
-            Deserialize<T>(await _http.Get<WebApiResponse>(Url(apiMethod, args), cancellationToken ?? CancellationToken.None).ConfigureAwait(false));
+        public async Task<T> Get<T>(string apiMethod, Args args, CancellationToken? cancellationToken) where T : class
+        {
+            var requestMessage = new HttpRequestMessage(HttpMethod.Get, Url(apiMethod, args));
+            return Deserialize<T>(await _http.Execute<WebApiResponse>(requestMessage, cancellationToken ?? CancellationToken.None).ConfigureAwait(false));
+        }
+
+        /// <summary>
+        /// Calls a Slack API that requires POST content.
+        /// </summary>
+        /// <param name="apiMethod">Name of Slack method.</param>
+        /// <param name="args">Arguments to send to Slack. The "token" parameter will be filled in automatically.</param>
+        /// <param name="cancellationToken"></param>
+        public Task Post(string apiMethod, Args args, CancellationToken? cancellationToken) =>
+            Post<object>(apiMethod, args, cancellationToken);
+
+        /// <summary>
+        /// Calls a Slack API that requires POST content.
+        /// </summary>
+        /// <typeparam name="T">Type of response expected.</typeparam>
+        /// <param name="apiMethod">Name of Slack method.</param>
+        /// <param name="args">Arguments to send to Slack. The "token" parameter will be filled in automatically.</param>
+        /// <param name="cancellationToken"></param>
+        public async Task<T> Post<T>(string apiMethod, Args args, CancellationToken? cancellationToken) where T : class
+        {
+            var requestMessage = new HttpRequestMessage(HttpMethod.Post,Url(apiMethod));
+            requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", _token);
+            requestMessage.Content = new StringContent(JsonConvert.SerializeObject(args, _jsonSettings.SerializerSettings), Encoding.UTF8, "application/json");
+
+            var response = await _http.Execute<WebApiResponse>(requestMessage, cancellationToken ?? CancellationToken.None).ConfigureAwait(false);
+            return Deserialize<T>(response);
+        }
 
         /// <summary>
         /// Calls a Slack API that requires POST content.
@@ -166,9 +214,15 @@ public Task Post(string apiMethod, Args args, HttpContent content, CancellationT
         /// <param name="args">Arguments to send to Slack. The "token" parameter will be filled in automatically.</param>
         /// <param name="content">POST body content. Should be either <see cref="FormUrlEncodedContent"/> or <see cref="MultipartFormDataContent"/>.</param>
         /// <param name="cancellationToken"></param>
-        public async Task<T> Post<T>(string apiMethod, Args args, HttpContent content, CancellationToken? cancellationToken) where T : class =>
-            Deserialize<T>(await _http.Post<WebApiResponse>(Url(apiMethod, args), content, cancellationToken ?? CancellationToken.None).ConfigureAwait(false));
-
+        public async Task<T> Post<T>(string apiMethod, Args args, HttpContent content, CancellationToken? cancellationToken) where T : class
+        {
+            var requestMessage = new HttpRequestMessage(HttpMethod.Post, Url(apiMethod, args)) { Content = content };
+            return Deserialize<T>(await _http.Execute<WebApiResponse>(requestMessage, cancellationToken ?? CancellationToken.None).ConfigureAwait(false));
+        }
+
+        private string Url(string apiMethod) =>
+            _urlBuilder.Url(apiMethod, new Args());
+
         private string Url(string apiMethod, Args args)
         {
             if (!args.ContainsKey("token"))

SlackNet/WebApi/ApiApi.cs

@@ -38,7 +38,7 @@ public class ApiApi : IApiApi
         public async Task<IReadOnlyDictionary<string, string>> Test(string error, Args args, CancellationToken? cancellationToken = null)
         {
             var query = new Args(args) { ["error"] = error };
-            return (await _client.Get<TestResponse>("api.test", query, cancellationToken).ConfigureAwait(false)).Args;
+            return (await _client.Post<TestResponse>("api.test", query, cancellationToken).ConfigureAwait(false)).Args;
         }
     }
 }

SlackNet/WebApi/AuthApi.cs

@@ -40,6 +40,6 @@ public async Task<bool> Revoke(bool test, CancellationToken? cancellationToken =
         /// Checks authentication and tells you who you are.
         /// </summary>
         public Task<AuthTestResponse> Test(CancellationToken? cancellationToken = null) =>
-            _client.Get<AuthTestResponse>("auth.test", new Args(), cancellationToken);
+            _client.Post<AuthTestResponse>("auth.test", new Args(), cancellationToken);
     }
 }

SlackNet/WebApi/ChannelsApi.cs

@@ -162,7 +162,7 @@ public class ChannelsApi : IChannelsApi
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
         public Task Archive(string channelId, CancellationToken? cancellationToken = null) =>
-            _client.Get("channels.archive", new Args { { "channel", channelId } }, cancellationToken);
+            _client.Post("channels.archive", new Args { { "channel", channelId } }, cancellationToken);
 
         /// <summary>
         /// Used to create a channel.
@@ -172,7 +172,7 @@ public Task Archive(string channelId, CancellationToken? cancellationToken = nul
         /// <param name="validate">Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.</param>
         /// <param name="cancellationToken"></param>
         public async Task<Channel> Create(string name, bool validate = false, CancellationToken? cancellationToken = null) =>
-            (await _client.Get<ChannelResponse>("channels.create", new Args
+            (await _client.Post<ChannelResponse>("channels.create", new Args
                 {
                     { "name", name },
                     { "validate", validate }
@@ -220,7 +220,7 @@ public async Task<Channel> Info(string channelId, CancellationToken? cancellatio
         /// <param name="userId">User to invite to channel.</param>
         /// <param name="cancellationToken"></param>
         public async Task<Channel> Invite(string channelId, string userId, CancellationToken? cancellationToken = null) =>
-            (await _client.Get<ChannelResponse>("channels.invite", new Args
+            (await _client.Post<ChannelResponse>("channels.invite", new Args
                 {
                     { "channel", channelId },
                     { "user", userId }
@@ -240,7 +240,7 @@ public async Task<Channel> Invite(string channelId, string userId, CancellationT
         /// This allows a client to see that the request to join GeNERaL is the same as the channel #general that the user is already in.
         /// </returns>
         public Task<ChannelJoinResponse> Join(string channelName, bool validate = false, CancellationToken? cancellationToken = null) =>
-            _client.Get<ChannelJoinResponse>("channels.join", new Args
+            _client.Post<ChannelJoinResponse>("channels.join", new Args
                 {
                     { "channel", channelName },
                     { "validate", validate }
@@ -253,7 +253,7 @@ public Task<ChannelJoinResponse> Join(string channelName, bool validate = false,
         /// <param name="userId">User to remove from channel.</param>
         /// <param name="cancellationToken"></param>
         public Task Kick(string channelId, string userId, CancellationToken? cancellationToken = null) =>
-            _client.Get("channels.kick", new Args
+            _client.Post("channels.kick", new Args
                 {
                     { "channel", channelId },
                     { "user", userId }
@@ -266,7 +266,7 @@ public Task Kick(string channelId, string userId, CancellationToken? cancellatio
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
         public Task Leave(string channelId, CancellationToken? cancellationToken = null) =>
-            _client.Get("channels.leave", new Args { { "channel", channelId } }, cancellationToken);
+            _client.Post("channels.leave", new Args { { "channel", channelId } }, cancellationToken);
 
         /// <summary>
         /// Returns a list of all channels in the team. 
@@ -292,7 +292,7 @@ public async Task<IReadOnlyList<Channel>> List(bool excludeArchived = false, boo
         /// <param name="ts">Timestamp of the most recently seen message.</param>
         /// <param name="cancellationToken"></param>
         public Task Mark(string channelId, string ts, CancellationToken? cancellationToken = null) =>
-            _client.Get("channels.mark", new Args
+            _client.Post("channels.mark", new Args
                 {
                     { "channel", channelId },
                     { "ts", ts }
@@ -308,7 +308,7 @@ public Task Mark(string channelId, string ts, CancellationToken? cancellationTok
         /// <param name="validate">Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.</param>
         /// <param name="cancellationToken"></param>
         public async Task<Channel> Rename(string channelId, string name, bool validate = false, CancellationToken? cancellationToken = null) =>
-            (await _client.Get<ChannelResponse>("channels.rename", new Args
+            (await _client.Post<ChannelResponse>("channels.rename", new Args
                 {
                     { "channel", channelId },
                     { "name", name },
@@ -338,7 +338,7 @@ public async Task<IReadOnlyList<MessageEvent>> Replies(string channelId, string
         /// <param name="cancellationToken"></param>
         /// <returns>The channel's new purpose.</returns>
         public async Task<string> SetPurpose(string channelId, string purpose, CancellationToken? cancellationToken = null) =>
-            (await _client.Get<PurposeResponse>("channels.setPurpose", new Args
+            (await _client.Post<PurposeResponse>("channels.setPurpose", new Args
                 {
                     { "channel", channelId },
                     { "purpose", purpose }
@@ -353,7 +353,7 @@ public async Task<string> SetPurpose(string channelId, string purpose, Cancellat
         /// <param name="cancellationToken"></param>
         /// <returns>The channel's new topic.</returns>
         public async Task<string> SetTopic(string channelId, string topic, CancellationToken? cancellationToken = null) =>
-            (await _client.Get<TopicResponse>("channels.setTopic", new Args
+            (await _client.Post<TopicResponse>("channels.setTopic", new Args
                 {
                     { "channel", channelId },
                     { "topic", topic }
@@ -366,6 +366,6 @@ public async Task<string> SetTopic(string channelId, string topic, CancellationT
         /// <param name="channelId">Channel to unarchive.</param>
         /// <param name="cancellationToken"></param>
         public Task Unarchive(string channelId, CancellationToken? cancellationToken = null) =>
-            _client.Get("channels.unarchive", new Args { { "channel", channelId } }, cancellationToken);
+            _client.Post("channels.unarchive", new Args { { "channel", channelId } }, cancellationToken);
     }
 }