micro_core_http

License Package Version Package Points Coverage

This package is a wrapper of the dio package with a handful of features out of the box.

Platform Support

Android iOS MacOS Web Linux Windows
✅ ✅ ✅ ✅ ✅ ✅

Features

  • Basic HTTP Requests (DELETE, GET, PATCH, POST, PUT)
  • Request's Authorization and Logging can be easily implemented and in an organized way
  • Retry Requests setting number of retries and delay between retries
  • Refresh the authorization tokens implementing the interceptor for that.

Coming Soon

  • Download Request passing the path of the file to be downloaded to
  • Improvements on Retry Request Flow
  • Improvements on Refresh Token Interceptor to make easier to implement

Usage

Basic Usage

micro_core_example.dart

import 'package:micro_core_http/micro_core_http.dart';

final class AppHttpAuthorizationHandler implements IHttpAuthorizationHandler {
    // Local Storage Instance

    const AppHttpAuthorizationHandler();

    // Define where to add the token
    @override
    HttpAuthorizationType get authorizationType => HttpAuthorizationType.headers;

    @override
    Future<Map<String, String>> getAuthorization() async {
        // Use Local Storage Instance to return the Authorization Token
        return {
        'Authorization':
            'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMiLCJ1c2VybmFtZSI6IjE1NDk0NDkzNzA5IiwiZW1haWwiOiJqcDk4c21hcnRpbnNAZ21haWwuY29tIiwiaXAiOjAsImxvZ2luX3Rva2VuIjoib2trbGFlb2lxamg0N3p4bDU2bG8yIiwidHlwZSI6IkFQUCIsImlhdCI6MTcwMjk4OTIyMywiZXhwIjoxNzAyOTkyODIzfQ.pNqx0JTt9FC7xkGMHgcLZE1Ln71nTnhC-qpOXlYPfGM',
        };
    }
}

final class Repository {
    final IHttpClient api;

    const Repository(this.api);

    Future<Map<String, dynamic>> getPackagesList() async {
        try {
        // Implement the request
        final response = await api.get(
            '/packages',
            segment: 'Packages',
            step: 'Getting Packages List',
        );

        // Return the response
        return Map<String, dynamic>.from(response.data);
        } on HttpException catch (exception) {
        // Treat basic/custom Exceptions here
        if (exception is HttpExceptionUnauthorized) {
            print('User is Unauthorized!');
        }
        rethrow;
        }
    }
}

class Controller {
    final Repository _repository;

    const Controller(this._repository);

    Future<void> getPackagesList() async {
        final result = await _repository.getPackagesList();

        // Deal with the result
        print(result.toString());
    }
}

void main() {
    final options = HttpOptions(
        authorizationHandler: AppHttpAuthorizationHandler(),
        baseUrl: "https://api.jotapetecnologia.com.br",
        delayBetweenRetries: Duration(seconds: 2),
        requestTimeout: Duration(seconds: 8),
        extraRetries: 2,
        showLogs: true,
    );
    final api = HttpClient(options: options);
    final repository = Repository(api);
    final controller = Controller(repository);

    controller.getPackagesList();
}

Adapter Usage

example/adapter/entities/default_http_options.dart

import 'package:micro_core_http/micro_core_http.dart';

import '../overrides/http_response_handler.dart';

// * It could be created different options for each environment/feature of the app

final class DefaultHttpOptions {
  late final HttpOptions _options;
  HttpOptions get options => _options;

  DefaultHttpOptions(
    IHttpAuthorizationHandler authorizationHandler,
  ) {
    _options = HttpOptions(
      authorizationHandler: authorizationHandler,
      baseUrl: 'https://api.jotapetecnologia.com.br',
      delayBetweenRetries: const Duration(seconds: 2),
      responseHandler: HttpResponseHandler(),
      extraRetries: 2,
      requestTimeout: const Duration(seconds: 12),
      showLogs: true,
    );
  }
}

example/adapter/interfaces/http_adapter_interface.dart

import 'package:micro_core_http/micro_core_http.dart';

abstract interface class IHttpAdapter {
  Future<HttpResponse> delete(
    String endpoint, {
    bool authenticate = false,
    dynamic body,
    Map<String, String>? headers,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  });

  Future<HttpResponse> get(
    String endpoint, {
    bool authenticate = false,
    Map<String, String>? headers,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  });

  Future<HttpResponse> patch(
    String endpoint, {
    bool authenticate = false,
    dynamic body,
    Map<String, String>? headers,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  });

  Future<HttpResponse> post(
    String endpoint, {
    bool authenticate = false,
    dynamic body,
    Map<String, String>? headers,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  });

  Future<HttpResponse> put(
    String endpoint, {
    bool authenticate = false,
    dynamic body,
    Map<String, String>? headers,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  });
}

example/adapter/overrides/http_authorization_handler.dart

import 'package:micro_core_http/micro_core_http.dart';

final class AppHttpAuthorizationHandler implements IHttpAuthorizationHandler {
  // Local Storage Instance

  const AppHttpAuthorizationHandler();

  // Define where to add the token
  @override
  HttpAuthorizationType get authorizationType => HttpAuthorizationType.headers;

