Commit 89ffa4b8 authored by Youhei SASAKI's avatar Youhei SASAKI

Imported Upstream version 0.3.4

parents
*~
*.omc
.omakedb
.omakedb.lock
_build
*.db
.DS_Store
.gem
*.rbc
.bundle
.config
.yardoc
Gemfile.lock
InstalledFiles
_yardoc
coverage
doc/
lib/bundler/man
pkg
rdoc
spec/reports
test/tmp
test/version_tmp
tmp
--color
--profile
source :rubygems
gemspec
PATH
remote: .
specs:
atig (0.3.4)
json
net-irc
oauth
rake
sqlite3 (>= 1.3.2)
GEM
remote: http://rubygems.org/
specs:
diff-lcs (1.1.3)
json (1.6.5)
net-irc (0.0.9)
oauth (0.4.5)
rake (0.9.2.2)
rspec (2.8.0)
rspec-core (~> 2.8.0)
rspec-expectations (~> 2.8.0)
rspec-mocks (~> 2.8.0)
rspec-core (2.8.0)
rspec-expectations (2.8.0)
diff-lcs (~> 1.1.2)
rspec-mocks (2.8.0)
sqlite3 (1.3.5)
PLATFORMS
ruby
DEPENDENCIES
atig!
rspec
Atig.rb - Another Twitter Irc Gateway
===========================================
OVERVIEW
--------
Atig.rb is Twitter Irc Gateway.
Atig.rb is forked from cho45's tig.rb. We improve some features of tig.rb.
PREREQUISITES
-------------
* Ruby 1.8 or 1.9
* sqlite3-ruby
* json(when use Ruby 1.8)
* rspec(for unit test)
* rake(for unit test)
HOW TO USE
----------
You type:
$ cd atig
$ ruby atig.rb -d
I, [2010-04-05T07:22:07.861527 #62002] INFO -- : Host: localhost Port:16668
and access localhost:16668 by Irc client.
DOCUMENTS
---------
See `docs/`, if you could read Japanese.
BRANCH POLICY
-------------
* master: a branch for current release.
* testing: a branch for next release.
* other branches: feature branch
LICENCE
-------
This program is free software; you can redistribute it and/or
modify it under Ruby Lincence.
AUTHOR
------
MIZUNO "mzp" Hiroki (mzp@happyabc.org)
AVAILABILITY
------------
The complete atig.rb distribution can be accessed at this[http://mzp.github.com/atig/]..
# -*- mode:ruby -*-
require 'rubygems'
require 'rake'
require 'rake/clean'
require 'rspec/core/rake_task'
require "bundler/gem_tasks"
CLEAN.include(
"**/*.db"
)
CLOBBER.include(
"pkg"
)
RSpec::Core::RakeTask.new do |t|
t.pattern = 'spec/**/*_spec.rb'
end
task :default => [:spec, :clean]
# -*- encoding: utf-8 -*-
require File.expand_path('../lib/atig/version', __FILE__)
Gem::Specification.new do |gem|
gem.authors = ["SHIBATA Hiroshi"]
gem.email = ["shibata.hiroshi@gmail.com"]
gem.description = %q{Atig.rb is Twitter Irc Gateway.}
gem.summary = %q{Atig.rb is forked from cho45's tig.rb. We improve some features of tig.rb.}
gem.homepage = "https://github.com/mzp/atig"
gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
gem.files = `git ls-files`.split("\n")
gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
gem.name = "atig"
gem.require_paths = ["lib"]
gem.version = Atig::VERSION
gem.add_dependency 'sqlite3', ['>= 1.3.2']
gem.add_dependency 'net-irc', ['>= 0']
gem.add_dependency 'oauth', ['>= 0']
gem.add_dependency 'rake', ['>= 0'] unless defined? Rake
gem.add_dependency 'json', ['>= 0'] unless defined? JSON
gem.add_development_dependency 'rspec', ['>= 0']
end
#!/usr/bin/env ruby
# stolen from termtter
self_file =
if File.symlink?(__FILE__)
require 'pathname'
Pathname.new(__FILE__).realpath
else
__FILE__
end
$:.unshift(File.dirname(self_file) + "/../lib")
require 'atig'
Atig::Client.run
# OMakefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_a4) $(SPHINXOPTS) .
SRCS[] =
index
config
options
tiarra
commandline_options
commands
quickstart
feature
irc
changelog
tig
.PHONY : clean
.DEFAULT: $(addsuffix .rst, $(SRCS))
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
clean:
rm -rf $(BUILDDIR)/html/* *~
\ No newline at end of file
########################################################################
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this file, to deal in the File without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the File, and to permit persons to whom the
# File is furnished to do so, subject to the following condition:
#
# THE FILE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE FILE OR
# THE USE OR OTHER DEALINGS IN THE FILE.
########################################################################
# The standard OMakeroot file.
# You will not normally need to modify this file.
# By default, your changes should be placed in the
# OMakefile in this directory.
#
# If you decide to modify this file, note that it uses exactly
# the same syntax as the OMakefile.
#
#
# Include the standard installed configuration files.
# Any of these can be deleted if you are not using them,
# but you probably want to keep the Common file.
#
open build/C
open build/OCaml
open build/LaTeX
#
# The command-line variables are defined *after* the
# standard configuration has been loaded.
#
DefineCommandVars()
#
# Include the OMakefile in this directory.
#
.SUBDIRS: .
更新履歴
==============
v0.3.3(2012-01-24)
------------------------------
http://github.com/mzp/atig/tree/v0.3.3
機能追加
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- gem コマンドでインストールできるようにしました
機能修正
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Ruby 1.9 に対応しました
- SQLite3-1.3.5 に対応しました
- bundler に対応しました
- HTTP アクセス時の media-range から Quality 指定を削除しました
- bit.ly の API 変更に追従しました
バグ修正
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- 非公式RTが実行できない不具合を修正
v0.3.2(2010-10-10)
------------------------------
http://github.com/mzp/atig/tree/v0.3.2
機能追加
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :doc:`config`: `Atig::IFilter::RetweetTime` を追加しました
機能修正
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- DBのデータ削除の周期を減らしました
- DMチャンネルでのDMの送信に対応しました
- :doc:`commands`: `limit` にリセットされる日付を表示するようにした (thx. `hirose31`_ )
- :doc:`config`: 自動展開するURLにhtn.to, goo.glを追加
.. _hirose31: http://twitter.com/hirose31
v0.3.1(2010-07-26)
------------------------------
http://github.com/mzp/atig/tree/v0.3.1
機能追加
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :doc:`commands`: `refresh` を追加しました
- :doc:`commands`: `spam` を追加しました
- :doc:`agent` : 他人のリストをフォローできるようになりました
機能修正
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- キャッシュを/tmp/atigに置くように変更しました。
- 定期的にキャッシュ中の古い内容を削除するように変更しました。
バグ修正
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- アンフォローしたユーザがキャッシュ中に残るバグを修正
v0.3.0(2010-06-12)
------------------------------
http://github.com/mzp/atig/tree/v0.3.0
機能追加
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :doc:`commands`: `search` を追加しました。(thx. `xeres`_ )
.. _xeres: http://blog.xeres.jp/2010/06/04/atig_rb-tweet-search/
機能修正
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- キャッシュとして用いているSQLiteのDBにインデックスを貼るようにしました。(thx. `L_star`_ )
- 定期的にGCを起動し、メモリ消費量を抑えるようにしました。
- 誤ったBit.lyのAPIキーを指定した際のエラーメッセージを分かりやすくしました。( `Issues 1`_ )
.. _L_Star: http://d.hatena.ne.jp/mzp/20100407#c
.. _Issues 1: http://github.com/mzp/atig/issues/closed#issue/1
バグ修正
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
v0.2.1(2010-04-17)
------------------------------
http://github.com/mzp/atig/tree/v0.2.1
機能追加
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :doc:`commands`: `autofix`, `location` を追加しました。
- :doc:`irc`: `/topic` が `/me autofix` のエイリアスになりました。
- 最新の発言を削除した場合、トピック(topic)をひとつ前に戻すようにした
v0.2(2010-04-11)
------------------------------
http://github.com/mzp/atig/tree/v0.2
機能追加
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :doc:`options`: `sid` を追加した。
- :doc:`config`: `Atig::IFilter::Sid` を追加した。
- :doc:`options`: `old_style_reply` を追加した。
- :doc:`commands`: `reply`, `retweet`, `destory`, `fav`, `unfav`, `thread` でスクリーンネームやsidを利用できるようにした。
バグ修正
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- followingの取得時にSSL Verified Errorが発生する不具合を修正
v0.1
------------------------------
http://github.com/mzp/atig/tree/v0.1
- 最初のリリース
コマンドラインオプション
==============================
書式
------------------------------
::
ruby atig.rb [opts]
オプション
------------------------------
`-p`, `--port` ``PORT``
起動するポート番号を指定します。デフォルトは16668です。
`-h`, `--host` ``HOST``
起動するホスト名、またはIPアドレスを指定します。デフォルトはlocalhostです。
`-l`, `--log` ``LOG``
ログを記録するファイル名を指定します。
`--debug`
デバッグモードを有効にします。
`-c`, `--conf` ``filename``
ロードする設定ファイルを指定します。詳しくは doc:`conf` を参照してください。
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
フォローしているユーザ一覧を再読み込みさせます。
# -*- 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, 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.3'
# The full version, including alpha/beta/rc tags.
release = '0.3.2'
# 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
設定
==============================
概要
------------------------------
- atig.rbは起動時に `~/.atig/config` を読み込みます。