百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
J

jpmobile

> 编程语言
开源

一个用于日本手机的 Rails 插件

322 stars0 点赞3 次浏览
访问官网GitHub

工具介绍

一个用于日本手机的 Rails 插件

jpmobile: A Rails plugin for Japanese mobile-phones

jpmobileとは

携帯電話特有の機能を Rails や Rack middleware で利用するためのプラグイン。 以下の機能を備える。

  • 携帯電話のキャリア判別

    • User-Agent による判別に加え、HTTP Client Hints (Sec-CH-UA-Mobile, Sec-CH-UA-Platform) による判別に対応。Client Hints が送信されている場合は User-Agent より優先して判定する。
  • 端末位置情報の取得

    • GeoKit との連携
  • 端末製造番号、契約者番号等の取得

  • IPアドレスの検証(キャリアが公開しているIPアドレス帯域からのアクセスか判定)

    • IPアドレスの検証には jpmobile-ipaddresses が必要です。
  • ディスプレイ情報(画面サイズ、ブラウザ画面サイズ、カラー・白黒、色数)の取得

    • ディスプレイ情報の取得には jpmobile-terminfo が必要です。
  • 文字コード変換機能/絵文字のキャリア間相互変換

  • メールの送信

    • 絵文字と漢字コードの変換
  • メールの受信(experimental)

    • 絵文字と漢字コードの変換

また Rails に以下の機能を追加する

  • ビューへの自動振分け
  • 位置情報取得などのリンクヘルパーの追加
  • セッションIDをフォーム/リンクに付与(Trans SID)

他のバージョンの Rails については Versions : Jpmobile vs Rails を参照。

インストール

gemでインストールする場合

bash
% gem install jpmobile

IPアドレス検証が必要な場合

bash
% gem install jpmobile-ipaddresses

ディスプレイ情報を取得する必要がある場合

bash
% gem install jpmobile-terminfo

使用例

携帯電話の識別

環境変数 ENV['rack.jpmobile'] にキャリアクラスのインスタンスが格納されています。また Rack::Request#mobile としても取得可能です。

キャリアの識別

ruby
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

あるいは

ruby
if request.mobile.is_a?(Jpmobile::Mobile::Docomo)
  # for DoCoMo
end

ビューの中で一部を切替える例

ruby

  携帯電話からのアクセスです。

  携帯電話からのアクセスではありません。

  スマートフォンからのアクセスです。

  スマートフォンからのアクセスではありません。

  タブレットからのアクセスです。

  タブレットからのアクセスではありません。

別に用意した携帯電話用コントローラへリダイレクトする例

ruby
class PcController 
画面高さ 

ただし jpmobile-terminfo がインストールされていない場合はエラーとなるので注意が必要。

文字コード変換機能/絵文字のキャリア間相互変換

jpmobileを読み込むとDoCoMo、Au、SoftBankの絵文字を透過的に扱うことができる。

  • Rails の場合は、下記の設定を追加することで有効になる。

    ruby
    # Rack middleware を追加するメソッド
    Rails.application.config.jpmobile.mobile_filter
      or
    Jpmobile.config.mobile_filter
    • 下記の設定を追加することで、 タグの accept-charset が変更される。

      ruby
      #  などに変更する
      Rails.application.config.jpmobile.form_accept_charset_conversion = true
        or
      Jpmobile.config.form_accept_charset_conversion = true
    • Android/iPhone では Google 絵文字や Unicode 6.0 絵文字が使われています。下記の設定を追加すると、互換性をもたせるために3キャリアの絵文字に変換することができます。また表示の変換も可能です。

      ruby
      Rails.application.config.jpmobile.smart_phone_emoticon_compatibility = true
        or
      Jpmobile.config.smart_phone_emoticon_compatibility = true

携帯電話上では特に問題とならない。PCブラウザでテストする際に問題となるためのオプション。

  • Sinatra の場合は下記のように指定する。
    ruby
    require 'jpmobile'
    
    use Jpmobile::MobileCarrier
    use Jpmobile::ParamsFilter
    use Jpmobile::Filter
    
    get '/' do
      erb :index
    end

Rails のみ半角・全角の自動変換フィルターが用意されている。用いるには 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に渡される。

  • DoCoMo、Auとの通信時にはShift_JIS、SoftBankとの通信時にはUTF-8が使用される。
  • :hankaku=>true指定時は、カタカナは半角カナに変換されて送出される。携帯電話から送られた半角カナは全角カナに変換される。
  • 絵文字はキャリアにあわせて変換されて送出される。
  • 携帯電話からの絵文字はUnicode私的領域にマップされ、UTF-8でparamsに格納される。

ビューの自動振り分け

ビューの自動振り分けを行うには、以下の設定が必要です。

ruby
class ApplicationController :gps) %>

セッションIDの付与(Trans SID)

Cookie非対応携帯だけに付与する

ruby
class MyController
  trans_sid
end

PCにも付与する

ruby
class MyController
  trans_sid :always
end

trans_sid 機能を使う場合には、cookie session store を使用することができず、 active_record_storeのgemパッケージが必要です。 また Rails では Cookie が使える場合にはそちらが優先されてしまうため、:always を指定した場合に問題になる場合があります。 trans_sid を使用する際には、例えば config/initializers/session_store.rb で

ruby
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 を解除する必要があるでしょう。

また、

ruby
link_to "hoge", "/controller/action/id"

のようにリンク先を直接指定するとセッションIDは付加されません。

ruby
link_to "hoge", :controller => "controller", :action => "action", :id => "id"

のように指定する必要があります。

メールの送受信

メールにて絵文字や漢字コードの変換、ビューの自動振り分けを行なうには Jpmobile::Mailer::Base を使う。

ruby
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 であれば app/views/mobile_mailer/registration_mobile_docomo.html.erb など
  • 受信に関しては、docomo/SoftBank でテストできていないため、実験版とします。

    • テストして問題あれば随時報告してください。
  • オプションに :decorated => true を追加すると、各キャリアのデコメに適したフォーマットで送信します。

    • ただし docomo/SoftBank でテスト出来ていないため、実験版とします。

jpmobileの開発方法

jpmobileの開発に関しては こちら へ

リンク

  • http://jpmobile-rails.org

作者

Copyright 2006-2012 (c) Yoji Shidara, under MIT License.

Shin-ichiro OGAWA , Yoji Shidara

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

Ruby

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月18日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言