schmobile 1.0.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 802ea6e9f8a8f7704a536ad2c160f00b8bfd878a
+  data.tar.gz: 7df41ab6221edceac3207e95db03344ad9535d88
+SHA512:
+  metadata.gz: 06d2ae455e5cd12a9a7c25a8a7ffd258c60c4aa8558839f2c57c0ca27d8e7c6c4b1b0e8bc56cfbbdae3e86ed3ffc308aefbe63a24d4866a5191dfa376211d7d9
+  data.tar.gz: 679ef4bb196954cbe593a5fe5c5cafc457c45422da3af56831007bdac54e62c920b82c6a86178892e1dd0b21dcdc6032e2bd94621c2e351efd4f82c40f106b2f

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
+gemfiles/*.gemfile.lock
 pkg/
 # rcov generated

data/.travis.yml

@@ -1,7 +1,26 @@
-before_install:
-  - gem update --system
+sudo: false
+
+cache: bundler
+
+branch:
+  only: master
+
 rvm:
-  - 1.8.7
-  - 1.9.3
-  - jruby
-  - ree
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - rbx-3.14
+  - jruby-9.0.5.0
+
+gemfile:
+  - gemfiles/rack1.0.gemfile
+  - gemfiles/rack2.0.gemfile
+
+matrix:
+  fast_finish: true
+  exclude:
+    - rvm: 2.1.8
+      gemfile: gemfiles/rack2.0.gemfile
+  allow_failures:
+    - rvm: jruby-9.0.5.0
+      gemfile: gemfiles/rack2.0.gemfile

data/Gemfile

@@ -1,3 +1 @@
-source "http://rubygems.org"
-
-gemspec
+eval_gemfile('gemfiles/rack1.0.gemfile')

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -1,4 +1,4 @@
-# Schmobile [![Build Status](https://secure.travis-ci.org/morten/schmobile.png)](http://travis-ci.org/morten/schmobile)
+# Schmobile [![Build Status](https://secure.travis-ci.org/zendesk/schmobile.png)](http://travis-ci.org/zendesk/schmobile)
 
 A mobile user agent detection Rack middleware. It provides `Rack::Request#is_mobile?`
 
@@ -50,6 +50,13 @@ Rack::Request#is_mobile?
 use Schmobile, :redirect_to => "/mobile", :if => Proc.new { |request| request.host =~ /staging/ }
 ```
 
-## License
+## Copyright and license
 
-Released under the Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0.html
+Copyright 2013 Zendesk
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/Rakefile

@@ -1,12 +1,9 @@
+require 'bundler/setup'
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'wwtd/tasks'
+require 'bump/tasks'
 
-Rake::TestTask.new do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task :default do
-  sh "bundle exec rake test"
-end
+task default: :spec

data/gemfiles/rack1.0.gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gemspec path: Bundler.root.sub('/gemfiles', '')
+
+gem 'rack', '~> 1.6'

data/gemfiles/rack2.0.gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: Bundler.root.sub('/gemfiles', '')
+
+gem 'rack', '~> 2.0.0.alpha'
+gem 'actionpack', '~> 5.0.0.beta2'
+gem 'activesupport', '~> 5.0.0.beta2'

data/lib/schmobile.rb

@@ -1,10 +1,16 @@
 require 'rack'
 
+begin
+  require 'action_dispatch'
+rescue LoadError
+  # It's fine, actionpack isn't present
+end
+
+require 'schmobile/version'
 require 'schmobile/middleware'
 require 'schmobile/request_extension'
 require 'schmobile/filters'
 
 module Schmobile
-  VERSION   = "0.5.0"
-  IS_MOBILE = "is_mobile"
+  IS_MOBILE = 'is_mobile'
 end

data/lib/schmobile/filters/is_mobile_param.rb

@@ -3,7 +3,7 @@ module Schmobile
     module IsMobileParam
       def self.call(request)
         if request.params.key?(Schmobile::IS_MOBILE)
-           request.session[Schmobile::IS_MOBILE] = (request.params[Schmobile::IS_MOBILE] == "true")
+           request.session[Schmobile::IS_MOBILE] = (request.params[Schmobile::IS_MOBILE] == 'true')
         end
 
         nil

data/lib/schmobile/middleware.rb

@@ -10,7 +10,7 @@ module Schmobile
       request = Rack::Request.new(env)
 
       if request.is_mobile? && redirect?(request)
-        [ 301, { "Location" => redirect_location(request) }, [] ]
+        [ 301, { 'Location' => redirect_location(request) }, [] ]
       else
         @app.call(env)
       end
@@ -31,7 +31,7 @@ module Schmobile
         redirecting = false
       end
 
-      redirecting ? redirect_location(request) : nil
+      redirecting
     end
 
     def redirect_location(request)

data/lib/schmobile/request_extension.rb

@@ -14,11 +14,10 @@ module Schmobile
     end
 
     def is_device?(identifier)
-      user_agent =~ /#{identifier}/i
+      !!(user_agent =~ /#{identifier}/i)
     end
   end
 end
 
-Rack::Request.class_eval do
-  include Schmobile::Request
-end
+Rack::Request.include Schmobile::Request
+ActionDispatch::Request.include Schmobile::Request if defined?(ActionDispatch::Request)

data/lib/schmobile/user_agents.rb

@@ -40,11 +40,11 @@ module Schmobile
     end
 
     def self.mobile_agent_matcher
-      @mobile_agent_matcher ||= Regexp.new(MOBILE_USER_AGENTS.uniq.compact.map { |v| Regexp.escape(v) }.join("|"))
+      @mobile_agent_matcher ||= Regexp.new(MOBILE_USER_AGENTS.uniq.compact.map { |v| Regexp.escape(v) }.join('|'))
     end
 
     def self.non_mobile_agent_matcher
-      @non_mobile_agent_matcher ||= Regexp.new(NON_MOBILE_USER_AGENTS.uniq.compact.map { |v| Regexp.escape(v) }.join("|"))
+      @non_mobile_agent_matcher ||= Regexp.new(NON_MOBILE_USER_AGENTS.uniq.compact.map { |v| Regexp.escape(v) }.join('|'))
     end
 
     def self.matched_by?(user_agent)

data/lib/schmobile/version.rb

@@ -0,0 +1,3 @@
+module Schmobile
+  VERSION = '2.0.0'
+end

data/schmobile.gemspec

@@ -1,24 +1,28 @@
-Gem::Specification.new "Schmobile", "1.0.0" do |s|
+require './lib/schmobile/version'
+
+Gem::Specification.new do |s|
   s.name        = 'schmobile'
+  s.version     = Schmobile::VERSION
   s.date        = '2012-06-14'
   s.files       = `git ls-files`.split("\n")
-  s.license     = "Apache License Version 2.0"
+  s.license     = 'Apache License Version 2.0'
 
-  s.summary     = "A mobile user agent detection Rack middleware."
-  s.description = "A mobile user agent detection Rack middleware. See the README."
+  s.summary     = 'A mobile user agent detection Rack middleware.'
+  s.description = 'A mobile user agent detection Rack middleware. See the README.'
 
-  s.authors  = ["Morten Primdahl"]
-  s.email    = 'primdahl@me.com'
+  s.authors  = ['Morten Primdahl', 'Pierre Schambacher']
+  s.email    = %w[primdahl@me.com pschambacher@zendesk.com]
   s.homepage = 'http://github.com/zendesk/schmobile'
 
   s.require_paths = %w[lib]
 
-  s.add_runtime_dependency("rack")
+  s.add_runtime_dependency('rack')
 
   s.add_development_dependency('rake')
   s.add_development_dependency('bundler')
-  s.add_development_dependency('shoulda')
-  s.add_development_dependency('mocha')
+  s.add_development_dependency('wwtd')
+  s.add_development_dependency('bump')
+  s.add_development_dependency('rspec')
 
   s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
 end

data/spec/action_dispatch_request_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+if defined?(ActionDispatch::Request)
+  describe ActionDispatch::Request do
+    it 'respond to the schmobile helpers' do
+      expect(action_dispatch_request('HTTP_USER_AGENT' => ipad)      .is_device?('ipad'))      .to be true
+      expect(action_dispatch_request('HTTP_USER_AGENT' => ipad)      .is_device?('blackberry')).to be false
+      expect(action_dispatch_request('HTTP_USER_AGENT' => blackberry).is_device?('blackberry')).to be true
+      expect(action_dispatch_request('HTTP_USER_AGENT' => iphone)    .is_device?('blackberry')).to be false
+      expect(action_dispatch_request('HTTP_USER_AGENT' => iphone)    .is_device?('iphone'))    .to be true
+      expect(action_dispatch_request('HTTP_USER_AGENT' => msie6)     .is_device?('iphone'))    .to be false
+    end
+  end
+end

data/spec/filters_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Schmobile::Filters do
+  let(:session) { {} }
+  let(:params)  { {} }
+  let(:request) { double('Request', user_agent: msie8, params: params, session: session) }
+
+  describe '#apply' do
+    describe 'on a pristine request' do
+      it 'returns true if the session is already mobile' do
+        expect(Schmobile::UserAgents).to_not receive(:is_mobile_agent?)
+        session[Schmobile::IS_MOBILE] = true
+        expect(Schmobile::Filters.apply(request)).to be true
+      end
+
+      it "returns true if there's an is_mobile parameter with value true" do
+        expect(Schmobile::UserAgents).to_not receive(:is_mobile_agent?)
+        params.merge!('is_mobile' => 'true')
+        expect(Schmobile::Filters.apply(request)).to be true
+      end
+
+      it "returns false if there's an is_mobile parameter with value false" do
+        expect(Schmobile::UserAgents).to_not receive(:is_mobile_agent?)
+        params.merge!('is_mobile' => 'false')
+        expect(Schmobile::Filters.apply(request)).to be false
+      end
+
+      it "defers to user agent check if there's no session or parameter" do
+        expect(Schmobile::UserAgents).to receive(:is_mobile_agent?).once
+        expect(Schmobile::Filters.apply(request)).to be false
+      end
+    end
+
+    describe 'on a request with mobile session set to false' do
+      it 'allows to change the session value with a parameter' do
+        expect(Schmobile::UserAgents).to_not receive(:is_mobile_agent?)
+        session[Schmobile::IS_MOBILE] = false
+        expect(Schmobile::Filters.apply(request)).to be false
+        params.merge!('is_mobile' => 'true')
+        expect(Schmobile::Filters.apply(request)).to be true
+        expect(request.session[Schmobile::IS_MOBILE]).to be true
+      end
+    end
+
+    describe 'on a request with mobile session set to true' do
+      it 'allows to change the session value with a parameter' do
+        expect(Schmobile::UserAgents).to_not receive(:is_mobile_agent?)
+        session[Schmobile::IS_MOBILE] = true
+        expect(Schmobile::Filters.apply(request)).to be true
+        params.merge!('is_mobile' => 'false')
+        expect(Schmobile::Filters.apply(request)).to be false
+        expect(request.session[Schmobile::IS_MOBILE]).to be false
+      end
+    end
+  end
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Schmobile::Middleware do
+  before do
+    @app  = Class.new { def call(app); true; end }.new
+    @rack = Schmobile::Middleware.new(@app)
+  end
+
+  it 'returns an HTTP permanent redirect when given a redirect path and used by a mobile client' do
+    @rack = Schmobile::Middleware.new(@app, redirect_to: '/hello')
+    expect_any_instance_of(Rack::Request).to receive(:is_mobile?).and_return(true)
+
+    expect(@rack.call(environment)).to eq(
+      [
+        301,
+        { 'Location'=>'/hello' },
+        []
+      ]
+    )
+  end
+
+  describe 'with no redirect_to' do
+    it 'does not redirect mobile traffic' do
+      expect_any_instance_of(Rack::Request).to receive(:params).and_return({})
+      expect(@app).to receive(:call)
+      @rack.call(environment('HTTP_USER_AGENT' => iphone))
+    end
+
+    it 'queries the request object to determine if this is a mobile request' do
+      expect_any_instance_of(Rack::Request).to receive(:is_mobile?).and_return(true)
+      @rack.call(environment('HTTP_USER_AGENT' => iphone))
+    end
+  end
+
+  describe 'with redirect_to' do
+    before do
+      @rack = Schmobile::Middleware.new(@app, redirect_to: '/wonderland')
+    end
+
+    describe '#redirect?' do
+      it 'returns true when not on mobile path' do
+        expect(@rack.redirect?(request('PATH_INFO' => '/somewhere'))).to be true
+      end
+
+      it 'returns true on base path' do
+        expect(@rack.redirect?(request('PATH_INFO' => '/'))).to be true
+      end
+
+      it 'returns false when already on path' do
+        expect(@rack.redirect?(request('PATH_INFO' => '/wonderland'))).to be false
+        expect(@rack.redirect?(request('PATH_INFO' => '/wonderland/more/stuff'))).to be false
+      end
+
+      it 'returns false when :if resolves to false' do
+        @rack = Schmobile::Middleware.new(@app, redirect_to: '/wonderland', redirect_if: Proc.new { |request| false })
+        expect(@rack.redirect?(request('PATH_INFO' => '/somewhere'))).to be false
+      end
+    end
+
+    describe '#redirect' do
+      it 'interpolates the argument string xxxx' do
+        @rack = Schmobile::Middleware.new(@app, redirect_to: '/wonderland', redirect_with: '/{{path}}')
+        expect(@rack.redirect_location(request('PATH_INFO' => 'wiffle'))).to eq('/wonderland/wiffle')
+      end
+
+      it 'interpolates a multipart argument string' do
+        @rack = Schmobile::Middleware.new(@app, redirect_to: '/wonderland/', redirect_with: '{{path}}/lemurs/{{path}}')
+        expect(@rack.redirect_location(request('PATH_INFO' => 'wiffle'))).to eq('/wonderland/wiffle/lemurs/wiffle')
+      end
+    end
+  end
+end

data/spec/rack_request_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Schmobile::Request do
+  describe '#is_device?' do
+    it 'matchs devices as part of the user agent case insensitively' do
+      expect(request('HTTP_USER_AGENT' => ipad)      .is_device?('ipad'))      .to be true
+      expect(request('HTTP_USER_AGENT' => ipad)      .is_device?('blackberry')).to be false
+      expect(request('HTTP_USER_AGENT' => blackberry).is_device?('blackberry')).to be true
+      expect(request('HTTP_USER_AGENT' => iphone)    .is_device?('blackberry')).to be false
+      expect(request('HTTP_USER_AGENT' => iphone)    .is_device?('iphone'))    .to be true
+      expect(request('HTTP_USER_AGENT' => msie6)     .is_device?('iphone'))    .to be false
+    end
+  end
+
+  describe '#is_mobile?' do
+    it 'only calls the filter chain once' do
+      expect(Schmobile::Filters).to receive(:apply).once.and_return(false)
+      one_request = request
+      3.times { one_request.is_mobile? }
+    end
+
+    it 're-calls the filter chain once reset' do
+      expect(Schmobile::Filters).to receive(:apply).twice.and_return(false)
+      one_request = request
+      3.times { one_request.is_mobile? }
+      one_request.toggle_mobile_session!
+      3.times { one_request.is_mobile? }
+    end
+
+    describe 'without params' do
+      before do
+        allow_any_instance_of(Rack::Request).to receive(:params).and_return({})
+      end
+
+      it 'does not detect a regular browser as mobile' do
+        expect(request.is_mobile?).to be false
+        expect(request('HTTP_USER_AGENT' => nil).is_mobile?).to be false
+
+        [ :msie6, :msie8, :opera, :chrome ].each do |browser|
+          agent = self.send(browser)
+          expect(request('HTTP_USER_AGENT' => agent).is_mobile?).to be false
+        end
+      end
+
+      it 'detects mobile units as mobile' do
+        [ :ipod, :iphone, :android, :blackberry, :samsung, :palm, :htc_touch, :danger ].each do |phone|
+          agent = self.send(phone)
+          expect(request('HTTP_USER_AGENT' => agent).is_mobile?).to be true
+        end
+      end
+
+      it 'not detects an ipad as a mobile browser' do
+        expect(request('HTTP_USER_AGENT' => ipad).is_mobile?).to be false
+      end
+
+      it 'returns false when forced in the session' do
+        allow_any_instance_of(Rack::Request).to receive(:session).and_return({ Schmobile::IS_MOBILE => false })
+        expect(request('HTTP_USER_AGENT' => iphone).is_mobile?).to be false
+      end
+
+      it 'returns true when forced in the session' do
+        allow_any_instance_of(Rack::Request).to receive(:session).and_return({ Schmobile::IS_MOBILE => true })
+        expect(request.is_mobile?).to be true
+      end
+    end
+
+    describe 'with params' do
+      it 'returns false when forced via a request parameter' do
+        allow_any_instance_of(Rack::Request).to receive(:params).and_return({ Schmobile::IS_MOBILE => 'false' })
+        expect(request('HTTP_USER_AGENT' => iphone).is_mobile?).to be false
+      end
+
+      it 'returns true when forced via a request parameter' do
+        allow_any_instance_of(Rack::Request).to receive(:params).and_return({ Schmobile::IS_MOBILE => 'true' })
+        expect(request.is_mobile?).to be true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'schmobile'
+require 'support/request_helper'
+
+RSpec.configure do |c|
+  c.include RequestHelper
+end

data/{test/helper.rb → spec/support/request_helper.rb}

@@ -1,14 +1,4 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-require 'mocha'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require 'schmobile'
-
-class Test::Unit::TestCase
+module RequestHelper
 
   def ipod
     'Mozilla/5.0 (iPod; U; CPU iPhone OS 2_2 like Mac OS X; en-us) AppleWebKit/525.18.1 (KHTML, like Gecko) Version/3.1.1 Mobile/5G77 Safari/525.20'
@@ -27,11 +17,11 @@ class Test::Unit::TestCase
   end
 
   def ipad
-    "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"
+    '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
 
   def palm
-    "Mozilla/5.0 (webOS/1.0; U; en-US) AppleWebKit/525.27.1 (KHTML, like Gecko) Version/1.0 Safari/525.27.1 Pre/1.0"
+    'Mozilla/5.0 (webOS/1.0; U; en-US) AppleWebKit/525.27.1 (KHTML, like Gecko) Version/1.0 Safari/525.27.1 Pre/1.0'
   end
 
   def samsung
@@ -39,33 +29,37 @@ class Test::Unit::TestCase
   end
 
   def htc_touch
-    "HTC_Touch_Diamond2_T5353 Opera/9.50 (Windows NT 5.1; U; en)"
+    'HTC_Touch_Diamond2_T5353 Opera/9.50 (Windows NT 5.1; U; en)'
   end
 
   def danger
-    "Mozilla/5.0 (Danger hiptop 5.0; U; rv:1.7.12) Gecko/20050920"
+    'Mozilla/5.0 (Danger hiptop 5.0; U; rv:1.7.12) Gecko/20050920'
   end
 
   def msie6
-    "Mozilla/4.0 (compatible; MSIE 6.0; Update a; AOL 6.0; Windows 98)"
+    'Mozilla/4.0 (compatible; MSIE 6.0; Update a; AOL 6.0; Windows 98)'
   end
 
   def msie8
-    "Client: Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; WOW64; Trident/4.0; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; MDDR; .NET CLR 3.5.30729; InfoPath.2; .NET CLR 3.0.30729; OfficeLiveConnector.1.3; OfficeLivePatch.0.0; .NET CLR 4.0.20506; Creative AutoUpdate v1.40.01)"
+    'Client: Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; WOW64; Trident/4.0; SLCC1; .NET CLR 2.0.50727; Media Center PC 5.0; MDDR; .NET CLR 3.5.30729; InfoPath.2; .NET CLR 3.0.30729; OfficeLiveConnector.1.3; OfficeLivePatch.0.0; .NET CLR 4.0.20506; Creative AutoUpdate v1.40.01)'
   end
 
   def chrome
-    "Mozilla/5.0 (Windows NT 5.1) AppleWebKit/534.24 (KHTML, like Gecko) Chrome/11.0.696.71 Safari/534.24"
+    'Mozilla/5.0 (Windows NT 5.1) AppleWebKit/534.24 (KHTML, like Gecko) Chrome/11.0.696.71 Safari/534.24'
   end
 
   def opera
-    "Opera/9.25 (Windows NT 6.0; U; en)"
+    'Opera/9.25 (Windows NT 6.0; U; en)'
   end
 
   def request(overwrite = {})
     Rack::Request.new(environment(overwrite))
   end
 
+  def action_dispatch_request(overwrite = {})
+    ActionDispatch::Request.new(environment(overwrite))
+  end
+
   def environment(overwrite = {})
      {
        'GATEWAY_INTERFACE'=> 'CGI/1.2',

data/spec/user_agents_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Schmobile::UserAgents do
+  describe '#remove_user_agent_pattern' do
+    it 'allows removal of a user agent' do
+      expect(Schmobile::UserAgents.is_mobile_agent?('novarra')).to be true
+
+      Schmobile::UserAgents.remove_user_agent_pattern('novarra')
+
+      expect(Schmobile::UserAgents.is_mobile_agent?('novarra')).to be false
+    end
+  end
+
+  describe '#add_user_agent_pattern' do
+    it 'allows adding a user agent' do
+      expect(Schmobile::UserAgents.is_mobile_agent?('wibble')).to be false
+
+      Schmobile::UserAgents.add_user_agent_pattern('wibble')
+
+      expect(Schmobile::UserAgents.is_mobile_agent?('wibble')).to be true
+    end
+
+    it 'allows changing behavior for a non-mobile agent' do
+      expect(Schmobile::UserAgents.is_mobile_agent?('ipad')).to be false
+
+      Schmobile::UserAgents.add_user_agent_pattern('ipad')
+
+      expect(Schmobile::UserAgents.is_mobile_agent?('ipad')).to be false
+
+      Schmobile::UserAgents.remove_non_mobile_user_agent_pattern('ipad')
+
+      expect(Schmobile::UserAgents.is_mobile_agent?('ipad')).to be true
+
+      Schmobile::UserAgents.add_non_mobile_user_agent_pattern('ipad')
+    end
+  end
+
+  describe '#is_mobile_agent?' do
+    it 'returns false for common browsers' do
+      [ :msie6, :msie8, :opera, :chrome ].each do |browser|
+        agent = self.send(browser)
+        expect(Schmobile::UserAgents.is_mobile_agent?(agent)). to be(false), "#{browser} should not detect as mobile, #{agent}"
+      end
+    end
+  end
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: schmobile
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Morten Primdahl
+- Pierre Schambacher
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -14,95 +14,104 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: wwtd
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: bump
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A mobile user agent detection Rack middleware. See the README.
-email: primdahl@me.com
+email:
+- primdahl@me.com
+- pschambacher@zendesk.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .travis.yml
+- ".document"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
+- gemfiles/rack1.0.gemfile
+- gemfiles/rack2.0.gemfile
 - lib/schmobile.rb
 - lib/schmobile/filters.rb
 - lib/schmobile/filters/is_mobile_param.rb
@@ -111,39 +120,37 @@ files:
 - lib/schmobile/middleware.rb
 - lib/schmobile/request_extension.rb
 - lib/schmobile/user_agents.rb
+- lib/schmobile/version.rb
 - schmobile.gemspec
-- test/helper.rb
-- test/test_filters.rb
-- test/test_middleware.rb
-- test/test_rack_request.rb
-- test/test_user_agents.rb
+- spec/action_dispatch_request_spec.rb
+- spec/filters_spec.rb
+- spec/middleware_spec.rb
+- spec/rack_request_spec.rb
+- spec/spec_helper.rb
+- spec/support/request_helper.rb
+- spec/user_agents_spec.rb
 homepage: http://github.com/zendesk/schmobile
 licenses:
 - Apache License Version 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A mobile user agent detection Rack middleware.
-test_files:
-- test/test_filters.rb
-- test/test_middleware.rb
-- test/test_rack_request.rb
-- test/test_user_agents.rb
+test_files: []

data/test/test_filters.rb

@@ -1,62 +0,0 @@
-require 'helper'
-
-class TestFukters < Test::Unit::TestCase
-
-  context "Schmobile::Filters" do
-    context "#apply" do
-      setup do
-        @request = stub(:user_agent => msie8)
-        @request.stubs(:params).returns({})
-        @session = {}
-        @request.stubs(:session).returns(@session)
-      end
-
-      context "on a pristine request" do
-        should "return true if the session is already mobile" do
-          Schmobile::UserAgents.expects(:is_mobile_agent?).never
-          @session[Schmobile::IS_MOBILE] = true
-          assert Schmobile::Filters.apply(@request)
-        end
-
-        should "return true if there's an is_mobile parameter with value true" do
-          Schmobile::UserAgents.expects(:is_mobile_agent?).never
-          @request.stubs(:params).returns({ "is_mobile" => "true" })
-          assert Schmobile::Filters.apply(@request)
-        end
-
-        should "return false if there's an is_mobile parameter with value false" do
-          Schmobile::UserAgents.expects(:is_mobile_agent?).never
-          @request.stubs(:params).returns({ "is_mobile" => "false" })
-          assert !Schmobile::Filters.apply(@request)
-        end
-
-        should "defer to user agent check if there's no session or parameter" do
-          Schmobile::UserAgents.expects(:is_mobile_agent?).once
-          assert !Schmobile::Filters.apply(@request)
-        end
-      end
-
-      context "on a request with mobile session set to false" do
-        should "allow to change the session value with a parameter" do
-          Schmobile::UserAgents.expects(:is_mobile_agent?).never
-          @request.session[Schmobile::IS_MOBILE] = false
-          assert !Schmobile::Filters.apply(@request)
-          @request.stubs(:params).returns({ "is_mobile" => "true" })
-          assert Schmobile::Filters.apply(@request)
-          assert @request.session[Schmobile::IS_MOBILE]
-        end
-      end
-
-      context "on a request with mobile session set to true" do
-        should "allow to change the session value with a parameter" do
-          Schmobile::UserAgents.expects(:is_mobile_agent?).never
-          @request.session[Schmobile::IS_MOBILE] = true
-          assert Schmobile::Filters.apply(@request)
-          @request.stubs(:params).returns({ "is_mobile" => "false" })
-          assert !Schmobile::Filters.apply(@request)
-          assert !@request.session[Schmobile::IS_MOBILE]
-        end
-      end
-    end
-  end
-end

data/test/test_middleware.rb

@@ -1,69 +0,0 @@
-require 'helper'
-
-class TestMiddleware < Test::Unit::TestCase
-
-  context "Schmobile::Middleware" do
-    setup do
-      @app  = Class.new { def call(app); true; end }.new
-      @rack = Schmobile::Middleware.new(@app)
-    end
-
-    should "return an HTTP permanent redirect when given a redirect path and used by a mobile client" do
-      @rack = Schmobile::Middleware.new(@app, :redirect_to => "/hello")
-      Rack::Request.any_instance.expects(:is_mobile?).returns(true)
-
-      assert_equal [301, { "Location"=>"/hello" }, []], @rack.call(environment)
-    end
-
-    context "with no redirect_to" do
-      should "not redirect mobile traffic" do
-        Rack::Request.any_instance.expects(:params).returns({})
-        @app.expects(:call)
-        @rack.call(environment("HTTP_USER_AGENT" => iphone))
-      end
-
-      should "query the request object to determine if this is a mobile request" do
-        Rack::Request.any_instance.expects(:is_mobile?).returns(true)
-        @rack.call(environment("HTTP_USER_AGENT" => iphone))
-      end
-    end
-
-    context "with redirect_to" do
-      setup do
-        @rack = Schmobile::Middleware.new(@app, :redirect_to => "/wonderland")
-      end
-
-      context "#redirect?" do
-        should "return true when not on mobile path" do
-          assert @rack.redirect?(request("PATH_INFO" => "/somewhere"))
-        end
-
-        should "return true on base path" do
-          assert @rack.redirect?(request("PATH_INFO" => "/"))
-        end
-
-        should "return false when already on path" do
-          assert !@rack.redirect?(request("PATH_INFO" => "/wonderland"))
-          assert !@rack.redirect?(request("PATH_INFO" => "/wonderland/more/stuff"))
-        end
-
-        should "return false when :if resolves to false" do
-          @rack = Schmobile::Middleware.new(@app, :redirect_to => "/wonderland", :redirect_if => Proc.new { |request| false })
-          assert !@rack.redirect?(request("PATH_INFO" => "/somewhere"))
-        end
-      end
-
-      context "#redirect" do
-        should "interpolate the argument string xxxx" do
-          @rack = Schmobile::Middleware.new(@app, :redirect_to => "/wonderland", :redirect_with => "/{{path}}")
-          assert_equal "/wonderland/wiffle", @rack.redirect_location(request("PATH_INFO" => "wiffle"))
-        end
-
-        should "interpolate a multipart argument string" do
-          @rack = Schmobile::Middleware.new(@app, :redirect_to => "/wonderland/", :redirect_with => "{{path}}/lemurs/{{path}}")
-          assert_equal "/wonderland/wiffle/lemurs/wiffle", @rack.redirect_location(request("PATH_INFO" => "wiffle"))
-        end
-      end
-    end
-  end
-end

data/test/test_rack_request.rb

@@ -1,82 +0,0 @@
-require 'helper'
-
-class TestRackRequest < Test::Unit::TestCase
-
-  context "Rack::Request" do
-    context "#is_device?" do
-      should "match devices as part of the user agent case insensitively" do
-        assert request("HTTP_USER_AGENT"  => ipad).is_device?("ipad")
-        assert !request("HTTP_USER_AGENT" => ipad).is_device?("blackberry")
-        assert request("HTTP_USER_AGENT"  => blackberry).is_device?("blackberry")
-        assert !request("HTTP_USER_AGENT" => iphone).is_device?("blackberry")
-        assert request("HTTP_USER_AGENT" => iphone).is_device?("iphone")
-        assert !request("HTTP_USER_AGENT" => msie6).is_device?("iphone")
-      end
-    end
-
-    context "#is_mobile?" do
-      should "only call the filter chain once" do
-        Schmobile::Filters.expects(:apply).once.returns(false)
-        one_request = request
-        3.times { one_request.is_mobile? }
-      end
-
-      should "re-call the filter chain once reset" do
-        Schmobile::Filters.expects(:apply).twice.returns(false)
-        one_request = request
-        3.times { one_request.is_mobile? }
-        one_request.toggle_mobile_session!
-        3.times { one_request.is_mobile? }
-      end
-
-      context "without params" do
-        setup do
-          Rack::Request.any_instance.stubs(:params).returns({})
-        end
-
-        should "not detect a regular browser as mobile" do
-          assert !request.is_mobile?
-          assert !request("HTTP_USER_AGENT" => nil).is_mobile?
-
-          [ :msie6, :msie8, :opera, :chrome ].each do |browser|
-            agent = self.send(browser)
-            assert !request("HTTP_USER_AGENT" => agent).is_mobile?
-          end
-        end
-
-        should "detect mobile units as mobile" do
-          [ :ipod, :iphone, :android, :blackberry, :samsung, :palm, :htc_touch, :danger ].each do |phone|
-            agent = self.send(phone)
-            assert request("HTTP_USER_AGENT" => agent).is_mobile?
-          end
-        end
-
-        should "not detect an ipad as a mobile browser" do
-          assert !request("HTTP_USER_AGENT" => ipad).is_mobile?
-        end
-
-        should "return false when forced in the session" do
-          Rack::Request.any_instance.stubs(:session).returns({ Schmobile::IS_MOBILE => false })
-          assert !request("HTTP_USER_AGENT" => iphone).is_mobile?
-        end
-
-        should "return true when forced in the session" do
-          Rack::Request.any_instance.stubs(:session).returns({ Schmobile::IS_MOBILE => true })
-          assert request.is_mobile?
-        end
-      end
-
-      context "with params" do
-        should "return false when forced via a request parameter" do
-          Rack::Request.any_instance.stubs(:params).returns({ Schmobile::IS_MOBILE => "false" })
-          assert !request("HTTP_USER_AGENT" => iphone).is_mobile?
-        end
-
-        should "return true when forced via a request parameter" do
-          Rack::Request.any_instance.stubs(:params).returns({ Schmobile::IS_MOBILE => "true" })
-          assert request.is_mobile?
-        end
-      end
-    end
-  end
-end

data/test/test_user_agents.rb

@@ -1,41 +0,0 @@
-require 'helper'
-
-class TestUserAgents < Test::Unit::TestCase
-
-  context "Schmobile::UserAgents" do
-    context "#remove_user_agent_pattern" do
-      should "allow removal of a user agent" do
-        assert Schmobile::UserAgents.is_mobile_agent?("novarra")
-        Schmobile::UserAgents.remove_user_agent_pattern("novarra")
-        assert !Schmobile::UserAgents.is_mobile_agent?("novarra")
-      end
-    end
-
-    context "#add_user_agent_pattern" do
-      should "allow adding a user agent" do
-        assert !Schmobile::UserAgents.is_mobile_agent?("wibble")
-        Schmobile::UserAgents.add_user_agent_pattern("wibble")
-        assert Schmobile::UserAgents.is_mobile_agent?("wibble")
-      end
-
-      should "allow changing behavior for a non-mobile agent" do
-        assert !Schmobile::UserAgents.is_mobile_agent?("ipad")
-        Schmobile::UserAgents.add_user_agent_pattern("ipad")
-        assert !Schmobile::UserAgents.is_mobile_agent?("ipad")
-        Schmobile::UserAgents.remove_non_mobile_user_agent_pattern("ipad")
-        assert Schmobile::UserAgents.is_mobile_agent?("ipad")
-        Schmobile::UserAgents.add_non_mobile_user_agent_pattern("ipad")
-      end
-    end
-
-    context "#is_mobile_agent?" do
-      should "return false for common browsers" do
-        [ :msie6, :msie8, :opera, :chrome ].each do |browser|
-          agent = self.send(browser)
-          assert !Schmobile::UserAgents.is_mobile_agent?(agent), "#{browser} should not detect as mobile, #{agent}"
-        end
-      end
-    end
-  end
-
-end