Update models and expose new classes (#14)

Author: AnasNaouchi

example/flutter_example/lib/main.dart

@@ -78,7 +78,7 @@ class _MyHomePageState extends State<MyHomePage> {
         onPressed: () async {
           setLoading(true);
           try {
-            final token = await omiseApi.tokens.create(const CreateTokenRequest(
+            final token = await omiseApi.tokens.create(CreateTokenRequest(
               name: "Name",
               number: "4242424242424242", // Example test card number
               expirationMonth: "09", // Card expiry month

lib/omise_dart.dart

@@ -10,3 +10,5 @@ export 'src/enums/card_brand.dart';
 export 'src/enums/payment_method_name.dart';
 export 'src/enums/tokenization_method.dart';
 export 'src/enums/omise_api_errors.dart';
+export 'src/enums/charge_status.dart';
+export 'src/exceptions/omise_api_exception.dart';

lib/src/enums/charge_status.dart

@@ -0,0 +1,17 @@
+enum ChargeStatus {
+  failed,
+  expired,
+  pending,
+  reversed,
+  successful,
+  unknown, // when there is no charge attached to the token
+}
+
+extension ChargeStatusExtension on ChargeStatus {
+  static ChargeStatus fromString(String? value) {
+    return ChargeStatus.values.firstWhere(
+      (status) => status.name.toLowerCase() == value?.toLowerCase(),
+      orElse: () => ChargeStatus.unknown,
+    );
+  }
+}

lib/src/extensions/date_time_no_milliseconds.dart

@@ -0,0 +1,5 @@
+extension DateTimeExtensions on DateTime {
+  String toIso8601StringWithoutMilliseconds() {
+    return '${toUtc().toIso8601String().split('.').first}Z';
+  }
+}

lib/src/models/requests/create_token_request.dart

@@ -1,19 +1,19 @@
 class CreateTokenRequest {
-  final String name;
-  final String number;
-  final String expirationMonth;
-  final String expirationYear;
-  final String? securityCode;
-  final String? city;
-  final String? country;
-  final String? postalCode;
-  final String? phoneNumber;
-  final String? email;
-  final String? state;
-  final String? street1;
-  final String? street2;
+  String name;
+  String number;
+  String expirationMonth;
+  String expirationYear;
+  String? securityCode;
+  String? city;
+  String? country;
+  String? postalCode;
+  String? phoneNumber;
+  String? email;
+  String? state;
+  String? street1;
+  String? street2;
 
-  const CreateTokenRequest({
+  CreateTokenRequest({
     required this.name,
     required this.number,
     required this.expirationMonth,

lib/src/models/responses/token.dart

@@ -1,10 +1,12 @@
+import 'package:omise_dart/src/enums/charge_status.dart';
+import 'package:omise_dart/src/extensions/date_time_no_milliseconds.dart';
 import 'package:omise_dart/src/models/responses/base_response.dart';
 
 class Token extends BaseResponse {
   final bool used;
-  final String chargeStatus;
+  final ChargeStatus chargeStatus;
   final Card card;
-  final String createdAt;
+  final DateTime createdAt;
 
   Token({
     required super.object,
@@ -25,9 +27,9 @@ class Token extends BaseResponse {
       livemode: json['livemode'],
       location: json['location'],
       used: json['used'],
-      chargeStatus: json['charge_status'],
+      chargeStatus: ChargeStatusExtension.fromString(json['charge_status']),
       card: Card.fromJson(json['card']),
-      createdAt: json['created_at'],
+      createdAt: DateTime.parse(json['created_at']),
     );
   }
 
@@ -37,9 +39,9 @@ class Token extends BaseResponse {
     final baseJson = super.toJson();
     baseJson.addAll({
       'used': used,
-      'charge_status': chargeStatus,
+      'charge_status': chargeStatus.name,
       'card': card.toJson(),
-      'created_at': createdAt,
+      'created_at': createdAt.toIso8601StringWithoutMilliseconds(),
     });
     return baseJson;
   }

test/enums/charge_status_test.dart

@@ -0,0 +1,31 @@
+import 'package:omise_dart/src/enums/charge_status.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('ChargeStatusExtension', () {
+    test('fromString should return the correct ChargeStatus for valid strings',
+        () {
+      expect(ChargeStatusExtension.fromString('failed'), ChargeStatus.failed);
+      expect(ChargeStatusExtension.fromString('expired'), ChargeStatus.expired);
+      expect(ChargeStatusExtension.fromString('pending'), ChargeStatus.pending);
+      expect(
+          ChargeStatusExtension.fromString('reversed'), ChargeStatus.reversed);
+      expect(ChargeStatusExtension.fromString('successful'),
+          ChargeStatus.successful);
+    });
+
+    test('fromString should return ChargeStatus.unknown for invalid strings',
+        () {
+      expect(ChargeStatusExtension.fromString('nonexistent'),
+          ChargeStatus.unknown);
+      expect(ChargeStatusExtension.fromString(null), ChargeStatus.unknown);
+      expect(ChargeStatusExtension.fromString(''), ChargeStatus.unknown);
+    });
+
+    test('fromString should be case insensitive', () {
+      expect(ChargeStatusExtension.fromString('FAILED'), ChargeStatus.failed);
+      expect(ChargeStatusExtension.fromString('Expired'), ChargeStatus.expired);
+      expect(ChargeStatusExtension.fromString('PeNdInG'), ChargeStatus.pending);
+    });
+  });
+}

test/models/requests/create_token_request_test.dart

@@ -4,7 +4,7 @@ import 'package:omise_dart/src/models/requests/create_token_request.dart';
 void main() {
   group('CreateTokenRequest', () {
     test('toJson should convert CreateTokenRequest to correct map', () {
-      const request = CreateTokenRequest(
+      final request = CreateTokenRequest(
         name: 'John Doe',
         number: '4242424242424242',
         expirationMonth: '12',
@@ -72,7 +72,7 @@ void main() {
     });
 
     test('toJson and fromJson should work together', () {
-      const request = CreateTokenRequest(
+      final request = CreateTokenRequest(
         name: 'John Doe',
         number: '4242424242424242',
         expirationMonth: '12',

test/models/responses/token_test.dart

@@ -1,3 +1,4 @@
+import 'package:omise_dart/src/enums/charge_status.dart';
 import 'package:omise_dart/src/models/responses/token.dart';
 import 'package:test/test.dart';
 
@@ -24,9 +25,9 @@ void main() {
         id: 'tok_123',
         livemode: true,
         used: false,
-        chargeStatus: 'pending',
+        chargeStatus: ChargeStatus.pending,
         card: card,
-        createdAt: '2024-09-15T00:00:00Z',
+        createdAt: DateTime.parse('2024-09-15T00:00:00Z'),
       );
 
       final json = token.toJson();
@@ -70,9 +71,9 @@ void main() {
       expect(token.id, 'tok_123');
       expect(token.livemode, true);
       expect(token.used, false);
-      expect(token.chargeStatus, 'pending');
+      expect(token.chargeStatus, ChargeStatus.pending);
       expect(token.card.id, 'card_123');
-      expect(token.createdAt, '2024-09-15T00:00:00Z');
+      expect(token.createdAt, DateTime.parse('2024-09-15T00:00:00Z'));
     });
 
     test('toJson and fromJson should work together', () {
@@ -96,9 +97,9 @@ void main() {
         id: 'tok_123',
         livemode: true,
         used: false,
-        chargeStatus: 'pending',
+        chargeStatus: ChargeStatus.pending,
         card: card,
-        createdAt: '2024-09-15T00:00:00Z',
+        createdAt: DateTime.parse('2024-09-15T00:00:00Z'),
       );
 
       final json = token.toJson();