jaguar_throttle 2.4.1

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 46

jaguar_throttle #

Rate limiter for Jaguar

Usage #

@Api()
class ExampleApi {
  Throttler throttle(_) =>
      new Throttler(new Rate(new Duration(seconds: 10), 100));

  @Get(path: '/hello')
  @WrapOne(#throttle)
  String sayHello(Context ctx) => 'hello';
}

Docs #

Quota #

Rate class provides an easy to define count per time interval. It is used to specify throttling quote of the Throttler

The constructor of Rate takes interval in Duration and count.

Rate(Duration interval, int count);

To create a rate of 100 requests per 10 seconds:

new Rate(new Duration(seconds: 10), 100);

Id maker #

ThrottleIdMaker creates the criteria by which requests are throttled. ThrottleIdMaker is a function that takes Context object and returns a String identifying the request.

typedef FutureOr<String> ThrottleIdMaker(Context ctx);

By default, Throttler uses throttleIdByIp as ThrottleIdMaker. throttleIdByIp throttles requests by remote IP address.

Store #

Throttler uses Cache to store request count stats. By default, defaultThrottleCache, which is an InMemoryCache, is used as store.

Headers #

Throttler sets X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset rate-limit headers with quota, quota remaining and duration in seconds after which quota resets respectively. In case, the quota for the current interval is completely used, Throttler also sets the header Retry-After with duration in seconds after which the client can retry.

Changelog #

0.2.1 #

  • throttle function based throttler

0.2.0 #

  • Renamed Throttle to Throttler
  • Introduced Rate structure to hold quota

0.1.0 #

  • Expose ThrottleState through Interceptor output
  • Use Cache instead of ThrottleStore

0.0.1 #

  • Initial version, created by Stagehand

example/example.dart

// Copyright (c) 2017, Ravi Teja Gudapati. All rights reserved. Use of this source code
// is governed by a BSD-style license that can be found in the LICENSE file.

import 'dart:io';
import 'package:http/http.dart' as http;
import 'package:jaguar/jaguar.dart';
import 'package:jaguar_throttle/jaguar_throttle.dart';
import 'package:jaguar_client/jaguar_client.dart';

final client = JsonClient(new http.IOClient());

runServer() async {
  final jaguar = Jaguar(port: 10000)
    ..get('/one', (_) => 'one', before: [Throttler.perMin(10)])
    ..get('/two', (_) => 'two', before: [Throttler.perMin(10)]);
  await jaguar.serve();
}

runClient() async {
  for (int i = 0; i < 10; i++) {
    await client
        .get('http://localhost:10000/one')
        .expect([statusCodeIs(200), bodyIs('one')]);
  }
  await client
      .get('http://localhost:10000/one')
      .expect([statusCodeIs(429), bodyIs('Limit exceeded')]);
  await client
      .get('http://localhost:10000/two')
      .expect([statusCodeIs(429), bodyIs('Limit exceeded')]);
}

main() async {
  await runServer();
  await runClient();

  exit(0);
}

Use this package as a library

1. Depend on it

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


dependencies:
  jaguar_throttle: ^2.4.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

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

3. Import it

Now in your Dart code, you can use:


import 'package:jaguar_throttle/jaguar_throttle.dart';
  
Version Uploaded Documentation Archive
2.4.1 Sep 18, 2018 Go to the documentation of jaguar_throttle 2.4.1 Download jaguar_throttle 2.4.1 archive
2.1.4 Aug 8, 2018 Go to the documentation of jaguar_throttle 2.1.4 Download jaguar_throttle 2.1.4 archive
2.1.1 May 20, 2018 Go to the documentation of jaguar_throttle 2.1.1 Download jaguar_throttle 2.1.1 archive
1.3.1 Feb 2, 2018 Go to the documentation of jaguar_throttle 1.3.1 Download jaguar_throttle 1.3.1 archive
1.2.6 Jan 13, 2018 Go to the documentation of jaguar_throttle 1.2.6 Download jaguar_throttle 1.2.6 archive
0.2.2 Jul 23, 2017 Go to the documentation of jaguar_throttle 0.2.2 Download jaguar_throttle 0.2.2 archive
0.2.1 Jul 23, 2017 Go to the documentation of jaguar_throttle 0.2.1 Download jaguar_throttle 0.2.1 archive
0.2.0 Jul 23, 2017 Go to the documentation of jaguar_throttle 0.2.0 Download jaguar_throttle 0.2.0 archive
0.1.0 Jul 23, 2017 Go to the documentation of jaguar_throttle 0.1.0 Download jaguar_throttle 0.1.0 archive
0.0.1 Jul 22, 2017 Go to the documentation of jaguar_throttle 0.0.1 Download jaguar_throttle 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
8
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60
Overall:
Weighted score of the above. [more]
46
Learn more about scoring.

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

  • Dart: 2.1.0
  • pana: 0.12.13

Platforms

Detected platforms: Flutter, other

Primary library: package:jaguar_throttle/jaguar_throttle.dart with components: io.

Maintenance issues and suggestions

Homepage URL doesn't exist. (-20 points)

At the time of the analysis the homepage field https://github.com/Jaguar-dart/jaguar_throttle was unreachable.

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
jaguar ^2.4.4 2.4.26
jaguar_cache ^2.1.2 2.1.2
Transitive dependencies
auth_header 2.1.2
charcode 1.1.2
collection 1.14.11
convert 2.1.1
crypto 2.0.6
http_server 0.9.8+1
jaguar_common 2.1.4
jaguar_serializer 2.2.8
logging 0.11.3+2
meta 1.1.7
mime 0.9.6+2
path 1.6.2
path_tree 2.2.2
stack_trace 1.9.3
typed_data 1.1.6
Dev dependencies
jaguar_client ^2.4.1
test ^1.3.0