Commit: c73b1f92a94573af44b1f954bbd42f1c117b928d - node_sample_clitweets (git)

command line interface based Twitter client

Commit MetaInfo

• Revision: c73b1f92a94573af44b1f954bbd42f1c117b928d (tree)
• Time: 2012-12-19 23:44:47
• Author: hylom <hylom@hylo...>
• Commiter: hylom

Log Message

update comments

Change Summary

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

Incremental Difference

--- a/auth.js
+++ b/auth.js
@@ -59,80 +59,52 @@ function authenticate(callback) {
 }
 
 /*
- * 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) {
+exports.getClient = function (callback) {
   var keys = {
     consumer_key: consumerKey,
     consumer_secret: consumerSecret
   };
   // ファイルに保存しておいたアクセストークンを読み出す
-  readAuthenticationKeys(function (err, data) {
+  fs.readFile(configFile, 'utf8', function (err, data) {
     // 読み出しに失敗したら認証を実行する
-    if (err || data.access_token_key === undefined
-       || data.access_token_secret === undefined ) {
+    if (err) {
       authenticate(function (err, token, secret) {
         if (err) {
           callback(err);
+          return;
         }
+
+        // クライアントを作成する
         keys.access_token_key = token;
         keys.access_token_secret = secret;
-        var twitter = createTwitterClient(keys);
+        var twitter = new Twitter(keys);
+
         // アクセストークンをファイルに保存しておく
-        writeAuthenticationKeys(twitter, function (err) {
+        var tokens = {
+          access_token_key: keys.access_token_key,
+          access_token_secret: keys.access_token_secret
+        };
+        var jsonString = JSON.stringify(tokens, null, 2);
+        fs.writeFile(configFile, jsonString, 'utf8', 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);
+    var token = JSON.parse(data);
+    keys.access_token_key = token.access_token_key;
+    keys.access_token_secret = token.access_token_secret;
+    var twitter = new Twitter(keys);
+
+    // 処理完了
     callback(null, twitter);
   });
-}
+};
+

--- a/clitweets.js
+++ b/clitweets.js
@@ -1,8 +1,8 @@
 #!/usr/local/bin/node
 
-var auth = require('./auth');
 var readline = require('readline');
 
+var auth = require('./auth');
 var tweetWriter = require('./tweetwriter');
 
 var rl = null;
@@ -20,7 +20,7 @@ var mode = {
   }
 }
 
-// タイムラインモードを定義
+// timelineモードを定義
 var timeline = {
   start: function () {
     if (rl !== null) {
@@ -29,6 +29,7 @@ var timeline = {
     }
     tweetWriter.resume();
     process.stdin.once('data', function () {
+      // commandモードに遷移
       mode.start(command);
     });
     process.stdin.resume();
@@ -38,7 +39,7 @@ var timeline = {
   }
 };
 
-// コマンドラインモードを定義
+// commandモードを定義
 var command = {
   start: function () {
     rl = readline.createInterface({
@@ -61,42 +62,52 @@ var command = {
   exit: function () {
   },
   line: function (data) {
+    // 入力された文字列に応じて処理を切り替える
     switch(data) {
     case 'tweet':
+      // writeMessageモードを開始する
       mode.start(writeMessage);
       break;
     case 'quit':
+      // アプリケーションを終了する
       process.exit(0);
     case '':
+      // timelineモードに遷移する
       mode.start(timeline);
       break;
     default:
+      // エラーメッセージを表示してtimelineモードに遷移する
       process.stdout.write('invalid command: ' + data + '\n');
       mode.start(timeline);
       break;
     }
   },
   SIGINT: function () {
+    // Ctrl-Cを受け付けたらtimelineモードに遷移する
     mode.start(timeline);
   }
 }
 
-// tweet入力モードを定義
+// writeMessageモードを定義
 var newMessage = '';
 var writeMessage = {
   start: function () {
+    newMessage = '';
+
+    // readlineインターフェイスのイベントハンドラの付け替えを行う
     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 {
@@ -105,10 +116,15 @@ var writeMessage = {
     rl.prompt();
   },
   SIGINT: function () {
+    // Ctrl-Cを受け付けたらメッセージの入力を終了する
     process.stdout.write('\n----\n');
     process.stdout.write(newMessage + '\n');
     process.stdout.write('----\n');
+
+    // メッセージを表示し、投稿するかどうかを確認する
     var message = 'tweet this message? (y:yes/n:no) ';
+    rl.question(message, onAnswer);
+
     function onAnswer(answer) {
       if (answer === 'y') {
         twitter.updateStatus(newMessage, {}, function (err, data) {
@@ -122,18 +138,23 @@ var writeMessage = {
         rl.question(message, onAnswer);
       }
     }
-    rl.question(message, onAnswer);
+
   }
 }
 
-// User streamによるタイムライン受信を開始
-function startUserStream() {
+// ntwitter.Twitterクラスのインスタンスを生成して処理を開始する
+auth.getClient(function (err, twit) {
+  twitter = twit;
+
+  // タイムライン最新20件を取得する
   twitter.getHomeTimeline({}, function (err, data) {
     if (err) {
       throw err;
     }
     tweetWriter.write(data.reverse());
   });
+
+  // User streamを使ったタイムライン受信を開始する
   twitter.stream('user', {}, function (stream) {
     stream.on('data', function (data) {
       tweetWriter.write(data);
@@ -142,14 +163,6 @@ function startUserStream() {
       console.log(err);
     });
   });
-};
-
-// ntwitter.Twitterクラスのインスタンスを生成する
-auth.authenticate(function (err, twit) {
-  twitter = twit;
-
-  // User streamを使ったタイムライン受信の開始
-  startUserStream();
 
   // タイムラインモードを開始
   mode.start(timeline);

--- a/tweetwriter.js
+++ b/tweetwriter.js
@@ -1,9 +1,12 @@
-// tweetの書き込みを行うモジュール
+var util = require('util');
 
 var buffer = [];
-var util = require('util');
 var writable =  false;
 
+/*
+ * tweetをコンソールに出力する
+ * @param {Object|Array} tweet 出力するtweet、もしくはその配列
+ */
 exports.write = function (tweet) {
   if (util.isArray(tweet)) {
     tweet.forEach(_write);
@@ -12,6 +15,25 @@ exports.write = function (tweet) {
   }
 };
 
+/*
+ * tweetのコンソールへの出力を再開する
+ */
+exports.resume = function () {
+  buffer.forEach(function (data) {
+    process.stdout.write(data);
+  });
+  buffer = [];
+  writable = true;
+},
+
+/*
+ * tweetのコンソールへの出力を一時停止する
+ */
+exports.pause = function () {
+  writable = false;
+}
+
+// tweetを整形して出力する
 function _write(tweet) {
   if (tweet.user === undefined) {
     return;
@@ -24,6 +46,8 @@ function _write(tweet) {
   _push('\n');
 }
 
+// コンソールへの書き出しが許可されていれば文字列を出力し
+// 許可されていなければバッファに格納する
 function _push(data) {
   if (writable) {
     process.stdout.write(data);
@@ -31,15 +55,3 @@ function _push(data) {
     buffer.push(data);
   }
 };
-
-exports.resume = function () {
-  buffer.forEach(function (data) {
-    process.stdout.write(data);
-  });
-  buffer = [];
-  writable = true;
-},
-
-exports.pause = function () {
-  writable = false;
-}