  @override
  Future<Map<String, String>> getAuthorization() async {
    // Use Local Storage Instance to return the Authorization Token
    return {
      'Authorization':
          'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMiLCJ1c2VybmFtZSI6IjE1NDk0NDkzNzA5IiwiZW1haWwiOiJqcDk4c21hcnRpbnNAZ21haWwuY29tIiwiaXAiOjAsImxvZ2luX3Rva2VuIjoib2trbGFlb2lxamg0N3p4bDU2bG8yIiwidHlwZSI6IkFQUCIsImlhdCI6MTcwMjk4OTIyMywiZXhwIjoxNzAyOTkyODIzfQ.pNqx0JTt9FC7xkGMHgcLZE1Ln71nTnhC-qpOXlYPfGM',
    };
  }
}

example/adapter/overrides/http_response_handler.dart

import 'package:micro_core_http/micro_core_http.dart';

final class HttpResponseHandler implements IHttpResponseHandler {
  @override
  void logResponse(HttpResponse response) {
    if (response.statusCode > 199 && response.statusCode < 300) {
      // return Logger.logSuccess(response.toString());
    }

    // return Logger.logWarning(response.toString());
  }

  @override
  void onResponse(HttpResponse response) {}
}

example/adapter/http_adapter.dart

import 'package:micro_core_http/micro_core_http.dart';

import 'interfaces/http_adapter_interface.dart';

final class HttpAdapter implements IHttpAdapter {
  final HttpOptions options;

  const HttpAdapter(this.options);

  static const Map<String, String> defaultHeaders = {
    "accept": "*/*",
    "content-type": "application/json",
  };

  @override
  Future<HttpResponse> delete(
    String endpoint, {
    bool authenticate = false,
    dynamic body,
    Map<String, String>? headers = defaultHeaders,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  }) {
    final client = HttpClient(
      options: options,
    );

    return client.delete(
      endpoint,
      authenticate: authenticate,
      body: body,
      headers: headers,
      queryParameters: queryParameters,
      replaceBaseUrl: replaceBaseUrl,
      segment: segment,
      step: step,
    );
  }

  @override
  Future<HttpResponse> get(
    String endpoint, {
    bool authenticate = false,
    Map<String, String>? headers = defaultHeaders,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  }) {
    final client = HttpClient(
      options: options,
    );

    return client.get(
      endpoint,
      authenticate: authenticate,
      headers: headers,
      queryParameters: queryParameters,
      replaceBaseUrl: replaceBaseUrl,
      segment: segment,
      step: step,
    );
  }

  @override
  Future<HttpResponse> patch(
    String endpoint, {
    bool authenticate = false,
    body,
    Map<String, String>? headers = defaultHeaders,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  }) {
    final client = HttpClient(
      options: options,
    );

    return client.patch(
      endpoint,
      authenticate: authenticate,
      body: body,
      headers: headers,
      queryParameters: queryParameters,
      replaceBaseUrl: replaceBaseUrl,
      segment: segment,
      step: step,
    );
  }

  @override
  Future<HttpResponse> post(
    String endpoint, {
    bool authenticate = false,
    body,
    Map<String, String>? headers = defaultHeaders,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  }) {
    final client = HttpClient(
      options: options,
    );

    return client.post(
      endpoint,
      authenticate: authenticate,
      body: body,
      headers: headers,
      queryParameters: queryParameters,
      replaceBaseUrl: replaceBaseUrl,
      segment: segment,
      step: step,
    );
  }

  @override
  Future<HttpResponse> put(
    String endpoint, {
    bool authenticate = false,
    body,
    Map<String, String>? headers = defaultHeaders,
    Map<String, dynamic>? queryParameters,
    String? replaceBaseUrl,
    String? segment,
    String? step,
  }) {
    final client = HttpClient(
      options: options,
    );

    return client.put(
      endpoint,
      authenticate: authenticate,
      body: body,
      headers: headers,
      queryParameters: queryParameters,
      replaceBaseUrl: replaceBaseUrl,
      segment: segment,
      step: step,
    );
  }
}

micro_core_adapter_example.dart

import 'package:micro_core_http/micro_core_http.dart';

import 'entities/default_http_options.dart';
import 'http_adapter.dart';
import 'interfaces/http_adapter_interface.dart';
import 'overrides/http_authorization_handler.dart';

final class Repository {
  final IHttpAdapter api;

  const Repository(this.api);

  Future<Map<String, dynamic>> getPackagesList() async {
    try {
      // Implement the request
      final response = await api.get(
        '/packages',
        segment: 'Packages',
        step: 'Getting Packages List',
      );

      // Return the response
      return Map<String, dynamic>.from(response.data);
    } on HttpException catch (exception) {
      // Treat basic/custom Exceptions here
      if (exception is HttpExceptionUnauthorized) {
        print('User is Unauthorized!');
      }
      rethrow;
    }
  }
}

class Controller {
  final Repository _repository;

  const Controller(this._repository);

  Future<void> getPackagesList() async {
    final result = await _repository.getPackagesList();

    // Deal with the result
    print(result.toString());
  }
}

void main() {
  final authorizationHandler = AppHttpAuthorizationHandler();
  final defaultOptions = DefaultHttpOptions(authorizationHandler);
  final api = HttpAdapter(defaultOptions.options);
  final repository = Repository(api);
  final controller = Controller(repository);

  controller.getPackagesList();
}

Libraries

micro_core_http