webfaction_api 0.8.3

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 69

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:
environment:
  sdk: '>1.24.0 <2.0.0'

dependencies:
  webfaction_api: '>=0.8.3'
  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)));

    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');
    client.app.createFromInstance(app)
        .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
client.login();
  1. Call api methods.

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.3

  • Bugfix: API's were not being set properly

0.8.2

  • Removed createList helper

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:


dependencies:
  webfaction_api: "^0.8.3"

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:webfaction_api/client.dart';

      import 'package:webfaction_api/response.dart';
  
Version Uploaded Documentation 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

Analysis

We analyzed this package on Jul 13, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
37 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100 / 100
Overall score:
Weighted score of the above. [more]
69
Learn more about scoring.

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in libraries.

Suggestions

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

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

  • Maintain an example.

    None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use webfaction_api.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.24.0 < 2.0.0
xml_rpc ^0.1.4 0.1.4 0.2.1
Transitive dependencies
async 2.0.7
charcode 1.1.2
collection 1.14.10
http 0.11.3+17
http_parser 3.1.2
matcher 0.12.3
path 1.6.1
petitparser 1.7.6
source_span 1.4.0
stack_trace 1.9.2
string_scanner 1.0.2
typed_data 1.1.5
xml 2.6.0 3.0.0
Dev dependencies
test ^0.12.0