refactor(nextcloud): separate webdav utils and models from the webdav/client library

Signed-off-by: Nikolas Rimikis <leptopoda@users.noreply.github.com>

Author: Leptopoda

packages/nextcloud/lib/src/webdav/client.dart

@@ -5,15 +5,14 @@ import 'dart:typed_data';
 import 'package:dynamite_runtime/http_client.dart';
 import 'package:http/http.dart' as http;
 import 'package:meta/meta.dart';
+import 'package:nextcloud/src/webdav/models.dart';
 import 'package:nextcloud/src/webdav/path_uri.dart';
 import 'package:nextcloud/src/webdav/props.dart';
+import 'package:nextcloud/src/webdav/utils.dart';
 import 'package:nextcloud/src/webdav/webdav.dart';
 import 'package:nextcloud/utils.dart';
 import 'package:universal_io/io.dart' hide HttpClient;
 
-/// Base path used on the server
-final webdavBase = PathUri.parse('/remote.php/webdav');
-
 // ignore: do_not_use_environment
 const bool _kIsWeb = bool.fromEnvironment('dart.library.js_util');
 
@@ -119,16 +118,6 @@ class WebDavClient {
 
   Uri _constructUri([PathUri? path]) => constructUri(rootClient.baseURL, path);
 
-  @visibleForTesting
-  // ignore: public_member_api_docs
-  static Uri constructUri(Uri baseURL, [PathUri? path]) {
-    final segments = baseURL.pathSegments.toList()..addAll(webdavBase.pathSegments);
-    if (path != null) {
-      segments.addAll(path.pathSegments);
-    }
-    return baseURL.replace(pathSegments: segments.where((s) => s.isNotEmpty));
-  }
-
   Future<WebDavMultistatus> _parseResponse(http.StreamedResponse response) async =>
       WebDavMultistatus.fromXmlElement(await response.stream.xml);
 
@@ -150,12 +139,7 @@ class WebDavClient {
       _constructUri(),
     );
 
-    final davCapabilities = response.headers['dav'];
-    final davSearchCapabilities = response.headers['dasl'];
-    return WebDavOptions(
-      davCapabilities?.split(',').map((e) => e.trim()).where((e) => e.isNotEmpty).toSet(),
-      davSearchCapabilities?.split(',').map((e) => e.trim()).where((e) => e.isNotEmpty).toSet(),
-    );
+    return parseWebDavOptions(response.headers);
   }
 
   /// Creates a collection at [path].
@@ -428,42 +412,3 @@ class WebDavClient {
         },
       );
 }
-
-/// WebDAV capabilities
-class WebDavOptions {
-  /// Creates a new WebDavStatus.
-  WebDavOptions(
-    Set<String>? capabilities,
-    Set<String>? searchCapabilities,
-  )   : capabilities = capabilities ?? {},
-        searchCapabilities = searchCapabilities ?? {};
-
-  /// DAV capabilities as advertised by the server in the 'dav' header.
-  Set<String> capabilities;
-
-  /// DAV search and locating capabilities as advertised by the server in the 'dasl' header.
-  Set<String> searchCapabilities;
-}
-
-/// Depth used for [WebDavClient.propfind].
-///
-/// See http://www.webdav.org/specs/rfc2518.html#HEADER_Depth for more information.
-enum WebDavDepth {
-  /// Returns props of the resource.
-  zero('0'),
-
-  /// Returns props of the resource and its immediate children.
-  ///
-  /// Only works on collections and returns the same as [WebDavDepth.zero] for other resources.
-  one('1'),
-
-  /// Returns props of the resource and all its progeny.
-  ///
-  /// Only works on collections and returns the same as [WebDavDepth.zero] for other resources.
-  infinity('infinity');
-
-  const WebDavDepth(this.value);
-
-  // ignore: public_member_api_docs
-  final String value;
-}

packages/nextcloud/lib/src/webdav/file.dart

@@ -1,8 +1,8 @@
 import 'package:nextcloud/src/utils/date_time.dart';
 import 'package:nextcloud/src/utils/http_date_parser.dart';
-import 'package:nextcloud/src/webdav/client.dart';
 import 'package:nextcloud/src/webdav/path_uri.dart';
 import 'package:nextcloud/src/webdav/props.dart';
+import 'package:nextcloud/src/webdav/utils.dart';
 import 'package:nextcloud/src/webdav/webdav.dart';
 import 'package:timezone/timezone.dart' as tz;
 

packages/nextcloud/lib/src/webdav/models.dart

