Merge pull request #2 from richardschneider/httpclient

Asynchronous I/O

Author: richardschneider

appveyor.yml

@@ -30,7 +30,7 @@ nuget:
 
 before_build:
   - nuget restore
-  - ps: gitversion /output buildserver /updateAssemblyInfo >gitversion.log
+  - ps: gitversion /output buildserver /updateAssemblyInfo 
 
 platform: Any CPU
 configuration: Release

src/Add.cs

@@ -3,6 +3,10 @@
 using System.Linq;
 using System.Text;
 using System.IO;
+using System.Threading.Tasks;
+using System.Net.Http;
+using System.Net.Http.Headers;
+using Newtonsoft.Json.Linq;
 
 namespace Ipfs.Api
 {
@@ -12,16 +16,16 @@ public partial class IpfsClient
         ///   Add a file to the interplanetary file system.
         /// </summary>
         /// <param name="path"></param>
-        public MerkleNode AddFile(string path)
+        public Task<MerkleNode> AddFileAsync(string path)
         {
-            throw new NotImplementedException();
+            return AddAsync(new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read));
         }
 
         /// <summary>
         ///   Add a directory and its files to the interplanetary file system.
         /// </summary>
         /// <param name="path"></param>
-        public MerkleNode AddDirectory(string path, bool recursive = true)
+        public Task<MerkleNode> AddDirectoryAsync(string path, bool recursive = true)
         {
             throw new NotImplementedException();
         }
@@ -30,18 +34,46 @@ public MerkleNode AddDirectory(string path, bool recursive = true)
         ///   Add some text to the interplanetary file system.
         /// </summary>
         /// <param name="text"></param>
-        public MerkleNode AddText(string text)
+        public Task<MerkleNode> AddTextAsync(string text)
         {
-            throw new NotImplementedException();
+            return AddAsync(new MemoryStream(Encoding.UTF8.GetBytes(text)));
         }
 
         /// <summary>
         ///   Add a <see cref="Stream"/> to interplanetary file system.
         /// </summary>
-        /// <param name="s"></param>
-        public MerkleNode Add(Stream s)
+        /// <param name="stream"></param>
+        public async Task<MerkleNode> AddAsync(Stream stream)
         {
-            throw new NotImplementedException();
+            var content = new MultipartFormDataContent();
+            var streamContent = new StreamContent(stream);
+            streamContent.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
+            content.Add(streamContent, "file");
+
+            try
+            {
+                var url = BuildCommand("add");
+                if (log.IsDebugEnabled)
+                    log.Debug("POST " + url.ToString());
+                using (var response = await Api().PostAsync(url, content))
+                {
+                    await ThrowOnError(response);
+                    var json = await response.Content.ReadAsStringAsync();
+                    if (log.IsDebugEnabled)
+                        log.Debug("RSP " + json);
+                    var r = JObject.Parse(json);
+
+                    return new MerkleNode((string)r["Hash"]);
+                }
+            }
+            catch (IpfsException)
+            {
+                throw;
+            }
+            catch (Exception e)
+            {
+                throw new IpfsException(e);
+            }
         }
     }
 }

src/Id.cs

@@ -5,6 +5,7 @@
 using System.Text;
 using System.IO;
 using System.Net;
+using System.Threading.Tasks;
 
 namespace Ipfs.Api
 {
@@ -19,9 +20,9 @@ public partial class IpfsClient
         /// </param>
         /// <returns>
         /// </returns>
-        public PeerNode Id(string peer = null)
+        public Task<PeerNode> Id(string peer = null)
         {
-            return DoCommand<PeerNode>("id", peer);
+            return DoCommandAsync<PeerNode>("id", peer);
         }
     }
 }

src/IpfsApi.csproj

@@ -58,7 +58,7 @@
     <Reference Include="System" />
     <Reference Include="System.Core" />
     <Reference Include="Microsoft.CSharp" />
-    <Reference Include="System.Web" />
+    <Reference Include="System.Net.Http" />
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Add.cs" />

src/IpfsClient.cs

@@ -3,11 +3,12 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
-using System.Net;
 using System.Reflection;
-using System.Web;
 using Newtonsoft.Json;
 using System.IO;
