List visits

Author: virtualmarc

CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 0.4.0
 
--
+- List visits
 
 ## 0.3.0
 

lib/shlink.dart

@@ -4,3 +4,6 @@ export 'src/shlink_base.dart';
 export 'src/shlink_exception.dart';
 export 'src/dto/create_short_url.dart';
 export 'src/dto/short_url.dart';
+export 'src/dto/meta.dart';
+export 'src/dto/visit.dart';
+export 'src/enums/order_field.dart';

lib/src/dto/visit.dart

@@ -0,0 +1,55 @@
+import 'package:shlink/shlink.dart';
+
+class Visit {
+  final String referer;
+  final DateTime date;
+  final String userAgent;
+  final VisitLocation visitLocation;
+
+  Visit._(this.referer, this.date, this.userAgent, this.visitLocation);
+
+  factory Visit.fromJson(Map mJson) {
+    String referer = mJson['referer'];
+    DateTime date = DateTime.parse(mJson['date']);
+    String userAgent = mJson['userAgent'];
+    VisitLocation visitLocation;
+
+    if (mJson.containsKey('visitLocation') && mJson['visitLocation'] != null) {
+      visitLocation = VisitLocation.fromJson(mJson['visitLocation']);
+    }
+
+    return Visit._(referer, date, userAgent, visitLocation);
+  }
+
+  @override
+  String toString() =>
+      'Visit{referer=$referer;date=$date;userAgent=$userAgent;visitLocation=$visitLocation}';
+}
+
+class VisitLocation {
+  final String cityName;
+  final String countryCode;
+  final String countryName;
+  final String latitude;
+  final String longitude;
+  final String regionName;
+  final String timezone;
+
+  VisitLocation._(this.cityName, this.countryCode, this.countryName,
+      this.latitude, this.longitude, this.regionName, this.timezone);
+
+  factory VisitLocation.fromJson(Map mJson) {
+    return VisitLocation._(
+        mJson['cityName'],
+        mJson['countryCode'],
+        mJson['countryName'],
+        mJson['latitude'],
+        mJson['longitude'],
+        mJson['regionName'],
+        mJson['timezone']);
+  }
+
+  @override
+  String toString() =>
+      'VisitLocation{cityName=$cityName;countryCode=$countryCode;countryName=$countryName;latitude=$latitude;longitude=$longitude;regionName=$regionName;timezone=$timezone}';
+}

lib/src/shlink_base.dart

@@ -5,6 +5,7 @@ import 'shlink_exception.dart';
 import 'dto/create_short_url.dart';
 import 'dto/meta.dart';
 import 'dto/short_url.dart';
+import 'dto/visit.dart';
 import 'enums/order_field.dart';
 import 'extension/datetime.dart';
 
@@ -212,9 +213,7 @@ class Shlink {
     Map<String, dynamic> mShortUrls = mJson['shortUrls'];
 
     List<dynamic> lstData = mShortUrls['data'];
-    for (dynamic data in lstData) {
-      lstShortUrls.add(ShortUrl.fromJson(data));
-    }
+    lstShortUrls.addAll(lstData.map((u) => ShortUrl.fromJson(u)).toList());
 
     Map<String, dynamic> mPagination = mShortUrls['pagination'];
     if (mPagination['pagesCount'] > mPagination['currentPage']) {
@@ -334,4 +333,64 @@ class Shlink {
     String sBody = await utf8.decoder.bind(response).single;
     throw ShlinkException.fromJson(response.statusCode, sBody);
   }
+
+  /// List the visits of [shortCode] within [startDate] and [endDate]
+  Future<List<Visit>> listVisits(String shortCode,
+      {DateTime startDate, DateTime endDate}) async {
+    return _listVisits(1, shortCode, startDate, endDate);
+  }
+
+  /// Internal visit list method
+  Future<List<Visit>> _listVisits(
+      int iPage, String shortCode, DateTime startDate, DateTime endDate) async {
+    String sUrl = '$_url$_API_PATH/short-urls/${shortCode}/visits?page=$iPage';
+
+    if (_domain != null && _domain.isNotEmpty) {
+      sUrl += '&domain=$_domain';
+    }
+
+    // Start Date
+    if (startDate != null) {
+      sUrl +=
+          '&startDate=${Uri.encodeQueryComponent(startDate.toIso8601StringShlink())}';
+    }
+
+    // End Date
+    if (endDate != null) {
+      sUrl +=
+          '&endDate=${Uri.encodeQueryComponent(endDate.toIso8601StringShlink())}';
+    }
+
+    List<Visit> lstVisits = <Visit>[];
+
+    HttpClientRequest request = await HttpClient().getUrl(Uri.parse(sUrl))
+      ..headers.contentType = ContentType.json
+      ..headers.set(_HEADER_API_KEY, _apiKey);
+
+    HttpClientResponse response = await request.close();
+
+    if (response.statusCode == 404) {
+      return null;
+    }
+
+    String sBody = await utf8.decoder.bind(response).single;
+
+    if (response.statusCode != 200) {
+      throw ShlinkException.fromJson(response.statusCode, sBody);
+    }
+
+    Map<String, dynamic> mJson = jsonDecode(sBody);
+    Map<String, dynamic> mVisits = mJson['visits'];
+
+    List<dynamic> lstVisitsJson = mVisits['data'];
+    lstVisits.addAll(lstVisitsJson.map((v) => Visit.fromJson(v)).toList());
+
+    Map<String, dynamic> mPagination = mVisits['pagination'];
+    if (mPagination['pagesCount'] > mPagination['currentPage']) {
+      lstVisitsJson
+          .addAll(await _listVisits(iPage + 1, shortCode, startDate, endDate));
+    }
+
+    return lstVisits;
+  }
 }