atig 0.4.5 → 0.5.0

data/docs/commandline_options.rst

@@ -1,21 +0,0 @@
-コマンドラインオプション
-==============================
-
-書式
-------------------------------
-::
-
- bin/atig [opts]
-
-オプション
-------------------------------
-`-p`, `--port` ``PORT``
-  起動するポート番号を指定します。デフォルトは16668です。
-`-h`, `--host` ``HOST``
-  起動するホスト名、またはIPアドレスを指定します。デフォルトはlocalhostです。
-`-l`, `--log` ``LOG``
-  ログを記録するファイル名を指定します。
-`-d`, `--debug`
-  デバッグモードを有効にします。
-`-c`, `--conf` ``filename``
-  ロードする設定ファイルを指定します。詳しくは doc:`conf` を参照してください。

data/docs/commands.rst

@@ -1,84 +0,0 @@
-CTCP ACTION
-==================================
-
-概要
-------------------------------
-
-CTCP ACTIONによって、特定の発言への返信などが行なえます。
-
-CTCP ACTIONの送り方はクライアントによって異なりますが、LimeChatやirssi
-では ``/me`` です。 例えば、replyコマンド送信する場合は ``/me reply a`` のようになります。
-
-発言関係
-------------------------------
-発言の指定方法について
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-以下で ``tweet`` と書かれている部分では、次の書式が利用できます。
-
-- `a`: 一致するtidを持つ発言を指します。
-- `nick:a`:  一致するsidを持つ発言を指します。
-- `nick`:  @nickの最新の発言を指します。
-- `@nick`: @nickの最新の発言を指します。
-
-コマンド
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-reply ``tweet`` ``comment`` (別名: mention, re, rp)
-  ``tweet`` に対して返信します。
-retweet ``tweet`` [``comment``] (別名: rt, ort)
-  ``tweet`` をリツイートします。
-  コメントが省略された場合は、公式リツイートになります。
-destroy ``tweet`` (別名: remove, rm)
-  ``tweet`` を削除する。 ``tweet`` の発言が自分のものでない場合はエラーになります。
-fav ``tweet``
-  ``tweet`` をお気に入りに追加します。
-unfav ``tweet``
-  ``tweet`` をお気に入りから削除します。
-thread ``tweet`` [``count``]
-  ``tweet`` のin_reply_toを辿って、最大 ``count`` 件の会話を表示します。
-  ``count`` が省略された場合は10件になります。 ``count`` は20件以上を指定しても無視されます。
-autofix ``comment`` (別名: topic)
-  最新の発言が ``comment`` と類似している場合はその発言を削除し、 ``comment`` を発言として投稿します。
-autofix! ``tweet`` (別名: topic!)
-  最新の発言を削除し、 ``comment`` を発言として投稿します。
-search [ ``option`` ] ``text`` (別名: s)
-  ``text`` を含む発言を検索します。
-  オプションは ``:lang=<国コード>`` のみサポートしています。``/me s :lang=ja hoge`` だと日本人のツイートのみを検索します。
-
-
-ユーザ関係
-------------------------------
-userinfo ``screen_name`` (別名: bio)
-  ``screen_name`` のユーザのプロフィールを表示します。
-version ``screen_name``
-  ``screen_name`` のクライアントの情報を表示します。最新の発言に用いたクライアント名を表示します。
-time ``screen_name``
-  ``screen_name`` のタイムゾーン情報を表示します。
-user ``screen_name`` [``count``] (別名: u)
-  ``screen_name`` のユーザの最新の発言 ``count`` 件を表示します。
-  ``count`` が省略された場合は20件になります。 ``count`` は
-  200件以上を指定しても無視されます。
-spam ``screen_name``
-  ``screen_name`` のユーザをスパムアカウントとして通報します。
-
-プロフィール関連
-------------------------------
-location ``place`` (別名: in, location)
-  自分の現在地を ``place`` に更新します。
-name ``name``
-  自分の名前を ``name`` に更新します。
-
-システム関係
-------------------------------
-uptime
-  atig.rbの連続起動時間を表示します。
-limit (別名: limits, rls)
-  残りのAPIへのアクセス可能回数を表示します。
-opt  (別名: opts, option, options)
-  設定された :doc:`options` 一覧を表示します。
-opt ``name`` (別名: opts, option, options)
-  名前 ``name`` の :doc:`options` が持つ値を表示します。
-opt ``name`` ``value`` (別名: opts, option, options)
-  名前 ``name`` の :doc:`options` が持つ値を ``value`` に更新します。
-refresh
-  フォローしているユーザ一覧を再読み込みさせます。

data/docs/conf.py

@@ -1,194 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# atig documentation build configuration file, created by
-# sphinx-quickstart on Mon Mar 15 15:36:01 2010.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
-
-# -- General configuration -----------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.ifconfig']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'atig.rb'
-copyright = u'2010-2013, mzp'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '0.4'
-# The full version, including alpha/beta/rc tags.
-release = '0.4.3'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'sphinxdoc'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_use_modindex = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'atigdoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-  ('index', 'atig.tex', u'atig.rb Documentation',
-   u'mzp', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True

data/docs/config.rst

