mobvious 0.1.3 → 0.2.0

data/README.md

@@ -48,7 +48,8 @@ fork your front-end code with regard to device type. There is a
 
 *This is just a very basic way of setting up Mobvious. If you want to detect
 tablets separately, or let the user manually switch between interface versions of your
-app, or do some funnier stuff, see sections Detection Process and Detection Strategies.*
+app, or do some funnier stuff, see sections Detection Process, Example Configurations
+and Detection Strategies.*
 
 ## Detection Process
 
@@ -60,15 +61,54 @@ strategy is used. If no strategy is successful, the implicit device type is used
 in the `configure` block).
 
 
+## Example Configurations
+
+*   Detects only by User-Agent into mobile vs. tablet vs. desktop groups.
+
+        Mobvious.configure do
+          strategies = [ Mobvious::Strategies::MobileESP.new(:mobile_tablet_desktop) ]
+        end
+
+*   Detects by User-Agent into mobile vs. tablet vs. desktop groups, but allows users
+    to manually switch interface versions (Cookie strategy is used for this and it is
+    the first one, so it has top precedence).
+
+        Mobvious.configure do
+          strategies = [
+            Mobvious::Strategies::Cookie.new([:mobile, :tablet, :desktop])
+            Mobvious::Strategies::MobileESP.new(:mobile_tablet_desktop)
+          ]
+        end
+
+*   Detects by URL into mobile vs. desktop groups (if URL has `m.` subdomain,
+    use mobile interface), but only for users coming directly, not via a link
+    clicked. For users coming via a link (if HTTP Referer header is set)
+    this config will use User-Agent detection.
+
+    When using this config, you will have to perform redirects in your app if
+    the URL which user requested doesn't match their device type.
+    (E.g. if the user comes to 'm.foo.com' via a link, but Mobvious tells you
+    that their device is a desktop computer, make sure to redirect the user
+    immediately to 'www.foo.com'.)
+
+        Mobvious.configure do
+          strategies = [
+            Mobvious::Strategies::URL.new(:mobile_path, disable_if_referer_set: true)
+            Mobvious::Strategies::MobileESP.new
+          ]
+        end
+
+
 ## Detection Strategies
 
 ### MobileESP (User-Agent sniffing)
 
