Add utility methods for sending non-form data in pkg/http.

pkg/http/lib/src/base_client.dart

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library base_client;
 
 import 'dart:async';
+import 'dart:convert';
 import 'dart:io';
 import 'dart:typed_data';
 
 import 'base_request.dart';
 import 'client.dart';
 import 'request.dart';
 import 'response.dart';
 import 'streamed_response.dart';
 import 'utils.dart';
 
 /// The abstract base class for an HTTP client. This is a mixin-style class;
 /// subclasses only need to implement [send] and maybe [close], and then they
 /// get various convenience methods for free.
 abstract class BaseClient implements Client {
   /// Sends an HTTP HEAD request with the given headers to the given URL, which
   /// can be a [Uri] or a [String].
   ///
   /// For more fine-grained control over the request, use [send] instead.
   Future<Response> head(url, {Map<String, String> headers}) =>
     _sendUnstreamed("HEAD", url, headers);
 
   /// Sends an HTTP GET request with the given headers to the given URL, which
   /// can be a [Uri] or a [String].
   ///
   /// For more fine-grained control over the request, use [send] instead.
   Future<Response> get(url, {Map<String, String> headers}) =>
     _sendUnstreamed("GET", url, headers);
 
-  /// Sends an HTTP POST request with the given headers and fields to the given
-  /// URL, which can be a [Uri] or a [String]. If any fields are specified, the
-  /// content-type is automatically set to
-  /// `"application/x-www-form-urlencoded"`.
+  /// Sends an HTTP POST request with the given headers and body to the given
+  /// URL, which can be a [Uri] or a [String].
+  ///
+  /// [body] sets the body of the request. It can be a [String], a [List<int>]
+  /// or a [Map<String, String>]. If it's a String, it's encoded using
+  /// [encoding] and used as the body of the request. The content-type of the
+  /// request will default to "text/plain".
+  ///
+  /// If [body] is a List, it's used as-is as the body of the request.
+  ///
+  /// If [body] is a Map, it's encoded as form fields using [encoding]. The
+  /// content-type of the request will be set to
+  /// `"application/x-www-form-urlencoded"`; this cannot be overridden.
+  ///
+  /// [encoding] defaults to UTF-8.
   ///
   /// For more fine-grained control over the request, use [send] instead.
-  Future<Response> post(url,
-      {Map<String, String> headers,
-       Map<String, String> fields}) =>
-    _sendUnstreamed("POST", url, headers, fields);
+  Future<Response> post(url, {Map<String, String> headers, body,
+      Encoding encoding}) =>
+    _sendUnstreamed("POST", url, headers, body, encoding);
 
-  /// Sends an HTTP PUT request with the given headers and fields to the given
-  /// URL, which can be a [Uri] or a [String]. If any fields are specified, the
-  /// content-type is automatically set to
-  /// `"application/x-www-form-urlencoded"`.
+  /// Sends an HTTP PUT request with the given headers and body to the given
+  /// URL, which can be a [Uri] or a [String].
+  ///
+  /// [body] sets the body of the request. It can be a [String], a [List<int>]
+  /// or a [Map<String, String>]. If it's a String, it's encoded using
+  /// [encoding] and used as the body of the request. The content-type of the
+  /// request will default to "text/plain".
+  ///
+  /// If [body] is a List, it's used as-is as the body of the request.
+  ///
+  /// If [body] is a Map, it's encoded as form fields using [encoding]. The
+  /// content-type of the request will be set to
+  /// `"application/x-www-form-urlencoded"`; this cannot be overridden.
+  ///
+  /// [encoding] defaults to UTF-8.
   ///
   /// For more fine-grained control over the request, use [send] instead.
-  Future<Response> put(url,
-      {Map<String, String> headers,
-       Map<String, String> fields}) =>
-    _sendUnstreamed("PUT", url, headers, fields);
+  Future<Response> put(url, {Map<String, String> headers, body,
+      Encoding encoding}) =>
+    _sendUnstreamed("PUT", url, headers, body, encoding);
 
   /// Sends an HTTP DELETE request with the given headers to the given URL,
   /// which can be a [Uri] or a [String].
   ///
   /// For more fine-grained control over the request, use [send] instead.
   Future<Response> delete(url, {Map<String, String> headers}) =>
     _sendUnstreamed("DELETE", url, headers);
 
   /// Sends an HTTP GET request with the given headers to the given URL, which
   /// can be a [Uri] or a [String], and returns a Future that completes to the
@@ skipping 29 matching lines @@
 
   /// Sends an HTTP request and asynchronously returns the response.
   ///
   /// Implementers should call [BaseRequest.finalize] to get the body of the
   /// request as a [ByteStream]. They shouldn't make any assumptions about the
   /// state of the stream; it could have data written to it asynchronously at a
   /// later point, or it could already be closed when it's returned.
   Future<StreamedResponse> send(BaseRequest request);
 
   /// Sends a non-streaming [Request] and returns a non-streaming [Response].
-  Future<Response> _sendUnstreamed(
-      String method, url, Map<String, String> headers,
-      [Map<String, String> fields]) {
-    // Wrap everything in a Future block so that synchronous validation errors
-    // are passed asynchronously through the Future chain.
-    return async.then((_) {
+  Future<Response> _sendUnstreamed(String method, url,
+      Map<String, String> headers, [body, Encoding encoding]) {
+    return new Future.sync(() {
       if (url is String) url = Uri.parse(url);
       var request = new Request(method, url);
 
       if (headers != null) request.headers.addAll(headers);
-      if (fields != null && !fields.isEmpty) request.bodyFields = fields;
+      if (encoding != null) request.encoding = encoding;
+      if (body != null) {
+        if (body is String) {
+          request.body = body;
+        } else if (body is List) {
+          request.bodyBytes = body;
+        } else if (body is Map) {
+          request.bodyFields = body;
+        } else {
+          throw new ArgumentError('Invalid request body "$body".');
+        }
+      }
 
       return send(request);
     }).then(Response.fromStream);
   }
 
   /// Throws an error if [response] is not successful.
   void _checkResponseSuccess(url, Response response) {
     if (response.statusCode < 400) return;
     var message = "Request to $url failed with status ${response.statusCode}";
     if (response.reasonPhrase != null) {
       message = "$message: ${response.reasonPhrase}";
     }
     throw new HttpException("$message.");
   }
 
   /// Closes the client and cleans up any resources associated with it. It's
   /// important to close each client when it's done being used; failing to do so
   /// can cause the Dart process to hang.
   void close() {}
 }