streamy 0.0.7

  • README.md
  • Installing
  • Versions
  • 0

Streamy for Dart (experimental)

Build Status

Streamy is a feature-rich RPC/API framework for applications written using Dart programming language. It relies on Google API Discovery file format for API description. Streamy also provides out-of-the-box JSON-over-REST protocol.

Using Streamy your application can:

  • Access many Google APIs, such as Google Calendar API
  • Talk to your own APIs built using Google Cloud Endpoints
  • Talk to your own APIs hosted on your own servers and described using Google Discovery format

Features

  • Rich Entity/Request/Resource objects: mutable, immutable, observable with Map-like interface
  • Fully customizable (in fact, fully replaceable) request handling pipeline
    • Caching
    • Request deduplication
    • API proxy
    • One-shot and keep-alive
    • Tracing
    • Out-of-the-box JSON-over-REST implementation
    • Transactional API
    • Request batching

5-Minute Tutorial

Let's write a command-line program that shortens URLs using Google URL Shortener API.

What you need for this tutorial

  • Dart SDK (add Dart's bin folder to your PATH)

Get Full Streamy

The simplest way is to use git:

> git clone https://github.com/google/streamy-dart.git streamy-dart
> cd streamy-dart

Can't I just get it from pub?

Yes, and no. You can and should use pub to import Streamy runtime library necessary to run your app. However, Streamy comes with command-line tools to work with Discovery files and generate API client libraries, so you need to download the full version.

Get a Discovery file

Find one for the API you want to access. Let's use Google URL shortener as example:

> curl https://www.googleapis.com/discovery/v1/apis/urlshortener/v1/rest >urlshortener.json

Generate client library

> dart bin/apigen.dart \
    --discovery_file=urlshortener.json \
    --client_file=urlshortener.dart \
    --library_name=urlshortener

What just happened?

The apigen.dart program provided by Streamy reads the discovery file (urlshortener.json in the example) and produces a Dart file (urlshortener.dart in the example) that contains an API client library for the API described in the discovery file. You can also give the library your own custom name (urlshortener in the example).

Use it

Let's create an entry point for our program, called main.dart, which contains the following code:

import 'urlshortener.dart';
import 'package:streamy/impl_server.dart';

main(List<String> args) {
  var requestHandler = new ServerRequestHandler();
  var api = new Urlshortener(requestHandler);
  api.url.insert(new Url()..longUrl = args[0])
    .send().listen((Url response) {
      print('Shortened to ${response.id}');
    });
}

We are done. Let's run the program:

> dart main.dart http://www.google.com

This should print something like:

Shortened to http://goo.gl/fbsS

What just happened?

import 'urlshortener.dart';

This line imports the API client library that we just generated from the discovery file.

import 'package:streamy/impl_server.dart';

This import provides an implementation of Streamy's RequestHandler interface. This particular implementation works for server-side and command-line apps. If your app runs in the web-browser, use package:streamy/impl_html.dart and HtmlRequestHandler instead.

main() {
  var requestHandler = new ServerRequestHandler();
  var api = new Urlshortener(requestHandler);

The above two lines instantiate a Urlshortener API client backed by ServerRequestHandler.

  api.url.insert(new Url()..longUrl = args[0])

This is an example of how you create an API request. Streamy API generator generates a fully type-annotated root API class (Urlshortener), resources (url), resource methods (insert), entity classes (Url) as well as getters/setters for properties on the entities (longUrl), so you can use auto-completion in your IDE and rely on compiler warnings to tell you about issues in your usage of the API.

    .send().listen((Url response) {
      print('Shortened to ${response.id}');
    });

Finally, we .send() the request to the server and .listen(...) to a Stream of responses.

}

Use this package as a library

1. Depend on it

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


dependencies:
  streamy: ^0.0.7

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:streamy/streamy.dart';
  
Version Uploaded Documentation Archive
0.0.7 Nov 19, 2013 Go to the documentation of streamy 0.0.7 Download streamy 0.0.7 archive
0.0.4 Jun 20, 2013 Go to the documentation of streamy 0.0.4 Download streamy 0.0.4 archive
0.0.2 Jun 18, 2013 Go to the documentation of streamy 0.0.2 Download streamy 0.0.2 archive
0.0.1 Jun 18, 2013 Go to the documentation of streamy 0.0.1 Download streamy 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
0
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
0
Overall:
Weighted score of the above. [more]
0
Learn more about scoring.

We analyzed this package on Nov 19, 2018, and provided a score, details, and suggestions below. Analysis was completed with status tool failures using:

  • Dart: 2.0.0
  • pana: 0.12.6

Platforms

Detected platforms: unsure

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Analysis issues and suggestions

Fix dependencies in pubspec.yaml.

Running pub upgrade failed with the following output:

ERR: The current Dart SDK version is 2.0.0.
 
 Because streamy depends on json >=0.7.0 which requires SDK version >=0.7.0 <2.0.0, version solving failed.

Health suggestions

Format bin/apigen.dart.

Run dartfmt to format bin/apigen.dart.

Format lib/generator/default.dart.

Run dartfmt to format lib/generator/default.dart.

Format lib/generator/discovery.dart.

Run dartfmt to format lib/generator/discovery.dart.

Fix additional 24 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/generator/emitter.dart (Run dartfmt to format lib/generator/emitter.dart.)
  • lib/impl.dart (Run dartfmt to format lib/impl.dart.)
  • lib/impl_html.dart (Run dartfmt to format lib/impl_html.dart.)
  • lib/impl_server.dart (Run dartfmt to format lib/impl_server.dart.)
  • lib/indexed_cache.dart (Run dartfmt to format lib/indexed_cache.dart.)
  • lib/runtime/batching.dart (Run dartfmt to format lib/runtime/batching.dart.)
  • lib/runtime/cache.dart (Run dartfmt to format lib/runtime/cache.dart.)
  • lib/runtime/entity/base.dart (Run dartfmt to format lib/runtime/entity/base.dart.)
  • lib/runtime/entity/empty.dart (Run dartfmt to format lib/runtime/entity/empty.dart.)
  • lib/runtime/entity/raw.dart (Run dartfmt to format lib/runtime/entity/raw.dart.)
  • lib/runtime/entity/util.dart (Run dartfmt to format lib/runtime/entity/util.dart.)
  • lib/runtime/entity/wrapper.dart (Run dartfmt to format lib/runtime/entity/wrapper.dart.)
  • lib/runtime/error.dart (Run dartfmt to format lib/runtime/error.dart.)
  • lib/runtime/global.dart (Run dartfmt to format lib/runtime/global.dart.)
  • lib/runtime/http.dart (Run dartfmt to format lib/runtime/http.dart.)
  • lib/runtime/json.dart (Run dartfmt to format lib/runtime/json.dart.)
  • lib/runtime/multiplexer.dart (Run dartfmt to format lib/runtime/multiplexer.dart.)
  • lib/runtime/proxy.dart (Run dartfmt to format lib/runtime/proxy.dart.)
  • lib/runtime/request.dart (Run dartfmt to format lib/runtime/request.dart.)
  • lib/runtime/response.dart (Run dartfmt to format lib/runtime/response.dart.)
  • lib/runtime/transforms.dart (Run dartfmt to format lib/runtime/transforms.dart.)
  • lib/runtime/util.dart (Run dartfmt to format lib/runtime/util.dart.)
  • lib/testing/dynamic_entity.dart (Run dartfmt to format lib/testing/dynamic_entity.dart.)
  • lib/testing/testing.dart (Run dartfmt to format lib/testing/testing.dart.)

Maintenance issues and suggestions

Fix platform conflicts. (-20 points)

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Running dartdoc failed. (-10 points)

Make sure dartdoc runs without any issues.

Package is too old. (-100 points)

The package was released more than two years ago.

Maintain CHANGELOG.md. (-20 points)

Changelog entries help clients to follow the progress in your code.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use streamy.dart.

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

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

The description is too long. (-10 points)

Search engines will display only the first part of the description. Try to keep it under 180 characters.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=0.8.7