create models for first request

Author: felix-barz-brickmakers

.gitignore

@@ -20,5 +20,6 @@ doc/api/
 *.js.deps
 *.js.map
 
-# Generated files 
-*.chopper.dart
+# Generated files
+*.chopper.dart
+*.freezed.dart

analysis_options.yaml

@@ -7,6 +7,7 @@ include: package:lint/analysis_options_package.yaml
 # rules:
 # - camel_case_types
 
-# analyzer:
-# exclude:
-# - path/to/excluded/files/**
+analyzer:
+ exclude:
+ - '**/*.chopper.dart'
+ - '**/*.freezed.dart'

example/aha_client_example.dart

@@ -1 +1,31 @@
-void main() {}
+import 'dart:io';
+
+import 'package:aha_client/src/api/aha_client.dart';
+
+class _AhaClientHttpOverrides extends HttpOverrides {
+ final String _host;
+ final int _port;
+
+ _AhaClientHttpOverrides(this._host, this._port);
+
+ @override
+ HttpClient createHttpClient(SecurityContext? context) {
+ return super.createHttpClient(context)
+ ..badCertificateCallback =
+ (X509Certificate cert, String host, int port) =>
+ host == _host && port == _port;
+ }
+}
+
+Future<void> main() async {
+ HttpOverrides.global =
+ _AhaClientHttpOverrides(AhaClient.defaultHostName, 443);
+
+ final client = AhaClient();
+
+ final response = await client.login.getLoginStatus();
+
+ print(response.body);
+
+ client.dispose();
+}

lib/src/api/aha_client.dart

@@ -1,7 +1,9 @@
 import 'package:aha_client/src/api/login_service.dart';
+import 'package:aha_client/src/api/models/session_info.dart';
+import 'package:aha_client/src/api/xml_typed_converter.dart';
 import 'package:chopper/chopper.dart';
 
-abstract class AhaClient {
+class AhaClient {
  static const defaultHostName = 'fritz.box';
 
  final ChopperClient _client;
@@ -15,8 +17,14 @@ abstract class AhaClient {
  host: hostName,
  port: port,
  ).toString(),
+ converter: XmlTypedConverter()
+ ..registerConverter<SessionInfo>(SessionInfo.converter),
  services: [
  LoginService.create(),
  ],
  );
+
+ void dispose() => _client.dispose();
+
+ LoginService get login => _client.getService();
 }

lib/src/api/login_service.dart

@@ -1,3 +1,4 @@
+import 'package:aha_client/src/api/models/session_info.dart';
 import 'package:chopper/chopper.dart';
 
 part 'login_service.chopper.dart';
@@ -7,5 +8,5 @@ abstract class LoginService extends ChopperService {
  static LoginService create([ChopperClient? client]) => _$LoginService(client);
 
  @Get()
- Future<Response> getLoginStatus();
+ Future<Response<SessionInfo>> getLoginStatus();
 }

lib/src/api/models/session_info.dart

@@ -0,0 +1,66 @@
+import 'package:aha_client/src/api/xml_typed_converter.dart';
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:xml/xml.dart';
+
+import 'user.dart';
+
+part 'session_info.freezed.dart';
+
+@freezed
+class SessionInfo with _$SessionInfo {
+ static const invalidSid = '0000000000000000';
+
+ static const converter = _SessionInfoTypeConverter();
+
+ const SessionInfo._();
+
+ const factory SessionInfo({
+ required String sid,
+ required String challange,
+ required int blockTime,
+ required List<User> users,
+ }) = _SessionInfo;
+
+ factory SessionInfo.fromXml(XmlElement element) {
+ assert(element.name.toString() == 'SessionInfo');
+ return SessionInfo(
+ sid: element.getElement('SID')!.text,
+ challange: element.getElement('Challenge')!.text,
+ blockTime: int.parse(element.getElement('BlockTime')!.text),
+ users: element
+ .getElement('Users')!
+ .childElements
+ .map((e) => User.fromXml(e))
+ .toList(),
+ );
+ }
+
+ void toXml(XmlBuilder builder) {
+ builder.element(
+ 'SessionInfo',
+ nest: () => builder
+ ..element('SID', nest: sid)
+ ..element('Challange', nest: challange)
+ ..element('BlockTime', nest: blockTime)
+ ..element('Rights')
+ ..element(
+ 'Users',
+ nest: () {
+ for (final user in users) {
+ user.toXml(builder);
+ }
+ },
+ ),
+ );
+ }
+}
+
+class _SessionInfoTypeConverter extends SimpleTypeConverter<SessionInfo> {
+ const _SessionInfoTypeConverter();
+
+ @override
+ void buildXml(SessionInfo data, XmlBuilder builder) => data.toXml(builder);
+
+ @override
+ SessionInfo parseXml(XmlElement element) => SessionInfo.fromXml(element);
+}

