rack-mobile-detect 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### 0.2.0: Mar 14, 2010 ###
+* Added redirect_to option from github.com/joren
+* Added redirect_map option
+* Added dependency on rack
+* Added more test for redirect options
+* Renamed rb file to mobile-detect.rb
+* Updated tests, echo_env.rb to reference new file

data/README.md

@@ -3,6 +3,10 @@ Install
 
     sudo gem install rack-mobile-detect -s http://gemcutter.org
 
+In your code:
+
+    require 'rack-mobile-detect'
+
 Overview
 ========
 
@@ -77,6 +81,32 @@ Configuration/CLDC-1.1 VendorID/102' connects, the value of
 This allows you to limit the catchall expression to only the device
 list you choose.
 
+Redirects
+=========
+
+    use Rack::MobileDetect, :redirect_to => '/mobile'
+
+This allows you to choose a custom redirect path any time a mobile
+device is detected.
+
+    use Rack::MobileDetect, :targeted => /BlackBerry|iPhone/,
+                            :redirect_map => { 'BlackBerry' => '/m/blackberry', 'iPhone' => '/m/iphone' }
+
+This allows you to map specific redirect URLs to targeted devices. The
+key in the redirect_map should be the value of the matched pattern.
+
+    use Rack::MobileDetect, :targeted => /BlackBerry|iPhone/,
+                            :redirect_map => { 'BlackBerry' => '/m/blackberry', 'iPhone' => '/m/iphone' },
+                            :redirect_to => '/mobile'
+
+This allows you to map targeted devices to specific URLs. Non-targeted
+mobile devices will redirect to the url specified by redirect_to.
+
+In the example above, BlackBerrys and iPhones get redirected to
+device-specific URLs. All other mobile devices get redirected to
+'/mobile'.
+
+
 Utils
 =====
 

data/Rakefile

@@ -8,11 +8,12 @@ begin
     gem.summary = %Q{Rack middleware for ruby webapps to detect mobile devices.}
     gem.description = %Q{Rack::MobileDetect detects mobile devices and adds an
     X_MOBILE_DEVICE header to the request if a mobile device is detected. Specific
-    devices can be targeted with custom Regexps.}
+    devices can be targeted with custom Regexps and redirect support is available.}
     gem.email = "accounts@majortom.fastmail.us"
     gem.homepage = "http://github.com/talison/rack-mobile-detect"
-    gem.authors = ["Tom Alison", "Michael Wood"]
-    gem.add_development_dependency "shoulda", ">= 0"
+    gem.authors = ["Tom Alison"]
+    gem.add_development_dependency("shoulda", ">= 0")
+    gem.add_dependency("rack")
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/TODO

@@ -1 +1,3 @@
 * Allow options to disable UAProf detection, Accept detection
+
+

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:build: 
-:minor: 1
-:patch: 1
 :major: 0
+:minor: 2
+:build: 
+:patch: 0

data/lib/{rack-mobile-detect.rb → rack/mobile-detect.rb}

@@ -20,6 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rack'
+
 module Rack
   #
   # Full project at http://github.com/talison/rack-mobile-detect
@@ -121,6 +123,11 @@ module Rack
                    '240x320|320x320|mobileexplorer|j2me|sgh|portable|sprint|vodafone|' +
                    'docomo|kddi|softbank|pdxgw|j-phone|astel|minimo|plucker|netfront|' +
                    'xiino|mot-v|mot-e|portalmmm|sagem|sie-s|sie-m|android|ipod', true)
+
+      # A URL that specifies a single redirect-url for any device
+      @redirect_to = options[:redirect_to]
+      # A mapping of devices to redirect URLs, for targeted devices
+      @redirect_map = options[:redirect_map]
     end
 
     # Because the web app may be multithreaded, this method must
@@ -142,9 +149,28 @@ module Rack
       # Fall back on catch-all User-Agent regex
       device ||= Regexp.new(@regex_ua_catchall).match(user_agent) != nil
 
-      env[X_HEADER] = device.to_s if device
+      if device
+        device = device.to_s
+
+        env[X_HEADER] = device
+        redirect = check_for_redirect(device)
+
+        if redirect
+          path = Rack::Utils.unescape(env['PATH_INFO'])
+          return [301, {'Location' => redirect}, []] if redirect && path !~ /^#{redirect}/
+        end
+      end
 
       @app.call(env)
     end
+
+    # Checks to see if any redirect options were passed in
+    # and returns the appropriate redirect or nil (if no redirect requested)
+    def check_for_redirect(device)
+      # Find the device-specific redirect in the map, if exists
+      return @redirect_map[device] if @redirect_map && @redirect_map.has_key?(device)
+      # Return global redirect, or nil
+      return @redirect_to
+    end
   end
 end

data/rack-mobile-detect.gemspec

@@ -5,28 +5,30 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rack-mobile-detect}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Tom Alison", "Michael Wood"]
-  s.date = %q{2009-10-30}
+  s.authors = ["Tom Alison"]
+  s.date = %q{2010-03-14}
   s.description = %q{Rack::MobileDetect detects mobile devices and adds an
     X_MOBILE_DEVICE header to the request if a mobile device is detected. Specific
-    devices can be targeted with custom Regexps.}
+    devices can be targeted with custom Regexps and redirect support is available.}
   s.email = %q{accounts@majortom.fastmail.us}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md"
+     "README.md",
+     "TODO"
   ]
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG.md",
      "LICENSE",
      "README.md",
      "Rakefile",
      "TODO",
      "VERSION.yml",
