HTTP Exception

A brick create http_exception file based on .json user defined for better http exception handling.

🚧 Requirements

.json file format requirements

Format

[
  {
    "type": "exception_type",
    "code": "exception_code", # optional
    "message": "exception_message"
  }
]

• For default,.json file must be in assets/ folder, name is exception_info.json, the path will be assets/exception_info.json in project

• If you want to use your own .json file, you can paste your own path to exception_info_path variable.

• type is name of exception, it used to create a class name that implements Exception interface.

• code is code of exception, it used to create a const int value that represents the exception code.

• message is message of exception, it used to create a const String value that represents the exception message.

.json file is avaliable in my assets/ folder in Github repo. You can found it for using like example.

Example some foo.json file :))

[
  {
    "type": "HttpException",
    "code": 404,
    "message": "Not Found"
  },
  {
    "type": "HttpException",
    "code": 500,
    "message": "Internal Server Error"
  }
]

🚀 Usage

mason make http_exception -o ./output-path --exception_info_path path --exception_file_name fileName --use_super_parameters true/false

✨ Variables

📦 Input & Output

Input

.json file

[
  {
    "type": "unauthorized",
    "code": 401,
    "message": "Unauthorized"
  },
  {
    "type": "bad_request",
    "code": 400,
    "message": "Bad Request"
  },
  {
    "type": "timeout",
    "code": 408,
    "message": "Request Timeout"
  },
  {
    "type": "server_error",
    "code": 500,
    "message": "Internal Server Error"
  },
  {
    "type": "unhandled_error",
    "message": "Unhandled Error"
  }
]

Output

Generated a file after format with name exception_file_name.dart in output-path folder from exception_info_path json file path and not use super_parameters, this file will be:

class HttpException implements Exception {
  HttpException({
    this.statusCode,
    this.message = '',
  });

  final String message;
  final int? statusCode;

  @override
  String toString() =>
      '$runtimeType(message: $message, statusCode: $statusCode)';
}

class UnauthorizedException extends HttpException {
  UnauthorizedException() : super(statusCode: 401, message: 'Unauthorized');
}

class BadRequestException extends HttpException {
  BadRequestException() : super(statusCode: 400, message: 'Bad Request');
}

class TimeoutException extends HttpException {
  TimeoutException() : super(statusCode: 408, message: 'Request Timeout');
}

class ServerErrorException extends HttpException {
  ServerErrorException()
      : super(statusCode: 500, message: 'Internal Server Error');
}

class UnhandledErrorException extends HttpException {
  UnhandledErrorException() : super(message: 'Unhandled Error');
}

If use super_parameters is true, the generated file after format will be like this:

class HttpException implements Exception {
  HttpException({
    this.statusCode,
    this.message = '',
  });

  final String message;
  final int? statusCode;

  @override
  String toString() =>
      '$runtimeType(message: $message, statusCode: $statusCode)';
}

class UnauthorizedException extends HttpException {
  UnauthorizedException({
    super.statusCode = 401,
    super.message = 'Unauthorized',
  });
}

class BadRequestException extends HttpException {
  BadRequestException({
    super.statusCode = 400,
    super.message = 'Bad Request',
  });
}

class TimeoutException extends HttpException {
  TimeoutException({
    super.statusCode = 408,
    super.message = 'Request Timeout',
  });
}

class ServerErrorException extends HttpException {
  ServerErrorException({
    super.statusCode = 500,
    super.message = 'Internal Server Error',
  });
}

class UnhandledErrorException extends HttpException {
  UnhandledErrorException({
    super.message = 'Unhandled Error',
  });
}

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add http_exception

# Install globally
mason add -g http_exception

Usage 🚀

mason make http_exception

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.26 <0.1.0"

0.1.1

• docs: update README.md

0.1.0

• feat: make statusCode nullable to handle unknown status codes.
• enhancement(post_gen): add dart format on generated files.

0.0.3+1

• enhancement: toString() method added runtimeType property.

0.0.2+1

• enhancement: using Inverted Sections instead of creating new variable in hooks pre_gen.

0.0.1+1

• init: http_exception brick.

MIT License

Copyright (c) 2022 Nguyen Minh Dung

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.