Merge pull request #54 from matteobortolazzo/dev

Bug fix: Escape special character in database names.

Author: matteobortolazzo

.gitignore

@@ -328,3 +328,6 @@ ASALocalRun/
 
 # MFractors (Xamarin productivity tool) working folder 
 .mfractor/
+
+# VsCode
+.vscode

CHANGELOG.md

@@ -1,4 +1,13 @@
-# 1.1.3 (2019-06-14)
+# 1.1.5 (2019-12-19)
+
+## Bug Fixes
+* **Database:** Fixing special characters escaping in databases names. ([#PR54](https://github.com/matteobortolazzo/couchdb-net/pull/54))
+
+# 1.1.4 (2019-08-19)
+## Bug Fixes
+* **Queries:** Fixing enums serialized as string instead of int bug. ([#PR49](https://github.com/matteobortolazzo/couchdb-net/pull/49))
+
+# 1.1.3 (2019-06-14)
 
 ## Bug Fixes
 * **Exception:** Fixing null reference exception and poor exception handling. ([#PR45](https://github.com/matteobortolazzo/couchdb-net/pull/45))

LATEST_CHANGE.md

@@ -1,2 +1,2 @@
 ## Bug Fixes
-* **Exception:** Fixing null reference exception and poor exception handling. ([#PR45](https://github.com/matteobortolazzo/couchdb-net/pull/45))
+* **Database:** Fixing special characters escaping in databases names. ([#PR54](https://github.com/matteobortolazzo/couchdb-net/pull/54))

README.md

@@ -92,9 +92,9 @@ The produced Mango JSON:
 ## Getting started
 
 * Install it from NuGet: [https://www.nuget.org/packages/CouchDB.NET](https://www.nuget.org/packages/CouchDB.NET)
-* Create a client:
+* Create a client, where localhost will be the IP address and 5984 is CouchDB standard tcp port:
     ```csharp
-   using(var client = new CouchClient("http://localhost")) { }
+   using(var client = new CouchClient("http://localhost:5984")) { }
    ```
 * Create a document class:
     ```csharp
@@ -255,23 +255,23 @@ If authentication is needed currently there are two ways: Basic and Cookie authe
 ### Basic authentication
 
 ```csharp
-var client = new CouchClient("http://localhost", s => 
+var client = new CouchClient("http://localhost:5984", s => 
     s.UseBasicAuthentication("root", "relax")
 )
 ```
 
 ### Cookie authentication
 
 ```csharp
-var client = new CouchClient("http://localhost", s => s
+var client = new CouchClient("http://localhost:5984", s => s
     .UseCookieAuthentication("root", "relax")
 )
 ```
 
 It's also possible to specify the duration of the session.
 
 ```csharp
-var client = new CouchClient("http://localhost", s => s
+var client = new CouchClient("http://localhost:5984", s => s
     .UseCookieAuthentication("root", "relax", cookieDuration)
 )
 ```
@@ -281,7 +281,7 @@ var client = new CouchClient("http://localhost", s => s
 The second parameter of the client constructor is a function to configure CouchSettings fluently.
 
 ```csharp
-var client = new CouchClient("http://localhost", s => s
+var client = new CouchClient("http://localhost:5984", s => s
     .UseBasicAuthentication("root", "relax")
     .DisableEntitisPluralization()
     ....
@@ -360,4 +360,4 @@ Action<ClientFlurlHttpSettings> flurlConfigFunc
 
 ## Contributors
 
-Thanks to [Ben Origas](https://github.com/borigas) for features, ideas and tests like SSL custom validation, multi queryable, async deadlock, cookie authenication and many others.
+Thanks to [Ben Origas](https://github.com/borigas) for features, ideas and tests like SSL custom validation, multi queryable, async deadlock, cookie authenication and many others.

src/CouchDB.Driver/CouchClient.cs

@@ -66,18 +66,15 @@ public CouchClient(string connectionString, Action<CouchSettings> couchSettingsF
         #region CRUD
 
         /// <summary>
-        /// Returns an instance of the CouchDB database with the given name. 
+        /// Returns an instance of the CouchDB database with the given name.
         /// If EnsureDatabaseExists is configured, it creates the database if it doesn't exists.
         /// </summary>
         /// <typeparam name="TSource">The type of database documents.</typeparam>
         /// <param name="database">The database name.</param>
         /// <returns>An instance of the CouchDB database with given name.</returns>
         public CouchDatabase<TSource> GetDatabase<TSource>(string database) where TSource : CouchDocument
         {
-            if (database == null)
-            {
-                throw new ArgumentNullException(nameof(database));
-            }
+            database = EscapeDatabaseName(database);
 
             if (_settings.CheckDatabaseExists)
             {
@@ -102,15 +99,7 @@ public CouchDatabase<TSource> GetDatabase<TSource>(string database) where TSourc
         /// <returns>A task that represents the asynchronous operation. The task result contains the newly created CouchDB database.</returns>
         public async Task<CouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string database, int? shards = null, int? replicas = null) where TSource : CouchDocument
         {
-            if (database == null)
-            {
-                throw new ArgumentNullException(nameof(database));
-            }
-
-            if (!_systemDatabases.Contains(database) && !new Regex(@"^[a-z][a-z0-9_$()+/-]*$").IsMatch(database))
-            {
-                throw new ArgumentException($"Name {database} contains invalid characters. Please visit: https://docs.couchdb.org/en/stable/api/database/common.html#put--db", nameof(database));
-            }
+            database = EscapeDatabaseName(database);
 
             IFlurlRequest request = NewRequest()
                 .AppendPathSegment(database);
@@ -119,6 +108,7 @@ public async Task<CouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string da
             {
                 request = request.SetQueryParam("q", shards.Value);
             }
+
             if (replicas.HasValue)
             {
                 request = request.SetQueryParam("n", replicas.Value);
@@ -146,10 +136,7 @@ public async Task<CouchDatabase<TSource>> CreateDatabaseAsync<TSource>(string da
         /// <returns>A task that represents the asynchronous operation.</returns>
         public async Task DeleteDatabaseAsync<TSource>(string database) where TSource : CouchDocument
         {
-            if (database == null)
-            {
-                throw new ArgumentNullException(nameof(database));
-            }
+            database = EscapeDatabaseName(database);
 
             OperationResult result = await NewRequest()
                 .AppendPathSegment(database)
@@ -158,7 +145,8 @@ public async Task DeleteDatabaseAsync<TSource>(string database) where TSource :
                 .SendRequestAsync()
                 .ConfigureAwait(false);
 
-            if (!result.Ok) {
+            if (!result.Ok) 
+            {
                 throw new CouchException("Something went wrong during the delete.", "S");
             }
         }
@@ -168,7 +156,7 @@ public async Task DeleteDatabaseAsync<TSource>(string database) where TSource :
         #region CRUD reflection
 
         /// <summary>
-        /// Returns an instance of the CouchDB database of the given type. 
+        /// Returns an instance of the CouchDB database of the given type.
         /// If EnsureDatabaseExists is configured, it creates the database if it doesn't exists.
         /// </summary>
         /// <typeparam name="TSource">The type of database documents.</typeparam>
@@ -179,7 +167,7 @@ public CouchDatabase<TSource> GetDatabase<TSource>() where TSource : CouchDocume
         }
 
         /// <summary>
-        /// Creates a new database of the given type in the server. 
+        /// Creates a new database of the given type in the server.
         /// The name must begin with a lowercase letter and can contains only lowercase characters, digits or _, $, (, ), +, - and /.s
         /// </summary>
         /// <typeparam name="TSource">The type of database documents.</typeparam>
@@ -235,7 +223,7 @@ public CouchDatabase<TUser> GetUsersDatabase<TUser>() where TUser : CouchUser
         #region Utils
 
         /// <summary>
-        /// Determines whether the server is up, running, and ready to respond to requests. 
+        /// Determines whether the server is up, running, and ready to respond to requests.
         /// </summary>
         /// <returns>true is the server is not in maintenance_mode; otherwise, false.</returns>
         public async Task<bool> IsUpAsync()
@@ -249,7 +237,7 @@ public async Task<bool> IsUpAsync()
                     .ConfigureAwait(false);
                 return result.Status == "ok";
             }
-            catch(CouchNotFoundException)
+            catch (CouchNotFoundException)
             {
                 return false;
             }
@@ -292,6 +280,21 @@ private IFlurlRequest NewRequest()
             return _flurlClient.Request(ConnectionString);
         }
 
+        private string EscapeDatabaseName(string database)
+        {
+            if (database == null)
+            {
+                throw new ArgumentNullException(nameof(database));
+            }
+
+            if (!_systemDatabases.Contains(database) && !new Regex(@"^[a-z][a-z0-9_$()+/-]*$").IsMatch(database))
+            {
+                throw new ArgumentException($"Name {database} contains invalid characters. Please visit: https://docs.couchdb.org/en/stable/api/database/common.html#put--db", nameof(database));
+            }
+
+            return Uri.EscapeDataString(database);
+        }
+
         /// <summary>
         /// Performs the logout and disposes the HTTP client.
         /// </summary>
@@ -305,7 +308,7 @@ protected virtual void Dispose(bool disposing)
         {
             if (_settings.AuthenticationType == AuthenticationType.Cookie && _settings.LogOutOnDispose)
             {
-                AsyncContext.Run(() => LogoutAsync().ConfigureAwait(false));
+                _ = AsyncContext.Run(() => LogoutAsync().ConfigureAwait(false));
             }
             _flurlClient.Dispose();
         }

src/CouchDB.Driver/CouchDatabase.cs

@@ -25,6 +25,7 @@ public class CouchDatabase<TSource> where TSource : CouchDocument
         private readonly IFlurlClient _flurlClient;
         private readonly CouchSettings _settings;
         private readonly string _connectionString;
+        private string _database;
 
         /// <summary>
         /// The database name.
@@ -41,9 +42,10 @@ internal CouchDatabase(IFlurlClient flurlClient, CouchSettings settings, string
             _flurlClient = flurlClient ?? throw new ArgumentNullException(nameof(flurlClient));
             _settings = settings ?? throw new ArgumentNullException(nameof(settings));
             _connectionString = connectionString ?? throw new ArgumentNullException(nameof(connectionString));
-            Database = db ?? throw new ArgumentNullException(nameof(db));
-            _queryProvider = new CouchQueryProvider(flurlClient, _settings, connectionString, Database);
+            _database = db ?? throw new ArgumentNullException(nameof(db));
+            _queryProvider = new CouchQueryProvider(flurlClient, _settings, connectionString, _database);
 
+            Database = Uri.UnescapeDataString(_database);
             Security = new CouchSecurity(NewRequest);
         }
 
@@ -274,7 +276,7 @@ private async Task<List<TSource>> SendQueryAsync(Func<IFlurlRequest, Task<HttpRe
 
             return findResult.Docs.ToList();
         }
-        
+
         /// Finds all documents with given IDs.
         /// </summary>
         /// <param name="docIds">The collection of documents IDs.</param>
@@ -487,7 +489,7 @@ public override string ToString()
 
         private IFlurlRequest NewRequest()
         {
-            return _flurlClient.Request(_connectionString).AppendPathSegment(Database);
+            return _flurlClient.Request(_connectionString).AppendPathSegment(_database);
         }
 
         #endregion

src/CouchDB.Driver/CouchQueryProvider.cs

@@ -142,7 +142,7 @@ private object InvokeUnsupportedMethodCallExpression(object result, MethodCallEx
             MethodInfo queryableMethodInfo = methodCallExpression.Method;
             Expression[] queryableMethodArguments = methodCallExpression.Arguments.ToArray();
 
-            // Since Max and Min are not map 1 to 1 from Queryable to Enumerable 
+            // Since Max and Min are not map 1 to 1 from Queryable to Enumerable
             // they need to be handled differently
             MethodInfo FindEnumerableMethod()
             {

src/CouchDB.Driver/QueryTranslator.cs

@@ -6,7 +6,7 @@
 
 #pragma warning disable IDE0058 // Expression value is never used
 namespace CouchDB.Driver
-{    
+{
     internal partial class QueryTranslator : ExpressionVisitor
     {
         private readonly CouchSettings _settings;

tests/CouchDB.Driver.E2ETests/Client_Tests.cs

@@ -43,6 +43,42 @@ public async Task Crud()
                 await client.DeleteDatabaseAsync<Rebel>().ConfigureAwait(false);
             }
         }
+
+        [Fact]
+        public async Task Crud_SpecialCharacters()
+        {
+            var databaseName = "rebel0_$()+/-";
+
+            using (var client = new CouchClient("http://localhost:5984"))
+            {
+                IEnumerable<string> dbs = await client.GetDatabasesNamesAsync().ConfigureAwait(false);
+                CouchDatabase<Rebel> rebels = client.GetDatabase<Rebel>(databaseName);
+
+                if (dbs.Contains(rebels.Database))
+                {
+                    await client.DeleteDatabaseAsync<Rebel>(databaseName).ConfigureAwait(false);
+                }
+
+                rebels = await client.CreateDatabaseAsync<Rebel>(databaseName).ConfigureAwait(false);
+
+                Rebel luke = await rebels.CreateAsync(new Rebel { Name = "Luke", Age = 19 }).ConfigureAwait(false);
+                Assert.Equal("Luke", luke.Name);
+
+                luke.Surname = "Skywalker";
+                luke = await rebels.CreateOrUpdateAsync(luke).ConfigureAwait(false);
+                Assert.Equal("Skywalker", luke.Surname);
+
+                luke = await rebels.FindAsync(luke.Id).ConfigureAwait(false);
+                Assert.Equal(19, luke.Age);
+
+                await rebels.DeleteAsync(luke).ConfigureAwait(false);
+                luke = await rebels.FindAsync(luke.Id).ConfigureAwait(false);
+                Assert.Null(luke);
+
+                await client.DeleteDatabaseAsync<Rebel>(databaseName).ConfigureAwait(false);
+            }
+        }
+
         [Fact]
         public async Task Users()
         {