-     "lib/rack-mobile-detect.rb",
+     "lib/rack/mobile-detect.rb",
      "rack-mobile-detect.gemspec",
      "test/helper.rb",
      "test/test_rack-mobile-detect.rb",
@@ -38,8 +40,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Rack middleware for ruby webapps to detect mobile devices.}
   s.test_files = [
-    "test/test_rack-mobile-detect.rb",
-     "test/helper.rb"
+    "test/helper.rb",
+     "test/test_rack-mobile-detect.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -48,11 +50,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rack>, [">= 0"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rack>, [">= 0"])
   end
 end
 

data/test/helper.rb

@@ -4,7 +4,7 @@ require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rack-mobile-detect'
+require 'rack/mobile-detect'
 
 class Test::Unit::TestCase
 end

data/test/test_rack-mobile-detect.rb

@@ -122,6 +122,92 @@ class TestRackMobileDetect < Test::Unit::TestCase
     end
   end
 
+  context "An app with a custom redirect" do
+    setup do
+      @app = test_app
+      # Custom redirect
+      @rack = Rack::MobileDetect.new(@app, :redirect_to => '/mobile')
+    end
+
+    should "redirect to mobile website" do
+      env = test_env({ 'HTTP_USER_AGENT' => iphone })
+      status, headers, body = @rack.call(env)
+      assert_equal 'iPhone', env[x_mobile]
+
+      assert_equal(301, status)
+      assert_equal({'Location' => "/mobile"}, headers)
+    end
+  end
+
+  context "An app with a custom redirect map" do
+    setup do
+      @app = test_app
+      redirects = { "myphone" => "/m/myphone", "yourphone" => "/m/yourphone" }
+      # Target fake devices
+      @rack = Rack::MobileDetect.new(@app,
+                                     :targeted => /myphone|yourphone/,
+                                     :redirect_map => redirects)
+    end
+
+    should "redirect to the custom url of the targeted devices" do
+      env = test_env({ 'HTTP_USER_AGENT' => 'myphone rocks' })
+      status, headers, body = @rack.call(env)
+      assert_equal 'myphone', env[x_mobile]
+
+      assert_equal(301, status)
+      assert_equal({'Location' => "/m/myphone"}, headers)
+
+
+      env = test_env({ 'HTTP_USER_AGENT' => 'yourphone sucks' })
+      status, headers, body = @rack.call(env)
+      assert_equal 'yourphone', env[x_mobile]
+
+      assert_equal(301, status)
+      assert_equal({'Location' => "/m/yourphone"}, headers)
+
+    end
+
+    should "not redirect a non-targeted device" do
+      env = test_env({ 'HTTP_USER_AGENT' => 'some wap phone' })
+      status, headers, body = @rack.call(env)
+      assert_equal 'true', env[x_mobile]
+
+      assert_not_equal(301, status)
+    end
+  end
+
+  context "An app with a custom redirect map and redirect_to option" do
+    setup do
+      @app = test_app
+      redirects = { "myphone" => "/m/myphone", "yourphone" => "/m/yourphone" }
+      # Target fake devices
+      @rack = Rack::MobileDetect.new(@app,
+                                     :targeted => /myphone|yourphone/,
+                                     :redirect_map => redirects,
+                                     :redirect_to => '/m/genericdevice')
+    end
+
+    should "use the redirect value in the redirect map when targeted" do
+      env = test_env({ 'HTTP_USER_AGENT' => 'myphone rocks' })
+      status, headers, body = @rack.call(env)
+      assert_equal 'myphone', env[x_mobile]
+
+      assert_equal(301, status)
+      assert_equal({'Location' => "/m/myphone"}, headers)
+
+    end
+
+    should "use redirect_to to redirect a device not in the map" do
+      env = test_env({ 'HTTP_USER_AGENT' => 'some wap phone' })
+      status, headers, body = @rack.call(env)
+      assert_equal 'true', env[x_mobile]
+
+      assert_equal(301, status)
+      assert_equal({'Location' => "/m/genericdevice"}, headers)
+    end
+  end
+
+
   # Expected x_header
   def x_mobile
     Rack::MobileDetect::X_HEADER

data/util/echo_env.rb

@@ -3,7 +3,7 @@ require 'sinatra'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require 'rack-mobile-detect'
+require 'rack/mobile-detect'
 
 use Rack::MobileDetect
 

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: rack-mobile-detect
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tom Alison
-- Michael Wood
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-30 00:00:00 -04:00
+date: 2010-03-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,10 +22,20 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: |-
   Rack::MobileDetect detects mobile devices and adds an
       X_MOBILE_DEVICE header to the request if a mobile device is detected. Specific
-      devices can be targeted with custom Regexps.
+      devices can be targeted with custom Regexps and redirect support is available.
 email: accounts@majortom.fastmail.us
 executables: []
 
@@ -35,15 +44,17 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.md
+- TODO
 files: 
 - .document
 - .gitignore
+- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile
 - TODO
 - VERSION.yml
-- lib/rack-mobile-detect.rb
+- lib/rack/mobile-detect.rb
 - rack-mobile-detect.gemspec
 - test/helper.rb
 - test/test_rack-mobile-detect.rb
@@ -77,5 +88,5 @@ signing_key:
 specification_version: 3
 summary: Rack middleware for ruby webapps to detect mobile devices.
 test_files: 
-- test/test_rack-mobile-detect.rb
 - test/helper.rb
+- test/test_rack-mobile-detect.rb