lib/src/api/models/user.dart

@@ -0,0 +1,32 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:xml/xml.dart';
+
+part 'user.freezed.dart';
+
+@freezed
+class User with _$User {
+ const User._();
+
+ const factory User(
+ String user, {
+ @Default(false) bool last,
+ }) = _User;
+
+ factory User.fromXml(XmlElement element) {
+ assert(element.name.toString() == 'User');
+ return User(
+ element.text,
+ last: element.getAttribute('last') == '1',
+ );
+ }
+
+ void toXml(XmlBuilder builder) {
+ builder.element(
+ 'User',
+ attributes: {
+ if (last) 'last': '1',
+ },
+ nest: user,
+ );
+ }
+}

lib/src/api/xml_converter.dart

@@ -0,0 +1,29 @@
+import 'dart:async';
+
+import 'package:chopper/chopper.dart';
+import 'package:xml/xml.dart';
+
+class XmlConverter implements Converter {
+ @override
+ FutureOr<Request> convertRequest(Request request) {
+ final rawBody = request.body;
+ if (rawBody is XmlDocument) {
+ return request.copyWith(body: rawBody.toXmlString());
+ } else {
+ return request;
+ }
+ }
+
+ @override
+ FutureOr<Response<BodyType>> convertResponse<BodyType, InnerType>(
+ Response response,
+ ) {
+ if (BodyType == XmlDocument) {
+ return response.copyWith(
+ body: XmlDocument.parse(response.bodyString),
+ ) as Response<BodyType>;
+ } else {
+ return response.copyWith();
+ }
+ }
+}

lib/src/api/xml_typed_converter.dart

@@ -0,0 +1,78 @@
+import 'dart:async';
+
+import 'package:aha_client/src/api/xml_converter.dart';
+import 'package:chopper/chopper.dart';
+import 'package:meta/meta.dart';
+import 'package:xml/xml.dart';
+
+abstract class TypeConverter<T> {
+ const TypeConverter._();
+
+ XmlDocument toXml(T data);
+ T fromXml(XmlDocument xml);
+}
+
+abstract class SimpleTypeConverter<T> implements TypeConverter<T> {
+ const SimpleTypeConverter();
+
+ @override
+ T fromXml(XmlDocument xml) => parseXml(xml.rootElement);
+
+ @override
+ XmlDocument toXml(T data) {
+ final builder = XmlBuilder()..processing('xml', 'version="1.0"');
+ buildXml(data, builder);
+ return builder.buildDocument();
+ }
+
+ @protected
+ void buildXml(T data, XmlBuilder builder);
+
+ @protected
+ T parseXml(XmlElement element);
+}
+
+class XmlTypedConverter extends Converter {
+ final _xmlConverter = XmlConverter();
+
+ final _typeConverters = <Type, TypeConverter>{};
+
+ void registerConverter<T>(TypeConverter<T> converter) =>
+ _typeConverters[T] = converter;
+
+ @override
+ FutureOr<Request> convertRequest(Request request) {
+ final converter = _typeConverters[request.body.runtimeType];
+ if (converter != null) {
+ return _xmlConverter.convertRequest(
+ request.copyWith(
+ body: converter.toXml(request.body),
+ ),
+ );
+ } else {
+ return _xmlConverter.convertRequest(request);
+ }
+ }
+
+ @override
+ FutureOr<Response<BodyType>> convertResponse<BodyType, InnerType>(
+ Response response,
+ ) async {
+ final converter = _typeConverters[BodyType] as TypeConverter<BodyType>?;
+ if (converter != null) {
+ final xmlResponse = await _xmlConverter
+ .convertResponse<XmlDocument, XmlDocument>(response);
+ if (xmlResponse.body == null) {
+ return xmlResponse.copyWith();
+ }
+
+ return xmlResponse.copyWith(
+ body: converter.fromXml(xmlResponse.body!),
+ );
+ } else if (BodyType == XmlDocument) {
+ return _xmlConverter.convertResponse<BodyType, InnerType>(response);
+ } else {
+ return response.copyWith();
+ }
+ }
+}

pubspec.yaml

@@ -8,10 +8,14 @@ environment:
 
 dependencies:
  chopper: ^4.0.1
+ freezed_annotation: ^0.14.3
+ meta: ^1.7.0
+ xml: ^5.2.0
 
 dev_dependencies:
  build_runner: ^2.1.2
  chopper_generator: ^4.0.1
+ freezed: ^0.14.2
  lint: ^1.6.0
  test: ^1.16.0