nebx

Description:

nebx

Nebx #


Nebx is a wrapper that support a powerful Dio HTTP client with error handling included.
Get started #
Install #
Add the nebx package to your pubspec dependencies.
Examples #
Example project can be cloned from nebx-minimal-example.
IDioClient GET / POST / PUT / DELETE method usage flow:
class SomeDataModel {
// ... add your properties here
}

class SomeRepository {
late final IDioClient _client;

SomeRepository({required IDioClient client}) {
_client = client;
}

Future<IVerdict<SomeDataModel>> getWeatherForecast() async {
const String endpoint = "weather-forecast";
final query = {
"longitude": 106.827194,
"latitude": -6.175372,
};

final result = await _client.get(url: endpoint, queryParams: query);
if (result.isFailure) return Verdict.failed(result.issue);

late final SomeDataModel monasMonumentForecast;

try {
final jsonObject = CodecHelper.decodeJson(result.data);
monasMonumentForecast = SomeDataModel.fromJson(jsonObject);
} catch (e) {
// catch if the deserialization fail
return Verdict.failed(Issue.parsing());
}

return Verdict.successful(monasMonumentForecast);
}
}
copied to clipboard
Build pre-made Dio instance using DioBuilderFactory to automatically provide / refresh Json Web Token with logger and
internet interceptors:
String loadToken() {
// ... load your token here
return "random.jwt.token";
}

Future<IVerdict<String>> refreshToken(IDioClient client) async {
// ... do your api refreshing here, then return the string
return Verdict.successful("refreshed.jwt.token");
}

final checker = InternetCheckerImplementation();

final IDioClient safeClient = DioBuilderFactory.clientJsonWebToken(
baseUrl: "https://roselino.nebx.my.id/dummy",
onTokenLoad: loadToken,
onTokenRefresh: (client) => refreshToken(client),
internetChecker: checker,
)
.addRequestTimeOut(receiveTimeOutSeconds: 15, requestTimeOutSeconds: 5)
.buildErrorHandling();
copied to clipboard
Build pre-made basic Dio instance with only logger and internet interceptors:
final IDioClient safeClient = DioBuilderFactory.clientBasic(
baseUrl: "https://roselino.nebx.my.id/dummy",
internetChecker: checker,
)
.buildErrorHandling();
copied to clipboard
Build Dio instance manually with requirements:

disable dio auto decode
define your request content type into json
add request / receive timeout
add internet checker interceptor
add another interceptor

final checker = InternetCheckerImplementation();
final internetInterceptor = InternetInterceptor(checker: checker);

final IDioClient client = DioBuilder(autoDecode: false)
.addRequestContentType(type: HttpContentType.json)
.addRequestTimeOut(receiveTimeOutSeconds: 15, requestTimeOutSeconds: 5)
.addInterceptor(interceptor: (client) => internetInterceptor)
.addInterceptor(interceptor: (client) => anotherInterceptor)
.buildErrorHandling();
copied to clipboard
Decode / encode utility usage:
// pretend this is the returned json
final String singleJsonResponse = "{\"longitude\":106.827194,\"latitude\":-6.175372};";
final String arrayJsonResponse = "[{\"longitude\":106.827194,\"latitude\":-6.175372},{\"longitude\":106.827194,\"latitude\":-6.175372}]";

final Map<String, dynamic> singleJsonDecoded = CodecHelper.decodeJson(singleJsonResponse);
final List<dynamic> arrayJsonDecoded = CodecHelper.decodeJson<List>(arrayJsonResponse);

// pretend this is the returned xml
final String singleXmlResponse = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?><root><data><longitude>106.827194<\/longitude><latitude>-6.175372<\/latitude><\/data><\/root>";
final String arrayXmlResponse = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?><root><data><longitude>106.827194<\/longitude><latitude>-6.175372<\/latitude><\/data><data><longitude>106.827194<\/longitude><latitude>-6.175372<\/latitude><\/data><\/root>";

final Map<String, dynamic> singleXmlDecoded = CodecHelper.decodeXml(singleXmlResponse);
final List<dynamic> arrayXmlDecoded = CodecHelper.decodeXml<List>(arrayXmlResponse);

// encode to json string
final String encoded = CodecHelper.encodeJson(yourObject);
copied to clipboard
Custom Internet Checker implementation:
class YourOwnImplementation implements IInternetChecker {
YourOwnImplementation() {
// ... your implementation here.
}

@override
Future<bool> get hasInternetAccess {
// ... return the boolean here
}
}
copied to clipboard