A Rails plugin for Japanese mobile-phones
携帯電話特有の機能を Rails や Rack middleware で利用するためのプラグイン。 以下の機能を備える。
携帯電話のキャリア判別
Sec-CH-UA-Mobile,
Sec-CH-UA-Platform) による判別に対応。Client Hints が送信されている場合は
User-Agent より優先して判定する。端末位置情報の取得
端末製造番号、契約者番号等の取得
IPアドレスの検証(キャリアが公開しているIPアドレス帯域からのアクセスか判定)
ディスプレイ情報(画面サイズ、ブラウザ画面サイズ、カラー・白黒、色数)の取得
文字コード変換機能/絵文字のキャリア間相互変換
メールの送信
メールの受信(experimental)
また Rails に以下の機能を追加する
他のバージョンの Rails については Versions : Jpmobile vs Rails を参照。
% gem install jpmobile% gem install jpmobile-ipaddresses% gem install jpmobile-terminfo環境変数 ENV['rack.jpmobile'] にキャリアクラスのインスタンスが格納されています。また Rack::Request#mobile
としても取得可能です。
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
携帯電話からのアクセスです。
携帯電話からのアクセスではありません。
スマートフォンからのアクセスです。
スマートフォンからのアクセスではありません。
タブレットからのアクセスです。
タブレットからのアクセスではありません。
class PcController
画面高さ ただし jpmobile-terminfo がインストールされていない場合はエラーとなるので注意が必要。
jpmobileを読み込むとDoCoMo、Au、SoftBankの絵文字を透過的に扱うことができる。
Rails の場合は、下記の設定を追加することで有効になる。
# Rack middleware を追加するメソッド
Rails.application.config.jpmobile.mobile_filter
or
Jpmobile.config.mobile_filter下記の設定を追加することで、 タグの accept-charset が変更される。
# などに変更する
Rails.application.config.jpmobile.form_accept_charset_conversion = true
or
Jpmobile.config.form_accept_charset_conversion = trueAndroid/iPhone では Google 絵文字や Unicode 6.0 絵文字が使われています。下記の設定を追加すると、互換性をもたせるために3キャリアの絵文字に変換することができます。また表示の変換も可能です。
Rails.application.config.jpmobile.smart_phone_emoticon_compatibility = true
or
Jpmobile.config.smart_phone_emoticon_compatibility = true携帯電話上では特に問題とならない。PCブラウザでテストする際に問題となるためのオプション。
require 'jpmobile'
use Jpmobile::MobileCarrier
use Jpmobile::ParamsFilter
use Jpmobile::Filter
get '/' do
erb :index
endRails のみ半角・全角の自動変換フィルターが用意されている。用いるには
ruby class MyController hankaku_filter end
と指定する。またtextareaやhidden/text/passwordのinputタグで半角に変換したくない場合は :input => true
を指定する。このときNokogiriが必要となるため、Gemfileに追記してインストールする必要がある。
ruby class MyController hankaku_filter :input => true end
Jpmobile内では、各キャリアの絵文字はUnicode私的領域上にマッピングされ、管理される。 このとき、DoCoMo、Auは公式サイト記載のマッピングが使用される。 ただしSoftBankはAuとの重複を避けるため、公式のマッピングに0x1000加算しU+F001以降に割り当てる。 テンプレート内ではUTF-8でエンコードするか、数値文字参照の&#xHHHH;形式で指定する。
絵文字は送出時に内蔵の変換表に基づいて変換され、携帯電話のエンコーディングにあわせて送出される。 携帯電話から受信した絵文字は上記マッピングに基づいてUTF-8でparamsに渡される。
ビューの自動振り分けを行うには、以下の設定が必要です。
class ApplicationController :gps) %>class MyController
trans_sid
endclass MyController
trans_sid :always
endtrans_sid 機能を使う場合には、cookie session store を使用することができず、 active_record_storeのgemパッケージが必要です。 また Rails では 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 "[email protected]"
def registration(to)
mail(:to => to)
end
def receive(email)
email
end
endデフォルトで ISO-2022-JP エンコードで送信
docomo/SoftBank には Shift_JIS で送信
au は ISO-2022-JP エンコードで送信
ビューやレイアウトの自動振り分け
受信に関しては、docomo/SoftBank でテストできていないため、実験版とします。
オプションに :decorated => true を追加すると、各キャリアのデコメに適したフォーマットで送信します。
jpmobileの開発に関しては こちら へ
Copyright 2006-2012 (c) Yoji Shidara, under MIT License.
Shin-ichiro OGAWA , Yoji Shidara
No open issues yet, or sync has not completed.