+using System.Net.Http;
+using System.Threading.Tasks;
+using System.Net;
 
 namespace Ipfs.Api
 {
@@ -19,9 +20,15 @@ namespace Ipfs.Api
     /// </remarks>
     /// <seealso href="https://ipfs.io/docs/api/">IPFS API</seealso>
     /// <seealso href="https://ipfs.io/docs/commands/">IPFS commands</seealso>
+    /// <remarks>
+    ///   <b>IpfsClient</b> is thread safe, only one instance is required
+    ///   by the application.
+    /// </remarks>
     public partial class IpfsClient
     {
         static ILog log = LogManager.GetCurrentClassLogger();
+        static object safe = new object();
+        static HttpClient api = null;
 
         /// <summary>
         ///   The default URL to the IPFS API server.  The default is "http://localhost:5001".
@@ -83,7 +90,7 @@ Uri BuildCommand(string command, string arg = null, params string[] options)
             if (arg != null)
             {
                 q.Append("&arg=");
-                q.Append(HttpUtility.UrlEncode(arg));
+                q.Append(WebUtility.UrlEncode(arg));
             }
 
             foreach (var option in options)
@@ -98,7 +105,7 @@ Uri BuildCommand(string command, string arg = null, params string[] options)
                 {
                     q.Append(option.Substring(0, i));
                     q.Append('=');
-                    q.Append(HttpUtility.UrlEncode(option.Substring(i + 1)));
+                    q.Append(WebUtility.UrlEncode(option.Substring(i + 1)));
                 }
             }
 
@@ -112,13 +119,28 @@ Uri BuildCommand(string command, string arg = null, params string[] options)
             return new Uri(ApiUri, url);
         }
 
-        WebClient Api()
+        /// <summary>
+        ///   Get the IPFS API.
+        /// </summary>
+        /// <returns>
+        ///   A <see cref="HttpClient"/>.
+        /// </returns>
+        /// <remarks>
+        ///   Only one client is needed.  Its thread safe.
+        /// </remarks>
+        HttpClient Api()
         {
-            var api = new WebClient
+            if (api == null)
             {
-                Encoding = Encoding.UTF8
-            };
-            api.Headers["User-Agent"] = UserAgent;
+                lock (safe)
+                {
+                    if (api == null)
+                    {
+                        api = new HttpClient();
+                        api.DefaultRequestHeaders.Add("User-Agent", UserAgent);
+                    }
+                }
+            }
             return api;
         }
 
@@ -138,17 +160,25 @@ WebClient Api()
         /// <returns>
         ///   A string representation of the command's result.
         /// </returns>
