webfaction_api 0.8.1

  • README.md
  • Installing
  • Versions
  • 11

Build Status

webfaction_api #

A dart client for webfaction's RPC API.

Official reference: https://docs.webfaction.com/xmlrpc-api/

Webfaction info: https://www.webfaction.com/?aid=50399 (affiliate link)

Installation #

  1. pubspec.yaml:
  sdk: '>1.24.0 <2.0.0'

  webfaction_api: '>=0.8.1'
  1. pub get

Documentation #

~/dart-webfaction-api/ $ dartdoc
~/dart-webfaction-api/ $ pub serve doc/api

Example #

import 'package:webfaction_api/client.dart';
import 'package:webfaction_api/response.dart';

main() async {
  var client = new Client('username', 'password', 'SomeServer543');
  await client.login();

  // or

  client.login().then((response) async {
    List<Map> rawResponse = await client.app.list();

    // Response objects imported from `response.dart`
    List<App> appListManuallyCreated = await client.app.list()
        .then((response) => response.map((data) => new App.fromMap(data)));

    // ... the `createList` helper is imported from 'create_list.dart`
    // It uses mirrors and is incompatible with flutter
    List<App> appListUsingHelper = await client.app.list()
        .then((response) => createList(App, response));

    App newApp = await client.app
        .create('MyNewApp', 'django-2.0.5_mod_wsgi-4.6.4_python-3.6')
        .then((response) => new App.fromMap(response));

    // Or pass objects around
    App app = new App('MyNewApp', 'django-2.0.5_mod_wsgi-4.6.4_python-3.6');
        .then((_) => client.app.deleteFromInstance(app));

Usage Summary #

  1. Import client.dart for the client and API classes. Import response.dart to use the response objects and related helper function
import 'package:webfaction_api/client.dart';
import 'package:webfaction_api/response.dart';
  1. Instantiate a client with your webfaction username, password, and server name
var client = new Client('username', 'password, 'Server153');
  1. Login. The session ID is stored in the client so there is no need to pass it to subsequent calls. According to webfaction, the session ID remains valid for one hour
  1. Call api methods.

Fluter compatibility: mirrors #

Neither client.dart nor response.dart use mirrors, however the create_list.dart helper does.

Method location #

The webfaction API is large and flat. In order to tidy things up and make code completion more helpful, the methods were grouped and scoped to class properties corresponding to the section or subsection they appear under on the API reference page.

For example, methods under Applications are found on client.app.<method>

A couple slight deviations from this convention are as follows:

  • Databases: client.db
  • Email -> Addresses: client.email
  • Email -> Mailboxes: client.mailbox
  • Miscellaneous: client.misc
  • General -> Login: client.login(...)

Method naming #

The method names use camel case instead of snake case, as per dart style recommendations, and the 'section' is removed from the name:

create_db becomes client.db.create

create_db_user becomes client.db.createUser

API response objects #

A collection of dumb objects have been provided that represent API input or output.

Most methods have a corresponding <methodName>FromInstance or FromInstances method that can be called with objects instead of manually passing individual parameters.

Objects intended to be used with API methods that return data have a .fromMap factory constructor that can be used to instanciate directly with the response data.

0.8.1 #

  • Isolated createList to its own package to allow compatibility with flutter

0.8.0 #

  • Complete API support
  • Response objects include to use with the API

Use this package as a library

1. Depend on it

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

  webfaction_api: ^0.8.1

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:webfaction_api/client.dart';
import 'package:webfaction_api/create_list.dart';
import 'package:webfaction_api/response.dart';
Version Uploaded Documentation Archive
1.0.1 Dec 22, 2018 Go to the documentation of webfaction_api 1.0.1 Download webfaction_api 1.0.1 archive
1.0.0 Aug 4, 2018 Go to the documentation of webfaction_api 1.0.0 Download webfaction_api 1.0.0 archive
0.9.2 Aug 4, 2018 Go to the documentation of webfaction_api 0.9.2 Download webfaction_api 0.9.2 archive
0.9.1 Aug 3, 2018 Go to the documentation of webfaction_api 0.9.1 Download webfaction_api 0.9.1 archive
0.9.0 Jul 21, 2018 Go to the documentation of webfaction_api 0.9.0 Download webfaction_api 0.9.0 archive
0.8.3 Jun 10, 2018 Go to the documentation of webfaction_api 0.8.3 Download webfaction_api 0.8.3 archive
0.8.2 Jun 10, 2018 Go to the documentation of webfaction_api 0.8.2 Download webfaction_api 0.8.2 archive
0.8.1 Jun 10, 2018 Go to the documentation of webfaction_api 0.8.1 Download webfaction_api 0.8.1 archive
0.8.0 May 13, 2018 Go to the documentation of webfaction_api 0.8.0 Download webfaction_api 0.8.0 archive
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

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.

Analysis issues and suggestions

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.

Maintenance issues and suggestions

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