Commit: a089eb23fae184402f54847598deb4ed21225225 - node_sample_clitweets (git)

command line interface based Twitter client

Commit MetaInfo

• Revision: a089eb23fae184402f54847598deb4ed21225225 (tree)
• Time: 2012-12-19 01:25:47
• Author: hylom <hylom@hylo...>
• Commiter: hylom

Log Message

rewrite clienttweets.js

Change Summary

• modified: auth.js
• modified: clitweets.js
• add: tweetwriter.js

Incremental Difference

--- a/auth.js
+++ b/auth.js
@@ -2,31 +2,39 @@
 var oauth = require('oauth');
 var commander = require('commander');
 var Twitter = require('ntwitter');
+var fs = require('fs');
+var configFile = '.account';
 
 // OAuth parameters
 var consumerKey = 'd3MqFro8tVXtlEzz5hVrZA';
-var secretKey = 'RSWIniHQldyhhmLBj2PpP6V4gOnxf3vEEFUEZXT1Q';
+var consumerSecret = 'RSWIniHQldyhhmLBj2PpP6V4gOnxf3vEEFUEZXT1Q';
 var requestUrl = 'https://api.twitter.com/oauth/request_token';
 var accessUrl = 'https://api.twitter.com/oauth/access_token';
 var authUrl = 'https://api.twitter.com/oauth/authenticate';
 
