atig 0.0.1

data/docs/hacking_guide.rst

@@ -0,0 +1,43 @@
+内部構造
+==============================
+
+
+全体図
+------------------------------
+
+.. image:: _static/structure.png
+
+Twitter
+------------------------------
+
+ - TwitterのAPIを叩くためのクラス
+
+Scheduler
+------------------------------
+
+ - API呼び出し回数を最適化するためのクラス(予定)
+
+
+Agent
+------------------------------
+
+ - Twitterから情報を取得し、DBに登録するクラス
+ - 例: メインタイムラインを取得し、DBに登録する
+
+Db
+------------------------------
+
+Gateway
+------------------------------
+
+Channel
+------------------------------
+
+IFilter
+------------------------------
+
+OFilter
+------------------------------
+
+Command
+------------------------------

data/docs/index.rst

@@ -0,0 +1,109 @@
+.. atig documentation master file, created by
+   sphinx-quickstart on Mon Mar 15 15:36:01 2010.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+atig.rb : Another Twitter Irc Gateway
+==================================
+atig.rbはTwitterとIRCを結ぶゲートウェイです。
+
+スクリーンショット
+------------------------------
+
+.. image:: _static/limechat_s.png
+
+ダウンロード
+------------------------------
+
+ - 安定板: `atigrb-0.3.2.tgz`_. ( `過去のバージョン`_ )
+ - 開発版: `Github Repository`_.
+
+.. _atigrb-0.3.2.tgz: http://github.com/mzp/atig/tarball/v0.3.2
+.. _過去のバージョン: http://github.com/mzp/atig/downloads
+.. _GitHub Repository: http://github.com/mzp/atig
+
+既知のバグ
+------------------------------
+
+ - sqlite3-ruby 1.3.0/1.3.1に対応していません。(`Issue 2`_ )
+
+.. _Issue 2: http://github.com/mzp/atig/issues#issue/2
+
+特徴
+------------------------------
+
+必要なのはIRCクライアントだけ
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - IRCクライアントさえあれば、どこからでもTwitterできます。
+ - CUI中毒やEmacs中毒の方でも安心してお使いいただけます。
+
+Listsにも対応してます
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - Listsはチャンネルになります。
+
+大抵のOSで動きます
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - Rubyで書いてあるので大抵のOSで動作します。
+
+IRC用のソフトが流用できます。
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - 既存のIRC用のソフトを流用することができます。
+ - 例えば、IRCプロキシであるTiarraと連携させることで、24時間Twitterのログがとることが可能です。
+
+
+
+.. 構造化された設計
+   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    ~ tig.rbよりいいよ
+
+その他のドキュメント
+------------------------------
+.. toctree::
+   :maxdepth: 2
+
+   quickstart
+   feature
+   irc
+   commandline_options
+   options
+   commands
+   config
+   tig
+   changelog
+
+バグ、疑問点、不満点を見つけたときは
+------------------------------------
+
+こんな場合は、mzpまで気軽にご連絡ください。
+できる範囲でサポートします。
+
+ - atig.rbの挙動がおかしい
+ - 設定の仕方がよく分からない
+ - 欲しい機能がなかった
+ - atig.rbに足りないクールな機能を実装したぜ
+
+連絡方法は以下のものがあります。それ以外の方法でもmzpまでに届けばかまいません。
+
+ - Githubの `Issues`_ に登録する。
+ - `@mzp`_ 宛につぶやく。
+ - `Blog`_ の適当なページにコメントをつける
+ - Githubでforkして、pull requestを送る
+
+.. _Issues: http://github.com/mzp/atig/issues
+.. _@mzp: http://twitter.com/mzp/
+.. _Blog: http://d.hatena.ne.jp/mzp/
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+
+
+.. |heart| replace:: ♥

data/docs/irc.rst

