jpmobile 技术文档

1. 安装指南

使用 gem 安装

gem install jpmobile

如果需要进行 IP 地址验证，需要安装 jpmobile-ipaddresses：

gem install jpmobile-ipaddresses

如果需要获取显示信息，需要安装 jpmobile-terminfo：

gem install jpmobile-terminfo

2. 项目使用说明

jpmobile 是一个为 Rails 和 Rack middleware 提供的插件，用于利用 Rails 或 Rack 中间件来使用移动电话特有的功能。它具备以下功能：

• 判断手机运营商
• 获取终端位置信息
• 获取终端制造编号、合同者编号等
• 验证 IP 地址是否属于运营商公开的 IP 地址段
• 获取显示信息（屏幕尺寸、浏览器屏幕尺寸、颜色或黑白、色数）
• 文字编码转换功能/运营商间表情符号相互转换
• 发送邮件（支持表情符号和汉字编码转换）
• 接收邮件（实验性功能）

3. 项目 API 使用文档

携带电话的识别

在环境变量 ENV['rack.jpmobile'] 中存储了运营商类的实例，也可以通过 Rack::Request#mobile 获取。

判断运营商

case request.mobile
when Jpmobile::Mobile::Docomo
  # DoCoMo 用处理
when Jpmobile::Mobile::Au
  # au 用处理
when Jpmobile::Mobile::Softbank
  # SoftBank 用处理
when Jpmobile::Mobile::Willcom
  # Willcom 用处理
when Jpmobile::Mobile::Emobile
  # EMOBILE 用处理
else
  # 电脑端处理
end

视图中的条件切换示例

<% if request.mobile? %>
  来自移动电话的访问。
<% else %>
  不是移动电话的访问。
<% end %>

<% if request.smart_phone? %>
  来自智能手机的访问。
<% else %>
  不是智能手机的访问。
<% end %>

<% if request.tablet? %>
  来自平板电脑的访问。
<% 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
@longitude  = request.mobile.position.lon

获取终端信息

如果终端侧提供了信息，可以通过 request.mobile.ident 获取合同特定的识别符或终端的制造编号。

验证 IP 地址

通过 request.mobile.valid_ip? 方法可以验证是否来自运营商公开的 IP 地址段。

获取屏幕尺寸

通过 request.mobile.display 可以获取屏幕尺寸信息。

屏幕宽度 <%= request.mobile.display.width %>
屏幕高度 <%= request.mobile.display.height %>

文字编码转换功能/表情符号的运营商间相互转换

jpmobile 会透明地处理 DoCoMo、au、SoftBank 的表情符号。

在 Rails 中，需要在 vendor/plugins 目录下配置 GeoKit，并添加以下设置以启用：

# 在 Rack middleware 中添加
Rails.application.config.jpmobile.mobile_filter

4. 项目安装方式

请参考上述的安装指南，使用 gem 进行安装。

gem install jpmobile

如果需要额外功能，根据需要安装 jpmobile-ipaddresses 和 jpmobile-terminfo。

以上就是 jpmobile 的技术文档，详细介绍了安装方式、使用说明以及 API 使用方法。