Expose headers method & Add qualifiedVersion to headers

Author: brunoocasali

lib/src/http_request.dart

@@ -14,6 +14,9 @@ abstract class HttpRequest {
   /// Timeout in milliseconds for opening a url.
   int? get connectTimeout;
 
+  /// Retrieve all headers used when Http calls are made.
+  Map<String, dynamic> headers();
+
   /// GET method
   Future<Response<T>> getMethod<T>(
     String path, {

lib/src/http_request_impl.dart

@@ -1,4 +1,5 @@
 import 'package:dio/dio.dart';
+import 'package:meilisearch/src/version.dart';
 import 'http_request.dart';
 import 'exception.dart';
 
@@ -9,6 +10,7 @@ class HttpRequestImpl implements HttpRequest {
           headers: <String, dynamic>{
             if (apiKey != null) 'X-Meili-API-Key': apiKey,
             'Content-Type': 'application/json',
+            'User-Agent': Version.qualifiedVersion,
           },
           responseType: ResponseType.json,
           connectTimeout: connectTimeout ?? 0,
@@ -25,6 +27,11 @@ class HttpRequestImpl implements HttpRequest {
 
   final Dio dio;
 
+  @override
+  Map<String, dynamic> headers() {
+    return this.dio.options.headers;
+  }
+
   @override
   Future<Response<T>> getMethod<T>(
     String path, {

pubspec.yaml

@@ -11,3 +11,6 @@ dependencies:
 
 dev_dependencies:
   test: ^1.0.0
+
+assets:
+  - pubspec.yaml

test/analytics_test.dart

@@ -0,0 +1,52 @@
+import 'dart:io';
+
+import 'package:meilisearch/src/version.dart';
+import 'package:test/test.dart';
+
+import 'utils/client.dart';
+
+void main() {
+  group('Version', () {
+    test('extracts current version from yaml', () {
+      final path = '${Directory.current.path}/test/fixtures/fake_spec.yaml';
+
+      final version = Version.current(path);
+
+      expect(version, equals('0.9.1'));
+    });
+
+    test("responds with invalid when can't read file", () {
+      final path = '${Directory.current.path}/test/fixtures/invalid_spec.yaml';
+
+      final version = Version.current(path);
+
+      expect(version, equals('invalid'));
+    });
+
+    test('gets current package version', () {
+      final path = '${Directory.current.path}/pubspec.yaml';
+      String pubspec = new File(path).readAsStringSync();
+
+      final version = Version.current(path);
+
+      expect(pubspec, contains(version));
+    });
+  });
+
+  group('Analytics', () {
+    setUpClient();
+
+    test('sends the User-Agent header in every call', () {
+      final headers = client.http.headers();
+
+      expect(headers.keys, contains('User-Agent'));
+      expect(headers['User-Agent'], isNotNull);
+    });
+
+    test('has current version from pubspec.yaml', () {
+      final headers = client.http.headers();
+
+      expect(headers['User-Agent'], equals(Version.qualifiedVersion));
+    });
+  });
+}

test/fixtures/fake_spec.yaml

@@ -0,0 +1,16 @@
+name: meilisearch
+description: MeiliSearch Dart is the MeiliSearch API client for Dart and Flutter developers.
+version: 0.9.1
+homepage: https://github.com/meilisearch/meilisearch-dart
+
+environment:
+  sdk: ">=2.12.0 <3.0.0"
+
+dependencies:
+  dio: ^4.0.0
+
+dev_dependencies:
+  test: ^1.0.0
+
+assets:
+  - pubspec.yaml

test/fixtures/invalid_spec.yaml

@@ -0,0 +1,16 @@
+name: meilisearch
+description: MeiliSearch Dart is the MeiliSearch API client for Dart and Flutter developers.
+version: invalid-0.version.1
+homepage: https://github.com/meilisearch/meilisearch-dart
+
+environment:
+  sdk: ">=2.12.0 <3.0.0"
+
+dependencies:
+  dio: ^4.0.0
+
+dev_dependencies:
+  test: ^1.0.0
+
+assets:
+  - pubspec.yaml