Introducing Node.js API wrapper for Utopian.rocks

in #utopian-io6 years ago (edited)

Repository

https://github.com/gigatoride/node-utopian-rocks

NPM Package

https://www.npmjs.com/package/node-utopian-rocks

node-utopian-rocks

What is the project about?

I've realized that utopian.io official API isn't available for a while, And all existing Utopian API modules can't be functioning while API provider isn't available, I also have realized many people were asking for API which is only available at utopian.rocks, however, I couldn't find any module for Node.js API wrapper available for it then I've decided to make a module for it which gonna make any projects depends on Utopian API comes back to work easily by just installing that alternative module and following simple usage instructions.

Usage

Install using npm:

npm install node-utopian-rocks

Then

const utopian = require('node-utopian-rocks');

Examples

Calling Asynchronously:

// Retrieve posts by category, status
await utopian.getPosts('development', 'reviewed')

// Retrieve posts by category, status, author, non-staff-picks
await utopian.getPosts('development', 'reviewed', 'gigatoride', null, false)

// Retrieve moderators
await utopian.getModerators();

// Retrieve Statistics by today for task requests
await utopian.getStats('today', 'task_requests');

You can also do it using then()
for more information please visit README.md

Test

For testing using jest

npm test

Results:
test.png

Technology Stack

  • Node.js
  • JavaScript

Roadmap

  • Adding any upcoming API calls that will be available on https://utopian.rocks
  • More improvements and more advanced options, configs.

Commits

the project has been published recently
https://github.com/gigatoride/node-utopian-rocks/commits/master

How to contribute?

Feel free to contribute to the project by opening a new pull request or open a new issue if there is any bug.
To get in touch with me please use my email address in my GitHub profile.

GitHub Account

https://github.com/gigatoride

Sort:  

Thank you for your contribution.

  1. This is a nice wrapper for the utopian.rocks API, although I'd like to see further data extractions from JSON data.
  2. There used to be some projects e.g. this that is based on the official utopian API - but seems suspended and no longer in use after the incident.
  3. +1 for the tests. But expecting to be 'object' may not be good enough - In Javascript, every thing is object.

Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post, click here.


Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]

Thank you for your review, @justyy!

So far this week you've reviewed 3 contributions. Keep up the good work!

Thanks, your feedback will be taken into account for further improvements.

Hi @gigatoride!

Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your post is eligible for our upvote, thanks to our collaboration with @utopian-io!
Feel free to join our @steem-ua Discord server

Hey, @gigatoride!

Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!

Get higher incentives and support Utopian.io!
Simply set @utopian.pay as a 5% (or higher) payout beneficiary on your contribution post (via SteemPlus or Steeditor).

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!

Coin Marketplace

STEEM 0.30
TRX 0.12
JST 0.034
BTC 64136.70
ETH 3128.20
USDT 1.00
SBD 3.94