tus 0.0.5

  • Readme
  • Changelog
  • Example
  • Installing
  • 83

tus-flutter-client #

Protocol

A Flutter plugin to upload files using the tus resumable upload protocol:

Features #

  • Supports multiple upload endpoints.
  • Callbacks for the following events: Progress, Completed and Error.

Pull Requests and Issues #

Pull requests are always welcome!

Installation #

Add the following to your pubspec.yml

dependencies:
  #...
  tus: 0.0.1

Getting Started #

import 'package:tus/tus.dart';

// Create tus client
var tusD = Tus(endpointUrl);

// Setup tus headers
tusD.headers = <String, String>{
  "Authorization": authorizationHeader,
};

// Initialize the tus client
var response = await tusD.initializeWithEndpoint();
response.forEach((dynamic key, dynamic value) {
  print("[$key] $value");
});

// Callbacks for tus events
tusD.onError = (String error, Tus tus) {
  print(error);
  setState(() {
    progressBar = 0.0;
    inProgress = true;
    resultText = error;
  });
};

tusD.onProgress =
    (int bytesWritten, int bytesTotal, double progress, Tus tus) {
  setState(() {
    progressBar = (bytesWritten / bytesTotal);
  });
};

tusD.onComplete = (String result, Tus tus) {
  print("File can be found: $result");
  setState(() {
    inProgress = true;
    progressBar = 1.0;
    resultText = result;
  });
};

// Trigger file upload.
//
await tusD.createUploadFromFile(
    path, // local path on device i.e. /storage/.../image.jpg
    metadata: <String, String>{ // additional metadata 
      "test": "message",
    },
);

// Get the result from your onComplete callback

Future Work #

  • [ ] Write tests and code coverage
  • [ ] tus client for the web

License #

MIT

0.0.4 #

  • Initialize the tus client if it has not already been initialized.

0.0.1 #

  • Initial Release
  • Added uploads to tus clients using iOS and Android.
  • TODO: Tests

example/lib/main.dart

// Copyright 2020 Lionell Yip. All rights reserved.

import 'dart:async';
import 'dart:io';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:image_picker/image_picker.dart';
import 'package:tus/tus.dart';

final String endpointUrl = "http://127.0.0.1:8080/files";
final String authorizationHeader = "Bearer JWT";

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  Tus tusD;

  double progressBar = 0;
  bool inProgress = false;
  String resultText = "";

  @override
  void initState() {
    super.initState();
    initPlatformState();
    progressBar = 0.0;
  }

  File _image;

  Future getImage() async {
    var image = await ImagePicker.pickImage(source: ImageSource.gallery);

    setState(() {
      _image = image;
    });
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    String platformVersion;
    // Platform messages may fail, so we use a try/catch PlatformException.
    try {
      platformVersion = await Tus.platformVersion;
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    tusD = Tus(endpointUrl);

    tusD.headers = <String, String>{
      "Authorization": authorizationHeader,
    };

    var response = await tusD.initializeWithEndpoint();
    response.forEach((dynamic key, dynamic value) {
      print("[$key] $value");
    });
    tusD.onError = (String error, Tus tus) {
      print(error);
      setState(() {
        progressBar = 0.0;
        inProgress = true;
        resultText = error;
      });
    };

    tusD.onProgress =
        (int bytesWritten, int bytesTotal, double progress, Tus tus) {
      setState(() {
        progressBar = (bytesWritten / bytesTotal);
      });
    };

    tusD.onComplete = (String result, Tus tus) {
      print("File can be found: $result");
      setState(() {
        inProgress = true;
        progressBar = 1.0;
        resultText = result;
      });
    };

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Tus Flutter Client Upload Demo'),
        ),
        body: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          mainAxisSize: MainAxisSize.max,
          crossAxisAlignment: CrossAxisAlignment.center,
          children: <Widget>[
            Center(
              child: Text('Running on: $_platformVersion\n'),
            ),
            RaisedButton(
              child: Text("Choose a photo to upload!"),
              onPressed: () async {
                await getImage();
                setState(() {
                  inProgress = true;
                  progressBar = 0;
                });
                print(await tusD.createUploadFromFile(
                  _image.path,
                  metadata: <String, String>{
                    "test": "message",
                  },
                ));
              },
            ),
            Padding(
              padding: EdgeInsets.symmetric(horizontal: 20, vertical: 10),
              child: inProgress
                  ? LinearProgressIndicator(
                      value: progressBar,
                    )
                  : Container(),
            ),
            Padding(
              padding: EdgeInsets.symmetric(horizontal: 20, vertical: 10),
              child: Text(resultText),
            ),
          ],
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  tus: ^0.0.5

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:tus/tus.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
70
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
83
Learn more about scoring.

We analyzed this package on May 26, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.1
  • pana: 0.13.8-dev
  • Flutter: 1.17.0

Health issues and suggestions

Document public APIs. (-1 points)

25 out of 25 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/tus.dart. (-0.50 points)

Analysis of lib/tus.dart reported 1 hint:

line 49 col 16: This function has a return type of 'Future

Maintenance suggestions

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.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test