atig 0.4.5 → 0.5.0

data/docs/feature.rst

@@ -1,41 +0,0 @@
-atig.rbの特徴
-==============================
-
-主な機能
-------------------------------
- * フレンドタイムライン/DM/Mentionの取得
- * OAuthによる認証
- * ListsによるFollowingの分類
- * 公式RT/コメント付き非公式RT
- * IRCクライアントならなんでも使える柔軟性
-
-動作環境
-------------------------------
-開発時には以下の環境でテストしています。
-
- * MacOS 10.5(Leopard) + Ruby 1.9
- * MacOS 10.6(Snow Leopard) + Ruby 1.9
- * CentOS 5.3 + Ruby 1.8
-
-スクリーンショット
-------------------------------
-
-`Lime Chat`_
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. _Lime Chat: http://limechat.net/
-
-.. image:: _static/limechat.png
-
-`Irssi`_
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. _Irssi: http://www.irssi.org/
-
-.. image:: _static/irssi.png
-
-`Riece`_ on Emacs.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. _Riece: http://www.nongnu.org/riece/index.html.ja
-
-.. image:: _static/emacs.png
-

data/docs/hacking_guide.rst

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

data/docs/index.rst

@@ -1,102 +0,0 @@
-.. 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.4.3.tgz`_. ( `過去のバージョン`_ )
- - 開発版: `Github Repository`_.
-
-.. _atigrb-0.4.3.tgz: http://github.com/mzp/atig/tarball/v0.4.3
-.. _過去のバージョン: http://github.com/mzp/atig/tags
-.. _GitHub Repository: http://github.com/mzp/atig
-
-特徴
-------------------------------
-
-必要なのは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 の挙動がおかしい
- - 設定の仕方がよく分からない
- - 欲しい機能がなかった
- - atig に足りないクールな機能を実装したぜ
-
-連絡方法は以下のものがあります。それ以外の方法でも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

@@ -1,31 +0,0 @@
-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

@@ -1,76 +0,0 @@
-クライアントオプション
-==================================
-
-概要
-------------------------------
-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`` がつきます。たいていのクライアントだと
-  ``@`` がつきます。
-
-発言関連
-------------------------------
-stream
-  `UserStream`_ を有効にします。
-  実行中の変更には対応していません。
-footer=\ ``footer``
-  発言の末尾に、 ``footer`` を追加します。
-  ただし ``footer`` がfalseの場合は、追加しません。
-old_style_reply
-  @nickで始まる発言が、@nick の最新の発言へのreplyとなるモードに切り替えます。
-
-.. _UserStream: https://dev.twitter.com/docs/streaming-apis/streams/user
-
-URL短縮関係
-------------------------------
-
-発言中の長いURLを自動で短縮します。どの短縮URLサービスを用いて短縮する
-か、どの程度の長さのURLを短縮するか、などが設定できます。
-
-bitlify
-  |len|\ 字以上のURLを http://bit.ly\ によって短縮します。
-bitlify=\ ``size``
-  ``size``\ 字以上のURLを http://bit.ly\ によって短縮します。
-bitlify=\ ``username``:\ ``api_key``
-  |len|\ 字以上のURLを http://bit.ly のAPIによって短縮します。
-bitlify=\ ``username``:\ ``api_key``:\ ``size``
-  ``size``\ 字以上のURLを http://bit.ly のAPIによって短縮します。
-  APIを利用して短縮すると、ユーザページに短縮したURLが記録されたりします。
-  詳しくは、 http://bit.ly のSign up for bit.lyを読んでください。
-
-.. |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

@@ -1,96 +0,0 @@
-クイックスタート
-================
-
-必要なソフトウェア
-------------------------------
-以下のものが必要です。
-
- - 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(単体テストを実行する場合, 開発者以外は不要)
-
-インストール
-------------
-
-リリース版
-~~~~~~~~~~
-Rubygemsを使用してインストールしてください。::
-
- $ gem install atig
-
-または `GitHub`_ からダウンロードしてください。
-
-.. _GitHub: http://github.com/mzp/atig/downloads
-
-trunk版
-~~~~~~~~~~
-githubからpullしてください。::
-
- $ git clone https://github.com/mzp/atig.git
-
-使ってみる
-----------
-
-起動
-~~~~~~~~~
-コマンドラインから起動します。::
-
- $ atig -d
-
-githubからダウンロードした場合::
-
- $ cd atig
- $ bin/atig -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

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

data/docs/tiarra.rst

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

data/docs/tig.rst

@@ -1,21 +0,0 @@
-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/requirements.txt

@@ -1,5 +0,0 @@
-Jinja2==2.7.1
-MarkupSafe==0.18
-Pygments==1.6
-Sphinx==1.2b3
-docutils==0.11