galakei 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Portions copyright (c) 2010 Mobalean LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,8 @@
+# Galakei: Japanese feature phone support
+
+[Japanese feature phones](http://www.mobalean.com/en/keitai_web_technology_guide) (a.k.a., keitai, galakei) have a number of restrictions over normal web browsers.  This library adds support for them.
+
+### Goals
+
+ * Provide support for 3G handsets from the major 3 carriers in Japan (docomo, au, SoftBank)
+ * Avoid modifying Rails internals as much as possible

data/lib/galakei/email.rb

@@ -0,0 +1,15 @@
+module Galakei::Email
+
+  GALAKEI_EMAIL_ADDRESS_PATTERNS = [
+    /^.+@(.+\.)?pdx\.ne\.jp$/,
+    /^.+@ezweb\.ne\.jp$/,
+    /^.+@(?:softbank\.ne\.jp|disney\.ne\.jp)$/,
+    /^.+@[dhtcrknsq]\.vodafone\.ne\.jp$/,
+    /^.+@jp-[dhtcrknsq]\.ne\.jp$/,
+    /^.+@emnet\.ne\.jp$/,
+    /^.+@docomo\.ne\.jp$/ ]
+
+  def self.galakei_email_address?(email)
+    GALAKEI_EMAIL_ADDRESS_PATTERNS.any?{|p| p =~ email }
+  end
+end

data/lib/galakei/filter/base.rb

@@ -0,0 +1,27 @@
+module Galakei
+  module Filter
+    class Base
+      attr_accessor :controller
+
+      def self.condition?(controller)
+        @instance ||= self.new
+        @instance.controller = controller
+        @instance.condition?
+      end
+
+      def self.filter(controller, &block)
+        @instance ||= self.new
+        @instance.controller = controller
+        @instance.filter(&block)
+      end
+
+      def method_missing(m, *args)
+        if controller.respond_to?(m)
+          controller.send(m, *args)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/galakei/filter/content_type.rb

@@ -0,0 +1,18 @@
+# Takes care of ensuring the Content-Type is set to application/xhtml+xml
+# for docomo devices as is required to use xhtml instead of text/html.  If
+# text/html is used, the content is rendered as the vastly inferior i-mode
+# html (aka CHTML).
+class Galakei::Filter::ContentType < Galakei::Filter::Base
+  def self.inject(klass)
+    this_class = self
+    klass.after_filter self, :if => lambda {|c| this_class.condition?(c) }
+  end
+
+  def condition?
+    request.docomo? && %r{text/html} =~ response.content_type
+  end
+
+  def filter
+    response.content_type = 'application/xhtml+xml'
+  end
+end

data/lib/galakei/filter/haml.rb

@@ -0,0 +1,15 @@
+# Set template format to xhtml.  This method of setting the format is rails
+# specific so leave a filter
+class Galakei::Filter::Haml < Galakei::Filter::Base
+  def self.inject(klass)
+    klass.around_filter self, :if => :galakei?
+  end
+
+  def filter
+    old_format = ::Haml::Template.options[:format] 
+    ::Haml::Template.options[:format] = :xhtml
+    yield
+  ensure
+    ::Haml::Template.options[:format] = old_format
+  end
+end

data/lib/galakei/filter/session_id_parameter.rb

@@ -0,0 +1,29 @@
+class Galakei::Filter::SessionIdParameter < Galakei::Filter::Base
+  def self.inject(klass)
+    klass.before_filter self
+  end
+
+  def filter
+    key = ::Rails.application.config.session_options[:key]
+    if device_needs_session_param_in_url?
+      session[:_dummy_param_to_force_session_init] = nil
+      logger.debug("adding session param '#{key}' to default_url_options")
+      default_url_options[key] = request.session_options[:id]
+    else
+      # workaround for issue in rails 3.0.3: default_url_options aren't cleared
+      default_url_options.delete(key)
+    end
+  end
+
+  private
+
+  def device_needs_session_param_in_url?
+    galakei? && !request.cookies? && session
+  end
+
+  def default_url_options
+    controller.send :default_url_options
+  end
+
+
+end

data/lib/galakei/filter/views.rb

@@ -0,0 +1,10 @@
+class Galakei::Filter::Views < Galakei::Filter::Base
+  def self.inject(klass)
+    klass.before_filter self, :if => :galakei?
+  end
+
+  def filter
+    logger.debug("appending galakei views")
+    prepend_view_path(::Rails.root.join('app','views.galakei'))
+  end
+end

data/lib/galakei/helper_methods.rb

@@ -0,0 +1,13 @@
+module Galakei
+  module HelperMethods
+    def self.included(klass)
+      klass.helper_method :galakei?
+    end
+
+    protected
+
+    def galakei?
+      request.galakei?
+    end
+  end
+end

data/lib/galakei/railtie.rb

@@ -0,0 +1,15 @@
+module Galakei
+  class Railtie < Rails::Railtie
+    config.galakei = ActiveSupport::OrderedOptions.new
+    config.galakei.session_id_parameter = false
+    initializer "galakei.extend.action_controller" do |app|
+      ActiveSupport.on_load :action_controller do
+        include Galakei::HelperMethods
+        filters = %w[Views ContentType]
+        filters << :Haml if defined?(Haml)
+        filters << :SessionIdParameter if app.config.galakei.session_id_parameter
+        filters.each {|f| Galakei::Filter.const_get(f).inject(self) }
+      end
+    end
+  end
+end

data/lib/galakei/request.rb

@@ -0,0 +1,36 @@
+require "rack/request"
+
+module Galakei
+  module Request
+    def docomo?
+      /DoCoMo/i =~ user_agent
+    end
+
+    def au?
+      # doesn't detect some 2G phones, but as they will be discontinued soon, doesn't really matter
+      /KDDI/ =~ user_agent
+    end
+
+    def softbank?
+      /^(SoftBank|Vodafone)/ =~ user_agent
+    end
+
+    def cookies?
+      !imode_browser_1_0?
+    end
+
+    def imode_browser_1_0?
+      if /docomo(.*\((.*;)?c(\d+)\;)?/i =~ user_agent
+        $3.to_i < 500
+      else
+        false
+      end
+    end
+
+    def galakei?
+      docomo? || au? || softbank?
+    end
+  end
+end
+
+Rack::Request.send :include, Galakei::Request

data/lib/galakei/shoulda_macros.rb

@@ -0,0 +1,19 @@
+class ActionController::TestCase
+  class << self
+    {:pc => "mozilla", :galakei => "DoCoMo/2.0 SH06A3(c500;TB;W24H14)"}.each do |method, user_agent|
+      class_eval(<<-EOD)
+        def with_#{method}(&block)
+          context("with #{method} browser") do
+            setup { @request.user_agent = '#{user_agent}' }
+            merge_block(&block)
+          end
+        end
+      EOD
+    end
+    def with_pc_and_galakei(&block)
+      with_pc(&block)
+      with_galakei(&block)
+    end
+  end
+end
+

data/lib/galakei.rb

@@ -0,0 +1,14 @@
+require 'galakei/railtie' if defined?(Rails)
+require 'galakei/request'
+
+module Galakei
+  autoload :Email, "galakei/email"
+  autoload :HelperMethods, "galakei/helper_methods"
+  module Filter
+    autoload :Base, "galakei/filter/base"
+    autoload :ContentType, "galakei/filter/content_type"
+    autoload :Haml, "galakei/filter/haml"
+    autoload :Views, "galakei/filter/views"
+    autoload :SessionIdParameter, "galakei/filter/session_id_parameter"
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: galakei
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul McMahon
+- Michael Reinsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-07 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  type: :runtime
+  version_requirements: *id002
+description: Japanese feature phones (a.k.a., keitai, galakei) have a number of restrictions over normal web browsers.  This library adds support for them
+email: info@mobalean.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- lib/galakei/email.rb
+- lib/galakei/filter/base.rb
+- lib/galakei/filter/content_type.rb
+- lib/galakei/filter/haml.rb
+- lib/galakei/filter/session_id_parameter.rb
+- lib/galakei/filter/views.rb
+- lib/galakei/helper_methods.rb
+- lib/galakei/railtie.rb
+- lib/galakei/request.rb
+- lib/galakei/shoulda_macros.rb
+- lib/galakei.rb
+has_rdoc: true
+homepage: http://www.mobalean.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: "[none]"
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Japanese feature phones support
+test_files: []
+