@@ -0,0 +1,31 @@
+IRCコマンド
+==============================
+
+nickなどの扱い
+------------------------------
+
+ - nick: OAuthのプロファイル名、ベーシック認証時のユーザ名
+ - real: クライアントオプション。詳細は :doc:`options` を参照してください。
+ - pass: ベーシック認証時のパスワード
+
+IRCコマンドとの対応
+------------------------------
+
+\/invite ``screen_name`` ``channel``
+  ``channel`` がメインチャンネル(通常は#twitter)の場合、ユーザ ``screen_name`` をフォローします。  同時にユーザ一覧の更新も行なうので、「follow ``screen_name`` 」と発言するよりも便利です。
+
+  ``channel`` がリストチャンネルの場合、ユーザ ``screen_name`` をリストに追加します。
+
+\/kick ``screen_name`` ``channel``
+  ``channel`` がメインチャンネル(通常は#twitter)の場合、ユーザ ``screen_name`` をリムーブします。
+
+  ``channel`` がリストチャンネルの場合、ユーザ ``screen_name`` をリストから削除します。
+
+\/whois ``screen_name``
+  ``screen_name`` の情報を表示します。ID番号、名前、自己紹介、現在地などを表示します。
+
+\/topic ``topic``
+  :doc:`commands` の `autofix` へのエイリアスです。
+  ``topic`` が前回の発言と類似している場合、古い発言を上書きします。
+\/who ``channel``
+  ``channel`` の参加者の情報を表示します。ID番号、名前などを表示します。

data/docs/options.rst

@@ -0,0 +1,75 @@
+クライアントオプション
+==================================
+
+概要
+------------------------------
+realnameのユーザ名の後ろにいろいろと書くことで、各オプションを有効にできます。
+
+例えば次のようにすると、tidオプションとonlyオプションが有効になります。 ::
+
+    twitter {
+        host: localhost
+        port: 19876
+        name: mzp tid only
+    }
+
+:doc:`commands` のoptコマンドを用いると、実行中に変更できます。
+
+発言関係
+------------------------------
+tid
+  各発言にtidを表示します。tidは特定の発言へreplyする場合などに利用します。
+
+  :doc:`commands` も参照してください。
+sid
+  各発言にsidを表示します。sidはtidと同様に利用できます。
+
+  sidは ``ユーザ名``:\ ``id`` という書式にです。そのため、
+  ユーザ名の補完機能のあるクライアントではtidより入力が容易です。
+
+フォロワー関係
+------------------------------
+only
+  指定すると片思い表示機能を有効にします。有効にしていると、自分が一方的
+  にフォローしている人に ``+o`` がつきます。たいていのクライアントだと
+  ``@`` がつきます。
+
+発言関連
+------------------------------
+footer=\ ``footer``
+  発言の末尾に、 ``footer`` を追加します。
+  ただし ``footer`` がfalseの場合は、追加しません。
+old_style_reply
+  @nickで始まる発言が、@nick の最新の発言へのreplyとなるモードに切り替えます。
+
+URL短縮関係
+------------------------------
+
+発言中の長いURLを自動で短縮します。どの短縮URLサービスを用いて短縮する
+か、どの程度の長さのURLを短縮するか、などが設定できます。
+
+bitlify=\ ``size``
+  ``size``\ 字以上のURLを http://bit.ly\ によって短縮します。
+bitlify
+  |len|\ 字以上のURLを http://bit.ly\ によって短縮します。
+bitlify=\ ``api_key``:\ ``api_key``:\ ``size``
+  ``size``\ 字以上のURLを http://bit.ly のAPIによって短縮します。
+  APIを利用して短縮すると、ユーザページに短縮したURLが記録されたりします。
+  詳しくは、 http://bit.ly のSign up for bit.lyを読んでください。
+bitlify=\ ``api_key``:\ ``api_key``
+  |len|\ 字以上のURLを http://bit.ly のAPIによって短縮します。
+unuify= \ ``size``
+  ``size`` 字以上のURLを http://u.nu によって短縮します。
+unuify
+  |len| 字以上のURLを http://u.nu によって短縮します。
+
+.. |len| replace:: 20
+
+システム関係
+------------------------------
+api_base=\ ``api_base``
+  Twitterのエントリポイントを指定します。実行中の変更には対応していません。指定しない場合は、https://api.twitter.com/1/が用いられます。
+.. stream_api_base=\ ``api_base``
+   Stream APIのエントリポイントを指定します。実行中の変更には対応していません。指定しない場合は、http://stream.twitter.com/1/'が用いられます。
+   stream_timeout=\ ``timeout``
+   Stream APIの接続は一定時間ごとに再接続を行ないます。その時間間隔を指定します。0を指定した場合は、再接続を行ないません。

data/docs/quickstart.rst

@@ -0,0 +1,89 @@
+クイックスタート
+================
+
+必要なソフトウェア
+------------------------------
+以下のものが必要です。
+
+ - Ruby 1.8/1.9
+ - Sqlite3
+ - 適当なIRCクライアント(例: `LimeChat`_ )
+
+.. _LimeChat: http://limechat.net/
+
+またRubyには次のライブラリがインストールされている必要があります。
+
+ - oauth
+ - sqlite3-ruby
+ - json(Ruby 1.8の場合, Ruby 1.9の場合は不要)
+ - rspec(単体テストを実行する場合, 開発者以外は不要)
+ - rake(単体テストを実行する場合, 開発者以外は不要)
+
+インストール
+------------
+
+リリース版
+~~~~~~~~~~
+`GitHub`_ からダウンロードしてください。
+
+.. _GitHub: http://github.com/mzp/atig/downloads
+
+
+trunk版
+~~~~~~~~~~
+githubからpullしてください。::
+
+ $ git pull http://mzp.github.com/atig
+
+使ってみる
+----------
+
+起動
+~~~~~~~~~
+コマンドラインから起動します。::
+
+ $ cd atig
+ $ ruby atig.rb -d
+ I, [2010-04-05T07:22:07.861527 #62002]  INFO -- : Host: localhost Port:16668
+
+接続
+~~~~~~~~~
+IRCクライアントで、localhost:16668に接続します。
+
+ - nickname: Twitterのユーザ名
+ - login name: 使ってないので適当に
+ - real name: :doc:`options` 。tidがおすすめです。
+ - password: 空欄
+ - 詳しくは :doc:`irc` を参照してください。
+
+.. image:: _static/irc_setting.png
+
+
+
+OAuth認証
+~~~~~~~~~
+初回接続時のみ、OAuthで認証させる必要があります。
+接続時に#oauthにjoinされ、認証用のURLが表示されます。
+
+.. image:: _static/oauth_channel.png
+
+表示されたURLにアクセスし、atig.rbに認証を与えます。
+
+.. image:: _static/allow.png
+
+7桁の数字が表示されるので、それを#oauthに入力します。
+
+.. image:: _static/verify.png
+
+発言してみる
+~~~~~~~~~~~~
+ - #twitterで発言すると、Twitterに投稿されます。
+ - :doc:`commands` を用いると、RTやreplyが行なえます。
+
+さらに詳しい使い方
+--------------------
+
+ - Tiarraと連携させると、発言のログを取ることができす。
+ - `God`_ などと連携させると、atig.rbを常駐(デーモン化)させることができます。
+
+.. _God: http://god.rubyforge.org/

data/docs/resize.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+for i in $@; do
+    echo $i
+    mv $i $i.$$
+    convert -resize 300x300 $i.$$ $i
+    rm -f $i.$$
+done

data/docs/tiarra.rst

@@ -0,0 +1,2 @@
+Tiarraとの連携
+==============

data/docs/tig.rst

@@ -0,0 +1,21 @@
+tig.rbとの違い
+==================================
+atig.rbは `tig.rb`_ から派生したプロジェクトです。
+
+.. _tig.rb: http://github.com/cho45/net-irc
+
+そのため基本的な機能は同様ですが、いくつかの細かい点が異なります。
+
+機能の違い
+------------------------------
+
+ - 認証にxAuthではなくOAuthを使う。
+ - ツイートを指定するのにtidだけでなくsidが使える。 sidは :doc:`options` の `sid` を参照してください。
+ - 一部の :doc:`commands` の名前が異なる。例: tig.rbだと `list` 、atig.rbでは `user`\ 。
+ - 自分への言及を表示する `#mention` チャンネルや、リツイートを表示する `#retweet` チャンネルがある。 :doc:`config` の「チャンネルの変更」で変更できます。
+ - 自分への言及が `#twitter` チャンネルに表示されません。
+
+その他の違い
+------------------------------
+ - クラス単位でファイルを分割しているます。たぶん、コードをいじりやすいはず。
+ - :doc:`commands` は本体のコードを触らずに拡張可能(たぶん)

data/lib/atig.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+$KCODE = "u" unless defined? ::Encoding # json use this
+
+require 'rubygems'
+require 'sqlite3'
+require 'net/irc'
+require 'oauth'
+require 'json'
+
+require 'atig/version'
+require 'atig/monkey'
+require 'atig/twitter'
+require 'atig/scheduler'
+require 'atig/agent'
+require 'atig/ifilter'
+require 'atig/ofilter'
+require 'atig/command'
+require 'atig/channel'
+require 'atig/gateway'

data/lib/atig/agent.rb

@@ -0,0 +1,8 @@
+require 'atig/agent/full_list'
+require 'atig/agent/following'
+require 'atig/agent/list_status'
+require 'atig/agent/mention'
+require 'atig/agent/dm'
+require 'atig/agent/timeline'
+require 'atig/agent/clenup'
+require 'atig/agent/user_stream'

data/lib/atig/agent/agent.rb

@@ -0,0 +1,38 @@
+# -*- mode:ruby; coding:utf-8 -*-
+
+require 'atig/util'
+
+module Atig
+  module Agent
+    class Agent
+      include Util
+
+      def initialize(context, api, db)
+        @log = context.log
+        @api = api
+        @prev = nil
+
+        log :info, "initialize"
+
+        @api.repeat( interval ) do|t|
+          q = { :count => 200 }
+          if @prev
+            q.update :since_id => @prev
+          else
+            q.update :count => 20
+          end
+
+          sources = t.get( path, q)
+
+          sources.reverse_each do|s|
+            db.statuses.transaction do|d|
+              d.add :source => source, :status => s, :user => s.user
+            end
+          end
+
+          @prev = sources.first.id if sources && !sources.empty?
+        end
+      end
+    end
+  end
+end