Merge pull request #33 from matteobortolazzo/BulkGet

Bulk Get API

Author: matteobortolazzo

README.md

@@ -205,6 +205,7 @@ await rebels.CreateOrUpdateAsync(rebel);
 await rebels.DeleteAsync(rebel);
 var rebel = await rebels.FindAsync(id);
 var rebel = await rebels.FindAsync(id, withConflicts: true);
+var rebels = await rebels.FindManyAsync(ids);
 // Bulk
 await rebels.CreateOrUpdateRangeAsync(moreRebels);
 // Utils

src/CouchDB.Driver/CouchDatabase.cs

@@ -236,6 +236,25 @@ public async Task<TSource> FindAsync(string docId, bool withConflicts = false)
             }
         }
 
+        /// <summary>
+        /// Finds all documents with given IDs.
+        /// </summary>
+        /// <param name="docIds">The collection of documents IDs.</param>
+        /// <returns></returns>
+        public async Task<List<TSource>> FindManyAsync(IEnumerable<string> docIds)
+        {
+            var bulkGetResult = await NewRequest()
+                .AppendPathSegment("_bulk_get")
+                .PostJsonAsync(new
+                {
+                    docs = docIds.Select(id => new { id })
+                }).ReceiveJson<BulkGetResult<TSource>>()
+                .SendRequestAsync()
+                .ConfigureAwait(false);
+
+            return bulkGetResult.Results.SelectMany(r => r.Docs).Select(d => d.Item).ToList();
+        }
+
         #endregion
 
         #region Writing
@@ -345,7 +364,7 @@ public async Task<IEnumerable<TSource>> CreateOrUpdateRangeAsync(IEnumerable<TSo
                 .SendRequestAsync()
                 .ConfigureAwait(false);
 
-            IEnumerable<(TSource Document, DocumentSaveResponse SaveResponse)> zipped = 
+            IEnumerable<(TSource Document, DocumentSaveResponse SaveResponse)> zipped =
                 documents.Zip(response, (doc, saveResponse) => (Document: doc, SaveResponse: saveResponse));
 
             foreach ((TSource document, DocumentSaveResponse saveResponse) in zipped)

src/CouchDB.Driver/DTOs/BulkGetResult.cs

@@ -0,0 +1,30 @@
+using CouchDB.Driver.Types;
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace CouchDB.Driver.DTOs
+{
+#pragma warning disable CA1812 // Avoid uninstantiated internal classes
+    internal class BulkGetResult<TSource> where TSource : CouchDocument
+    {
+        [JsonProperty("results")]
+        public List<BulkGetResultDoc<TSource>> Results { get; set; }
+    }
+
+    internal class BulkGetResultDoc<TSource> where TSource : CouchDocument
+    {
+        [JsonProperty("docs")]
+        public List<BulkGetResultItem<TSource>> Docs { get; set; }
+    }
+
+    internal class BulkGetResultItem<TSource> where TSource : CouchDocument
+    {
+        [JsonProperty("ok")]
+        public TSource Item { get; set; }
+    }
+#pragma warning restore CA1812 // Avoid uninstantiated internal classes
+}

src/CouchDB.Driver/Helpers/MicrosecondEpochConverter.cs

@@ -8,17 +8,17 @@ namespace CouchDB.Driver.Helpers
     internal class MicrosecondEpochConverter : DateTimeConverterBase
 #pragma warning restore CA1812 // Avoid uninstantiated internal classes
     {
-        private static readonly DateTime Epoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
+        private static readonly DateTime _epoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
 
         public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
         {
-            writer.WriteRawValue(((DateTime)value - Epoch).TotalMilliseconds + "000");
+            writer.WriteRawValue(((DateTime)value - _epoch).TotalMilliseconds + "000");
         }
 
         public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
         {
             if (reader.Value == null) { return null; }
-            return Epoch.AddMilliseconds((long)reader.Value / 1000d);
+            return _epoch.AddMilliseconds((long)reader.Value / 1000d);
         }
     }
 }

tests/CouchDB.Driver.UnitTests/Database_Tests.cs

@@ -49,6 +49,31 @@ public async Task FindWithConflicts()
             }
         }
         [Fact]
+        public async Task FindMany()
+        {
+            using (var httpTest = new HttpTest())
+            {
+                httpTest.RespondWith(@"{""results"":[{""id"":""1"",""docs"":[{""ok"":{""_id"":""1"",""Name"":""Luke""}}]},{""id"":""2"",""docs"":[{""ok"":{""_id"":""2"",""Name"":""Leia""}}]}]}");
+                var ids = new string[] { "1", "2" };
+                var result = await _rebels.FindManyAsync(ids);
+                httpTest
+                    .ShouldHaveCalled("http://localhost/rebels/_bulk_get")
+                    .WithRequestJson(new
+                    {
+                        docs = new[]
+                        {
+                            new { id = "1" },
+                            new { id = "2" },
+                        }
+                    })
+                    .WithVerb(HttpMethod.Post);
+
+                Assert.Equal(2, result.Count);
+                Assert.Equal("Luke", result[0].Name);
+                Assert.Equal("Leia", result[1].Name);
+            }
+        }
+        [Fact]
         public async Task Create()
         {
             using (var httpTest = new HttpTest())