radiant-mobile-extension 0.1.5 → 0.2.0

data/README.md

@@ -12,6 +12,29 @@ This very simple extension allows you to offer a cache-friendly mobile version o
 
 4. Use the radius tags `<r:if_mobile_>` and `<r:unless_mobile>` to make layout or content decisions based on whether this is a request for the mobile site.
 
+## Web views
+
+Any request that whose address begins 'app.', or which matches the configured 'app.host' is considered to be a request from a smartphone app for a web view. Such requests will set the mobile flag and will also set an app flag, so you can use an additional `<r:if_app>` radius tag to distinguish such requests from normal mobile phone usage.
+
+## Configuration
+
+You can set configuration entries to determine site addresses:
+
+* `mobile.host` -> fully-specified mobile host name, eg m.spanner.org
+* `app.host` -> fully-specified app host name
+
+and to define the user-agent fragments that identify mobile (and non-mobile) devices:
+
+* `mobile.ua.positives` -> comma-separated list of mobile UA markers like 'iphone,android,etc'
+* `mobile.ua.negatives` -> comma-separated list of non-mobile UA markers like 'ipad'
+* `mobile.ua.required` -> comma-separated list of UA markers that must be present to confirm mobileness
+
+The logic of mobile device detection is this:
+
+	match any positive && not match any negatives && match any required
+
+which allows us to pick a path through the messy and regrettable business of browser-sniffing with reasonable accuracy.
+
 ## Possibly AQ
 
 ### Why not just set :format (or use mobile-fu)?
@@ -77,7 +100,7 @@ With the `layouts` or `nested_layouts` extension you could create a simple layou
 
 ## Status
 
-Brand new and not well tested, but there's not much to it.
+This has been in use for a couple of years without problems. The app-view part is new but ordinary: you should be able to use this extension with confidence.
 
 ## Bugs and comments
 

data/config/initializers/radiant_config.rb

@@ -1,6 +1,8 @@
 Radiant.config do |config|
-  config.namespace('mobile') do |mob|
-    mob.define 'host', :allow_blank => true
-    mob.define 'redirect?', :default => true
-  end
+  config.define 'app.host', :allow_blank => true
+  config.define 'mobile.host', :allow_blank => true
+  config.define 'mobile.redirect?', :default => true
+  config.define 'mobile.ua.positive', :allow_blank => true, :default => "palm,blackberry,nokia,phone,midp,mobi,symbian,chtml,ericsson,minimo,audiovox,motorola,samsung,telit,upg1,windows,ce,ucweb,astel,plucker,x320,x240,j2me,sgh,portable,sprint,docomo,kddi,softbank,android,mmp,pdxgw,netfront,xiino,vodafone,portalmmm,sagem,mot-,sie-,ipod,webos,amoi,novarra,cdm,alcatel,pocket,iphone,mobileexplorer,mobile"
+  config.define 'mobile.ua.negative', :allow_blank => true, :default => "ipad"
+  config.define 'mobile.ua.required', :allow_blank => true, :default => "mobile"
 end 

data/lib/mobile_page.rb

@@ -1,5 +1,5 @@
 module MobilePage
-  attr_accessor :mobile
+  attr_accessor :mobile, :app
 
   # The extended site controller calls page.mobile = true if we are in a mobile context
   #
@@ -7,11 +7,18 @@ module MobilePage
     !!@mobile
   end
 
