feat: Add support for 426: Upgrade Required (#12)

* feat: Add support for 426: Upgrade Required

* Reformat

* Add library-level doc comment and re-order library exports

* Upgrade min dio version to 5.2.0, which has DioException

lib/src/network_response.dart

@@ -38,6 +38,10 @@ class NetworkResponse<R> with _$NetworkResponse<R> {
     required R response,
   }) = _UnprocessableEntity;
 
+  /// 426 - for responses when access to a resource requires a client upgrade.
+  const factory NetworkResponse.upgradeRequired(DioException error) =
+      _UpgradeRequired;
+
   /// 500 - for responses where the service had an error while processing
   /// the request.
   const factory NetworkResponse.serverError(DioException error) = _ServerError;

lib/src/sturdy_http.dart

@@ -194,6 +194,9 @@ class SturdyHttp {
               response: error.response?.data as R,
             );
             break;
+          case 426:
+            resolvedResponse = NetworkResponse.upgradeRequired(error);
+            break;
           case 500:
             resolvedResponse = NetworkResponse.serverError(error);
             break;

lib/sturdy_http.dart

@@ -1,8 +1,9 @@
+/// A strongly typed, event-based, reliable HTTP client that wraps Dio.
 library sturdy_http;
 
 export 'src/_dio_error.dart';
-export 'src/sturdy_http.dart';
-export 'src/sturdy_http_event_listener.dart';
 export 'src/network_request.dart';
 export 'src/network_response.dart';
 export 'src/retry_behavior.dart';
+export 'src/sturdy_http.dart';
+export 'src/sturdy_http_event_listener.dart';

pubspec.yaml

@@ -9,7 +9,7 @@ environment:
 
 dependencies:
   collection: ^1.17.1
-  dio: ^5.1.1
+  dio: ^5.2.0
   freezed_annotation: ^2.2.0
   uuid: ^4.1.0
 

test/src/sturdy_http_test.dart

@@ -710,6 +710,33 @@ void main() {
             });
           });
 
+          group('when status code is 426', () {
+            setUp(() {
+              setupErrorResponse(
+                statusCode: 426,
+                body: const Foo(message: 'error').toJson(),
+              );
+            });
+
+            test('it returns upgradeRequired', () async {
+              final response =
+                  await buildSubject().execute<Json, Result<bool, String>>(
+                const GetRequest(defaultPath),
+                onResponse: (response) {
+                  return response.maybeWhen(
+                    upgradeRequired: (error) => const Result.success(true),
+                    orElse: () => const Result.failure('Not expected: orElse'),
+                  );
+                },
+              );
+
+              response.when(
+                success: (s) => expect(s, isTrue),
+                failure: fail,
+              );
+            });
+          });
+
           group('when status code is 500', () {
             setUp(() {
               setupErrorResponse(statusCode: 500);