easy-twitter

easy-twitter

A basic Twitter API for Node.js / io.js written in ECMAScript 6. Follow, unfollow, tweet, get infos about a twitter account and more ...

Getting started

When you have installed and include this twitter module, you have to create a new instance:

Introduction

To use this module, you need to use either:

• Node.Js v4.0.0.
• Io.js v3.3.0

Installation

npm install easy-twitter --save

Launch your application

You need to use use_strict parameter:

node --use_strict your-app.js

#### Include the module

var TwitterClient = require('easy-twitter');
//_Create a new Twitter app and get the keys needed
var twitter = new TwitterClient({consumer_key: "xxxx", 
                                 consumer_secret: "yyyy",
                                 access_token_key: "zzzz", 
                                 access_token_secret : "aaaa"});

---

Usage

Create a tweet (message)

If you want to tweet a message you can use the method Twitter.tweet(). This method returns a promise with the message in parameter when succeed.

var message = 'Hello world !';
twitter.tweet(message)
            .then(function(data) {
                //_Successfully tweet the message
                console.log('Posted the tweet:' + data.tweet);
            })
            .catch(function(err) {
                //_If failed to tweet
                console.log(err.error);
            });

Create a tweet with image

The first parameter is the message you want to post and the second parameter is the path to the image that you want to post.

var message = 'I like Twitter !';
var path    = '/foo/bar/image.png';

twitter.uploadMedia(message, path)
    .then(function(data) {
        console.log('Tweeted the message: ' + data.message);
    })
    .catch(function(err) {
        console.log(err.error);
    });

Follow a twitter account

You can follow someone with the method follow() with the name of the twitter account in parameter. You can pass in parameter the name of the account with or without the '@'.

//_Both the variables are correct
var twitterAccount = 'iAmAlphaZz';
var secondTwitterAccount = '@iAmAlphaZz';

twitter.follow(twitterAccount)
    .then(function(data) {
        console.log('You\'re now following :' + data.user);    
    })
    .catch(function(err) {
        console.log(err.error);
    });

Unfollow a twitter account

The unfollow() method is used like the follow() method: you just have to pass in parameter the name of the twitter account.

//_Both the variables are correct
var twitterAccount = 'iAmAlphaZz';
var secondTwitterAccount = '@iAmAlphaZz';

twitter.unfollow(twitterAccount)
    .then(function(data) {
        console.log('You\'re now following :' + data.user);    
    })
    .catch(function(err) {
        console.log(err.error);
    });

Get the followers of a twitter account

Get the count (max: 200) followers list of twitterAccount

var twitterAccount = 'iAmAlphaZz';
var count = 12;

twitter.getFollowersList(twitterAccount, count)
    .then(function(data) {
        // data.followers : Array of the followers name ( 12 followers because count = 12)
        // data.fullInfos : More infos below
        // data.user : 'iAmAlphaZz' in this case
    })
    .catch(function(err) {
        console.log(err.error);
    });

The method getFollowersList() return three datas:

• followers: An array with the account names of the followers
• fullInfos: A JSON Object which contains a lot of informations. Here is a link showing the differents informations returned in this object ( look the 'Example Result' : https://dev.twitter.com/rest/reference/get/followers/list)
• user: Is the user name of the twitter account you entered in parameter to the method.

Get the friends of a twitter account

Get the count (max: 200)people from the followers list of twitterAccount. Actually, it returns only the lasts. The page parameter will able to choose more precisely.

var twitterAccount = 'iAmAlphaZz';
var count = 50;

twitter.getFollowersList(twitterAccount, count, page)
    .then(function(data) {
        // data.friends : Array of the friends name ( 50 followers because count = 50)
        // data.fullInfos : More infos below
        // data.user : 'iAmAlphaZz' in this case
    })
    .catch(function(err) {
        console.log(err.error);
    });

The method getFollowersList() return three datas:

• followers: An array with the account names of the followers
• fullInfos: A JSON Object which contains a lot of informations. Here is a link showing the differents informations returned in this object ( look the 'Example Result' : https://dev.twitter.com/rest/reference/get/friends/list)
• user: Is the user name of the twitter account you entered in parameter to the method.
• page: Is not yet implemented...

#### Get the followers count & friends count

twitter.getCounts('iAmAlphaZz')
    .then(function(data) {
        // data.user : In this case 'iAmAlphaZz'
        // data.followersCount : Count of people following the account in parameter
        // data.friendsCount : count of people the twitter account in parameter is following
    })
    .catch(function(err) {
        console.log(err.error);
    })