-exports.authenticate = function (callback) {
+/*
+ * OAuth認証を行う
+ * @param {Function(err, token, secret)} callback
+ *  結果を受け取るコールバック関数。
+ *  err引数にはエラーオブジェクトが、token引数にはアクセストークンが、
+ *  secret引数にはsecret文字列が格納される
+ */
+function authenticate(callback) {
   var self = this;
   // Create authenticate client
   var client = new oauth.OAuth(
     requestUrl,
     accessUrl,
     consumerKey,
-    secretKey,
+    consumerSecret,
     '1.0',
     'oob',
     "HMAC-SHA1"
   );
 
-  // Send auth request to twitter
   client.getOAuthRequestToken(getAccessToken);
 
-  // get access token from request token
+  // リクエストトークンからアクセストークンを取得する
   function getAccessToken(err, token, secret, results) {
     if (err) {
       console.log('oauth request failed.');
@@ -36,31 +44,95 @@ exports.authenticate = function (callback) {
     console.log('Open URL printed below, and input displayed PIN code.');
     console.log(url);
     commander.prompt('Input PIN: ', function (pin) {
-      client.getOAuthAccessToken(token, secret, pin, createTwitterClient);
+      client.getOAuthAccessToken(token, secret, pin, receiveToken);
     });
   }
 
-  // create twitter object
-  function createTwitterClient(err, token, secret, results) {
+  // アクセストークンを受け取る
+  function receiveToken(err, token, secret, results) {
     if (err) {
-      console.log('oauth access token request failed.');
-      process.exit(1);
+      callback(err);
+      return;
     }
-    var twitter = self.createTwitterClient({
-      consumerKey: consumerKey,
-      consumerSecret: secretKey,
-      accessTokenKey: token,
-      accessTokenSecret: secret
-    }, callback);
+    callback(err, token, secret);
   }
 }
 
-exports.createTwitterClient = function (keys, callback) {
-  var twitter = new Twitter({
-    consumer_key: keys.consumerKey,
-    consumer_secret: keys.consumerSecret,
-    access_token_key: keys.accessTokenKey,
-    access_token_secret: keys.accessTokenSecret
+/*
+ * ntwitter.Twitterクラスのインスタンスを生成する
+ * @param {Object} keys アクセスに使用するキー
+ * @returns 作成されたインスタンス
+ */
+function createTwitterClient(keys) {
+  var twitter = new Twitter(keys);
+  return twitter;
+}
+
+/*
+ * .accountファイルにアクセストークン情報を書き出す
+ * @param {Object} twitter　ntwitter.Twitterクラスのインスタンス
+ * @param {Function(err)} callback エラーオブジェクトを返すコールバック関数
+ */
+function writeAuthenticationKeys(twitter, callback) {
+  var keys = {
+    access_token_key: twitter.options.access_token_key,
+    access_token_secret: twitter.options.access_token_secret
+  };
+  fs.writeFile(configFile, JSON.stringify(keys, null, 2), 'utf8', callback);
+}
+
+/*
+ * .accountファイルに保存しておいたアクセストークン情報を読み出す
+ * @param {Function(err, key)} callback コールバック関数。
+ *  err引数にはエラーオブジェクトが、
+ *  keys引数には読み出したアクセストークン情報を格納するオブジェクト
+ *  格納される
+ */
+function readAuthenticationKeys(callback) {
+  fs.readFile(configFile, 'utf8', function (err, data) {
+    if (err) {
+      callback(err);
+      return;
+    }
+    var keys = JSON.parse(data);
+    callback(err, keys);
+  });
+}
+
+/*
+ * 認証を行ってntwitter.Twitterクラスのインスタンスを返す
+ * @param {Function(err, twitter)} callback コールバック関数
+ *  err引数にはエラーオブジェクトが、
+ *  twitter引数には作成されたインスタンスが格納される
+ */
+exports.authenticate = function (callback) {
+  var keys = {
+    consumer_key: consumerKey,
+    consumer_secret: consumerSecret
+  };
+  // ファイルに保存しておいたアクセストークンを読み出す
+  readAuthenticationKeys(function (err, data) {
+    // 読み出しに失敗したら認証を実行する
+    if (err || data.access_token_key === undefined
+       || data.access_token_secret === undefined ) {
+      authenticate(function (err, token, secret) {
+        if (err) {
+          callback(err);
+        }
+        keys.access_token_key = token;
+        keys.access_token_secret = secret;
+        var twitter = createTwitterClient(keys);
+        // アクセストークンをファイルに保存しておく
+        writeAuthenticationKeys(twitter, function (err) {
+          callback(err, twitter);
+        });
+      });
+      return;
+    }
+    // 読み出しに成功したらその値からクライアントを作成する
+    keys.access_token_key = data.access_token_key;
+    keys.access_token_secret = data.access_token_secret;
+    var twitter = createTwitterClient(keys);
+    callback(null, twitter);
   });
-  callback(null, twitter);
-};
+}

--- a/clitweets.js
+++ b/clitweets.js
@@ -1,178 +1,142 @@
 #!/usr/local/bin/node
 
 var auth = require('./auth');
-var fs = require('fs');
-var util = require('util');
 var readline = require('readline');
 
-var configFile = '.account';
+var tweetWriter = require('./tweetwriter');
 
-var argv = require('optimist')
-  .usage('$0 - CLI based Twitter client.')
-  .describe('u', 'Twitter username')
-  .describe('p', 'Twitter password')
-  .argv;
-
-var rl;
-var timeLineCache = [];
-var isTimeLineAlive = false;
-var readlineMode = '';
+var rl = null;
 var twitter = null;
 
-// 認証キーを読み込み、認証を行ってメインルーチンを実行する
-readAuthenticationKeys(function (err, keys) {
-  if (err) {
-    authenticate(doMain);
-    return;
-  }
-  auth.createTwitterClient(keys, doMain);
-});
-
-function pushToCache(texts) {
-  if (isTimeLineAlive) {
-    process.stdout.write(texts);
-  } else {
-    timeLineCache.push(texts);
+// モードを表す疑似クラス
+var mode = {
+  current: null,
+  start: function (mode) {
+    if (this.current) {
+      this.current.exit();
+    }
+    this.current = mode;
+    this.current.start();
   }
 }
 
-function showTweet(tweet) {
-  if (util.isArray(tweet)) {
-    tweet.forEach(showTweet);
-    return;
-  }
-  if (tweet.user === undefined) {
-    return;
+// タイムラインモードを定義
+var timeline = {
+  start: function () {
+    if (rl !== null) {
+      rl.close();
+      rl = null;
+    }
+    tweetWriter.resume();
+    process.stdin.once('data', function () {
+      mode.start(command);
+    });
+    process.stdin.resume();
+  },
+  exit: function () {
+    tweetWriter.pause();
   }
-  var name = tweet.user.name + ' (@' + tweet.user.screen_name + ')';
-  var timestamp = tweet.created_at;
-  var text = tweet.text;
-  pushToCache(name + ' ' + timestamp + '\n');
-  pushToCache(text + '\n');
-  pushToCache('\n');
-}
+};
 
-var newTweet;
-var modes = {
-  tweet: {
-    start: function () {
-      rl.setPrompt('tweet> ');
-      process.stdout.write('write tweet message and push Ctrl-C.\n');
-    },
-    line: function (data) {
-      if (newTweet === '') {
-        newTweet = data;
-      } else {
-        newTweet = newTweet + '\n' + data;
-      }
-      rl.prompt();
-    },
-    SIGINT: function () {
-      process.stdout.write('\n----\n');
-      process.stdout.write(newTweet + '\n');
-      process.stdout.write('----\n');
-      var message = 'tweet this message? (y:yes/n:no) ';
-      function onAnswer(answer) {
-        if (answer === 'y') {
-          twitter.updateStatus(newTweet, {}, function (err, data) {
-          });
-          process.stdout.write('tweet done.\n\n');
-          exitPrompt();
-        } else if (answer === 'n') {
-          process.stdout.write('tweet canceled.\n\n');
-          exitPrompt();
-        } else {
-          rl.question(message, onAnswer);
-        }
+// コマンドラインモードを定義
+var command = {
+  start: function () {
+    rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+      completer: function (line) {
+        var completions = ['tweet', 'quit'];
+        var hits = completions.filter(function(c) {
+          return c.indexOf(line) == 0;
+        });
+        // show all completions if none found
+        return [hits.length ? hits : completions, line];
       }
-      rl.question(message, onAnswer);
-    },
+    });
+    rl.on('line', this.line);
+    rl.on('SIGINT', this.SIGINT);
+    rl.setPrompt('> ');
+    rl.prompt();
   },
-  prompt: {
-    start: function () {
-      rl.setPrompt('> ');
-    },
-    line: function (data) {
-      switch(data) {
-      case 'tweet':
-        setReadlineMode('tweet');
-        newTweet = '';
-        rl.prompt();
-        break;
-      case 'quit':
-        process.exit(0);
-      case '':
-        rl.prompt();
-        break;
-      default:
-        process.stdout.write('invalid command: ' + data + '\n');
-        rl.prompt();
-      }
-    },
-    SIGINT: function () {
-      exitPrompt();
-    },
+  exit: function () {
+  },
+  line: function (data) {
+    switch(data) {
+    case 'tweet':
+      mode.start(writeMessage);
+      break;
+    case 'quit':
+      process.exit(0);
+    case '':
+      mode.start(timeline);
+      break;
+    default:
+      process.stdout.write('invalid command: ' + data + '\n');
+      mode.start(timeline);
+      break;
+    }
+  },
+  SIGINT: function () {
+    mode.start(timeline);
   }
 }
 
-function setReadlineMode(modeName) {
-  var mode = modes[modeName];
-  rl.removeAllListeners('line');
-  rl.removeAllListeners('SIGINT');
-  rl.on('line', mode.line);
-  rl.on('SIGINT', mode.SIGINT);
-  mode.start();
-}
-
-function startPrompt() {
-  rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-    completer: function (line) {
-      var completions = ['tweet', 'quit'];
-      var hits = completions.filter(function(c) {
-        return c.indexOf(line) == 0;
-      });
-      // show all completions if none found
-      return [hits.length ? hits : completions, line];
+// tweet入力モードを定義
+var newMessage = '';
+var writeMessage = {
+  start: function () {
+    rl.removeAllListeners('line');
+    rl.removeAllListeners('SIGINT');
+    rl.on('line', this.line);
+    rl.on('SIGINT', this.SIGINT);
+    rl.setPrompt('tweet> ');
+    process.stdout.write('write tweet message and push Ctrl-C.\n');
+    newMessage = '';
+    rl.prompt();
+  },
+  exit: function () {
+  },
+  line: function (data) {
+    if (newMessage === '') {
+      newMessage = data;
+    } else {
+      newMessage = newMessage + '\n' + data;
     }
-  });
-  setReadlineMode('prompt');
-  rl.prompt();
-}
-
-function exitPrompt() {
-  rl.close();
-  startTimeLine();
-}
-
-function stopTimeLine() {
-  isTimeLineAlive = false;
-}
-
-function startTimeLine() {
-  process.stdin.once('data', function () {
-    stopTimeLine();
-    startPrompt();
-  });
-  process.stdin.resume();
-  timeLineCache.forEach(function (data) {
-    process.stdout.write(data);
-  });
-  timeLineCache = [];
-  isTimeLineAlive = true;
+    rl.prompt();
+  },
+  SIGINT: function () {
+    process.stdout.write('\n----\n');
+    process.stdout.write(newMessage + '\n');
+    process.stdout.write('----\n');
+    var message = 'tweet this message? (y:yes/n:no) ';
+    function onAnswer(answer) {
+      if (answer === 'y') {
+        twitter.updateStatus(newMessage, {}, function (err, data) {
+        });
+        process.stdout.write('tweet done.\n\n');
+        mode.start(timeline);
+      } else if (answer === 'n') {
+        process.stdout.write('tweet canceled.\n\n');
+        mode.start(timeline);
+      } else {
+        rl.question(message, onAnswer);
+      }
+    }
+    rl.question(message, onAnswer);
+  }
 }
 
-function doMain(err, twit) {
-  twitter = twit;
-  startTimeLine();
-
+// User streamによるタイムライン受信を開始
+function startUserStream() {
   twitter.getHomeTimeline({}, function (err, data) {
-    showTweet(data);
+    if (err) {
+      throw err;
+    }
+    tweetWriter.write(data.reverse());
   });
   twitter.stream('user', {}, function (stream) {
     stream.on('data', function (data) {
-      showTweet(data);
+      tweetWriter.write(data);
     });
     stream.on('error', function(err) {
       console.log(err);
@@ -180,35 +144,14 @@ function doMain(err, twit) {
   });
 };
 
-function authenticate(callback) {
-  auth.authenticate(function(err, twitter) {
-    if (err) {
-      callback(err);
-      return;
-    }
-    writeAuthenticationKeys(twitter, function(err) {
-      callback(null, twitter);
-    });
-  });
-}
+// ntwitter.Twitterクラスのインスタンスを生成する
+auth.authenticate(function (err, twit) {
+  twitter = twit;
 
-function readAuthenticationKeys(callback) {
-  fs.readFile(configFile, 'utf8', function (err, data) {
-    if (err) {
-      callback(err);
-      return;
-    }
-    var keys = JSON.parse(data);
-    callback(err, keys);
-  });
-}
+  // User streamを使ったタイムライン受信の開始
+  startUserStream();
+
+  // タイムラインモードを開始
+  mode.start(timeline);
+});
 
-function writeAuthenticationKeys(twitter, callback) {
-  var keys = {
-    consumerKey: twitter.options.consumer_key,
-    consumerSecret: twitter.options.consumer_secret,
-    accessTokenKey: twitter.options.access_token_key,
-    accessTokenSecret: twitter.options.access_token_secret
-  };
-  fs.writeFile(configFile, JSON.stringify(keys, null, 2), 'utf8', callback);
-}

--- /dev/null
+++ b/tweetwriter.js
@@ -0,0 +1,45 @@
+// tweetの書き込みを行うモジュール
+
+var buffer = [];
+var util = require('util');
+var writable =  false;
+
+exports.write = function (tweet) {
+  if (util.isArray(tweet)) {
+    tweet.forEach(_write);
+  } else {
+    _write(tweet);
+  }
+};
+
+function _write(tweet) {
+  if (tweet.user === undefined) {
+    return;
+  }
+  var name = tweet.user.name + ' (@' + tweet.user.screen_name + ')';
+  var timestamp = tweet.created_at;
+  var text = tweet.text;
+  _push(name + ' ' + timestamp + '\n');
+  _push(text + '\n');
+  _push('\n');
+}
+
+function _push(data) {
+  if (writable) {
+    process.stdout.write(data);
+  } else {
+    buffer.push(data);
+  }
+};
+
+exports.resume = function () {
+  buffer.forEach(function (data) {
+    process.stdout.write(data);
+  });
+  buffer = [];
+  writable = true;
+},
+
+exports.pause = function () {
+  writable = false;
+}