Add requestHeaders on each endpoint

Author: thinkingserious

CSharpHTTPClient/Client.cs

@@ -77,7 +77,7 @@ public enum Methods
         ///     REST API client.
         /// </summary>
         /// <param name="host">Base url (e.g. https://api.sendgrid.com)</param>
-        /// <param name="requestHeaders">A dictoinary of request headers</param>
+        /// <param name="requestHeaders">A dictionary of request headers</param>
         /// <param name="version">API version, override AddVersion to customize</param>
         /// <param name="urlPath">Path to endpoint (e.g. /path/to/endpoint)</param>
         /// <returns>Fluent interface to a REST API</returns>
@@ -86,19 +86,28 @@ public Client(string host, Dictionary<string,string> requestHeaders = null, stri
             Host = host;
             if(requestHeaders != null)
             {
-                RequestHeaders = (RequestHeaders != null)
-                    ? RequestHeaders.Union(requestHeaders).ToDictionary(pair => pair.Key, pair => pair.Value) : requestHeaders;
+                AddRequestHeader(requestHeaders);
             }
             Version = (version != null) ? version : null;
             UrlPath = (urlPath != null) ? urlPath : null;
         }
 
+        /// <summary>
+        ///     Add requestHeaders to the API call
+        /// </summary>
+        /// <param name="requestHeaders">A dictionary of request headers</param>
+        public void AddRequestHeader(Dictionary<string, string> requestHeaders)
+        {
+            RequestHeaders = (RequestHeaders != null)
+                    ? RequestHeaders.Union(requestHeaders).ToDictionary(pair => pair.Key, pair => pair.Value) : requestHeaders;
+        }
+
         /// <summary>
         ///     Build the final URL
         /// </summary>
-        /// <param name="query_params">A string of JSON formatted query parameters (e.g {'param': 'param_value'})</param>
+        /// <param name="queryParams">A string of JSON formatted query parameters (e.g {'param': 'param_value'})</param>
         /// <returns>Final URL</returns>
-        private string BuildUrl(string query_params = null)
+        private string BuildUrl(string queryParams = null)
         {
             string endpoint = null;
 
@@ -111,10 +120,10 @@ private string BuildUrl(string query_params = null)
                 endpoint = Host + UrlPath;
             }
 
