Dart pub
Prevent comment spam using the Akismet service, in Dart.
The latest Dart SDK and Pub versions. If you plan to play with the sources, you will also need the latest Grinder version.
Add this to your package's pubspec.yaml file:
dependencies:
akismet: *
Install this package and its dependencies from a command prompt:
$ pub get
Now in your Dart code, you can use:
import 'package:akismet/akismet.dart';
try {
var client = new Client('your API key', 'http://your.blog.url');
var isValid = await client.verifyKey();
print(isValid ? 'Your API key is valid.' : 'Your API key is invalid.');
}
on Exception catch (err) {
print('An error occurred: $err');
}
try {
var comment = new Comment(
new Author('127.0.0.1', 'Mozilla/5.0'),
content: 'A comment.',
date: new DateTime.now()
);
var isSpam = await client.checkComment(comment);
print(isSpam ? 'The comment is marked as spam.' : 'The comment is marked as ham.');
}
on Exception catch (err) {
print('An error occurred: $err');
}
try {
await client.submitSpam(comment);
print('Spam submitted.');
await client.submitHam(comment);
print('Ham submitted.');
}
on Exception catch (err) {
print('An error occurred: $err');
}
The Client class triggers some events during its life cycle:
request : emitted every time a request is made to the remote service.response : emitted every time a response is received from the remote service.These events are exposed as Stream, you can listen to them using the on<EventName> properties:
client.onRequest.listen((request) => print('Client request: ${request.url}'));
client.onResponse.listen((response) => print('Server response: ${response.statusCode}'));
In order to run the tests, you must set the AKISMET_API_KEY environment variable to the value of your Akismet API key:
$ export AKISMET_API_KEY="<YourAPIKey>"
Then, you can run the test script from the command prompt:
$ pub run test
Akismet for Dart is distributed under the MIT License.
This file contains highlights of what changes on each version of the Akismet for Dart library.
final.toJson() and toString() methods from the Client class.version property is now private.CommentType enumeration.Client.serviceUrl constant to defaultEndPoint.Client.endPoint property.version constant.Blog.language string property for the languages list property.core, html and io) into the sole akismet one.DEFAULT_SERVICE constant, serviceUrl property and queryService() method from the Client class.EndPoints and HttpHeaders enumerations.VERSION constant.Client.toJson() method.onRequest and onResponse event streams to the Client class.Client constructor are now optional.Client.userAgent property.async/await implementation.role property to Author class.isTest property to Client class.date and postModified properties to Comment class.Future API to async and await.Server.start method to bind.Server.bindSecure method to support SSL protocol.Client child classes to the base abstract class.Blog class to support the latest Akismet APIs.Server events: you can listen to onClose, onError, onListening and onRequest streams.--silent option to server CLI.Server.stop method to close.HTTPHeaders constants by using X_ as prefix.Client.useSecureRequests property.Server class and CLI now use port 3000 as default.build.dart and tool/generate_docs.dart).Server class.tool folder.Server.secureRequests property to useSecureRequests.Uri in constructors can no longer be specified as String.Client.encoding property.EndPoints class providing the URLs of the Akismet service end points.Add this to your package's pubspec.yaml file:
dependencies:
akismet: ^3.2.0
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.
Now in your Dart code, you can use:
import 'package:akismet/akismet.dart';
|
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
0
|
|
Health:
Code health derived from static analysis.
[more]
|
--
|
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
--
|
|
Overall:
Weighted score of the above.
[more]
|
0
|
The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.
Support Dart 2 in pubspec.yaml.
The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://dart.dev/dart-2#migration.
Make sure dartdoc successfully runs on your package's source files. (-10 points)
Dependencies were not resolved.
| Package | Constraint | Resolved | Available |
|---|---|---|---|
| Direct dependencies | |||
| Dart SDK | >=1.24.0 <2.0.0 | ||