+  # The extended site controller calls page.mobile = true if we are in a mobile context
+  #
+  def app?
+    !!@app
+  end
+
   include Radiant::Taggable
 
   desc %{
     Expands if the url of the current request matches the host name defined in Radiant::Config['mobile.host'].
-    (or if there is no such definition, if the domain begins with m.)
+    (or if there is no such definition, if the domain begins with m.) Note that if there is an app site then it will 
+    also be considered mobile.
 
     *Usage:*
     <pre><code><r:if_mobile>...</r:if_mobile></code></pre>
@@ -22,7 +29,8 @@ module MobilePage
 
   desc %{
     Expands unless the url of the current request matches the host name defined in Radiant::Config['mobile.host'].
-    (or if there is no such definition, unless it begins with m.)
+    (or if there is no such definition, unless it begins with m.) Note that if there is an app site then it will 
+    also be considered mobile.
 
     *Usage:*
     <pre><code><r:unless_mobile>...</r:unless_mobile></code></pre>
@@ -31,4 +39,26 @@ module MobilePage
     tag.expand unless mobile?
   end
 
+  desc %{
+    Expands if the url of the current request matches the host name defined in Radiant::Config['app.host'].
+    (or if there is no such definition, if the domain begins with app.)
+
+    *Usage:*
+    <pre><code><r:if_app>...</r:if_app></code></pre>
+  }
+  tag 'if_app' do |tag|
+    tag.expand if app?
+  end
+
+  desc %{
+    Expands unless the url of the current request matches the host name defined in Radiant::Config['app.host'].
+    (or if there is no such definition, unless it begins with app.)
+
+    *Usage:*
+    <pre><code><r:unless_app>...</r:unless_app></code></pre>
+  }
+  tag 'unless_app' do |tag|
+    tag.expand unless app?
+  end
+
 end

data/lib/mobile_site_controller.rb

@@ -4,40 +4,66 @@ module MobileSiteController
   # we can redirect to the corresponding page in a mobile site, and if we are on the mobile
   # site we set a flag on the page that radius tags can use to select content.
   
-  
-  # approach and UA strings borrowed from mobile-fu
-  # http://github.com/brendanlim/mobile-fu/tree/master
-  MOBILE_USER_AGENTS = 'palm|blackberry|nokia|phone|midp|mobi|symbian|chtml|ericsson|minimo|' +
-                       'audiovox|motorola|samsung|telit|upg1|windows ce|ucweb|astel|plucker|' +
-                       'x320|x240|j2me|sgh|portable|sprint|docomo|kddi|softbank|android|mmp|' +
-                       'pdxgw|netfront|xiino|vodafone|portalmmm|sagem|mot-|sie-|ipod|up\\.b|' +
-                       'webos|amoi|novarra|cdm|alcatel|pocket|iphone|mobileexplorer|' +
-                       'mobile'
-
   # Returns true if the requested host matches the defined mobile host
   # (or in the absence of such a definition, if the host begins m.)
   #
   def mobile?
     mobile_host = Radiant.config['mobile.host']
-    unless mobile_host.blank?
+    match = unless mobile_host.blank?
       request.host == mobile_host
     else
       request.host =~ /^m\./
     end
+    !!match
+  end
+
+  # Returns true if the requested host matches the defined app host
+  # (or in the absence of such a definition, if the host begins app.)
+  #
+  def app?
+    app_host = Radiant.config['app.host']
+    match = unless app_host.blank?
+      request.host == app_host
+    else
+      request.host =~ /^app\./
+    end
+    !!match
   end
 
-  # Returns true if the request comes from a mobile device
-  # (based on the supplied user-agent string)
+  # Returns true if the request comes from a mobile device (based on the supplied user-agent string)
   #
   def mobile_device?
-    request.user_agent.to_s.downcase =~ Regexp.new(MobileSiteController::MOBILE_USER_AGENTS)
+    ua = request.user_agent.to_s.downcase
+    ua =~ Regexp.new(positive_markers.join('|')) && ua =~ Regexp.new(required_markers.join('|')) && ua !~ Regexp.new(negative_markers.join('|'))
+  end
+  
+  # Returns the list of string fragments whose presence indicates that this is a mobile device.
+  # The default list (and the approach) is borrowed from mobile-fu: https://github.com/brendanlim/mobile-fu/blob/master/lib/mobile_fu.rb
+  #
+  def positive_markers
+    @positive_ua_markers ||= Radiant.config['mobile.ua.positive'].split(/,\s*/)
+  end
+  
+  # Returns the list of string fragments whose presence indicates that this is a tablet and should not be treated as a mobile device.
+  # eg. Ipad UA includes 'mobile' (which in this context is a false positive) and also 'ipad' (which allows us to eliminate it).
+  #
+  def negative_markers
+    @negative_ua_markers ||= Radiant.config['mobile.ua.negative'].split(/,\s*/)
+  end
+  
+  # Returns the list of string fragments that must be present or this is not a mobile device.
+  # eg. android tablet UA includes 'android' but not 'mobile', so we require the mobile flag.
+  #
+  def required_markers
+    @required_ua_markers ||= Radiant.config['mobile.ua.required'].split(/,\s*/)
   end
 
-  # Extends the process_page method to place a 'mobile' flag in the page-rendering 
+  # Extends the process_page method to place a 'mobile' and 'app' flags in the page-rendering 
   # context to support presentation choices in radius tags.
   #
   def process_page_with_mobile(page)
-    page.mobile = mobile?
+    page.app = app?
+    page.mobile = app? || mobile?
     process_page_without_mobile(page)
   end
 

data/lib/radiant-mobile-extension.rb

@@ -1,7 +1,7 @@
 module RadiantMobileExtension
-  VERSION = '0.1.5'
-  SUMMARY = %q{Provide a mobile version of your radiant site with minimal reworking.}
-  DESCRIPTION = %q{This extension provides radius tags and a redirection mechanism that makes it trivially simple to provide a mobile version of your site.}
+  VERSION = '0.2.0'
+  SUMMARY = %q{Provide a mobile and app versions of your radiant site from within one page tree, using radius tags to select content.}
+  DESCRIPTION = %q{This extension provides radius tags and a redirection mechanism that makes it simple to provide a mobile version of your site and to serve web views for use in mobile apps.}
   URL = "http://github.com/spanner/radiant-mobile-extension"
   AUTHORS = ["William Ross"]
   EMAIL = ["radiant@spanner.org"]

data/spec/controllers/mobile_site_controller_spec.rb

@@ -6,8 +6,11 @@ describe SiteController do
   before do
     @host = "m.test.host"
     @page = pages(:first)
-    Radiant::Config['mobile.host'] = @host
-    Radiant::Config['mobile.redirect?'] = true
+    Radiant.config['mobile.host'] = @host
+    Radiant.config['mobile.redirect?'] = true
+    Radiant.config['mobile.ua.positive'] = "palm,blackberry,nokia,phone,midp,mobi,symbian,chtml,ericsson,minimo,audiovox,motorola,samsung,telit,upg1,windows,ce,ucweb,astel,plucker,x320,x240,j2me,sgh,portable,sprint,docomo,kddi,softbank,android,mmp,pdxgw,netfront,xiino,vodafone,portalmmm,sagem,mot-,sie-,ipod,webos,amoi,novarra,cdm,alcatel,pocket,iphone,mobileexplorer,mobile"
+    Radiant.config['mobile.ua.negative'] = "ipad"
+    Radiant.config['mobile.ua.required'] = "mobile"
   end
   
   describe "responding to a mobile-site request" do
@@ -25,6 +28,23 @@ describe SiteController do
       get :show_page, :url => @page.url
     end
   end
+
+  describe "responding to an app-site request" do
+    before do
+      request.stub!(:host).and_return("app.test.host")
+      controller.stub!(:find_page).and_return(@page)
+    end
+
+    it "should notice that this is a request for the app site" do
+      controller.app?.should be_true
+    end
+
+    it "should set both the mobile and app flags on a processed page to true" do
+      @page.should_receive(:mobile=).with(true)
+      @page.should_receive(:app=).with(true)
+      get :show_page, :url => @page.url
+    end
+  end
   
   describe "responding to a standard-site request" do
     before do
@@ -41,6 +61,50 @@ describe SiteController do
       get :show_page, :url => @page.url
     end
     
+    describe "detecting devices:" do
+      describe "android phone" do
+        before do
+          request.stub!(:user_agent).and_return("Mozilla/5.0 (Linux; U; Android 2.2.1; en-us; Nexus One Build/FRG83) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Mobile Safari/533.1")
+        end
+        it "should be mobile" do
+          controller.mobile_device?.should be_true
+        end
+      end
+      describe "iphone" do
+        before do
+          request.stub!(:user_agent).and_return("Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1C25 Safari/419.3")
+        end
+        it "should be mobile" do
+          controller.mobile_device?.should be_true
+        end
+      end
+      describe "android tablet" do
+        before do
+          request.stub!(:user_agent).and_return("Mozilla/5.0 (Linux; U; Android 2.2.1; en-us; device Build/FRG83) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Safari/533.1")
+        end
+        it "should not be mobile" do
+          controller.mobile_device?.should be_false
+        end
+      end
+      describe "ipad" do
+        before do
+          request.stub!(:user_agent).and_return("Mozilla/5.0 (iPad; U; CPU OS 3_2 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Version/4.0.4 Mobile/7B334b Safari/531.21.10")
+        end
+        it "should not be mobile" do
+          controller.mobile_device?.should be_false
+        end
+      end
+      describe "with configured ua fragments" do
+        before do
+          Radiant.config['mobile.ua.positive'] = 'foo,bar,baz'
+          request.stub!(:user_agent).and_return("Mozilla/5.0 (Foo) Mobile")
+        end
+        it "should be mobile" do
+          controller.mobile_device?.should be_true
+        end
+      end
+    end
+    
     describe "from a mobile device" do
       before do
         controller.stub!(:mobile_device?).and_return(true)

data/spec/models/mobile_page_spec.rb

@@ -11,4 +11,11 @@ describe Page do
     page.mobile.should be_true
     page.mobile?.should be_true
   end
+
+  it "should get and set an app? attribute" do
+    page.app?.should be_false
+    lambda{ page.app = true }.should_not raise_error
+    page.app.should be_true
+    page.app?.should be_true
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: radiant-mobile-extension
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 5
-  version: 0.1.5
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - William Ross
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-13 00:00:00 Z
+date: 2011-10-20 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: paperclip
@@ -33,7 +34,7 @@ dependencies:
         version: 2.3.16
   type: :runtime
   version_requirements: *id001
-description: This extension provides radius tags and a redirection mechanism that makes it trivially simple to provide a mobile version of your site.
+description: This extension provides radius tags and a redirection mechanism that makes it simple to provide a mobile version of your site and to serve web views for use in mobile apps.
 email: 
 - radiant@spanner.org
 executables: []
@@ -56,7 +57,6 @@ files:
 - lib/radiant-mobile-extension.rb
 - lib/tasks/mobile_extension_tasks.rake
 - mobile_extension.rb
-- radiant-mobile-extension-0.1.5.gem
 - radiant-mobile-extension.gemspec
 - Rakefile
 - README.md
@@ -65,10 +65,11 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - VERSION
+has_rdoc: true
 homepage: http://github.com/spanner/radiant-mobile-extension
 licenses: []
 
-post_install_message: "\n  Add this to your radiant project with a line in your Gemfile:\n\n    gem 'radiant-mobile-extension', '~> 0.1.5'\n\n  "
+post_install_message: "\n  Add this to your radiant project with a line in your Gemfile:\n\n    gem 'radiant-mobile-extension', '~> 0.2.0'\n\n  "
 rdoc_options: []
 
 require_paths: 
@@ -94,10 +95,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
-summary: Provide a mobile version of your radiant site with minimal reworking.
+summary: Provide a mobile and app versions of your radiant site from within one page tree, using radius tags to select content.
 test_files: 
 - spec/controllers/mobile_site_controller_spec.rb
 - spec/models/mobile_page_spec.rb