-`Mobvious::Strategies::MobileESP`
+`Mobvious::Strategies::MobileESP` | [view docs](http://rdoc.info/github/jistr/mobvious/master/Mobvious/Strategies/MobileESP)
 
 Selects the device type using information present in the User-Agent HTTP header.
 
-Constructor takes a detection procedure.
+[Constructor](http://rdoc.info/github/jistr/mobvious/master/Mobvious/Strategies/MobileESP#initialize-instance_method)
+takes a detection procedure.
 Detection procedure decides what device type it should return based on the
 information it can dig out of MobileESPConverted::UserAgentInfo instance.
 
@@ -84,12 +124,18 @@ There are two predefined detection procedures (and you can write your own):
 
 ### URL (URL pattern matching)
 
-`Mobvious::Strategies::URL`
+`Mobvious::Strategies::URL` | [view docs](http://rdoc.info/github/jistr/mobvious/master/Mobvious/Strategies/URL)
 
 Selects the device type by matching a pattern against the request's URL (whole URL,
 including protocol information).
 
-Constructor takes a hash of rules in format `/regular_expression/ => :device_type`.
+[Constructor](http://rdoc.info/github/jistr/mobvious/master/Mobvious/Strategies/URL#initialize-instance_method)
+takes a hash of rules in format `{ /regular_expression/ => :device_type }` and options. Using the options you
+can disable this strategy for requests that have the Referer HTTP header set or matching / not matching some
+regular expression
+([see docs](http://rdoc.info/github/jistr/mobvious/master/Mobvious/Strategies/URL#initialize-instance_method)).
+This is useful if you want to exclude URL detection for users coming via links from other sites and let the
+User-Agent detection take precedence.
 
 There is one predefined rule set:
 
@@ -99,7 +145,7 @@ There is one predefined rule set:
 
 ### Cookie (remembering user's manual choice)
 
-`Mobvious::Strategies::Cookie`
+`Mobvious::Strategies::Cookie` | [view docs](http://rdoc.info/github/jistr/mobvious/master/Mobvious/Strategies/Cookie)
 
 This strategy is useful when user should be able to make a manual switch between
 interface versions and you want all the interface versions running on the exact same URL.
@@ -114,7 +160,8 @@ In Rails it is accessible simply by writing `response`, as shown in the code exa
 Make sure to put the Cookie strategy high enough in your strategies array
 (the first entry?) so it does not get overriden by some other strategy.
 
-Constructor takes array of allowed device types ("whitelist") that your
+[Constructor](http://rdoc.info/github/jistr/mobvious/master/Mobvious/Strategies/Cookie#initialize-instance_method)
+takes an array of allowed device types ("whitelist") that your
 application supports. This is a countermeasure to users tampering with cookies. When
 the device type read from cookie is not whitelisted, the strategy passes the detection
 process to other strategies.

data/lib/mobvious/strategies/mobileesp.rb

@@ -23,10 +23,17 @@ module Mobvious
       # Creates a new instance of MobileESP strategy.
       #
       # @param detection_procedure
-      #   A lambda function that gets one parameter (`MobileESPConverted::UserAgentInfo` instance)
-      #   and returns device type symbol or nil.
-      def initialize(detection_procedure = DEVICE_TYPES_MOBILE_DESKTOP)
-        @detection_procedure = detection_procedure
+      #   a lambda function that gets one parameter (`MobileESPConverted::UserAgentInfo` instance)
+      #   and returns device type symbol or nil.  
+      #   **or**  
+      #   a symbol for one of predefined detection procedures (`:mobile_desktop`,
+      #   `:mobile_tablet_desktop`)
+      def initialize(detection_procedure = :mobile_desktop)
+        if detection_procedure.is_a? Symbol
+          @detection_procedure = eval("DEVICE_TYPES_#{detection_procedure.to_s.upcase}")
+        else
+          @detection_procedure = detection_procedure
+        end
       end
 
       # Gets device type using user-agent sniffing. Can return nil if the used

data/lib/mobvious/strategies/url.rb

@@ -3,14 +3,16 @@ module Mobvious
     # Mobvious device detection strategy that uses URL pattern matching.
     class URL
       # Rule set with only one rule for domains that begin with `m.` matching as `:mobile`.
-      MOBILE_PATH_RULES = { /^\w+:\/\/m\./ => :mobile }
+      RULES_MOBILE_PATH = { /^\w+:\/\/m\./ => :mobile }
 
       # Creates a new URL strategy instance.
       #
       # @param rules
       #   A hash containing regular expressions mapped to symbols. The regular expression
       #   is evaluated against the whole URL of the request (including `http://`). If matching,
-      #   the corresponding symbol is returned as the device type.
+      #   the corresponding symbol is returned as the device type.  
+      #   **or**  
+      #   a symbol for one of predefined detection rules (`:mobile_path_rules`)
       # @param options
       #   A hash with strategy options.  
       #   `disable_if_referer_set: true` disables the strategy if HTTP Referer header is set  
@@ -18,8 +20,12 @@ module Mobvious
       #   given regular expression  
       #   `disable_unless_referer_matches: /regex/` disables the strategy if HTTP Referer
       #   doesn't match given regular expression  
-      def initialize(rules = MOBILE_PATH_RULES, options = {})
-        @rules = rules
+      def initialize(rules = :mobile_path, options = {})
+        if rules.is_a? Symbol
+          @rules = eval("RULES_#{rules.to_s.upcase}")
+        else
+          @rules = rules
+        end
 
         default_options = {
           disable_if_referer_set: false,

data/lib/mobvious/version.rb

@@ -1,3 +1,3 @@
 module Mobvious
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/mobvious/strategies/mobileesp_spec.rb

@@ -3,14 +3,17 @@ require_relative '../../spec_helper'
 module Mobvious::Strategies
   class MobileESPSpec < MiniTest::Spec
   describe MobileESP do
-    describe "using mobile_desktop strategy" do
+    before do
+      @request = mock 'request'
+      @env = mock 'env'
+
+      @request.stubs(:env).returns(@env)
+      @env.stubs('[]').with('HTTP_ACCEPT').returns('text/html')
+    end
+
+    describe "using default (mobile_desktop) strategy" do
       before do
         @strategy = Mobvious::Strategies::MobileESP.new
-        @request = mock 'request'
-        @env = mock 'env'
-
-        @request.stubs(:env).returns(@env)
-        @env.stubs('[]').with('HTTP_ACCEPT').returns('text/html')
       end
 
       it "categorizes iPhone as :mobile" do
@@ -31,13 +34,7 @@ module Mobvious::Strategies
 
     describe "using mobile_tablet_desktop strategy" do
       before do
-        @strategy = Mobvious::Strategies::MobileESP.new(
-          Mobvious::Strategies::MobileESP::DEVICE_TYPES_MOBILE_TABLET_DESKTOP)
-        @request = mock 'request'
-        @env = mock 'env'
-
-        @request.stubs(:env).returns(@env)
-        @env.stubs('[]').with('HTTP_ACCEPT').returns('text/html')
+        @strategy = Mobvious::Strategies::MobileESP.new(:mobile_tablet_desktop)
       end
 
       it "categorizes iPhone as :mobile" do
@@ -55,6 +52,20 @@ module Mobvious::Strategies
         @strategy.get_device_type(@request).must_equal :desktop
       end
     end
+
+    describe "custom strategy" do
+      before do
+        procedure = lambda {|mobileesp|
+          return :test
+        }
+        @strategy = Mobvious::Strategies::MobileESP.new(procedure)
+      end
+
+      it "categorizes anything as :test" do
+        @request.stubs(:user_agent).returns("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.46 Safari/535.11")
+        @strategy.get_device_type(@request).must_equal :test
+      end
+    end
   end
   end
 end

data/spec/mobvious/strategies/url_spec.rb

@@ -27,7 +27,7 @@ class URLSpec < MiniTest::Spec
 
     describe "disabled if referer is set" do
       before do
-        @strategy = URL.new(URL::MOBILE_PATH_RULES, disable_if_referer_set: true)
+        @strategy = URL.new(:mobile_path, disable_if_referer_set: true)
         @env.merge!({
           'HTTP_REFERER' => 'http://localhost'
         })
@@ -40,7 +40,7 @@ class URLSpec < MiniTest::Spec
 
     describe "disabled if referer is set" do
       before do
-        @strategy = URL.new(URL::MOBILE_PATH_RULES, disable_if_referer_set: true)
+        @strategy = URL.new(:mobile_path, disable_if_referer_set: true)
         @env.merge!({
           'HTTP_REFERER' => 'http://localhost'
         })
@@ -59,10 +59,10 @@ class URLSpec < MiniTest::Spec
       end
 
       it "returns nil even when matching rule found" do
-        @strategy = URL.new(URL::MOBILE_PATH_RULES, disable_if_referer_matches: /local/)
+        @strategy = URL.new(:mobile_path, disable_if_referer_matches: /local/)
         @strategy.get_device_type(@request).must_equal nil
 
-        @strategy = URL.new(URL::MOBILE_PATH_RULES, disable_if_referer_matches: /nothing/)
+        @strategy = URL.new(:mobile_path, disable_if_referer_matches: /nothing/)
         @strategy.get_device_type(@request).must_equal :mobile
       end
     end
@@ -75,13 +75,23 @@ class URLSpec < MiniTest::Spec
       end
 
       it "returns nil even when matching rule found" do
-        @strategy = URL.new(URL::MOBILE_PATH_RULES, disable_unless_referer_matches: /nothing/)
+        @strategy = URL.new(:mobile_path, disable_unless_referer_matches: /nothing/)
         @strategy.get_device_type(@request).must_equal nil
 
-        @strategy = URL.new(URL::MOBILE_PATH_RULES, disable_unless_referer_matches: /local/)
+        @strategy = URL.new(:mobile_path, disable_unless_referer_matches: /local/)
         @strategy.get_device_type(@request).must_equal :mobile
       end
     end
+
+    describe "using custom rules" do
+      before do
+        @strategy = URL.new(/\.foo\./ => :test)
+      end
+
+      it "returns :test for any url" do
+        @strategy.get_device_type(@request).must_equal :test
+      end
+    end
   end
 end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobvious
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-17 00:00:00.000000000 Z
+date: 2012-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &21675260 !ruby/object:Gem::Requirement
+  requirement: &11301980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *21675260
+  version_requirements: *11301980
 - !ruby/object:Gem::Dependency
   name: mobileesp_converted
-  requirement: &21764500 !ruby/object:Gem::Requirement
+  requirement: &11391240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *21764500
+  version_requirements: *11391240
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &21763900 !ruby/object:Gem::Requirement
+  requirement: &11390700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21763900
+  version_requirements: *11390700
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &21763120 !ruby/object:Gem::Requirement
+  requirement: &11389880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21763120
+  version_requirements: *11389880
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &21762380 !ruby/object:Gem::Requirement
+  requirement: &11389100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21762380
+  version_requirements: *11389100
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &21761700 !ruby/object:Gem::Requirement
+  requirement: &11388480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21761700
+  version_requirements: *11388480
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &21761140 !ruby/object:Gem::Requirement
+  requirement: &11387880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21761140
+  version_requirements: *11387880
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &21760420 !ruby/object:Gem::Requirement
+  requirement: &11387220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21760420
+  version_requirements: *11387220
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &21759620 !ruby/object:Gem::Requirement
+  requirement: &11386380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21759620
+  version_requirements: *11386380
 - !ruby/object:Gem::Dependency
   name: libnotify
-  requirement: &21846540 !ruby/object:Gem::Requirement
+  requirement: &11473360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21846540
+  version_requirements: *11473360
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &21846100 !ruby/object:Gem::Requirement
+  requirement: &11472940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21846100
+  version_requirements: *11472940
 description: Rack middleware for choosing a version of an interface to render for
   given request
 email:
@@ -175,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -439395585953181489
+      hash: 416472323923315110
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -439395585953181489
+      hash: 416472323923315110
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11