Initial version

Author: f3ath

.travis.yml

@@ -0,0 +1,8 @@
+language: dart
+dart:
+- stable
+dart_task:
+- test: --platform vm
+- test: --platform chrome --exclude-tags vm-only
+- dartfmt: true
+- dartanalyzer: --fatal-infos --fatal-warnings lib test

README.md

@@ -1,2 +1,3 @@
-# json-api-dart-client
-JSON:API client in Dart
+# [JSON:API](http://jsonapi.org) v1.0 HTTP Client
+
+This is a work-in-progress. Feel free to join.

dart_test.yaml

@@ -0,0 +1,2 @@
+tags:
+  vm-only: {test_on: "vm"}

lib/json_api.dart

@@ -0,0 +1,3 @@
+export 'src/exceptions.dart';
+export 'src/json_api_client.dart';
+export 'src/response.dart';

lib/src/exceptions.dart

@@ -0,0 +1,11 @@
+class JsonApiClientException implements Exception {
+  final String message;
+
+  JsonApiClientException(this.message);
+}
+
+/// Thrown when the client receives a response with the
+/// Content-Type different from [Document.mediaType]
+class InvalidContentTypeException extends JsonApiClientException {
+  InvalidContentTypeException(String message) : super(message);
+}

lib/src/json_api_client.dart

@@ -0,0 +1,99 @@
+import 'dart:convert';
+
+import 'package:http/http.dart' as http;
+import 'package:json_api/src/response.dart';
+import 'package:json_api_document/json_api_document.dart';
+
+/// JSON:API client
+///
+/// The client is based on top of Dart's [http.Client] class. To use a custom
+/// client, provide your own [clientFactory].
+class JsonApiClient {
+  JsonApiClient({
+    this.baseUrl = '',
+    ClientFactory clientFactory,
+    Map<String, String> defaultHeaders = const {},
+  })  : clientFactory = clientFactory ?? (() => http.Client()),
+        defaultHeaders = Map.unmodifiable({}
+          ..addAll(defaultHeaders)
+          ..['Accept'] = Document.mediaType);
+
+  final String baseUrl;
+  final ClientFactory clientFactory;
+  final Map<String, String> defaultHeaders;
+  final api = Api('1.0');
+
+  /// Fetches a [Document] containing resource(s) from the given [url].
+  /// Pass a [Map] of [headers] to add extra headers to the request.
+  ///
+  /// More details: https://jsonapi.org/format/#fetching-resources
+  Future<Response> fetchResource(String url,
+          {Map<String, String> headers = const {}}) async =>
+      Response(await _exec((_) => _.get(_url(url), headers: _headers(headers))),
+          preferResource: true);
+
+  /// Fetches a [Document] containing identifier(s) from the given [url].
+  /// Pass a [Map] of [headers] to add extra headers to the request.
+  ///
+  /// More details: https://jsonapi.org/format/#fetching-relationships
+  fetchRelationship(String url,
+          {Map<String, String> headers = const {}}) async =>
+      Response(
+          await _exec((_) => _.get(_url(url), headers: _headers(headers))));
+
+  /// Creates a new [resource] sending a POST request to the [url].
+  /// Pass a [Map] of [headers] to add extra headers to the request.
+  ///
+  /// More details: https://jsonapi.org/format/#crud-creating
+  createResource(String url, Resource resource,
+          {Map<String, String> headers = const {}}) async =>
+      Response(
+          await _exec((_) => _.post(_url(url),
+              body: _body(resource),
+              headers: _headers(headers, withContentType: true))),
+          preferResource: true);
+
+  /// Deletes the resource sending a DELETE request to the [url].
+  /// Pass a [Map] of [headers] to add extra headers to the request.
+  ///
+  /// More details: https://jsonapi.org/format/#crud-deleting
+  deleteResource(String url, {Map<String, String> headers = const {}}) async =>
+      Response(
+          await _exec((_) => _.delete(_url(url), headers: _headers(headers))));
+
+  /// Updates the [resource] sending a PATCH request to the [url].
+  /// Pass a [Map] of [headers] to add extra headers to the request.
+  ///
+  /// More details: https://jsonapi.org/format/#crud-updating
+  updateResource(String url, Resource resource,
+          {Map<String, String> headers = const {}}) async =>
+      Response(
+          await _exec((_) => _.patch(_url(url),
+              body: _body(resource),
+              headers: _headers(headers, withContentType: true))),
+          preferResource: true);
+
+  String _body(Resource resource) =>
+      json.encode(DataDocument.fromResource(resource, api: api));
+
+  String _url(String url) => '${baseUrl}${url}';
+
+  Map<String, String> _headers(Map<String, String> headers,
+      {bool withContentType = false}) {
+    final h = <String, String>{}..addAll(defaultHeaders)..addAll(headers);
+    if (withContentType) h['Content-Type'] = Document.mediaType;
+    return h;
+  }
+
+  Future<http.Response> _exec(
+      Future<http.Response> fn(http.Client client)) async {
+    final client = clientFactory();
+    try {
+      return await fn(client);
+    } finally {
+      client.close();
+    }
+  }
+}
+
+typedef http.Client ClientFactory();

lib/src/response.dart

@@ -0,0 +1,28 @@
+import 'dart:convert';
+
+import 'package:http/http.dart' as http;
+import 'package:json_api/src/exceptions.dart';
+import 'package:json_api_document/json_api_document.dart';
+
+/// A result of a fetch() request.
+class Response {
+  final Document document;
+  final int status;
+  final Map<String, String> headers;
+
+  Response(http.Response r, {bool preferResource = false})
+      : status = r.statusCode,
+        headers = r.headers,
+        document = r.contentLength > 0
+            ? Document.fromJson(json.decode(r.body),
+                preferResource: preferResource)
+            : null {
+    const contentType = 'content-type';
+    if (headers.containsKey(contentType) &&
+        headers[contentType].startsWith(Document.mediaType)) return;
+
+    throw InvalidContentTypeException(headers[contentType]);
+  }
+
+  String get location => headers['location'];
+}

pubspec.yaml

@@ -0,0 +1,11 @@
+author: "Alexey Karapetov <karapetov@gmail.com>"
+description: "JSON:API v1.0 (http://jsonapi.org) HTTP Client"
+homepage: "https://github.com/f3ath/json-api-dart"
+name: "json_api"
+version: "0.0.1-dev1"
+dev_dependencies:
+  json_api_document: "^0.3.8"
+  pubspec_version: "^0.1.0"
+  test: "1.3.0"
+environment:
+  sdk: ">=2.0.0 <3.0.0"