Merge pull request #35 from CodingAleCR/release/0.3.2

Release: 0.3.2

Author: CodingAleCR

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.3.2
+
+* Changed: Example now showcases exception handling.
+* Changed: README now showcases exception handling.
+* Fixed: Interceptor no longer using custom exceptions, instead it rethrows in the case that the retry policy is not set or if it has reached max attempts.
+
 ## 0.3.1
 
 * Fixed: Retry Policy's `shouldAttemptRetryOnResponse` was synchronous which would not allow async token updates.

README.md

@@ -120,21 +120,27 @@ Here is an example with a repository using the `HttpWithInterceptor` class.
 ```dart
 class WeatherRepository {
 
-
-  Future<Map<String, dynamic>> fetchCityWeather(int id) async {
+    Future<Map<String, dynamic>> fetchCityWeather(int id) async {
     var parsedWeather;
     try {
-      var response = await HttpWithInterceptor.build(
-              interceptors: [WeatherApiInterceptor()])
-          .get("$baseUrl/weather", params: {'id': "$id"});
+      final response =
+          await client.get("$baseUrl/weather", params: {'id': "$id"});
       if (response.statusCode == 200) {
         parsedWeather = json.decode(response.body);
       } else {
-        throw Exception("Error while fetching. \n ${response.body}");
+        return Future.error(
+          "Error while fetching.",
+          StackTrace.fromString("${response.body}"),
+        );
       }
-    } catch (e) {
-      print(e);
+    } on SocketException {
+      return Future.error('No Internet connection 😑');
+    } on FormatException {
+      return Future.error('Bad response format 👎');
+    } on Exception {
+      return Future.error('Unexpected error 😢');
     }
+
     return parsedWeather;
   }
 
@@ -143,7 +149,7 @@ class WeatherRepository {
 
 ### Retrying requests
 
- **(NEW 🎉)** Sometimes you need to retry a request due to different circumstances, an expired token is a really good example. Here's how you could potentially implement an expired token retry policy with `http_interceptor`.
+**(NEW 🎉)** Sometimes you need to retry a request due to different circumstances, an expired token is a really good example. Here's how you could potentially implement an expired token retry policy with `http_interceptor`.
 
 ```dart
 class ExpiredTokenRetryPolicy extends RetryPolicy {
@@ -164,7 +170,7 @@ You can also set the maximum amount of retry attempts with `maxRetryAttempts` pr
 
 ### Using self signed certificates
 
- **(EXPERIMENTAL ⚗️)** This plugin allows you to override the default `badCertificateCallback` provided by Dart's `io` package, this is really useful when working with self-signed certificates in your server. This can be done by sending a the callback to the HttpInterceptor builder functions. This feature is marked as experimental and **might be subject to change before release 1.0.0 comes**.
+**(EXPERIMENTAL ⚗️)** This plugin allows you to override the default `badCertificateCallback` provided by Dart's `io` package, this is really useful when working with self-signed certificates in your server. This can be done by sending a the callback to the HttpInterceptor builder functions. This feature is marked as experimental and **might be subject to change before release 1.0.0 comes**.
 
 ```dart
 class WeatherRepository {

example/lib/credentials.dart

@@ -1,2 +1,2 @@
 // Replace this if you are going to run the example. You can get your own at https://openweathermap.org/
-const String OPEN_WEATHER_API_KEY = "YOUR-KEY-HERE";
+const String OPEN_WEATHER_API_KEY = "YOUR-KEY-HERE";

example/lib/main.dart

@@ -1,4 +1,5 @@
 import 'dart:convert';
+import 'dart:io';
 
 import 'package:flutter/material.dart';
 import 'package:http_interceptor/http_interceptor.dart';
@@ -142,7 +143,7 @@ class WeatherSearch extends SearchDelegate<String> {
             child: Text(snapshot.error),
           );
         }
-        
+
         if (!snapshot.hasData) {
           return Center(
             child: CircularProgressIndicator(),
@@ -267,9 +268,14 @@ class WeatherRepository {
           StackTrace.fromString("${response.body}"),
         );
       }
-    } catch (e) {
-      print(e);
+    } on SocketException {
+      return Future.error('No Internet connection 😑');
+    } on FormatException {
+      return Future.error('Bad response format 👎');
+    } on Exception {
+      return Future.error('Unexpected error 😢');
     }
+
     return parsedWeather;
   }
 }
@@ -280,7 +286,7 @@ class WeatherApiInterceptor implements InterceptorContract {
     try {
       data.params['appid'] = OPEN_WEATHER_API_KEY;
       data.params['units'] = 'metric';
-      data.headers["Content-Type"] = "application/json";
+      data.headers[HttpHeaders.contentTypeHeader] = "application/json";
     } catch (e) {
       print(e);
     }

example/pubspec.lock

@@ -87,7 +87,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.3.1"
+    version: "0.3.2"
   http_parser:
     dependency: transitive
     description:

lib/http_client_with_interceptor.dart

@@ -223,7 +223,7 @@ class HttpClientWithInterceptor extends BaseClient {
         _retryCount += 1;
         return _attemptRequest(request);
       } else {
-        throw HttpInterceptorException(error.toString());
+        rethrow;
       }
     }
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: http_interceptor
 description: A lightweight, simple plugin that allows you to intercept request and response objects and modify them if desired.
-version: 0.3.1
+version: 0.3.2
 homepage: https://github.com/CodingAleCR/http_interceptor
 issue_tracker: https://github.com/CodingAleCR/http_interceptor/issues
 repository: https://github.com/CodingAleCR/http_interceptor