birdwatch

Birdwatch :baby_chick::watch:

Get raw tweets from one or more specific twitter feeds.

Birdwatch will help you grab tweets from specific twitter accounts, and cache the tweets on-disk and in-memory on your server, thus avoiding any request limits set by the Twitter API, and giving you more control over the data that is saved. You can filter tweets by hashtags, or ignore retweets.

Note: This is a work in progress. Pull requests welcome!

Features

• Simple API
• Easily configure how often you want the cache to update
• Filter the tweets by hashtags
• Easy setup
• Option to ignore retweets

Usage

var Birdwatch = require('./index');

// Birdwatch @reactjs & @nodejs twitter feeds and update every 10 mins
var birdwatch = new Birdwatch({refreshTime: 600})
    .feed('reactjs', {filter_tags: /#reactjs/i })
    .feed('nodejs',  {filter_tags: /#nodejs/i  });

// Start the birdwatching process
birdwatch.start(function (err) {
    if(!err) {
        // done
    }
});

// Now get your tweets in JSON format to serve or print
birdwatch.getCachedTweets().then(function(tweetdata){
    console.log(tweetdata);
});

TODO:

• Better serving solution
• Write documentation
• Allow custom sorting rules
• HTML-ify the cached tweets
• More caching options (currently on-disk/in-memory only)

License

The MIT License (MIT)

Copyright (c) 2015 Michael Wuergler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.