schmobile 0.4.1 → 1.0.0

data/test/test_user_agents.rb

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

metadata

@@ -1,169 +1,148 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: schmobile
-version: !ruby/object:Gem::Version 
-  hash: 13
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
 platform: ruby
-authors: 
+authors:
 - Morten Primdahl
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-03 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 1
-        - 0
-        version: 1.1.0
-  version_requirements: *id001
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 41
-        segments: 
-        - 0
-        - 9
-        - 9
-        version: 0.9.9
-  version_requirements: *id002
-  name: mocha
-- !ruby/object:Gem::Dependency 
+    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
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id003
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: shoulda
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id004
-  name: bundler
-- !ruby/object:Gem::Dependency 
+    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
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 5
-        - 2
-        version: 1.5.2
-  version_requirements: *id005
-  name: jeweler
-description: Used to determine if a request is from a mobile client, and possibly redirect it if that's the case
-email: morten@zendesk.com
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A mobile user agent detection Rack middleware. See the README.
+email: primdahl@me.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - .document
+- .gitignore
+- .travis.yml
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION
-- lib/rack/schmobile.rb
-- lib/rack/schmobile/filters.rb
-- lib/rack/schmobile/filters/is_mobile_param.rb
-- lib/rack/schmobile/filters/mobile_session.rb
-- lib/rack/schmobile/filters/mobile_user_agent.rb
-- lib/rack/schmobile/middleware.rb
-- lib/rack/schmobile/request_extension.rb
-- lib/rack/schmobile/user_agents.rb
 - lib/schmobile.rb
+- lib/schmobile/filters.rb
+- lib/schmobile/filters/is_mobile_param.rb
+- lib/schmobile/filters/mobile_session.rb
+- lib/schmobile/filters/mobile_user_agent.rb
+- lib/schmobile/middleware.rb
+- lib/schmobile/request_extension.rb
+- lib/schmobile/user_agents.rb
 - schmobile.gemspec
 - test/helper.rb
 - test/test_filters.rb
 - test/test_middleware.rb
 - test/test_rack_request.rb
 - test/test_user_agents.rb
-has_rdoc: true
-homepage: http://github.com/morten/schmobile
-licenses: 
-- MIT
+homepage: http://github.com/zendesk/schmobile
+licenses:
+- Apache License Version 2.0
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A Rack middleware for detecting mobile user agents
-test_files: 
-- test/helper.rb
+summary: A mobile user agent detection Rack middleware.
+test_files:
 - test/test_filters.rb
 - test/test_middleware.rb
 - test/test_rack_request.rb

data/Gemfile.lock

