matanlurey / seltzer

An elegant and rich cross-platform HTTP library for Dart.

Seltzer

An elegant and rich cross-platform HTTP library for Dart.

Getting Started

You can use Seltzer as an object-oriented HTTP service or simply use top-level convenience methods like get and post directly.

Using HTTP the service

If you are using Seltzer with dependency injection:

import 'dart:async';

import 'package:seltzer/seltzer.dart';
import 'package:seltzer/platform/vm.dart';

void main() {
  new MyTwitterService(const VmSeltzerHttp()).tweet('Hello World!');
}

class MyTwitterService {
  final SeltzerHttp _http;
  
  MyTwitterService(this._http);
  
  // Uses the SeltzerHttp service to send a tweet.
  //
  // This means if we are in the browser or the VM we can expect
  // our http service to work about the same.
  Future<Null> tweet(String message) => ...
}

Using top-level methods

For simpler applications or scripts, Seltzer also provides a series of top-level convenience methods that automatically use a singleton instance of SeltzerHttp.

In your main() function, you just need to configure what platform you are expecting once:

import 'package:seltzer/seltzer.dart' as seltzer;
import 'package:seltzer/platform/browser.dart';

main() async {
  useSeltzerInTheBrowser();
  final response = await seltzer.get('some/url.json').send().first;
  print('Retrieved: ${await response.readAsString()}');
}

Using the WebSocket service

import 'dart:async';

import 'package:seltzer/seltzer.dart';
import 'package:seltzer/platform/vm.dart';

void main() {
  var service = new MyMessageService(connect('ws://127.0.0.1'));
  service.sendMessage('Hello World!');
}

class MyMessageService {
  final SeltzerWebSocket _webSocket;
   
  MyMessageService(this._webSocket);
  
  // Uses a SeltzerWebSocket to send a string message to a peer.
  //
  // This means if we are in the browser or the server we can expect
  // our WebSocket to work about the same.
  Future<Null> sendMessage(String message) => _webSocket.sendString(message);
}

seltzer's Issues

Can't run `pub get` with latest version of seltzer as a dependency

pub get outputs the following error:

Package reply has no versions that match 0.1.2-dev derived from:
- seltzer 0.4.0 depends on version 0.1.2-dev

SeltzerMessage is flawed: Some responses are streamed...

Such as I/O based, or chunked responses (common in HTTP)

Add example of using web socket to the README

SeltzerHttpResponse should return the HTTP response headers

Rename "server" to "io" (less confusing)

Especially given that Flutter is a client API, but uses dart:io.

Seltzer WS tests fail on Chrome

test/runtime/socket/browser_test.dart: SeltzerWebSocket should throw a StateError if data is sent after the socket closes
  InvalidAccessError: Failed to execute 'close' on 'WebSocket': The code must be either 1000, or between 3000 and 4999. 0 is neither.
  dart:html                                   EventTarget.close
  package:seltzer/platform/browser.dart 81:5  <fn>
  ===== asynchronous gap ===========================
  dart:_internal                              Object._asyncHelper
  package:seltzer/platform/browser.dart 81:5  <fn>
  ===== asynchronous gap ===========================
  dart:_internal                              Object._wrapJsFunctionForAsync
  package:seltzer/platform/browser.dart 79:3  BrowserSeltzerWebSocket.close
  package:seltzer/platform/browser.dart 82:3  BrowserSeltzerWebSocket.close
  test/common/ws.dart 39:13                   <fn>
  ===== asynchronous gap ===========================
  dart:_internal                              Object._wrapJsFunctionForAsync
  test/common/ws.dart 38:9                    runSocketTests.<fn>.<fn>

Add record/replay mode to simplify testing

Strawman:

import 'dart:io';

import 'package:seltzer/platform/server.dart';
import 'package:seltzer/platform/testing.dart';

main() {
  var recorder = new SeltzerHttpRecorder(const ServerSeltzerHttp());
  useSeltzerForTesting(http: recorder);
  await runTests();
  await recorder.dump('e2e_recording.json');
}

Usage:

main() async {
  useSeltzerForTesting(http: await SeltzerHttpPlayback.load('e2e_recording.json'));
  await runTests();
}

WebSocket.onClose should return a normalized CloseEvent...

Which includes the reason/error code.

Use UInt8Buffer instead of Stream#fold

Add CannedWebSocket implementation