autosel_http_proxy 0.0.1 → 0.0.4

data/ChangeLog

@@ -0,0 +1,5 @@
+2010-01-22  Kiwamu Okabe  <kiwamu@debian.or.jp>
+
+	* ver.0.0.4
+	* README.rdoc: Wrote README in English
+	* README.ja.rdoc: Wrote README in Japanese

data/README.ja.rdoc

@@ -0,0 +1,116 @@
+= AutoselHttpProxy
+
+AutoselHttpProxyは設定ファイルを元にして、HTTP proxyを自動的に設定するユーティリティです。
+設定ファイルを作成した後以下のようにすると、"http_proxy"などの環境変数を設定した状態で任意のコマンドを起動できます。
+
+  $ set_httpproxy 任意のコマンド
+
+また、rubyのプログラムならば以下のようにすれば、HTTP proxyの設定を検出できます。
+
+  require 'autosel_http_proxy'
+  AutoselHttpProxy::init
+  if AutoselHttpProxy::setting
+    p AutoselHttpProxy::setting[:proxy_host] # => proxyホスト名
+    p AutoselHttpProxy::setting[:proxy_port] # => proxyポート番号
+    p AutoselHttpProxy::setting[:proxy_user] # => proxy認証ユーザ名
+    p AutoselHttpProxy::setting[:proxy_pass] # => proxy認証パスワード
+  end
+
+ノートPCのようにネットワーク環境が頻繁に変更される場合に、本プログラムを使うことでHTTP proxy設定変更の手間が軽減されます。
+
+== インストール
+
+gem install autosel_http_proxyでインストールされます。
+インストール先のbinディレクトリにPATHを通してください。
+
+  $ export PATH = /var/lib/gems/1.8/bin:$PATH
+
+== 設定ファイルの作成
+
+まずはset_httpproxyコマンドを実行すると、設定ファイルのテンプレートが自動生成されます。
+
+  $ set_httpproxy
+  *** "/home/kiwamu/.autosel_http_proxy.conf" created.
+  *** Please config it.
+
+この設定ファイルを編集します。
+
+  $ cat ~/.autosel_http_proxy.conf
+  PROXY_LIST =
+    [{:if => 'hostname_found? "hostname.example.com"',
+       :proxy_host => 'proxy.example.com',
+       :proxy_port => '8080',
+       :proxy_user => nil,
+       :proxy_pass => nil,},]
+
+PROXY_LISTは配列になっているので、複数のHTTP proxy設定を列挙することができます。
+
+=== :if欄
+
+以下に挙げるHTTP proxyの設定を有効にする条件を設定します。
+
+  :if => 'hostname_found? "hogehoge.hogehoge.com"
+
+という設定にすると、hogehoge.hogehoge.comをDNSから引き、見つかれば:proxy_*欄に記載したHTTP proxyの設定を有効にします。
+
+=== :proxy_host欄
+
+:if欄が真の場合に設定するHTTP proxyのホスト名。
+
+=== :proxy_port欄
+
+:if欄が真の場合に設定するHTTP proxyのポート番号。
+
+=== :proxy_user欄
+
+:if欄が真の場合に設定するHTTP proxyの認証ユーザ名。HTTP proxy認証が不要な場合にはnilのままでOKです。
+
+=== :proxy_pass欄
+
+:if欄が真の場合に設定するHTTP proxyの認証パスワード。HTTP proxy認証が不要な場合にはnilのままでOKです。
+
+== 使い方
+
+=== 任意のコマンドをhttp_proxy環境変数付きで起動させる
+
+設定ファイルが適切に設定されていれば、コマンドの前にset_httpproxyを付けることで、http_proxy環境変数が自動的に設定された状態でコマンドが起動されます。wgetを例にすると以下のようになります。
+
+  $ set_httpproxy wget http://example.com/img/example.jpg
+
+このようにhttp_proxy環境変数を参照するようなコマンドは何でも上記の方法でHTTP proxy自動設定することができます。例えば以下のコマンド達はhttp_proxy環境変数を見ています。
+
+* apt-get
+* aptitude
+* gem
+* minitube
+* w3m
+* wget
+
+SHELLの設定ファイルに、aliasを作っておくと楽かもしれません。
+
+=== rubyアプリケーションに組込む
+
+例として{termtter}[http://termtter.org/]にHTTP proxy自動設定させる手順を解説します。
+まず、set_httpproxyが正常に動作するまで設定ファイルを作成しておきます。その後、~/.termtter/configファイルに以下を追記します。
+
+  require 'autosel_http_proxy'
+  AutoselHttpProxy::init
+  if AutoselHttpProxy::setting
+    config.proxy.host = AutoselHttpProxy::setting[:proxy_host]
+    config.proxy.port = AutoselHttpProxy::setting[:proxy_port]
+    config.proxy.user_name = AutoselHttpProxy::setting[:proxy_user]
+    config.proxy.password = AutoselHttpProxy::setting[:proxy_pass]
+  end
+
+この設定を施すことで、termtterを起動するたびにその時のネットワーク状態から適切なHTTP proxy設定を自動的に検出するようになります。
+
+== エラーについて
+
+プログラム内部では、設定ファイルはrubyスクリプトとしてそのまま解釈実行されます。そのため、設定ファイルにruby文法エラーがあった場合にはAutoselHttpProxyは異常終了してしまいます。注意してください。
+もし、エラーから復帰できないときは設定ファイルを一度消して、set_httpproxyコマンドで自動生成しなおすのも一案です。
+
+== リンク
+
+* {プロジェクトサイト}[http://gitorious.org/autosel_http_proxy]
+* {Gem}[http://gemcutter.org/gems/autosel_http_proxy]
+* {Twitter}[http://twitter.com/master_q]

data/README.rdoc

@@ -0,0 +1,27 @@
+= AutoselHttpProxy
+
+AutoselHttpProxy sets HTTP proxy settings automatically with a startup file.
+AutoselHttpProxy allows to execute a COMMAND with "http_proxy" environment variable.
+
+  $ set_httpproxy COMMAND
+
+If you use ruby's program, then can use the below code, to set HTTP proxy settings.
+
+  require 'autosel_http_proxy'
+  AutoselHttpProxy::init
+  if AutoselHttpProxy::setting
+    p AutoselHttpProxy::setting[:proxy_host] # => proxy hostname
+    p AutoselHttpProxy::setting[:proxy_port] # => proxy port number
+    p AutoselHttpProxy::setting[:proxy_user] # => proxy username
+    p AutoselHttpProxy::setting[:proxy_pass] # => proxy password
+  end
+
+== Usage and Detail
+
+Please read README.ja.rdoc file (in Japanese)...
+
+== Links
+
+* {Project page}[http://gitorious.org/autosel_http_proxy]
+* {Gem}[http://gemcutter.org/gems/autosel_http_proxy]
+* {Twitter}[http://twitter.com/master_q]

data/bin/set_httpproxy

@@ -1,12 +1,25 @@
 #!/usr/bin/env ruby
 # -*- coding: utf-8 -*-
 
-require 'autosel_http_proxy'
+self_file =
+  if File.symlink?(__FILE__)
+    require 'pathname'
+    Pathname.new(__FILE__).realpath
+  else
+    __FILE__
+  end
+$:.unshift(File.dirname(self_file) + "/../lib")
 
-### main
-if ARGV.size == 0
-  puts "Usage: " + $PROGRAM_NAME + " COMMAND"
-  exit 1
-end
+begin
+  require 'autosel_http_proxy'
+  AutoselHttpProxy::init
+ensure
+  ### main
+  if ARGV.size == 0
+    puts "Usage:   " + File.basename($PROGRAM_NAME) + " COMMAND"
+    puts "Version: " + AutoselHttpProxy::VERSION
+    exit 1
+  end
 
-system *ARGV
+  system *ARGV
+end

data/lib/autosel_http_proxy.rb

@@ -2,6 +2,7 @@
 require 'resolv'
 
 module AutoselHttpProxy
+  VERSION = '0.0.4'
   PROXY_CONFFILE = File.expand_path '~/.autosel_http_proxy.conf'
 
   class ConfigNotFound < RuntimeError; end
@@ -91,9 +92,6 @@ EOF
   class << self
     def url() Setting.proxy_url end
     def setting() Setting.proxy_setting end
+    def init() Setting.init end
   end
-
-
-  ### start
-  Setting.init
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: autosel_http_proxy
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors: 
 - Kiwamu Okabe
@@ -21,19 +21,23 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- README.ja.rdoc
 files: 
 - lib/autosel_http_proxy.rb
 - bin/set_httpproxy
 - README.rdoc
+- README.ja.rdoc
 - ChangeLog
 has_rdoc: true
-homepage: http://d.masterq.net/
+homepage: http://gitorious.org/autosel_http_proxy
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --main
 - README.rdoc
+- --charset
+- UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement