flutter_ghost_content_api 0.0.3

Flutter Ghost Content API #

A flutter wrapper around the Ghost Content API.

Blog post Explanation #

See this Ghost Content API blog post for a more in-depth explanation of the package.

Usage #

Before anything else, you will need to create a custom integration in your blog admin portal and make note of the Content API Key and URL.

Next, create a GhostContentAPIProvider at the root of your Flutter application:

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return GhostContentAPIProvider(
      client: GhostContentAPIClient(
        version: 'v2',
        url: 'https://your-subdomain.ghost.io',
        contentAPIkey: 'your content api key',
      ),
      child: MaterialApp(
        title: 'Flutter Demo',       
        home: MyHomePage(),
      ),
    );
  }
}

Finally, you can use a FutureBuilder anywhere you would like to access your Ghost content:

class MyHomePage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Flutter Ghost"),
      ),
      body: FutureBuilder(
        future: GhostContentAPIProvider.of(context).getPosts(),
        builder: (BuildContext context, AsyncSnapshot<PostsResponse> snapshot) {
          // Build your UI
        },
      ),
    );
  }
}

Alternatively, all calls through the Ghost Content API client returns a simple Future, so you can use any mechanism you need to for your app.

Example #

See the Flutter Ghost App for Learn Software for real-world usage.

Tests #

You can test this package by running the following commands:

  • flutter packages get
  • flutter test

Issues and Contributing #

See the GitLab project.

Changelog #

All notable changes to this project will be documented in this file.

[Unreleased]

[0.0.3] - 2019-06-01

Added #

  • Added repository, issue tracker and longer description to pubspec.yaml

[0.0.2] - 2019-05-31

Added #

  • Added blog post and more information the readme file

[0.0.1] - 2019-05-31

Added #

  • Created the initial package

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_ghost_content_api: ^0.0.3

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_ghost_content_api/flutter_ghost_content_api.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
23
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
57
Learn more about scoring.

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

  • Dart: 2.4.0
  • pana: 0.12.19
  • Flutter: 1.7.8+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-0.68 points)

184 out of 186 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and flutter_ghost_content_api.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
http ^0.12.0+2 0.12.0+2
Transitive dependencies
async 2.3.0
charcode 1.1.2
collection 1.14.11 1.14.12
http_parser 3.1.3
meta 1.1.6 1.1.7
path 1.6.4
pedantic 1.8.0+1
sky_engine 0.0.99
source_span 1.5.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test
mockito 4.0.0