library angel_http_exception; //import 'package:dart2_constant/convert.dart'; import 'dart:convert'; /// Exception class that can be serialized to JSON and serialized to clients. /// Carries HTTP-specific metadata, like [statusCode]. /// /// Originally inspired by /// [feathers-errors](https://github.com/feathersjs/feathers-errors). class AngelHttpException implements Exception { var error; /// A list of errors that occurred when this exception was thrown. final List errors = []; /// The cause of this exception. String message; /// The [StackTrace] associated with this error. StackTrace stackTrace; /// An HTTP status code this exception will throw. int statusCode; AngelHttpException(this.error, {this.message = '500 Internal Server Error', this.stackTrace, this.statusCode = 500, List errors = const []}) { if (errors != null) { this.errors.addAll(errors); } } Map toJson() { return { 'is_error': true, 'status_code': statusCode, 'message': message, 'errors': errors }; } Map toMap() => toJson(); @override String toString() { return '$statusCode: $message'; } factory AngelHttpException.fromMap(Map data) { return AngelHttpException( null, statusCode: (data['status_code'] ?? data['statusCode']) as int, message: data['message']?.toString(), errors: data['errors'] is Iterable ? ((data['errors'] as Iterable).map((x) => x.toString()).toList()) : [], ); } factory AngelHttpException.fromJson(String str) => AngelHttpException.fromMap(json.decode(str) as Map); /// Throws a 400 Bad Request error, including an optional arrray of (validation?) /// errors you specify. factory AngelHttpException.badRequest( {String message = '400 Bad Request', List errors = const []}) => AngelHttpException(null, message: message, errors: errors, statusCode: 400); /// Throws a 401 Not Authenticated error. factory AngelHttpException.notAuthenticated( {String message = '401 Not Authenticated'}) => AngelHttpException(null, message: message, statusCode: 401); /// Throws a 402 Payment Required error. factory AngelHttpException.paymentRequired( {String message = '402 Payment Required'}) => AngelHttpException(null, message: message, statusCode: 402); /// Throws a 403 Forbidden error. factory AngelHttpException.forbidden({String message = '403 Forbidden'}) => AngelHttpException(null, message: message, statusCode: 403); /// Throws a 404 Not Found error. factory AngelHttpException.notFound({String message = '404 Not Found'}) => AngelHttpException(null, message: message, statusCode: 404); /// Throws a 405 Method Not Allowed error. factory AngelHttpException.methodNotAllowed( {String message = '405 Method Not Allowed'}) => AngelHttpException(null, message: message, statusCode: 405); /// Throws a 406 Not Acceptable error. factory AngelHttpException.notAcceptable( {String message = '406 Not Acceptable'}) => AngelHttpException(null, message: message, statusCode: 406); /// Throws a 408 Timeout error. factory AngelHttpException.methodTimeout({String message = '408 Timeout'}) => AngelHttpException(null, message: message, statusCode: 408); /// Throws a 409 Conflict error. factory AngelHttpException.conflict({String message = '409 Conflict'}) => AngelHttpException(null, message: message, statusCode: 409); /// Throws a 422 Not Processable error. factory AngelHttpException.notProcessable( {String message = '422 Not Processable'}) => AngelHttpException(null, message: message, statusCode: 422); /// Throws a 501 Not Implemented error. factory AngelHttpException.notImplemented( {String message = '501 Not Implemented'}) => AngelHttpException(null, message: message, statusCode: 501); /// Throws a 503 Unavailable error. factory AngelHttpException.unavailable( {String message = '503 Unavailable'}) => AngelHttpException(null, message: message, statusCode: 503); }