-        public string DoCommand(string command, string arg = null, params string[] options)
+        public async Task<string> DoCommandAsync(string command, string arg = null, params string[] options)
         {
             try
             {
                 var url = BuildCommand(command, arg, options);
                 if (log.IsDebugEnabled)
                     log.Debug("GET " + url.ToString());
-                var s = Api().DownloadString(url);
-                if (log.IsDebugEnabled)
-                    log.Debug("RSP " + s);
-                return s;
+                using (var response = await Api().GetAsync(url))
+                {
+                    await ThrowOnError(response);
+                    var body = await response.Content.ReadAsStringAsync();
+                    if (log.IsDebugEnabled)
+                        log.Debug("RSP " + body);
+                    return body;
+                }
+            }
+            catch (IpfsException)
+            {
+                throw;
             }
             catch (Exception e)
             {
@@ -180,9 +210,9 @@ public string DoCommand(string command, string arg = null, params string[] optio
         ///   The command's response is converted to <typeparamref name="T"/> using
         ///   <c>JsonConvert</c>.
         /// </remarks>
-        public T DoCommand<T>(string command, string arg = null, params string[] options)
+        public async Task<T> DoCommandAsync<T>(string command, string arg = null, params string[] options)
         {
-            var json = DoCommand(command, arg, options);
+            var json = await DoCommandAsync(command, arg, options);
             return JsonConvert.DeserializeObject<T>(json);
         }
 
@@ -203,20 +233,120 @@ public T DoCommand<T>(string command, string arg = null, params string[] options
         /// <returns>
         ///   A <see cref="Stream"/> containing the command's result.
         /// </returns>
-        public Stream Download(string command, string arg = null, params string[] options)
+        public async Task<Stream> DownloadAsync(string command, string arg = null, params string[] options)
         {
             try
             {
                 var url = BuildCommand(command, arg, options);
                 if (log.IsDebugEnabled)
                     log.Debug("GET " + url.ToString());
-                return Api().OpenRead(url);
+                var response = await Api().GetAsync(url);
+                await ThrowOnError(response);
+                return await response.Content.ReadAsStreamAsync();
+            }
+            catch (IpfsException)
+            {
+                throw;
             }
             catch (Exception e)
             {
                 throw new IpfsException(e);
             }
         }
-    
+
+        /// <summary>
+        ///  Perform an <see href="https://ipfs.io/docs/api/">IPFS API command</see> returning a string.
+        /// </summary>
+        /// <param name="command">
+        ///   The <see href="https://ipfs.io/docs/api/">IPFS API command</see>, such as
+        ///   <see href="https://ipfs.io/docs/api/#apiv0filels">"file/ls"</see>.
+        /// </param>
+        /// <param name="arg">
+        ///   The optional argument to the command.
+        /// </param>
+        /// <param name="options">
+        ///   The optional flags to the command.
+        /// </param>
+        /// <returns>
+        ///   A string representation of the command's result.
+        /// </returns>
+        public string DoCommand(string command, string arg = null, params string[] options)
+        {
+            return DoCommandAsync(command, arg, options).Result;
+        }
+
+        /// <summary>
+        ///   Perform an <see href="https://ipfs.io/docs/api/">IPFS API command</see> returning 
+        ///   a specific <see cref="Type"/>.
+        /// </summary>
+        /// <typeparam name="T">
+        ///   The <see cref="Type"/> of object to return.
+        /// </typeparam>
+        /// <param name="command">
+        ///   The <see href="https://ipfs.io/docs/api/">IPFS API command</see>, such as
+        ///   <see href="https://ipfs.io/docs/api/#apiv0filels">"file/ls"</see>.
+        /// </param>
+        /// <param name="arg">
+        ///   The optional argument to the command.
+        /// </param>
+        /// <param name="options">
+        ///   The optional flags to the command.
+        /// </param>
+        /// <returns>
+        ///   A <typeparamref name="T"/>.
+        /// </returns>
+        /// <remarks>
+        ///   The command's response is converted to <typeparamref name="T"/> using
+        ///   <c>JsonConvert</c>.
+        /// </remarks>
+        public T DoCommand<T>(string command, string arg = null, params string[] options)
+        {
+            return DoCommandAsync<T>(command, arg, options).Result;
+        }
+
+        /// <summary>
+        ///  Perform an <see href="https://ipfs.io/docs/api/">IPFS API command</see> returning a
+        ///  <see cref="Stream"/>.
+        /// </summary>
+        /// <param name="command">
+        ///   The <see href="https://ipfs.io/docs/api/">IPFS API command</see>, such as
+        ///   <see href="https://ipfs.io/docs/api/#apiv0filels">"file/ls"</see>.
+        /// </param>
+        /// <param name="arg">
+        ///   The optional argument to the command.
+        /// </param>
+        /// <param name="options">
+        ///   The optional flags to the command.
+        /// </param>
+        /// <returns>
+        ///   A <see cref="Stream"/> containing the command's result.
+        /// </returns>
+        public Stream Download(string command, string arg = null, params string[] options)
+        {
+            return DownloadAsync(command, arg, options).Result;
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="response"></param>
+        /// <returns></returns>
+        /// <remarks>
+        ///   The API server returns an JSON error in the form <c>{ "Message": "...", "Code": ... }</c>.
+        /// </remarks>
+        async Task<bool> ThrowOnError(HttpResponseMessage response)
+        {
+            if (response.IsSuccessStatusCode)
+                return true; ;
+            if (response.StatusCode == HttpStatusCode.NotFound)
+                throw new IpfsException("Invalid command");
+
+            var body = await response.Content.ReadAsStringAsync();
+            if (log.IsDebugEnabled)
+                log.Debug("ERR " + body);
+            var message = (string)JsonConvert.DeserializeObject<dynamic>(body).Message;
+            throw new IpfsException(message);
+        }
+
     }
 }