v7 (#138)

Author: f3ath

.github/workflows/dart.yml

@@ -25,4 +25,4 @@ jobs:
       - name: Tests
         run: dart test --coverage=.coverage -j1
       - name: Coverage
-        run: dart run coverage:format_coverage -l -c -i .coverage --report-on=lib | dart run check_coverage:check_coverage 98
+        run: dart run coverage:format_coverage -l -c -i .coverage --report-on=lib | dart run check_coverage:check_coverage

.github/workflows/publish.yml

@@ -0,0 +1,14 @@
+name: Publish to pub.dev
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+*'
+
+jobs:
+  publish:
+    permissions:
+      id-token: write # Required for authentication using OIDC
+    uses: dart-lang/setup-dart/.github/workflows/publish.yml@v1
+    # with:
+    #   working-directory: path/to/package/within/repository

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.0.0] - 2023-11-12
+### Changed
+- Migrated to `http_interop` v1.
+
 ## [6.0.1] - 2023-09-11
 ### Fixed
 - `NewRelationship` was not exported
@@ -242,6 +246,7 @@ the Document model.
 ### Added
 - Client: fetch resources, collections, related resources and relationships
 
+[7.0.0]: https://github.com/f3ath/json-api-dart/compare/6.0.1...7.0.0
 [6.0.1]: https://github.com/f3ath/json-api-dart/compare/6.0.0...6.0.1
 [6.0.0]: https://github.com/f3ath/json-api-dart/compare/5.4.0...6.0.0
 [5.4.0]: https://github.com/f3ath/json-api-dart/compare/5.3.0...5.4.0

example/server.dart

@@ -22,11 +22,11 @@ Future<void> main() async {
       ControllerRouter(controller, StandardUriDesign.matchTarget);
   handler = TryCatchHandler(handler,
       onError: ErrorConverter(onError: (e, stack) async {
-    stderr.writeln(e);
-    return Response(500,
-        document: OutboundErrorDocument(
-            [ErrorObject(title: 'Internal Server Error')]));
-  }));
+        stderr.writeln(e);
+        return Response(500,
+            document: OutboundErrorDocument(
+                [ErrorObject(title: 'Internal Server Error')]));
+      }).call);
   handler = LoggingHandler(handler,
       onRequest: (r) => print('${r.method} ${r.uri}'),
       onResponse: (r) => print('${r.statusCode}'));

example/server/cors_handler.dart

@@ -13,12 +13,12 @@ class CorsHandler implements Handler {
       'Access-Control-Expose-Headers': ['Location'],
     };
 
-    if (request.method.equals('OPTIONS')) {
+    if (request.method == 'options') {
       const methods = ['POST', 'GET', 'DELETE', 'PATCH', 'OPTIONS'];
       return Response(
           204,
-          Body.empty(),
-          Headers({
+          Body(),
+          Headers.from({
             ...headers,
             'Access-Control-Allow-Methods':
                 request.headers['Access-Control-Request-Method'] ?? methods,

lib/http.dart

@@ -1,5 +1,3 @@
-import 'dart:convert';
-
 import 'package:http_interop/http_interop.dart';
 
 class StatusCode {
@@ -29,7 +27,7 @@ class StatusCode {
 }
 
 class Json extends Body {
-  Json(Map<String, Object?> json) : super(jsonEncode(json), utf8);
+  Json(Map<String, Object?> super.object) : super.json();
 }
 
 class LoggingHandler implements Handler {

lib/src/client/client.dart

@@ -23,17 +23,17 @@ class Client {
   /// Sends the [request] to the given [uri].
   Future<Response> send(Uri uri, Request request) async {
     final json = await _encode(request.document);
-    final body = http.Body(json, utf8);
-    final headers = http.Headers({
+    final body = http.Body.text(json, utf8);
+    final headers = http.Headers.from({
       'Accept': [mediaType],
       if (json.isNotEmpty) 'Content-Type': [mediaType],
       ...request.headers
     });
     final url = request.query.isEmpty
         ? uri
         : uri.replace(queryParameters: request.query.toQuery());
-    final response = await _handler
-        .handle(http.Request(http.Method(request.method), url, body, headers));
+    final response =
+        await _handler.handle(http.Request(request.method, url, body, headers));
 
     final document = await _decode(response);
     return Response(response, document);

lib/src/client/request.dart

@@ -31,5 +31,5 @@ class Request {
   final query = Query();
 
   /// HTTP headers.
-  final headers = Headers({});
+  final headers = Headers();
 }

lib/src/document/inbound_document.dart

@@ -147,13 +147,11 @@ class _Parser {
 
   /// Decodes Link from [json]. Returns the decoded object.
   /// If the [json] has incorrect format, throws  [FormatException].
-  Link _link(Object json) {
-    if (json is String) return Link(Uri.parse(json));
-    if (json is Map) {
-      return Link(Uri.parse(json['href']))..meta.addAll(meta(json));
-    }
-    throw FormatException('Invalid JSON');
-  }
+  Link _link(Object json) => switch (json) {
+        String() => Link(Uri.parse(json)),
+        Map() => Link(Uri.parse(json['href']))..meta.addAll(meta(json)),
+        _ => throw FormatException('Invalid JSON')
+      };
 
   Map<String, Object?> _getAttributes(Map json) =>
       json.get<Map<String, Object?>>('attributes', orGet: () => {});
@@ -166,25 +164,19 @@ class _Parser {
       .get<Map>('relationships', orGet: () => {})
       .map((key, value) => MapEntry(key, newRelationship(value)));
 
-  Relationship _rel(data) {
-    if (data == null) return ToOne.empty();
-    if (data is Map) return ToOne(identifier(data));
-    if (data is List) return ToMany(data.whereType<Map>().map(identifier));
-    throw FormatException('Invalid relationship object');
-  }
-
-  NewRelationship _newRel(data) {
-    if (data == null) {
-      return NewToOne.empty();
-    }
-    if (data is Map) {
-      return NewToOne(newIdentifier(data));
-    }
-    if (data is List) {
-      return NewToMany(data.whereType<Map>().map(newIdentifier));
-    }
-    throw FormatException('Invalid relationship object');
-  }
+  Relationship _rel(data) => switch (data) {
+        null => ToOne.empty(),
+        Map() => ToOne(identifier(data)),
+        List() => ToMany(data.whereType<Map>().map(identifier)),
+        _ => throw FormatException('Invalid relationship object')
+      };
+
+  NewRelationship _newRel(data) => switch (data) {
+        null => NewToOne.empty(),
+        Map() => NewToOne(newIdentifier(data)),
+        List() => NewToMany(data.whereType<Map>().map(newIdentifier)),
+        _ => throw FormatException('Invalid relationship object')
+      };
 }
 
 extension _TypedGeter on Map {

lib/src/document/new_relationship.dart

@@ -12,8 +12,6 @@ class NewRelationship with IterableMixin<NewIdentifier> {
         if (meta.isNotEmpty) 'meta': meta,
       };
 
-  // coverage:ignore-start
   @override
   Iterator<NewIdentifier> get iterator => <NewIdentifier>[].iterator;
-// coverage:ignore-end
 }