schmobile 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,26 @@
 = schmobile
 
-A mobile user agent detection Rack middleware.
+A mobile user agent detection Rack middleware. It does this by providing +#is_mobile?+ to +Rack::Request+
+
+== Forcing mobile mode
+
+You can force toggle mobile mode by sending +is_mobile=true+ and +is_mobile=false+ as
+parameters in the request URL. This setting will be stored in the session for subsequent requests.
+This entirely overrides the user agent detection.
+
+== User agent detection
+
+You can add/remove user agents like so:
+
+  Rack::Schmobile::UserAgents.add_user_agent_pattern("wibble")
+  Rack::Schmobile::UserAgents.remove_user_agent_pattern("ipad")
+
+== Filters
+
+The outcome of the +request.is_mobile?+ call is the product of a series of filters getting evaluated
+against the request. You can manipulate the Rack::Schmobile::Filters::CHAIN array to alter if a
+request is deemed mobile or not. Add your own filter to bypass the check depending on e.g. location
+or request format.
 
 == Redirecting
 
@@ -16,23 +36,10 @@ Finally the middleware provides a request level method to determine if the clien
 
   Rack::Request#is_mobile?
 
-== Forcing mobile mode
-
-You can force toggle mobile mode by sending +is_mobile=true+ and +is_mobile=false+ as
-parameters in the request URL - note that these require session access. This entirely
-overrides the user agent detection.
-
 == Rolling out
 
   use Rack::Schmobile, :redirect_to => "/mobile", :if => Proc.new { |request| request.host =~ /staging/ }
 
-== User agent detection
-
-You can add/remove user agents like so:
-
-  Rack::Schmobile::UserAgents.add_user_agent_pattern("wibble")
-  Rack::Schmobile::UserAgents.remove_user_agent_pattern("ipad")
-
 == Thanks
 
 Not quite what we were looking for, but good inspiration and may work for you:

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/rack/schmobile/filters.rb

@@ -1,2 +1,16 @@
 require 'rack/schmobile/filters/is_mobile_param'
 require 'rack/schmobile/filters/mobile_user_agent'
+
+module Rack
+  module Schmobile
+    # Filters are tests that get run against a request to detrmine if it's a mobile request or not.
+    # A filter can return true, false or nil. The first non-nil value of the filter chain is the
+    # one that gets used.
+    #
+    # You can modify the chain to add new conditions that check on e.g. request format.
+    module Filters
+      CHAIN = [ Rack::Schmobile::Filters::IsMobileParam, Rack::Schmobile::Filters::MobileUserAgent ]
+    end
+  end
+end
+

data/lib/rack/schmobile/request_extension.rb

@@ -1,6 +1,6 @@
 Rack::Request.class_eval do
   def is_mobile?
-    Rack::Schmobile::FILTERS.each do |filter|
+    Rack::Schmobile::Filters::CHAIN.each do |filter|
       result = filter.call(self)
       return result unless result.nil?
     end

data/lib/rack/schmobile.rb

@@ -5,7 +5,6 @@ require 'rack/schmobile/filters'
 
 module Rack
   module Schmobile
-    FILTERS   = [ Rack::Schmobile::Filters::IsMobileParam, Rack::Schmobile::Filters::MobileUserAgent ]
     IS_MOBILE = "is_mobile"
   end
 end

data/schmobile.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{schmobile}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Morten Primdahl"]

data/test/test_rack_request.rb

@@ -21,17 +21,14 @@ class TestRackRequest < Test::Unit::TestCase
           end
         end
 
-        should "return true for a mobile browser" do
-          assert request("HTTP_USER_AGENT" => iphone).is_mobile?
-        end
-
         should "return false when forced in the session" do
           Rack::Request.any_instance.stubs(:session).returns({ Rack::Schmobile::IS_MOBILE => false })
           assert !request("HTTP_USER_AGENT" => iphone).is_mobile?
         end
 
         should "return true when forced in the session" do
-          assert request("rack.session" => { Rack::Schmobile::IS_MOBILE => "true" }).is_mobile?
+          Rack::Request.any_instance.stubs(:session).returns({ Rack::Schmobile::IS_MOBILE => true })
+          assert request.is_mobile?
         end
       end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: schmobile
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Morten Primdahl