@@ -1,159 +0,0 @@
-設定
-==============================
-
-概要
-------------------------------
- - atig.rbは起動時に `~/.atig/config` を読み込みます。
- - `~/.atig/config` はRubyのコードが記述可能です。
- - `Atig::Gateway::Session.<some_field>` を変更すると、atig.rbの動作をカスタマイズできます。
-
-利用可能なコマンドの変更
-------------------------------
-`Atig::Gateway::Session.commands` を変更すれば、利用可能な :doc:`commands` を変更できます::
-
-  Atig::Gateway::Session.commands = [
-                                     Atig::Command::Retweet,
-                                     Atig::Command::Reply,
-				     ..
-                                    ]
-
-標準で次のコマンドが用意されています。
-
-Atig::Command::Retweet
-  ``/me retweet ...`` を提供するクラス
-Atig::Command::Reply
-  ``/me reply ...`` を提供するクラス
-Atig::Command::User
-  ``/me user ...`` を提供するクラス
-Atig::Command::Favorite
-  ``/me fav, unfav ...`` を提供するクラス
-Atig::Command::Uptime
-  ``/me uptime ...`` を提供するクラス
-Atig::Command::Destroy
-  ``/me destory ...`` を提供するクラス
-Atig::Command::Status
-  通常の発言時に使われる内部コマンド
-Atig::Command::Thread
-  ``/me thread ...`` を提供するクラス
-Atig::Command::Time
-  ``/me time ...`` を提供するクラス
-Atig::Command::Version
-  ``/me verison ...`` を提供するクラス
-Atig::Command::UserInfo
-  ``/me userinfo ...`` を提供するクラス
-Atig::Command::Whois
-  ``/whois ...`` を提供するクラス
-Atig::Command::Option
-  ``/me opt ...`` を提供するクラス
-Atig::Command::Limit
-  ``/me limit`` を提供するクラス
-Atig::Command::Search
-  ``/me search`` を提供するクラス
-Atig::Command::Refresh
-  ``/me refresh`` を提供するクラス
-                                   Atig::Command::Spam,
-
-取得するAPIの変更
-------------------------------
-`Atig::Gateway::Session.agents` を変更すると、発言やFollowingを取得するのに利用するAPIを変更できます。::
-
-  Atig::Gateway::Session.agents  = [
-                                     Atig::Agent::List,
-                                     Atig::Agent::Following,
-				     ...
-                                    ]
-
-標準で次のAgentが用意されています。
-
-Atig::Agent::OwnList
-  自分のリストのfollowingを取得します。FullListと同時に指定できません。
-Atig::Agent::FullList
-  自分のリストと自分がフォローしているリストのfollowingを取得します。OwnListと同時に指定できません。
-Atig::Agent::Following
-  自分のfollowingを取得します。
-Atig::Agent::ListStatus
-  リスト内の発言を取得します。フォローせずに、Listでだけfollowしている人の発言を取得するために必要です。
-Atig::Agent::Mention
-  自分への言及(mention)を取得します。
-Atig::Agent::Dm
-  自分へのダイレクトメッセージを取得します。
-Atig::Agent::Timeline
-  自分のタイムラインを取得します。
-Atig::Agent::Cleanup
-  定期的にキャッシュのうち、古い内容を削除します。
-
-取得した発言の加工方法の変更
-------------------------------
-`Atig::Gateway::Session.ifilters` を変更すると、取得した発言の加工方法を変更できます。::
-
-  Atig::Gateway::Session.ifilters = [
-                                     Atig::IFilter::Utf7,
-                                     Atig::IFilter::Sanitize,
-                                     ...
-                                    ]
-
-標準で次のIFilterが用意されています。
-
-Atig::IFilter::Utf7
-  utf7をデコードします。
-Atig::IFilter::Sanitize
-  &gt; などを置き換えます。
-Atig::IFilter::ExpandUrl
-  短縮URLを展開します。
-Atig::IFilter::Strip.new([``footer1``, ``footer2``, ...])
-  指定したフッタを除去します。
-Atig::IFilter::Retweet
-  公式RTの先頭に♺ をつけます。
-Atig::IFilter::RetweetTime
-  公式RTの末尾に元発言の日時を表示します。
-Atig::IFilter::Tid
-  発言の末尾に、tidをつけます。 :doc:`options` も参照してください。
-Atig::IFilter::Sid
-  発言の末尾に、sidをつけます。 :doc:`options` も参照してください。
-
-自分の発言の加工
-------------------------------
-`Atig::Gateway::Session.ofilters` を変更すると、自分の発言の加工方法を変更できます。::
-
-Atig::Gateway::Session.ofilters = [
-                                   Atig::OFilter::EscapeUrl,
-                                   Atig::OFilter::ShortUrl,
-                                   Atig::OFilter::Geo,
-                                   Atig::OFilter::Footer,
-                                  ]
-
-標準で次のOFilterが用意されています。
-
-Atig::OFilter::EscapeUrl
-  URLエスケープを行ないます。
-Atig::OFilter::ShortUrl
-  URLを短縮します。 :doc:`options` も参照してください。
-Atig::OFilter::Geo
-  位置情報を付加します。 :doc:`options` も参照してください。
-Atig::OFilter::Footer
-  フッターを付加します。 :doc:`options` も参照してください。
-
-チャンネルの変更
-------------------------------
-`Atig::Gateway::Session.channels` を変更すると、作成するチャンネルを変更できます。::
-
-  Atig::Gateway::Session.channels = [
-                                     Atig::Channel::Timeline,
-                                     Atig::Channel::Mention,
-                                     Atig::Channel::Dm,
-                                     Atig::Channel::List,
-                                     Atig::Channel::Retweet
-                                    ]
-
-標準で次のChannelが用意されています。
-
-Atig::Channel::Timeline
-  フォローしている人全員の発言を表示する `#twitter` を作成します。
-Atig::Channel::Mention
-  自分への言及を表示する `#mention` を作成します。
-Atig::Channel::Retweet
-  自分のフォローしている人の公式RTを表示する `#retweet` を作成します。
-Atig::Channel::Dm
-  DMの受信時にチャンネルを作成します。
-Atig::Channel::List
-  リストごとにチャンネルを作成します。