jpmobile 0.0.4 → 0.0.6

data/README.rdoc

@@ -0,0 +1,227 @@
+= jpmobile: A Rails plugin for Japanese mobile-phones
+
+== jpmobileとは
+携帯電話特有の機能を Rails で利用するためのプラグイン。
+以下の機能を備える。
+
+* 携帯電話のキャリア判別
+* 端末位置情報の取得
+* 端末製造番号、契約者番号等の取得
+* IPアドレスの検証(キャリアが公開しているIPアドレス帯域からのアクセスか判定)
+* セッションIDをフォーム／リンクに付与(Trans SID)
+* 携帯電話ビューへの自動振分け
+* ディスプレイ情報(画面サイズ、ブラウザ画面サイズ、カラー・白黒、色数)の取得
+* GeoKit(http://geokit.rubyforge.org)との連携
+* 文字コード変換機能／絵文字のキャリア間相互変換
+
+== インストール
+Rails の Version に応じて選択してください。
+=== Rails 2.3.2
+==== pluginとしてインストールする場合
+
+リリース版:
+  % ./script/plugin install git://github.com/darashi/jpmobile.git -r 'tag x.x.x'
+  (x.x.xはバージョン)
+
+開発版:
+  % ./script/plugin install git://github.com/darashi/jpmobile.git
+
+==== gemでインストールする場合
+
+  # gem install jpmobile
+としてgemをインストールした後
+
+RAILS_ROOT/config/environment.rb の Rails::Initializer.run do |config| 〜 end 内に
+  config.gem "jpmobile"
+の行を追加する。
+
+=== Rails 2.2.x 以前
+リリース版:
+  % ./script/plugin install git://github.com/darashi/jpmobile.git -r 'tag 0.0.5'
+
+== 使用例
+
+=== 携帯電話の識別
+
+==== Viewの中で一部を切替える例
+  <% if request.mobile? %>
+    携帯電話からのアクセスです。
+  <% else %>
+    携帯電話からのアクセスではありません。
+  <% end %>
+
+==== 別に用意した携帯電話用コントローラへリダイレクトする例
+  class PcController < ApplicationController
+    before_filter :redirect_if_mobile
+
+    def index
+    end
+
+    private
+    def redirect_if_mobile
+      if request.mobile?
+        pa = params.dup
+        pa[:controller] = "/mobile"
+        redirect_to pa
+      end
+    end
+  end
+
+  class MobileController < ApplicationController
+     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
+
+=== 位置情報の取得
+
+==== 取得用リンクの生成
+
+以下のようなコードで、端末に位置情報を要求するリンクを出力する。
+  <%= get_position_link_to(:action=>:gps) %>
+
+==== 位置情報の取得
+
+  class MobileController < ApplicationController
+    def gps
+      if request.mobile && pos = request.mobile.position
+        @latitude = pos.lat
+        @longuitude = pos.lon
+      end
+    end
+  end
+
+
+=== 端末情報の取得
+
+端末側から通知されている場合、request.mobile.ident で
+契約に固有の識別子もしくは端末の製造番号を取得できる。
+両方存在する場合は契約に固有のIDが優先される。
+
+* 契約に固有のID (request.mobile.ident_subscriber)
+  * au: EZ番号(サブスクライバ番号)
+  * DoCoMo: FOMAカード製造番号
+  * EMOBILE: EMnet対応端末から通知されるユニークなユーザID
+* 端末製造番号 (request.mobile.ident_device)
+  * DoCoMo: 端末製造番号(FOMA, MOVA)
+  * SoftBank: 製造番号
+
+=== 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 を解除する必要があるでしょう。
+
+=== 端末の画面サイズ
+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される。したがって、
+
+  request.mobile.position.distance_to('札幌駅')
+
+とすることで、端末と「札幌駅」との距離を求めることができる。詳細は http://geokit.rubyforge.org/api/index.html 参照。
+
+=== 文字コード変換機能／絵文字のキャリア間相互変換
+
+JpmobileではControllerにmobile_filterを指定することで
+DoCoMo、Au、SoftBankの絵文字を透過的に扱うことができる。
+
+ class MyController
+   mobile_filter
+ end
+
+また、半角・全角の自動変換を用いる場合は
+ class MyController
+   mobile_filter :hankaku=>true
+ end
+と指定する。
+
+Jpmobile内では、各キャリアの絵文字はUnicode私的領域上にマッピングされ、管理される。
+このとき、DoCoMo、Auは公式サイト記載のマッピングが使用される。
+ただしSoftBankはAuとの重複を避けるため、公式のマッピングに0x1000加算しU+F001以降に割り当てる。
+テンプレート内ではUTF-8でエンコードするか、数値文字参照の&#xHHHH;形式で指定する。
+
+絵文字は送出時に内蔵の変換表に基づいて変換され、携帯電話のエンコーディングにあわせて送出される。
+携帯電話から受信した絵文字は上記マッピングに基づいてUTF-8でparamsに渡される。
+
+mobile_filterを有効にすると以下の処理が自動で行われる。
+* DoCoMo、Auとの通信時にはShift_JIS、SoftBankとの通信時にはUTF-8が使用される。
+* :hankaku=>true指定時は、カタカナは半角カナに変換されて送出される。携帯電話から送られた半角カナは全角カナに変換される。
+* 絵文字はキャリアにあわせて変換されて送出される。
+* 携帯電話からの絵文字はUnicode私的領域にマップされ、UTF-8でparamsに格納される。
+
+== テストに必要なgemパッケージ
+テストを実行するためには以下のgemパッケージが必要です。
+* rails
+* rack
+* hpricot
+* rspec
+* rspec-rails
+* spec-fixtures
+
+== リンク
+* Project Website: http://jpmobile-rails.org
+* RDoc Documentation: http://jpmobile.rubyforge.org/rdoc
+* GitHub: http://github.com/darashi/jpmobile/
+* RubyForge Project Page: http://rubyforge.org/projects/jpmobile
+* Mailing List: http://groups.google.com/group/jpmobile
+* IRC Channel #jpmobile@freenode.net
+
+== 作者
+
+Copyright 2006 (c) Yohji Shidara, under MIT License.
+
+Yohji Shidara <dara@shidara.net>
+
+http://d.hatena.ne.jp/darashi

data/Rakefile

@@ -25,7 +25,7 @@ CLEAN.include ['**/.*.sw?', '*.gem', '.config']
 RDOC_OPTS = ['--quiet', '--title', "jpmobile documentation",
     "--opname", "index.html",
     "--line-numbers",
-    "--main", "README",
+    "--main", "README.rdoc",
     "--inline-source"]
 
 desc "Packages up jpmobile gem."
@@ -35,19 +35,13 @@ task :package => [:clean]
 desc 'Default: run unit tests.'
 task :default => :test
 
-desc 'Test the jpmobile plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
 
 desc 'Generate documentation for the jpmobile plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.title    = 'Jpmobile'
   rdoc.options << '--line-numbers' << '--inline-source' << '-c UTF-8'
-  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('CHANGELOG')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
@@ -58,7 +52,7 @@ spec =
         s.version = VERS
         s.platform = Gem::Platform::RUBY
         s.has_rdoc = true
-        s.extra_rdoc_files = ["README", "CHANGELOG"]
+        s.extra_rdoc_files = ["README.rdoc", "CHANGELOG"]
         s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
         s.summary = DESCRIPTION
         s.description = DESCRIPTION
@@ -70,12 +64,12 @@ spec =
         s.bindir = "bin"
         s.require_path = "lib"
 
-        s.add_runtime_dependency('actionpack', '>=2.2.2')
+        s.add_runtime_dependency('actionpack', '>=2.3.2')
         s.add_development_dependency('rspec', '>=1.1.12')
         s.add_development_dependency('rspec-rails', '>=1.1.12')
         s.add_development_dependency('rspec-fixture', '>=0.0.2')
 
-        s.files = %w(README CHANGELOG Rakefile) +
+        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") +
@@ -118,6 +112,5 @@ task :rel => [:gem] do
   puts "git tag #{VERS}"
 end
 
-# setup RSpec tasks
-RAILS_ROOT = '.'
+task :test => ['test:legacy', 'spec:unit', 'test:rails']
 load 'tasks/jpmobile_tasks.rake'

data/lib/jpmobile/docomo_guid.rb

@@ -0,0 +1,42 @@
+#DoCoMoの時guid=onの付与
+class ActionController::Base #:nodoc:
+  class_inheritable_accessor :docomo_guid_mode
+
+  class << self
+    def docomo_guid(mode=:docomo)
+      include Jpmobile::DocomoGuid
+      self.docomo_guid_mode = mode
+    end
+  end
+end
+
+
+module Jpmobile::DocomoGuid #:nodoc:
+  protected
+  def default_url_options options=nil
+    result = super || {}
+    return result unless request # for test process
+    return result unless apply_add_guid?
+    return result.merge({:guid => "ON"})
+  end
+
+  #guid=ONを付与すべきか否かを返す
+  def apply_add_guid?
+    return true if docomo_guid_mode == :always
+    return false if docomo_guid_mode == :none
+
+    return false unless request.mobile?
+    return false unless request.mobile.is_a?(Jpmobile::Mobile::Docomo)
+    return false if not_apply_guid_user_agent?
+
+    if docomo_guid_mode == :valid_ip
+      return false unless request.mobile.valid_ip?
+    end
+
+    return true
+  end
+
+  def not_apply_guid_user_agent?
+    request.user_agent.match(/(?:Googlebot|Y!J-SRD\/1\.0|Y!J-MBS\/1\.0)/)
+  end
+end

data/lib/jpmobile/filter.rb

@@ -42,7 +42,7 @@ module Jpmobile
       def after(controller)
         @counter -= 1
         return unless @counter.zero?
-        if respond_to?(:to_external) && apply_outgoing?(controller)
+        if respond_to?(:to_external) && apply_outgoing?(controller) && controller.response.body.is_a?(String)
           controller.response.body = to_external(controller.response.body, controller)
           after_after(controller) if respond_to? :after_after
         end

data/lib/jpmobile/helpers.rb

@@ -147,10 +147,11 @@ module Jpmobile
       mode = "auto"
       if options.is_a?(Hash)
         options = options.symbolize_keys
+        mode = options.delete(:mode) || "auto"
         options[:only_path] = false
-        mode = options[:mode] || "auto"
         url = url_for(options)
       end
+      url.sub!(/\?/, '&')
       return "location:#{mode}?url=#{url}"
     end
 

data/lib/jpmobile/hook_action_controller.rb

@@ -1,3 +1,5 @@
+require 'action_pack'
+
 class ActionController::Base
   include Jpmobile::Helpers
   before_filter :gettext_force_ja_for_mobile
@@ -8,4 +10,14 @@ class ActionController::Base
     rescue NameError
     end
   end
+
+  class << self
+    def view_paths=(value)
+      @view_paths = ActionView::Base.process_view_paths(value) if value
+    end
+  end
+
+  def view_paths=(value)
+    @view_paths = ActionView::Base.process_view_paths(value, controller) if value
+  end
 end

data/lib/jpmobile/hook_action_view.rb

@@ -21,47 +21,43 @@ require 'action_view'
 # BUG: 現状、上記の例では index.rhtml が存在しない場合に振り分けが行われない
 # (ダミーファイルを置くことで回避可能)。
 
-class ActionView::Base #:nodoc:
-  delegate :default_url_options, :to => :controller unless respond_to?(:default_url_options)
-
-  if ::ActionPack::VERSION::MAJOR >=2 and ::ActionPack::VERSION::MINOR >= 2
-    ### Rails 2.2 or higher
-    alias _pick_template_without_jpmobile _pick_template #:nodoc:
-    alias render_partial_without_jpmobile render_partial #:nodoc:
-
-    def _pick_template(template_path)
-      mobile_path = mobile_template_path(template_path)
-      return mobile_path.nil? ? _pick_template_without_jpmobile(template_path) :
-                                _pick_template_without_jpmobile(mobile_path)
-    end
+module ActionView
+  class PathSet
+    alias find_template_without_jpmobile find_template #:nodoc:
+    alias initialize_without_jpmobile initialize #:nodoc:
+
+    attr_accessor :controller
 
-    def render_partial(options = {}) #:nodoc:
-      case partial_path = options[:partial]
-      when String, Symbol, NilClass
-        mobile_path = mobile_template_path(partial_path, true)
-        options = options.merge(:partial => mobile_path) if mobile_path
+    def initialize(*args)
+      if args.first.kind_of?(ActionController::Base)
+        @controller = args.shift
       end
-      render_partial_without_jpmobile(options)
-    end
-  else
-    ### Rails 2.1 or lower
-    alias render_file_without_jpmobile render_file #:nodoc:
-    alias render_partial_without_jpmobile render_partial #:nodoc:
-
-    def render_file(template_path, use_full_path = true, local_assigns = {})
-      mobile_path = mobile_template_path(template_path)
-      return mobile_path.nil? ? render_file_without_jpmobile(template_path, use_full_path, local_assigns) :
-                                render_file_without_jpmobile(mobile_path, use_full_path, local_assigns)
+      initialize_without_jpmobile(*args)
     end
 
-    def render_partial(partial_path, object_assigns = nil, local_assigns = {}) #:nodoc:
-      mobile_path = mobile_template_path(partial_path, true) if partial_path.class === "String"
-      return mobile_path.nil? ? render_partial_without_jpmobile(partial_path, object_assigns, local_assigns) :
-                                render_partial_without_jpmobile(mobile_path, object_assigns, local_assigns)
+    # hook ActionView::PathSet#find_template
+    def find_template(original_template_path, format = nil, html_fallback = true) #:nodoc:
+      if controller and controller.kind_of?(ActionController::Base) and controller.request.mobile?
+        return original_template_path if original_template_path.respond_to?(:render)
+        template_path = original_template_path.sub(/^\//, '')
+
+        template_candidates = mobile_template_candidates(controller)
+        format_postfix      = format ? ".#{format}" : ""
+
+        each do |load_path|
+          template_candidates.each do |template_postfix|
+            if template = load_path["#{template_path}_#{template_postfix}#{format_postfix}"]
+              return template
+            end
+          end
+        end
+      end
+
+      return find_template_without_jpmobile(original_template_path, format, html_fallback)
     end
-  end
 
-  def mobile_template_candidates
+    # collect cadidates of mobile_template
+    def mobile_template_candidates(controller)
       candidates = []
       c = controller.request.mobile.class
       while c != Jpmobile::Mobile::AbstractMobile
@@ -69,52 +65,66 @@ class ActionView::Base #:nodoc:
         c = c.superclass
       end
       candidates << "mobile"
+    end
   end
 
-  def mobile_template_partial mobile_path
-    # ActionView::PartialTemplate#extract_partial_name_and_path の動作を模倣
-    if mobile_path.include?('/')
-      path = File.dirname(mobile_path)
-      partial_name = File.basename(mobile_path)
-    else
-      path = self.controller.class.controller_path
-      partial_name = mobile_path
+  class Base #:nodoc:
+    delegate :default_url_options, :to => :controller unless respond_to?(:default_url_options)
+
+    # nothing to do
+    def view_paths=(paths)
+      @view_paths = self.class.process_view_paths(paths, controller)
     end
-    File.join(path, "_#{partial_name}")
-  end
 
-  def mobile_path template_path, type
-    "#{template_path}_#{type}"
-  end
+    def self.process_view_paths(value, controller = nil)
+      if controller && controller.is_a?(ActionController::Base)
+        ActionView::PathSet.new(controller, Array(value))
+      else
+        ActionView::PathSet.new(Array(value))
+      end
+    end
 
-  def mobile_template_path(template_path, partial=false)
-    if controller.is_a?(ActionController::Base) && m = controller.request.mobile
-      mobile_template_candidates.each do |v|
-        mpath = mobile_path template_path, v
-        if partial
-          full_path = mobile_template_partial mpath
-        else
-          full_path = mpath
-        end
-        if template_exists?(full_path)
-          return mpath
-        end
+    def mobile_template_candidates
+      candidates = []
+      c = controller.request.mobile.class
+      while c != Jpmobile::Mobile::AbstractMobile
+        candidates << "mobile_"+c.to_s.split(/::/).last.downcase
+        c = c.superclass
       end
+      candidates << "mobile"
+    end
+
+    def mobile_template_partial mobile_path
+      # ActionView::PartialTemplate#extract_partial_name_and_path の動作を模倣
+      if mobile_path.include?('/')
+        path = File.dirname(mobile_path)
+        partial_name = File.basename(mobile_path)
+      else
+        path = self.controller.class.controller_path
+        partial_name = mobile_path
+      end
+      File.join(path, "_#{partial_name}")
     end
-    return nil
-  end
 
-  if ::ActionPack::VERSION::MAJOR >=2 and ::ActionPack::VERSION::MINOR >= 2
-    ### Rails 2.2 or higher
-    def template_exists?(template_name)
-      send(:_pick_template_without_jpmobile, template_name) ? true : false
-    rescue ActionView::MissingTemplate
-      false
+    def mobile_path template_path, type
+      "#{template_path}_#{type}"
     end
-  else
-    ### Rails 2.1 or lower
-    def template_exists?(template_name)
-      finder.file_exists?(template_name)
+
+    def mobile_template_path(template_path, partial=false)
+      if controller.is_a?(ActionController::Base) && m = controller.request.mobile
+        mobile_template_candidates.each do |v|
+          mpath = mobile_path template_path, v
+          if partial
+            full_path = mobile_template_partial mpath
+          else
+            full_path = mpath
+          end
+          if template_exists?(full_path)
+            return mpath
+          end
+        end
+      end
+      return nil
     end
   end
 end