@@ -1,23 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    mocha (0.9.9)
-      rake
-    rack (1.1.0)
-    rake (0.8.7)
-    shoulda (2.11.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
-  mocha (= 0.9.9)
-  rack (~> 1.1.0)
-  shoulda

data/LICENSE.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2011 Morten Primdahl
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,65 +0,0 @@
-= schmobile
-
-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
-
-It can be configured to return the user to an explicit destination:
-
-  use Rack::Schmobile, :redirect_to => "/mobile"
-
-It supports string interpolation for dynamic destinations:
-
-  use Rack::Schmobile, :redirect_to => "/mobile/#!/{{path}}"
-
-Finally the middleware provides a request level method to determine if the client is a mobile device
-
-  Rack::Request#is_mobile?
-
-== Rolling out
-
-  use Rack::Schmobile, :redirect_to => "/mobile", :if => Proc.new { |request| request.host =~ /staging/ }
-
-== Thanks
-
-Not quite what we were looking for, but good inspiration and may work for you:
-
-  https://github.com/talison/rack-mobile-detect
-  https://github.com/brendanlim/mobile-fu
-
-
-== Contributing to schmobile
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Morten Primdahl. See LICENSE.txt for
-further details.
-

data/VERSION

@@ -1 +0,0 @@
-0.4.1

data/lib/rack/schmobile/filters/is_mobile_param.rb

@@ -1,15 +0,0 @@
-module Rack
-  module Schmobile
-    module Filters
-      module IsMobileParam
-        def self.call(request)
-          if request.params.key?(Rack::Schmobile::IS_MOBILE)
-             request.session[Rack::Schmobile::IS_MOBILE] = (request.params[Rack::Schmobile::IS_MOBILE] == "true")
-          end
-
-          nil
-        end
-      end
-    end
-  end
-end

data/lib/rack/schmobile/filters/mobile_session.rb

@@ -1,11 +0,0 @@
-module Rack
-  module Schmobile
-    module Filters
-      module MobileSession
-        def self.call(request)
-          request.session[Rack::Schmobile::IS_MOBILE]
-        end
-      end
-    end
-  end
-end

data/lib/rack/schmobile/filters/mobile_user_agent.rb

@@ -1,13 +0,0 @@
-require 'rack/schmobile/user_agents'
-
-module Rack
-  module Schmobile
-    module Filters
-      module MobileUserAgent
-        def self.call(request)
-          request.session[Rack::Schmobile::IS_MOBILE] = Rack::Schmobile::UserAgents.is_mobile_agent?(request.user_agent)
-        end
-      end
-    end
-  end
-end

data/lib/rack/schmobile/filters.rb

@@ -1,33 +0,0 @@
-require 'rack/schmobile/filters/mobile_session'
-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 determine 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 and this also gets used to mark the session as a "mobile session"
-    #
-    # You can manipulate the chain to add new conditions that check on e.g. request format.
-    module Filters
-      CHAIN = [
-        Rack::Schmobile::Filters::IsMobileParam, # Must come before session check
-        Rack::Schmobile::Filters::MobileSession,
-        Rack::Schmobile::Filters::MobileUserAgent # Always returns either true or false
-      ]
-
-      def self.apply(request)
-        Rack::Schmobile::Filters::CHAIN.each do |filter|
-          result = filter.call(request)
-          unless result.nil?
-            request.session[Rack::Schmobile::IS_MOBILE] = result
-            break
-          end
-        end
-
-        request.session[Rack::Schmobile::IS_MOBILE] ||= false
-      end
-    end
-  end
-end
-

data/lib/rack/schmobile/middleware.rb

@@ -1,61 +0,0 @@
-module Rack
-  module Schmobile
-    class Middleware
-
-      def initialize(app, options = {})
-        @app     = app
-        @options = options
-      end
-
-      def call(env)
-        request = Rack::Request.new(env)
-
-        if request.is_mobile? && redirect?(request)
-          [ 301, { "Location" => redirect_location(request) }, [] ]
-        else
-          @app.call(env)
-        end
-      end
-
-      # Returns true if this middleware has been configured with a redirect_to and the requested path
-      # is not already below the configured redirect_to
-      def redirect?(request)
-        redirecting = true
-
-        if @options.key?(:redirect_if)
-          redirecting = @options[:redirect_if].call(request)
-        end
-
-        if @options.key?(:redirect_to)
-          redirecting &&= request.path !~ /^#{@options[:redirect_to]}/
-        else
-          redirecting = false
-        end
-
-        redirecting ? redirect_location(request) : nil
-      end
-
-      def redirect_location(request)
-        "#{@options[:redirect_to]}#{redirect_with(request)}"
-      end
-
-      def redirect_with(request)
-        build_path(@options[:redirect_with].to_s, request)
-      end
-
-      private
-
-      def build_path(destination, request)
-        final_destination = destination.dup
-        destination.scan(/\{\{\w+\}\}/) do |call|
-          func = call.scan(/\w+/).to_s
-          if request.respond_to?(func)
-            final_destination.sub!(/\{\{#{func}\}\}/, request.send(func))
-          end
-        end
-        final_destination
-      end
-
-    end
-  end
-end

data/lib/rack/schmobile/request_extension.rb

@@ -1,26 +0,0 @@
-module Rack
-  module Schmobile
-    module Request
-      def is_mobile?
-        if @is_mobile.nil?
-          @is_mobile = Rack::Schmobile::Filters.apply(self)
-        end
-
-        @is_mobile
-      end
-
-      def toggle_mobile_session!
-        session[Rack::Schmobile::IS_MOBILE] = !is_mobile?
-        @is_mobile = nil
-      end
-
-      def is_device?(identifier)
-        user_agent =~ /#{identifier}/i
-      end
-    end
-  end
-end
-
-Rack::Request.class_eval do
-  include Rack::Schmobile::Request
-end

data/lib/rack/schmobile/user_agents.rb

@@ -1,60 +0,0 @@
-module Rack
-  module Schmobile
-    class UserAgents
-
-      MOBILE_USER_AGENTS = %w(
-        alcatel amoi android astel audiovox blackberry cdm chtml danger docomo ericsson htc_touch
-        iphone ipod j2me kddi midp minimo mmp mobi mobile mobileexplorer mot- motorola netfront nokia
-        novarra palm pdxgw phone plucker pocket portable portalmmm sagem samsung sgh sie- softbank
-        sprint symbian telit ucweb up.b upg1 vodafone webos windows\ ce x240 x320 xiino
-      )
-
-      NON_MOBILE_USER_AGENTS = %w(
-        ipad
-      )
-
-      def self.remove_user_agent_pattern(pattern)
-        MOBILE_USER_AGENTS.delete(pattern)
-        @mobile_agent_matcher = nil
-      end
-
-      def self.add_user_agent_pattern(pattern)
-        MOBILE_USER_AGENTS.push(*pattern)
-        @mobile_agent_matcher = nil
-      end
-
-      def self.remove_non_mobile_user_agent_pattern(pattern)
-        NON_MOBILE_USER_AGENTS.delete(pattern)
-        @non_mobile_agent_matcher = nil
-      end
-
-      def self.add_non_mobile_user_agent_pattern(pattern)
-        NON_MOBILE_USER_AGENTS.push(*pattern)
-        @non_mobile_agent_matcher = nil
-      end
-
-      def self.is_mobile_agent?(user_agent)
-        agent  = user_agent.to_s.downcase
-        mobile = !(agent =~ mobile_agent_matcher).nil?
-        mobile = mobile && agent !~ non_mobile_agent_matcher unless NON_MOBILE_USER_AGENTS.empty?
-        mobile
-      end
-
-      def self.mobile_agent_matcher
-        @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("|"))
-      end
-
-      def self.matched_by?(user_agent)
-        MOBILE_USER_AGENTS.each do |agent|
-          return agent if user_agent =~ /#{agent}/
-        end
-        nil
-      end
-
-    end
-  end
-end

data/lib/rack/schmobile.rb

@@ -1,10 +0,0 @@
-require 'rack'
-require 'rack/schmobile/middleware'
-require 'rack/schmobile/request_extension'
-require 'rack/schmobile/filters'
-
-module Rack
-  module Schmobile
-    IS_MOBILE = "is_mobile"
-  end
-end