Merge pull request #57 from matteobortolazzo/dev

1.2.0

Author: matteobortolazzo

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.2.0 (2020-01-24)
+
+## Features
+* **Attachments:** Adds support for attachments. ([#PR56](https://github.com/matteobortolazzo/couchdb-net/pull/56))
+
 # 1.1.5 (2019-12-19)
 
 ## Bug Fixes

LATEST_CHANGE.md

@@ -1,2 +1,2 @@
-## Bug Fixes
-* **Database:** Fixing special characters escaping in databases names. ([#PR54](https://github.com/matteobortolazzo/couchdb-net/pull/54))
+## Features
+* **Attachments:** Adds support for attachments. ([#PR56](https://github.com/matteobortolazzo/couchdb-net/pull/56))

README.md

@@ -345,6 +345,37 @@ public class OtherRebel : Rebel
 public DateTime BirthDate { get; set; }
 ```
 
+## Attachments
+
+The driver fully support attachments, you can list, create, delete and download them.
+
+```csharp
+// Get a document
+var luke = new Rebel { Name = "Luke", Age = 19 };
+
+// Add in memory
+var pathToDocument = @".\luke.txt"
+luke.Attachments.AddOrUpdate(pathToDocument, MediaTypeNames.Text.Plain);
+
+// Delete in memory
+luke.Attachments.Delete("yoda.txt");
+
+// Save
+luke = await rebels.CreateOrUpdateAsync(luke);
+
+// Get
+CouchAttachment lukeTxt = luke.Attachments["luke.txt"];
+
+// Iterate
+foreach (CouchAttachment attachment in luke.Attachments)
+{ 
+  ...
+}
+
+// Download
+string downloadFilePath = await rebels.DownloadAttachment(attachment, downloadFolderPath, "luke-downloaded.txt");
+```
+
 ## Advanced
 
 If requests have to be modified before each call, it's possible to override OnBeforeCall.

src/CouchDB.Driver/CouchDB.Driver.csproj

@@ -15,7 +15,7 @@
     <OutputType>Library</OutputType>
     <StartupObject />
     <NeutralLanguage>en</NeutralLanguage>
-    <Version>1.1.0</Version>
+    <Version>1.2.0</Version>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

src/CouchDB.Driver/CouchDatabase.cs

@@ -8,6 +8,7 @@
 using Flurl.Http;
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using System.Linq.Expressions;
 using System.Net.Http;
@@ -25,7 +26,7 @@ public class CouchDatabase<TSource> where TSource : CouchDocument
         private readonly IFlurlClient _flurlClient;
         private readonly CouchSettings _settings;
         private readonly string _connectionString;
-        private string _database;
+        private readonly string _database;
 
         /// <summary>
         /// The database name.
@@ -228,10 +229,13 @@ public async Task<TSource> FindAsync(string docId, bool withConflicts = false)
                     request = request.SetQueryParam("conflicts", true);
                 }
 
-                return await request
+                TSource document = await request
                     .GetJsonAsync<TSource>()
                     .SendRequestAsync()
                     .ConfigureAwait(false);
+
+                InitAttachments(document);
+                return document;
             }
             catch (CouchNotFoundException)
             {
@@ -274,7 +278,14 @@ private async Task<List<TSource>> SendQueryAsync(Func<IFlurlRequest, Task<HttpRe
                 .SendRequestAsync()
                 .ConfigureAwait(false);
 
-            return findResult.Docs.ToList();
+            var documents = findResult.Docs.ToList();
+
+            foreach (TSource document in documents)
+            {
+                InitAttachments(document);
+            }
+
+            return documents;
         }
 
         /// Finds all documents with given IDs.
@@ -291,8 +302,29 @@ public async Task<List<TSource>> FindManyAsync(IEnumerable<string> docIds)
                 }).ReceiveJson<BulkGetResult<TSource>>()
                 .SendRequestAsync()
                 .ConfigureAwait(false);
+                       
+            var documents = bulkGetResult.Results
+                .SelectMany(r => r.Docs)
+                .Select(d => d.Item)
+                .ToList();
 
-            return bulkGetResult.Results.SelectMany(r => r.Docs).Select(d => d.Item).ToList();
+            foreach (TSource document in documents)
+            {
+                InitAttachments(document);
+            }
+
+            return documents;
+        }
+
+        private void InitAttachments(TSource document)
+        {
+            foreach (CouchAttachment attachment in document.Attachments)
+            {
+                attachment.DocumentId = document.Id;
+                attachment.DocumentRev = document.Rev;
+                var path = $"{_connectionString}/{_database}/{document.Id}/{Uri.EscapeUriString(attachment.Name)}";
+                attachment.Uri = new Uri(path);
+            }
         }
 
         #endregion
@@ -325,8 +357,11 @@ public async Task<TSource> CreateAsync(TSource document, bool batch = false)
                 .ReceiveJson<DocumentSaveResponse>()
                 .SendRequestAsync()
                 .ConfigureAwait(false);
-
             document.ProcessSaveResponse(response);
+
+            await UpdateAttachments(document)
+                .ConfigureAwait(false);
+
             return document;
         }
 
@@ -356,8 +391,11 @@ public async Task<TSource> CreateOrUpdateAsync(TSource document, bool batch = fa
                 .ReceiveJson<DocumentSaveResponse>()
                 .SendRequestAsync()
                 .ConfigureAwait(false);
-
             document.ProcessSaveResponse(response);
+
+            await UpdateAttachments(document)
+                .ConfigureAwait(false);
+
             return document;
         }
 
@@ -410,6 +448,9 @@ public async Task<IEnumerable<TSource>> CreateOrUpdateRangeAsync(IEnumerable<TSo
             foreach ((TSource document, DocumentSaveResponse saveResponse) in zipped)
             {
                 document.ProcessSaveResponse(saveResponse);
+
+                await UpdateAttachments(document)
+                    .ConfigureAwait(false);
             }
 
             return documents;
@@ -435,10 +476,76 @@ public async Task EnsureFullCommitAsync()
             }
         }
 
+        private async Task UpdateAttachments(TSource document)
+        {
+            foreach (CouchAttachment attachment in document.Attachments.GetAddedAttachments())
+            {
+                var stream = new StreamContent(
+                    new FileStream(attachment.FileInfo.FullName, FileMode.Open));
+
+                AttachmentResult response = await NewRequest()
+                    .AppendPathSegment(document.Id)
+                    .AppendPathSegment(Uri.EscapeUriString(attachment.Name))
+                    .WithHeader("Content-Type", attachment.ContentType)
+                    .WithHeader("If-Match", document.Rev)
+                    .PutAsync(stream)
+                    .ReceiveJson<AttachmentResult>()
+                    .ConfigureAwait(false);
+
+                if (response.Ok)
+                {
+                    document.Rev = response.Rev;
+                    attachment.FileInfo = null;
+                }
+            }
+
+            foreach (CouchAttachment attachment in document.Attachments.GetDeletedAttachments())
+            {
+                AttachmentResult response = await NewRequest()
+                    .AppendPathSegment(document.Id)
+                    .AppendPathSegment(attachment.Name)
+                    .WithHeader("If-Match", document.Rev)
+                    .DeleteAsync()
+                    .ReceiveJson<AttachmentResult>()
+                    .ConfigureAwait(false);
+
+                if (response.Ok)
+                {
+                    document.Rev = response.Rev;
+                    document.Attachments.RemoveAttachment(attachment);
+                }                
+            }
+
+            InitAttachments(document);
+        }
+
         #endregion
 
         #region Utils
 
+        /// <summary>
+        ///  Asynchronously downloads a specific attachment.
+        /// </summary>
+        /// <param name="attachment">The attachment to download.</param>
+        /// <param name="localFolderPath">Path of local folder where file is to be downloaded.</param>
+        /// <param name="localFileName">Name of local file. If not specified, the source filename (from Content-Dispostion header, or last segment of the URL) is used.</param>
+        /// <param name="bufferSize">Buffer size in bytes. Default is 4096.</param>
+        /// <returns>The path of the downloaded file.</returns>
+        public async Task<string> DownloadAttachment(CouchAttachment attachment, string localFolderPath, string localFileName = null, int bufferSize = 4096)
+        {
+            if (attachment.Uri == null)
+            {
+                throw new InvalidOperationException("The attachment is not uploaded yet.");
+            }
+
+            return await NewRequest()
+                .AppendPathSegment(attachment.DocumentId)
+                .AppendPathSegment(Uri.EscapeUriString(attachment.Name))
+                .WithHeader("If-Match", attachment.DocumentRev)
+                .DownloadFileAsync(localFolderPath, localFileName, bufferSize)
+                .ConfigureAwait(false); 
+        }
+
         /// <summary>
         /// Requests compaction of the specified database.
         /// </summary>

src/CouchDB.Driver/DTOs/AttachmentResult.cs

@@ -0,0 +1,14 @@
+using Newtonsoft.Json;
+
+namespace CouchDB.Driver.DTOs
+{
+    public class AttachmentResult
+    {
+        [JsonProperty("id")]
+        public string Id { get; set; }
+        [JsonProperty("ok")]
+        public bool Ok { get; set; }
+        [JsonProperty("rev")]
+        public string Rev { get; set; }
+    }
+}

src/CouchDB.Driver/Extensions/CouchDocumentExtensions.cs

@@ -0,0 +1,20 @@
+using CouchDB.Driver.DTOs;
+using CouchDB.Driver.Exceptions;
+using CouchDB.Driver.Types;
+
+namespace CouchDB.Driver.Extensions
+{
+    internal static class CouchDocumentExtensions
+    {
+        public static void ProcessSaveResponse(this CouchDocument item, DocumentSaveResponse response)
+        {
+            if (!response.Ok)
+            {
+                throw new CouchException(response.Error, response.Reason);
+            }
+
+            item.Id = response.Id;
+            item.Rev = response.Rev;
+        }
+    }
+}

src/CouchDB.Driver/Types/CouchAttachment.cs

@@ -0,0 +1,40 @@
+using System;
+using System.IO;
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+
+namespace CouchDB.Driver.Types
+{
+    public class CouchAttachment
+    {
+        [JsonIgnore]
+        internal string DocumentId { get; set; }
+
+        [JsonIgnore]
+        internal string DocumentRev { get; set; }
+
+        [JsonIgnore]
+        internal FileInfo FileInfo { get; set; }
+
+        [JsonIgnore]
+        internal bool Deleted { get; set; }
+
+        [JsonIgnore]
+        public string Name { get; internal set; }
+
+        [JsonIgnore]
+        public Uri Uri { get; internal set; }
+
+        [DataMember]
+        [JsonProperty("content_type")]
+        public string ContentType { get; set; }
+
+        [DataMember]
+        [JsonProperty("digest")]
+        public string Digest { get; private set; }
+
+        [DataMember]
+        [JsonProperty("length")]
+        public int? Length { get; private set; }
+    }
+}