jpmobile 0.0.8 → 0.1.0.pre

data/.gitignore

@@ -1,6 +1,3 @@
 doc
 tmp
 pkg
-.bundle
-Gemfile
-Gemfile.lock

data/{spec/spec.opts → .rspec}

@@ -1,6 +1,5 @@
 --colour
 --format
 progress
---loadby
 mtime
---reverse
+-b

data/README.rdoc

@@ -1,74 +1,68 @@
 = jpmobile: A Rails plugin for Japanese mobile-phones
 
 == jpmobileとは
-携帯電話特有の機能を Rails で利用するためのプラグイン。
+携帯電話特有の機能を Rails や Rack middleware で利用するためのプラグイン。
 以下の機能を備える。
 
 * 携帯電話のキャリア判別
 * 端末位置情報の取得
+  * GeoKit(http://geokit.rubyforge.org)との連携
 * 端末製造番号、契約者番号等の取得
 * IPアドレスの検証(キャリアが公開しているIPアドレス帯域からのアクセスか判定)
-* セッションIDをフォーム／リンクに付与(Trans SID)
-* 携帯電話ビューへの自動振分け
 * ディスプレイ情報(画面サイズ、ブラウザ画面サイズ、カラー・白黒、色数)の取得
-* GeoKit(http://geokit.rubyforge.org)との連携
 * 文字コード変換機能／絵文字のキャリア間相互変換
 
-== インストール
-Rails の Version に応じて選択してください。
-=== Rails 2.3.3 〜 2.3.8
-==== pluginとしてインストールする場合
-開発版:
-  % ./script/plugin install git://github.com/jpmobile/jpmobile.git
-
-==== gemでインストールする場合
-
-  # gem install jpmobile -v 0.0.8
-としてgemをインストールした後
-
-RAILS_ROOT/config/environment.rb の Rails::Initializer.run do |config| 〜 end 内に
-  config.gem "jpmobile"
-の行を追加する。
-
-=== Rails 2.3.2
-==== pluginとしてインストールする場合
-
-リリース版: (Version 0.0.6)
-  % git clone git://github.com/jpmobile/jpmobile.git vendor/plugins/jpmobile
-  % cd vendor/plugins/jpmobile
-  % git checkout 0.0.6
-  % rm -rf .git
+また Rails に以下の機能を追加する
+* ビューへの自動振分け
+* 位置情報取得などのリンクヘルパーの追加
+* セッションIDをフォーム／リンクに付与(Trans SID)
 
+== インストール
 開発版:
   % ./script/plugin install git://github.com/jpmobile/jpmobile.git
 
-==== gemでインストールする場合
-
-  # gem install jpmobile -v 0.0.8
-としてgemをインストールした後
+== 使用例
 
-RAILS_ROOT/config/environment.rb の Rails::Initializer.run do |config| 〜 end 内に
-  config.gem "jpmobile"
-の行を追加する。
+=== 携帯電話の識別
+環境変数 env['rack.jpmobile'] にキャリアクラスのインスタンスが格納されています。また Rack::Request#mobile としても取得可能です。
 
-=== Rails 2.2.x 以前
-リリース版:
-  % git clone git://github.com/jpmobile/jpmobile.git vendor/plugins/jpmobile
-  % cd vendor/plugins/jpmobile
-  % git checkout 0.0.5
-  % rm -rf .git
+==== キャリアの識別
 
-== 使用例
+  case request.mobile
+  when Jpmobile::Mobile::Docomo
+    # for DoCoMo
+  when Jpmobile::Mobile::Au
+    # for au
+  when Jpmobile::Mobile::Softbank
+    # for SoftBank
+  when Jpmobile::Mobile::Willcom
+    # for Willcom
+  when Jpmobile::Mobile::Emobile
+    # for EMOBILE
+  else
+    # for PC
+  end
 
-=== 携帯電話の識別
+あるいは
+  if request.mobile.is_a?(Jpmobile::Mobile::Docomo)
+    # for DoCoMo
+  end
 
-==== Viewの中で一部を切替える例
+==== ビューの中で一部を切替える例
   <% if request.mobile? %>
     携帯電話からのアクセスです。
   <% else %>
     携帯電話からのアクセスではありません。
   <% end %>
 
+  <% if request.smart_phone? %>
+    スマートフォンからのアクセスです。
+  <% else %>
+    スマートフォンからのアクセスではありません。
+  <% end %>
+
+
+
 ==== 別に用意した携帯電話用コントローラへリダイレクトする例
   class PcController < ApplicationController
     before_filter :redirect_if_mobile
@@ -82,6 +76,10 @@ RAILS_ROOT/config/environment.rb の Rails::Initializer.run do |config| 〜 end
         pa = params.dup
         pa[:controller] = "/mobile"
         redirect_to pa
+      elsif request.smart_phone?
+        pa = params.dup
+        pa[:controller] = "/smart_phone"
+        redirect_to pa
       end
     end
   end
@@ -90,57 +88,19 @@ RAILS_ROOT/config/environment.rb の Rails::Initializer.run do |config| 〜 end
      mobile_filter
   end
 
-
-=== 携帯電話viewの自動振分け
-DoCoMo携帯電話からアクセスすると、
-* index_mobile_docomo.html.erb
-* index_mobile.html.erb
-* index.html.erb
-の順でテンプレートを検索し、最初に見付かったテンプレートが利用される。
-Auの場合は、index_mobile_au.html.erb、Softbankの場合はindex_mobile_softbank.html.erbが最初に検索される。
-
-BUG: 現状、上記の例では index.html.erb が存在しない場合に振り分けが行われない(ダミーファイルを置くことで回避可能)。
-
-==== キャリアの識別
-
-  case request.mobile
-  when Jpmobile::Mobile::Docomo
-    # for DoCoMo
-  when Jpmobile::Mobile::Au
-    # for au
-  when Jpmobile::Mobile::Softbank
-    # for SoftBank
-  when Jpmobile::Mobile::Willcom
-    # for Willcom
-  when Jpmobile::Mobile::Emobile
-    # for EMOBILE
-  else
-    # for PC
-  end
-
-あるいは
-  if request.mobile.is_a?(Jpmobile::Mobile::Docomo)
-    # for DoCoMo
-  end
-
 === 位置情報の取得
+Rack::Request#mobile.position に位置情報が格納されます。
 
-==== 取得用リンクの生成
+  @latitude   = request.mobile.position.lat
+  @longuitude = request.mobile.position.lon
 
-以下のようなコードで、端末に位置情報を要求するリンクを出力する。
-  <%= get_position_link_to(:action=>:gps) %>
+==== GeoKit(http://geokit.rubyforge.org)との連携
 
-==== 位置情報の取得
+vandor/plugins/geokit以下にGeoKitがインストールされていると、Jpmobile::PositionにGeoKit::Mappableがincludeされる。したがって、
 
-  class MobileController < ApplicationController
-    def gps
-      if request.mobile && pos = request.mobile.position
-        @latitude = pos.lat
-        @longuitude = pos.lon
-      end
-    end
-  end
+  request.mobile.position.distance_to('札幌駅')
 
+とすることで、端末と「札幌駅」との距離を求めることができる。詳細は http://geokit.rubyforge.org/api/index.html 参照。
 
 === 端末情報の取得
 
@@ -159,58 +119,42 @@ BUG: 現状、上記の例では index.html.erb が存在しない場合に振
 === IPの検証
 キャリアが公開しているIPアドレス帯域からのアクセスか判定する。
   request.mobile.valid_ip?
-
-=== セッションIDの付与(Trans SID)
-==== Cookie非対応携帯だけに付与する
-  class MyController
-    trans_sid
-  end
-
-==== PCにも付与する
-  class MyController
-    trans_sid :always
-  end
-
-trans_sid 機能を使う場合には cookie session store を使用することができません。
-trans_sid を使用する際には、例えば config/initializers/session_store.rb で
-  ActionController::Base.session_store = :active_record_store
-として active_record_store を使用します。
-このとき ApplicationController において protect_from_forgery の :secret を指定するか、
-あるいは protect_from_forgery を解除する必要があるでしょう。
-
-また、
-  link_to "hoge", "/controller/action/id"
-のようにリンク先を直接指定するとセッションIDは付加されません。
-  link_to "hoge", :controller => "controller", :action => "action", :id => "id"
-のように指定する必要があります。
-
+ただしスマートフォンの場合は必ずfalseとなる。
 
 === 端末の画面サイズ
 request.mobile.display で Jpmobile::Display クラスのインスタンスが返る。
   画面幅 <%= request.mobile.display.width %>
   画面高さ <%= request.mobile.display.height %>
 
-=== GeoKit(http://geokit.rubyforge.org)との連携
+=== 文字コード変換機能／絵文字のキャリア間相互変換
 
-vandor/plugins/geokit以下にGeoKitがインストールされていると、Jpmobile::PositionにGeoKit::Mappableがincludeされる。したがって、
+jpmobileを読み込むとDoCoMo、Au、SoftBankの絵文字を透過的に扱うことができる。
 
-  request.mobile.position.distance_to('札幌駅')
+* Rails の場合は vendor/plugins に配置し、下記の設定を追加することで有効になる。
 
-とすることで、端末と「札幌駅」との距離を求めることができる。詳細は http://geokit.rubyforge.org/api/index.html 参照。
+  # Rack middleware を追加するメソッド
+  Rails.application.config.jpmobile.mobile_fiter
 
-=== 文字コード変換機能／絵文字のキャリア間相互変換
+* Sinatra の場合は下記のように指定する。
 
-JpmobileではControllerにmobile_filterを指定することで
-DoCoMo、Au、SoftBankの絵文字を透過的に扱うことができる。
+  $LOAD_PATH << './lib/jpmobile/lib'
+  require 'jpmobile'
+  require 'jpmobile/rack'
 
- class MyController
-   mobile_filter
- end
+  use Jpmobile::Rack::MobileCarrier
+  use Jpmobile::Rack::ParamsFilter
+  use Jpmobile::Rack::Filter
+
+  get '/' do
+    erb :index
+  end
+
+Rails のみ半角・全角の自動変換フィルターが用意されている。用いるには
 
-また、半角・全角の自動変換を用いる場合は
  class MyController
    mobile_filter :hankaku=>true
  end
+
 と指定する。
 
 Jpmobile内では、各キャリアの絵文字はUnicode私的領域上にマッピングされ、管理される。
@@ -221,22 +165,72 @@ Jpmobile内では、各キャリアの絵文字はUnicode私的領域上にマ
 絵文字は送出時に内蔵の変換表に基づいて変換され、携帯電話のエンコーディングにあわせて送出される。
 携帯電話から受信した絵文字は上記マッピングに基づいてUTF-8でparamsに渡される。
 
-mobile_filterを有効にすると以下の処理が自動で行われる。
 * DoCoMo、Auとの通信時にはShift_JIS、SoftBankとの通信時にはUTF-8が使用される。
 * :hankaku=>true指定時は、カタカナは半角カナに変換されて送出される。携帯電話から送られた半角カナは全角カナに変換される。
 * 絵文字はキャリアにあわせて変換されて送出される。
 * 携帯電話からの絵文字はUnicode私的領域にマップされ、UTF-8でparamsに格納される。
 
+=== ビューの自動振分け
+DoCoMo携帯電話からアクセスすると、
+* index_mobile_docomo.html.erb
+* index_mobile.html.erb
+* index.html.erb
+の順でテンプレートを検索し、最初に見付かったテンプレートが利用される。
+Auの場合は、index_mobile_au.html.erb、Softbankの場合はindex_mobile_softbank.html.erbが最初に検索される。
+
+またiPhoneからアクセスすると、
+* index_smart_phone_iphone.html.erb
+* index_smart_phone.html.erb
+* index.html.erb
+の順でテンプレートを検索する。
+Androidの場合はindex_smart_phone_android.html.erb、Windows Phoneの場合はindex_smart_phone_windows_phone.html.erbが最初に検索される。
+
+携帯専用サイトであれば、index.html.erbがなくとも問題ない。
+
+=== 位置情報の取得用リンクの生成
+
+以下のようなコードで、端末に位置情報を要求するリンクを出力する。
+  <%= get_position_link_to(:action=>:gps) %>
+
+=== セッションIDの付与(Trans SID)
+==== Cookie非対応携帯だけに付与する
+  class MyController
+    trans_sid
+  end
+
+==== PCにも付与する
+  class MyController
+    trans_sid :always
+  end
+
+trans_sid 機能を使う場合には cookie session store を使用することができません。
+また Rails 3.0 では Cookie が使える場合にはそちらが優先されてしまうため、:always を指定した場合に問題になる場合があります。
+trans_sid を使用する際には、例えば config/initializers/session_store.rb で
+
+  Rails.application.config.session_store :active_record_store
+  Rails.application.config.session_options = {:cookie_only => false}
+
+として active_record_store を使用するように設定し、:cookie_only => false として Cookie を優先しないように設定します。
+このとき ApplicationController において protect_from_forgery の :secret を指定するか、
+あるいは protect_from_forgery を解除する必要があるでしょう。
+
+また、
+  link_to "hoge", "/controller/action/id"
+のようにリンク先を直接指定するとセッションIDは付加されません。
+  link_to "hoge", :controller => "controller", :action => "action", :id => "id"
+のように指定する必要があります。
+
 == テストに必要なgemパッケージ
 テストを実行するためには以下のgemパッケージが必要です。
 * rails (include rack)
 * sqlite3-ruby
-* test-unit (= 1.2.3)
-* hpricot
+* nokogiri
 * rspec
 * rspec-rails
 * rspec-fixture
+* rack-test
 * mocha
+* geokit
 
 == リンク
 

data/Rakefile

@@ -2,40 +2,35 @@ require 'rubygems'
 require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
 require 'rake/rdoctask'
-require 'rake/contrib/rubyforgepublisher'
 require 'fileutils'
 include FileUtils
-require File.join(File.dirname(__FILE__), 'lib', 'jpmobile', 'version')
 
-#
-AUTHOR = "dara"
-EMAIL = "dara@shidara.net"
-DESCRIPTION = "A Rails plugin for Japanese mobile-phones"
-RUBYFORGE_PROJECT = "jpmobile"
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-BIN_FILES = %w(  )
-
-NAME = "jpmobile"
-REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
-VERS = ENV['VERSION'] || (Jpmobile::VERSION::STRING + (REV ? ".#{REV}" : ""))
-CLEAN.include ['**/.*.sw?', '*.gem', '.config']
-RDOC_OPTS = ['--quiet', '--title', "jpmobile documentation",
-    "--opname", "index.html",
-    "--line-numbers",
-    "--main", "README.rdoc",
-    "--inline-source"]
-
-desc "Packages up jpmobile gem."
-task :default => [:test, :spec]
-task :package => [:clean]
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jpmobile"
+    gem.summary = "A Rails plugin for Japanese mobile-phones"
+    gem.description = "A Rails plugin for Japanese mobile-phones"
+    gem.email = "dara@shidara.net"
+    gem.homepage = "http://github.com/jpmobile/jpmobile"
+    gem.authors = ["Yoji Shidara", "Shin-ichiro OGAWA"]
+
+    gem.test_files.exclude 'test/rails/rails_root'
+
+    gem.add_development_dependency('rspec', '>=1.3.0')
+    gem.add_development_dependency('rspec-rails', '>=1.3.2')
+    gem.add_development_dependency('rspec-fixture', '>=0.0.2')
+    gem.add_development_dependency('jeweler', '>=1.4.0')
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+Jeweler::GemcutterTasks.new
 
 desc 'Default: run unit tests.'
 task :default => :test
 
-
 desc 'Generate documentation for the jpmobile plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'doc'
@@ -46,58 +41,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-spec =
-    Gem::Specification.new do |s|
-        s.name = NAME
-        s.version = VERS
-        s.platform = Gem::Platform::RUBY
-        s.has_rdoc = true
-        s.extra_rdoc_files = ["README.rdoc", "CHANGELOG"]
-        s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
-        s.summary = DESCRIPTION
-        s.description = DESCRIPTION
-        s.author = AUTHOR
-        s.email = EMAIL
-        s.homepage = HOMEPATH
-        s.executables = BIN_FILES
-        s.rubyforge_project = RUBYFORGE_PROJECT
-        s.bindir = "bin"
-        s.require_path = "lib"
-
-        s.add_runtime_dependency('actionpack', '>=2.3.8')
-        s.add_development_dependency('rspec', '>=1.3.0')
-        s.add_development_dependency('rspec-rails', '>=1.3.2')
-        s.add_development_dependency('rspec-fixture', '>=0.0.2')
-
-        s.files = %w(README.rdoc CHANGELOG Rakefile) +
-          Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") +
-          Dir.glob("ext/**/*.{h,c,rb}") +
-          Dir.glob("examples/**/*.rb") +
-          Dir.glob("tools/*.rb")
-
-        # s.extensions = FileList["ext/**/extconf.rb"].to_a
-    end
-
-Rake::GemPackageTask.new(spec) do |p|
-    p.need_tar = true
-    p.gem_spec = spec
-end
-
-task :install do
-  name = "#{NAME}-#{VERS}.gem"
-  sh %{rake package}
-  sh %{sudo gem install pkg/#{name}}
-end
-
-task :uninstall => [:clean] do
-  sh %{sudo gem uninstall #{NAME}}
-end
-
-desc "Publish the API documentation"
-task :pdoc => [:rdoc] do
-  sh "rsync -azv --delete doc/ dara@rubyforge.org:/var/www/gforge-projects/jpmobile/rdoc/"
-end
-
 desc "Update misc tables"
 task :update do
   Dir.glob("tools/update_*.rb").each do |path|
@@ -105,26 +48,5 @@ task :update do
   end
 end
 
-desc "Release helper"
-task :rel => [:gem] do
-  puts "-"*40
-  puts "rubyforge add_release #{NAME} #{NAME} #{VERS} pkg/#{NAME}-#{VERS}.gem"
-  puts "git tag #{VERS}"
-end
-
-task :test => ['test:legacy', 'spec:unit', 'test:rails']
-load 'tasks/jpmobile_tasks.rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "jpmobile"
-    gemspec.summary = %q{A Rails plugin for Japanese mobile-phones}
-    gemspec.description = %q{A Rails plugin for Japanese mobile-phones}
-    gemspec.email = %q{dara@shidara.net}
-    gemspec.homepage = %q{http://github.com/jpmobile/jpmobile}
-    gemspec.authors = ["Yoji Shidara", "Shin-ichiro OGAWA"]
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
+task :test => ['test:legacy', 'spec:unit', 'spec:rack', 'test:rails']
+load 'lib/tasks/jpmobile_tasks.rake'