@@ -0,0 +1,38 @@
+/// WebDAV capabilities.
+class WebDavOptions {
+  /// Creates a new WebDavStatus.
+  WebDavOptions(
+    Set<String>? capabilities,
+    Set<String>? searchCapabilities,
+  )   : capabilities = capabilities ?? {},
+        searchCapabilities = searchCapabilities ?? {};
+
+  /// DAV capabilities as advertised by the server in the 'dav' header.
+  Set<String> capabilities;
+
+  /// DAV search and locating capabilities as advertised by the server in the 'dasl' header.
+  Set<String> searchCapabilities;
+}
+
+/// Depth used for `propfind` requests.
+///
+/// See http://www.webdav.org/specs/rfc2518.html#HEADER_Depth for more information.
+enum WebDavDepth {
+  /// Returns props of the resource.
+  zero('0'),
+
+  /// Returns props of the resource and its immediate children.
+  ///
+  /// Only works on collections and returns the same as [WebDavDepth.zero] for other resources.
+  one('1'),
+
+  /// Returns props of the resource and all its progeny.
+  ///
+  /// Only works on collections and returns the same as [WebDavDepth.zero] for other resources.
+  infinity('infinity');
+
+  const WebDavDepth(this.value);
+
+  // ignore: public_member_api_docs
+  final String value;
+}

packages/nextcloud/lib/src/webdav/utils.dart

@@ -0,0 +1,27 @@
+import 'package:meta/meta.dart';
+import 'package:nextcloud/src/webdav/models.dart';
+import 'package:nextcloud/src/webdav/path_uri.dart';
+
+/// Base path used on the server
+final webdavBase = PathUri.parse('/remote.php/webdav');
+
+/// Parses the response headers from a `options` request.
+WebDavOptions parseWebDavOptions(Map<String, String> headers) {
+  final davCapabilities = headers['dav'];
+  final davSearchCapabilities = headers['dasl'];
+
+  return WebDavOptions(
+    davCapabilities?.split(',').map((e) => e.trim()).where((e) => e.isNotEmpty).toSet(),
+    davSearchCapabilities?.split(',').map((e) => e.trim()).where((e) => e.isNotEmpty).toSet(),
+  );
+}
+
+/// Constructs the uri for a webdav request for a given server [baseURL] and file [path].
+@internal
+Uri constructUri(Uri baseURL, [PathUri? path]) {
+  final segments = baseURL.pathSegments.toList()..addAll(webdavBase.pathSegments);
+  if (path != null) {
+    segments.addAll(path.pathSegments);
+  }
+  return baseURL.replace(pathSegments: segments.where((s) => s.isNotEmpty));
+}

packages/nextcloud/lib/webdav.dart

@@ -4,8 +4,10 @@ import 'package:nextcloud/src/webdav/client.dart';
 
 export 'src/webdav/client.dart' hide WebDavRequest;
 export 'src/webdav/file.dart';
+export 'src/webdav/models.dart';
 export 'src/webdav/path_uri.dart';
 export 'src/webdav/props.dart';
+export 'src/webdav/utils.dart' hide constructUri;
 export 'src/webdav/webdav.dart';
 
 // ignore: public_member_api_docs

packages/nextcloud/test/webdav_test.dart

@@ -6,6 +6,7 @@ import 'package:mocktail/mocktail.dart';
 import 'package:nextcloud/nextcloud.dart';
 import 'package:nextcloud/src/utils/date_time.dart';
 import 'package:nextcloud/src/utils/http_date_parser.dart';
+import 'package:nextcloud/src/webdav/utils.dart';
 import 'package:nextcloud_test/nextcloud_test.dart';
 import 'package:test/test.dart';
 import 'package:test_api/src/backend/invoker.dart';
@@ -29,27 +30,27 @@ void main() {
 
       test(baseURL, () {
         expect(
-          WebDavClient.constructUri(baseURL).toString(),
+          constructUri(baseURL).toString(),
           '$sanitizedBaseURL$webdavBase',
         );
         expect(
-          WebDavClient.constructUri(baseURL, PathUri.parse('/')).toString(),
+          constructUri(baseURL, PathUri.parse('/')).toString(),
           '$sanitizedBaseURL$webdavBase',
         );
         expect(
-          WebDavClient.constructUri(baseURL, PathUri.parse('test')).toString(),
+          constructUri(baseURL, PathUri.parse('test')).toString(),
           '$sanitizedBaseURL$webdavBase/test',
         );
         expect(
-          WebDavClient.constructUri(baseURL, PathUri.parse('test/')).toString(),
+          constructUri(baseURL, PathUri.parse('test/')).toString(),
           '$sanitizedBaseURL$webdavBase/test',
         );
         expect(
-          WebDavClient.constructUri(baseURL, PathUri.parse('/test')).toString(),
+          constructUri(baseURL, PathUri.parse('/test')).toString(),
           '$sanitizedBaseURL$webdavBase/test',
         );
         expect(
-          WebDavClient.constructUri(baseURL, PathUri.parse('/test/')).toString(),
+          constructUri(baseURL, PathUri.parse('/test/')).toString(),
           '$sanitizedBaseURL$webdavBase/test',
         );
       });