= jpmobile: A Rails plugin for Japanese mobile-phones
== jpmobileとは 携帯電話特有の機能を Rails 4.0 や Rack middleware で利用するためのプラグイン。 以下の機能を備える。
また Rails 4.0 に以下の機能を追加する
他のバージョンの Rails については {Versions : Jpmobile vs Rails}[https://github.com/jpmobile/jpmobile/wiki/Version-:-Jpmobile-vs-Rails] を参照。
== インストール === Rails pluginとしてインストールする場合 % rails plugin install git://github.com/jpmobile/jpmobile.git ==== IPアドレス検証が必要な場合 % rails plugin install git://github.com/jpmobile/jpmobile-ipaddresses.git ==== ディスプレイ情報を取得する必要がある場合 % rails plugin install git://github.com/jpmobile/jpmobile-terminfo.git
=== gemでインストールする場合 % gem install jpmobile ==== IPアドレス検証が必要な場合 % gem install jpmobile-ipaddresses ==== ディスプレイ情報を取得する必要がある場合 % gem install jpmobile-terminfo
== 使用例
=== 携帯電話の識別 環境変数 env['rack.jpmobile'] にキャリアクラスのインスタンスが格納されています。また Rack::Request#mobile としても取得可能です。
==== キャリアの識別
case request.mobile when Jpmobile::Mobile::Docomo
when Jpmobile::Mobile::Au
when Jpmobile::Mobile::Softbank
when Jpmobile::Mobile::Willcom
when Jpmobile::Mobile::Emobile
else
end
あるいは if request.mobile.is_a?(Jpmobile::Mobile::Docomo)
end
==== ビューの中で一部を切替える例 <% if request.mobile? %> 携帯電話からのアクセスです。 <% else %> 携帯電話からのアクセスではありません。 <% end %>
<% if request.smart_phone? %> スマートフォンからのアクセスです。 <% else %> スマートフォンからのアクセスではありません。 <% end %>
==== 別に用意した携帯電話用コントローラへリダイレクトする例 class PcController < ApplicationController before_action :redirect_if_mobile
def index
end
private
def redirect_if_mobile
if request.mobile?
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
class MobileController < ApplicationController end
=== 位置情報の取得 Rack::Request#mobile.position に位置情報が格納されます。
@latitude = request.mobile.position.lat @longuitude = request.mobile.position.lon
==== {GeoKit}[http://geokit.rubyforge.org] との連携
vandor/plugins/geokit以下にGeoKitがインストールされていると、Jpmobile::PositionにGeoKit::Mappableがincludeされる。したがって、
request.mobile.position.distance_to('札幌駅')
とすることで、端末と「札幌駅」との距離を求めることができる。詳細は http://geokit.rubyforge.org/api/index.html 参照。
=== 端末情報の取得
端末側から通知されている場合、request.mobile.ident で 契約に固有の識別子もしくは端末の製造番号を取得できる。 両方存在する場合は契約に固有のIDが優先される。
=== IPの検証 キャリアが公開しているIPアドレス帯域からのアクセスか判定する。 request.mobile.valid_ip? ただし {jpmobile-ipaddresses}[http://github.com/jpmobile/jpmobile-ipaddresses] がインストールされていないか、スマートフォンの場合は必ずfalseとなる。
=== 端末の画面サイズ request.mobile.display で Jpmobile::Display クラスのインスタンスが返る。 画面幅 <%= request.mobile.display.width %> 画面高さ <%= request.mobile.display.height %> ただし {jpmobile-terminfo}[http://github.com/jpmobile/jpmobile-terminfo] がインストールされていない場合はエラーとなるので注意が必要。
=== 文字コード変換機能/絵文字のキャリア間相互変換
jpmobileを読み込むとDoCoMo、Au、SoftBankの絵文字を透過的に扱うことができる。
Rails の場合は vendor/plugins に配置し、下記の設定を追加することで有効になる。
Rails.application.config.jpmobile.mobile_filter or Jpmobile.config.mobile_filter
下記の設定を追加することで、
Andriod/iPhone では Google 絵文字や Unicode 6.0 絵文字が使われています。下記の設定を追加すると、互換性をもたせるために3キャリアの絵文字に変換することができます。また表示の変換も可能です。 Rails.application.config.jpmobile.smart_phone_emoticon_compatibility = true or Jpmobile.config.smart_phone_emoticon_compatibility = true
携帯電話上では特に問題とならない。PCブラウザでテストする際に問題となるためのオプション。
Sinatra の場合は下記のように指定する。 $LOAD_PATH << './lib/jpmobile/lib' require 'jpmobile' require 'jpmobile/rack'
use Jpmobile::Rack::MobileCarrier use Jpmobile::Rack::ParamsFilter use Jpmobile::Rack::Filter
get '/' do erb :index end
Rails のみ半角・全角の自動変換フィルターが用意されている。用いるには class MyController hankaku_filter end
と指定する。またtextareaやhidden/text/passwordのinputタグで半角に変換したくない場合は :input => true を指定する。このときNokogiriが必要となるため、Gemfileに追記してインストールする必要がある。 class MyController hankaku_filter :input => true end
Jpmobile内では、各キャリアの絵文字はUnicode私的領域上にマッピングされ、管理される。 このとき、DoCoMo、Auは公式サイト記載のマッピングが使用される。 ただしSoftBankはAuとの重複を避けるため、公式のマッピングに0x1000加算しU+F001以降に割り当てる。 テンプレート内ではUTF-8でエンコードするか、数値文字参照のHHHH;形式で指定する。
絵文字は送出時に内蔵の変換表に基づいて変換され、携帯電話のエンコーディングにあわせて送出される。 携帯電話から受信した絵文字は上記マッピングに基づいてUTF-8でparamsに渡される。
=== ビューの自動振り分け ビューの自動振り分けを行うには、以下の設定が必要です。
class ApplicationController < ActionController::Base include Jpmobile::ViewSelector end
DoCoMo携帯電話からアクセスすると、
またiPhoneからアクセスすると、
自動振り分けを無効化するには、アクションにおいて以下のように設定する
def index disable_mobile_view! end
=== 位置情報の取得用リンクの生成
以下のようなコードで、端末に位置情報を要求するリンクを出力する。 <%= 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 を使用することができず、 active_record_storeのgemパッケージが必要です。 また Rails 4.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" のように指定する必要があります。
=== メールの送受信 メールにて絵文字や漢字コードの変換、ビューの自動振り分けを行なうには Jpmobile::Mailer::Base を使う。
class MobileMailer < Jpmobile::Mailer::Base default :from => "info@jpmobile-rails.org"
def registration(to)
mail(:to => to)
end
def receive(email)
email
end
end
== テストに必要なgemパッケージ テストを実行するためには以下のgemパッケージが必要です。
== リンク
== 作者
Copyright 2006-2012 (c) Yoji Shidara, under MIT License.
Shin-ichiro OGAWA rust.stnard@gmail.com, Yoji Shidara dara@shidara.net