ifvictr / rebrandly.js

⚡ A promise-based client for the Rebrandly API in Node.js

rebrandly.js

A promise-based client for the Rebrandly API in Node.js.

Installation

npm install rebrandly --save

Usage

const Rebrandly = require("rebrandly");
const client = new Rebrandly({
    apikey: "API_KEY_HERE",
    // `workspace` is optional
    workspace: "WORKSPACE_HERE"
});

// Output all shortlinks and the destinations they point to
client.links.list().then(res => {
    for(const link of res) {
        console.log(`${link.domainName}/${link.slashtag} -> ${link.destination}`);
    }
});

Methods

Methods in this module wrap around the REST API specified here: https://developers.rebrandly.com

• rebrandly.account.get()
• rebrandly.account.getTeams(params)
• rebrandly.account.getWorkspaces(params)
• rebrandly.domains.count(params)
• rebrandly.domains.get(id)
• rebrandly.domains.list(params)
• rebrandly.links.count(params)
• rebrandly.links.create(params)
• rebrandly.links.delete(id, params)
• rebrandly.links.get(id)
• rebrandly.links.getScripts(id, params)
• rebrandly.links.getTags(id, params)
• rebrandly.links.list(params)
• rebrandly.links.update(id, params)
• rebrandly.scripts.count()
• rebrandly.scripts.create(params)
• rebrandly.scripts.delete(id)
• rebrandly.scripts.get(id)
• rebrandly.scripts.list(params)
• rebrandly.scripts.update(id, params)
• rebrandly.tags.count()
• rebrandly.tags.create(params)
• rebrandly.tags.delete(id)
• rebrandly.tags.get(id)
• rebrandly.tags.list(params)
• rebrandly.tags.update(id, params)

License

MIT

rebrandly.js's Issues

Add unit tests

Each test will test one functionality. Tests will be located under test/ and use the AVA testing framework.

Rename repository to rebrandly.js

Module name will not be affected.

Add website demo

Should be located at https://projects.ifvictr.com/rebrandly.

Add usage examples

Each script will demonstrate one functionality of the package. All examples will be located under examples/.

Don't unnecessary expose data in requests

Client._request's takes an object of key/value pairs for the data parameter and passes it as the value for qs and body. Potentially sensitive information is being exposed in qs, because it will be in request logs. The solution is to look for values with a valid key and delete them when they're no longer necessary.

Changes to make:

Client.js:

_request(method, uri, data, keys) {
    return axios({
        method: method,
        baseURL: "https://api.rebrandly.com/v1/",
        url: uri,
        params: data.get(keys.query),
        headers: {
            apikey: this.apiKey,
            ...data.get(keys.header)
        },
        data: data.get(keys.body),
        responseType: "json"
    }).then(({data}) => data);
}

Link.js:

list(params) {
    return this.client.get("/links", params, {
        query: [
            "domain.id",
            "status",
            "favourite",
            "orderBy",
            "orderDir",
            "offset",
            "limit"
        ],
        header: [
            "workspace"
        ]
    });
}