-            if (query_params != null)
+            if (queryParams != null)
             {
                 JavaScriptSerializer jss = new JavaScriptSerializer();
-                var ds_query_params = jss.Deserialize<Dictionary<string, dynamic>>(query_params);
+                var ds_query_params = jss.Deserialize<Dictionary<string, dynamic>>(queryParams);
                 var query = HttpUtility.ParseQueryString(string.Empty);
                 foreach (var pair in ds_query_params)
                 {
@@ -211,25 +220,29 @@ public override bool TryInvokeMember(InvokeMemberBinder binder, object[] args, o
 
             if( Enum.IsDefined(typeof(Methods), binder.Name.ToUpper()))
             {
-                string query_params = null;
-                string request_body = null;
+                string queryParams = null;
+                string requestBody = null;
                 int i = 0;
 
                 foreach (object obj in args)
                 {
                     string name = binder.CallInfo.ArgumentNames.Count > i ?
                        binder.CallInfo.ArgumentNames[i] : null;
-                    if (name == "query_params")
+                    if (name == "queryParams")
+                    {
+                        queryParams = obj.ToString();
+                    }
+                    else if (name == "requestBody")
                     {
-                        query_params = obj.ToString();
+                        requestBody = obj.ToString();
                     }
-                    else if (name == "request_body")
+                    else if (name == "requestHeaders")
                     {
-                        request_body = obj.ToString();
+                        AddRequestHeader((Dictionary<string, string>)obj);
                     }
                     i++;
                 }
-                result = RequestAsync(binder.Name.ToUpper(), request_body: request_body, query_params: query_params).Result;
+                result = RequestAsync(binder.Name.ToUpper(), requestBody: requestBody, queryParams: queryParams).Result;
                 return true;
             }
             else
@@ -256,18 +269,18 @@ public async virtual Task<Response> MakeRequest(HttpClient client, HttpRequestMe
         ///     Prepare for async call to the API server
         /// </summary>
         /// <param name="method">HTTP verb</param>
-        /// <param name="request_body">JSON formatted string</param>
-        /// <param name="query_params">JSON formatted queary paramaters</param>
+        /// <param name="requestBody">JSON formatted string</param>
+        /// <param name="queryParams">JSON formatted queary paramaters</param>
         /// <returns>Response object</returns>
-        private async Task<Response> RequestAsync(string method, String request_body = null, String query_params = null)
+        private async Task<Response> RequestAsync(string method, String requestBody = null, String queryParams = null)
         {
             using (var client = new HttpClient())
             {
                 try
                 {
                     // Build the URL
                     client.BaseAddress = new Uri(Host);
-                    string endpoint = BuildUrl(query_params);
+                    string endpoint = BuildUrl(queryParams);
 
                     // Build the request headers
                     client.DefaultRequestHeaders.Accept.Clear();
@@ -293,9 +306,9 @@ private async Task<Response> RequestAsync(string method, String request_body = n
 
                     // Build the request body
                     StringContent content = null;
-                    if (request_body != null)
+                    if (requestBody != null)
                     {
-                        content = new StringContent(request_body.ToString().Replace("'", "\""), Encoding.UTF8, MediaType);
+                        content = new StringContent(requestBody.ToString().Replace("'", "\""), Encoding.UTF8, MediaType);
                     }
 
                     // Build the final request

Example/Example.cs

@@ -13,19 +13,21 @@ class Example
         static void Main(string[] args)
         {
             String host = "https://e9sk3d3bfaikbpdq7.stoplight-proxy.io";
-            Dictionary<String, String> requestHeaders = new Dictionary<String, String>();
+            Dictionary<String, String> globalRequestHeaders = new Dictionary<String, String>();
             string apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
-            requestHeaders.Add("Authorization", "Bearer " + apiKey);
-            requestHeaders.Add("Content-Type", "application/json");
+            globalRequestHeaders.Add("Authorization", "Bearer " + apiKey);
+            globalRequestHeaders.Add("Content-Type", "application/json");
 
             String version = "v3";
-            dynamic client = new Client(host, requestHeaders, version);
+            dynamic client = new Client(host: host, requestHeaders: globalRequestHeaders, version: version);
 
             // GET Collection
-            string query_params = @"{
+            string queryParams = @"{
                 'limit': 100
             }";
-            dynamic response = client.version("v3").api_keys.get(query_params: query_params);
+            Dictionary<String, String> requestHeaders = new Dictionary<String, String>();
+            requestHeaders.Add("X-Test", "test");
+            dynamic response = client.version("v3").api_keys.get(queryParams: queryParams, requestHeaders: requestHeaders);
             // Console.WriteLine(response.StatusCode);
             // Console.WriteLine(response.ResponseBody.ReadAsStringAsync().Result);
             // Console.WriteLine(response.ResponseHeaders.ToString());
@@ -46,15 +48,17 @@ static void Main(string[] args)
             Console.ReadLine();
 
             // POST
-            string request_body = @"{
+            string requestBody = @"{
                 'name': 'My API Key 5',
                 'scopes': [
                     'mail.send',
                     'alerts.create',
                     'alerts.read'
                 ]
             }";
-            response = client.api_keys.post(request_body: request_body);
+            requestHeaders.Clear();
+            requestHeaders.Add("X-Test", "test2");
+            response = client.api_keys.post(requestBody: requestBody, requestHeaders: requestHeaders);
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.ResponseBody.ReadAsStringAsync().Result);
             Console.WriteLine(response.ResponseHeaders.ToString());
@@ -75,10 +79,10 @@ static void Main(string[] args)
             Console.ReadLine();
 
             // PATCH
-            request_body = @"{
+            requestBody = @"{
                 'name': 'A New Hope'
             }";
-            response = client.api_keys._(api_key_id).patch(request_body: request_body);
+            response = client.api_keys._(api_key_id).patch(requestBody: requestBody);
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.ResponseBody.ReadAsStringAsync().Result);
             Console.WriteLine(response.ResponseHeaders.ToString());
@@ -87,14 +91,14 @@ static void Main(string[] args)
             Console.ReadLine();
 
             // PUT
-            request_body = @"{
+            requestBody = @"{
                 'name': 'A New Hope',
                 'scopes': [
                     'user.profile.read',
                     'user.profile.update'
                 ]
             }";
-            response = client.api_keys._(api_key_id).put(request_body: request_body);
+            response = client.api_keys._(api_key_id).put(requestBody: requestBody);
             Console.WriteLine(response.StatusCode);
             Console.WriteLine(response.ResponseBody.ReadAsStringAsync().Result);
             Console.WriteLine(response.ResponseHeaders.ToString());