alice 0.0.18

  • Readme
  • Changelog
  • Example
  • Installing
  • 91

Alice #

pub package pub package pub package

Alice is an HTTP Inspector tool for Flutter which helps debugging http requests. It catches and stores http requests and responses, which can be viewed via simple UI. It is inspired from Chuck ( https://github.com/jgilfelt/chuck ).

Suported Dart http client plugins:

  • Dio
  • HttpClient from dart:io package
  • Http from http/http package

Features:
✔️ Detailed logs for each HTTP calls (HTTP Request, HTTP Response)
✔️ Inspector UI for viewing HTTP calls
✔️ Save HTTP calls to file
✔️ Statistics
✔️ Notification on HTTP call
✔️ Support for top used HTTP clients in Dart
✔️ Error handling
✔️ Shake to open inspector

Install #

  1. Add this to your pubspec.yaml file:
dependencies:
  alice: ^0.0.17
  1. Install it
$ flutter packages get
  1. Import it
import 'package:alice/alice.dart';

Usage #

Alice configuration #

Create Alice instance:

Alice alice = Alice(showNotification: true);

Alice default behaviour is to show notification with http requests. You can disable it in Alice constructor.

Add navigator key to your application:

MaterialApp( navigatorKey: alice.getNavigatorKey(), home: ...)

You need to add this navigator key in order to show inspector UI. You can use also your navigator key in Alice:

Alice alice = Alice(showNotification: true, navigatorKey: yourNavigatorKeyHere);

You can set showInspectorOnShake in Alice constructor to open inspector by shaking your device (default disabled):

Alice alice = Alice(showNotification: true, showInspectorOnShake: true, navigatorKey: yourNavigatorKeyHere);

If you want to use dark mode just add darkTheme flag:

Alice alice = Alice(..., darkTheme: true);

HTTP Client configuration #

If you're using Dio, you just need to add interceptor.

Dio dio = Dio();
dio.interceptors.add(alice.getDioInterceptor());

If you're using HttpClient from dart:io package:

httpClient
	.getUrl(Uri.parse("https://jsonplaceholder.typicode.com/posts"))
	.then((request) async {
		alice.onHttpClientRequest(request);
		var httpResponse = await request.close();
		var responseBody = await httpResponse.transform(utf8.decoder).join();
		alice.onHttpClientResponse(httpResponse, request, body: responseBody);
 });

If you're using http from http/http package:

http.get('https://jsonplaceholder.typicode.com/posts').then((response) {
    alice.onHttpResponse(response);
});

To show inspector manually:

alice.showInspector();

Saving calls #

Alice supports saving logs to your mobile device storage. In order to make save feature works, you need to add in your Android application manifest:

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

Example #

See complete example here: https://github.com/jhomlala/alice/blob/master/example/lib/main.dart

0.0.18 #

  • Added share option in call details. Share allows user to share curl of the request. (by: Praveenkumar Ramasamy https://github.com/pravinarr)

0.0.17 #

0.0.16 #

  • Fixed server text overflow

0.0.15 #

  • Updated dependencies

0.0.14 #

  • Fixed Dio API breaking change

0.0.13 #

  • Updated dependencies
  • Notification won't init when showNotification is off

0.0.12 #

  • Updated flutter local notification dependency version
  • Refactor

0.0.11 #

0.0.10 #

  • Added stats feature
  • Added save feature
  • Added secured/not secured connection indicator in call list item
  • Query parameters feature (Dio only)
  • Fix for Uint8List SDK breaking change
  • Updated dependencies
  • Refactored code

0.0.6 #

  • Fixed http/http package requests

0.0.5 #

  • Updated dependencies
  • Navigator key can be provided now from application (instead of using Alice's navigator key)

0.0.4 #

  • Updated Kotlin version

0.0.3 #

  • Removed gif from package

0.0.2 #

  • Bug fixes

0.0.1 #

  • Initial release

example/README.md

alice_example #

Demonstrates how to use the alice plugin.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  alice: ^0.0.18

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:alice/alice.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
90
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
91
Learn more about scoring.

We analyzed this package on Nov 20, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.6

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (rxdart).

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.4.0 <3.0.0
dio ^3.0.3 3.0.5
flutter 0.0.0
flutter_local_notifications ^0.8.4 0.8.4+3
http ^0.12.0+2 0.12.0+2
open_file ^2.0.3 2.1.1
package_info ^0.4.0+6 0.4.0+10
path_provider ^1.3.0 1.4.4
permission_handler ^4.0.0 4.0.0
rxdart ^0.22.3 0.22.6 0.23.0-dev.1
shake ^0.1.0 0.1.0
share ^0.6.3+1 0.6.3+1
Transitive dependencies
async 2.4.0
charcode 1.1.2
collection 1.14.11 1.14.12
http_parser 3.1.3
meta 1.1.7 1.1.8
path 1.6.4
pedantic 1.8.0+1
platform 2.2.1
sensors 0.4.1+3
sky_engine 0.0.99
source_span 1.5.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8