nyanko v1.0.0

Nyanko =＾● ⋏ ●＾=

Nyanko eat an image as a meal =＾● ⋏ ●＾=

Usage

var nyanko = require('nyanko');

var nyankoTwitter = require('nyanko-twitter');
var nyankoTumblr  = require('nyanko-tumblr');

nyankoTwitter.configure({
  consumer_key:        process.env.TWITTER_CONSUMER_KEY,
  consumer_secret:     process.env.TWITTER_CONSUMER_SECRET,
  access_token_key:    process.env.TWITTER_ACCESS_TOKEN,
  access_token_secret: process.env.TWITTER_ACCESS_TOKEN_SECRET
});

nyankoTumblr.configure({
  consumer_key:        process.env.TUMBLR_CONSUMER_KEY,
  consumer_secret:     process.env.TUMBLR_CONSUMER_SECRET,
  access_token_key:    process.env.TUMBLR_ACCESS_TOKEN_KEY,
  access_token_secret: process.env.TUMBLR_ACCESS_TOKEN_SECRET
});

nyanko.configure({
  cron: '0 */1 * * * *',
  keywords: ['cat', '猫'],
  providers: [
    nyankoTwitter,
    nyankoTumblr
  ]
});

nyanko.on('add', function(meal){
  // meal
  //  .url      - event url
  //  .provider - event provider
  //  .keyword  - event keyword
  //  .event    - event identifier
  //  .payload  - event some informations
  //
  // Some Action
});

nyanko.start();

Install

npm install nyanko

Plugin Develop

Implement register()

exports.register = function(handler, config) {
  var keywords = config.keywords;
  // Ticking Event
  handler.on('tick', function(meal) {
    // Something...
    var image = {
      id:       'image_identifier',
      url:      'http://image_url',
      link:     'http://image_link',
      provider: 'plugin_name',
      keyword:  ['matched_keyword'],
      event:    'add', // available event 'config', 'init', 'tick', 'add'
      payload:  {}     // original event payload
    };
    handler.emit('add', image);
  });
}

see nyanko-twitter, nyanko-tumblr

License

Distributed under the MIT License.