mobvious 0.1.2 → 0.1.3

data/README.md

@@ -1,7 +1,9 @@
 # Mobvious
 
 Mobvious detects whether your app / website is being accessed by a phone, or by a tablet,
-or by a personal computer.
+or by a personal computer. You can then use this information throughout your app. (E.g.
+fork your front-end code with regard to device type. There is a
+[plugin for Ruby on Rails](https://github.com/jistr/mobvious-rails) that helps you with this.)
 
 ## Key Features
 
@@ -19,15 +21,18 @@ or by a personal computer.
 
 ## Get Started
 
-1.  **Include Mobvious in your Gemfile**: `gem 'mobvious'`
+1.  **Include Mobvious in your Gemfile**:
+
+        gem 'mobvious'
 
 2.  **Tell your app to use Mobvious::Manager as Rack middleware.**  
-    If you use Rails, simply add `config.middleware.use Mobvious::Manager` into your
-    `config/application.rb` file.
+    If you use Rails, simply add this into your `config/application.rb`:
+
+        config.middleware.use Mobvious::Manager
 
 3.  **Tell Mobvious which strategies it should use.**  
-    A good place to put this code for Rails is an initializer – create a file
-    `config/initializers/mobvious.rb` and put this in:
+    A good place for this code in Rails is an initializer – create
+    `config/initializers/mobvious.rb` and use this config to begin with:
 
         Mobvious.configure do
           strategies = [ Mobvious::Strategies::MobileESP.new ]
@@ -37,7 +42,9 @@ or by a personal computer.
     The information is
     in a Rack environment variable `env['mobvious.device_type']`, this variable will
     have a value of `:desktop` or `:mobile` depending on the device type that issued
-    the request. In Rails, you can access it via `request.env['mobvious.device_type']`.
+    the request. In Rails, you can access it via `request.env['mobvious.device_type']`
+    or use [mobvious-rails](https://github.com/jistr/mobvious-rails)
+    and access it simply via `device_type`.
 
 *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

data/lib/mobvious/strategies/url.rb

@@ -11,8 +11,22 @@ module Mobvious
       #   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.
-      def initialize(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  
+      #   `disable_if_referer_matches: /regex/` disables the strategy if HTTP Referer matches
+      #   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
+
+        default_options = {
+          disable_if_referer_set: false,
+          disable_if_referer_matches: nil,
+          disable_unless_referer_matches: nil
+        }
+        @options = default_options.merge(options)
       end
 
       # Gets device type using URL pattern matching. Returns nil if no match found.
@@ -20,11 +34,31 @@ module Mobvious
       # @param request [Rack::Request]
       # @return [Symbol] device type or nil
       def get_device_type(request)
+        return nil if disabled_by_referer_set?(request) ||
+                      disabled_by_referer_matching?(request) ||
+                      disabled_by_referer_not_matching?(request)
+
         @rules.each do |regex, device_type|
           return device_type if request.url =~ regex
         end
         nil
       end
+
+      private
+
+      def disabled_by_referer_set?(request)
+        @options[:disable_if_referer_set] && request.env['HTTP_REFERER']
+      end
+
+      def disabled_by_referer_matching?(request)
+        @options[:disable_if_referer_matches] &&
+            request.env['HTTP_REFERER'] =~ @options[:disable_if_referer_matches]
+      end
+
+      def disabled_by_referer_not_matching?(request)
+        @options[:disable_unless_referer_matches] &&
+            request.env['HTTP_REFERER'] !~ @options[:disable_unless_referer_matches]
+      end
     end
   end
 end

data/lib/mobvious/version.rb

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

data/spec/mobvious/strategies/url_spec.rb

@@ -17,7 +17,6 @@ class URLSpec < MiniTest::Spec
     end
 
     it "returns the right device type when matching rule found" do
-      puts @request.url
       @strategy.get_device_type(@request).must_equal :mobile
     end
 
@@ -25,6 +24,64 @@ class URLSpec < MiniTest::Spec
       @env['HTTP_HOST'] = 'www.foo.com'
       @strategy.get_device_type(@request).must_equal nil
     end
+
+    describe "disabled if referer is set" do
+      before do
+        @strategy = URL.new(URL::MOBILE_PATH_RULES, disable_if_referer_set: true)
+        @env.merge!({
+          'HTTP_REFERER' => 'http://localhost'
+        })
+      end
+
+      it "returns nil even when matching rule found" do
+        @strategy.get_device_type(@request).must_equal nil
+      end
+    end
+
+    describe "disabled if referer is set" do
+      before do
+        @strategy = URL.new(URL::MOBILE_PATH_RULES, disable_if_referer_set: true)
+        @env.merge!({
+          'HTTP_REFERER' => 'http://localhost'
+        })
+      end
+
+      it "returns nil even when matching rule found" do
+        @strategy.get_device_type(@request).must_equal nil
+      end
+    end
+
+    describe "disabled if referer matches" do
+      before do
+        @env.merge!({
+          'HTTP_REFERER' => 'http://localhost'
+        })
+      end
+
+      it "returns nil even when matching rule found" do
+        @strategy = URL.new(URL::MOBILE_PATH_RULES, 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.get_device_type(@request).must_equal :mobile
+      end
+    end
+
+    describe "disabled unless referer matches" do
+      before do
+        @env.merge!({
+          'HTTP_REFERER' => 'http://localhost'
+        })
+      end
+
+      it "returns nil even when matching rule found" do
+        @strategy = URL.new(URL::MOBILE_PATH_RULES, 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.get_device_type(@request).must_equal :mobile
+      end
+    end
   end
 end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobvious
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-12 00:00:00.000000000 Z
+date: 2012-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &16340920 !ruby/object:Gem::Requirement
+  requirement: &21675260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *16340920
+  version_requirements: *21675260
 - !ruby/object:Gem::Dependency
   name: mobileesp_converted
-  requirement: &16340180 !ruby/object:Gem::Requirement
+  requirement: &21764500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *16340180
+  version_requirements: *21764500
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &16339620 !ruby/object:Gem::Requirement
+  requirement: &21763900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16339620
+  version_requirements: *21763900
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &16338520 !ruby/object:Gem::Requirement
+  requirement: &21763120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16338520
+  version_requirements: *21763120
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &16337520 !ruby/object:Gem::Requirement
+  requirement: &21762380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16337520
+  version_requirements: *21762380
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &16336960 !ruby/object:Gem::Requirement
+  requirement: &21761700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16336960
+  version_requirements: *21761700
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &16336240 !ruby/object:Gem::Requirement
+  requirement: &21761140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16336240
+  version_requirements: *21761140
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &16335020 !ruby/object:Gem::Requirement
+  requirement: &21760420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16335020
+  version_requirements: *21760420
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &16423360 !ruby/object:Gem::Requirement
+  requirement: &21759620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16423360
+  version_requirements: *21759620
 - !ruby/object:Gem::Dependency
   name: libnotify
-  requirement: &16422940 !ruby/object:Gem::Requirement
+  requirement: &21846540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16422940
+  version_requirements: *21846540
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &16422460 !ruby/object:Gem::Requirement
+  requirement: &21846100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16422460
+  version_requirements: *21846100
 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: -1726316769951614505
+      hash: -439395585953181489
 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: -1726316769951614505
+      hash: -439395585953181489
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11