fork_mobu 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5df552d2081471626626bf6143e0999831abd75dd47c98c8f64879125437aaa
+  data.tar.gz: 5d7984af15825ccffac4e2254640b09241e84217b84e7c04c6f7ea3e1a99a615
+SHA512:
+  metadata.gz: f9bd8e40dfe28867f0ae72bc61157dfe204ebfa7f6f06b84d679df7f5fedc00ac8cdd061f142ce6d36ea1e300d6d01929fc92ff3060bcfeaf0ddebc5f0b15119
+  data.tar.gz: 67135708c45a4d33ff1425e100418e38d0b4f1b781244be2fda279548d4b8c7d85182768157848f7af28a37c816e1cdb8fcc3401192b64e47548b87754608280

data/.gitignore

@@ -0,0 +1,5 @@
+.ruby-version
+Gemfile.lock
+coverage
+pkg
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.5.2
+  - 2.1.4
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+if ENV['TRAVIS']
+  gem 'coveralls', require: false
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Neighborland, Inc.
+
+MIT License
+
+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.md

@@ -0,0 +1,79 @@
+# Mobu
+
+[![Gem Version](http://img.shields.io/gem/v/mobu.svg)](http://rubygems.org/gems/mobu)
+[![Build Status](http://img.shields.io/travis/neighborland/mobu.svg)](https://travis-ci.org/neighborland/mobu)
+[![Code Climate](http://img.shields.io/codeclimate/github/neighborland/mobu.svg)](https://codeclimate.com/github/neighborland/mobu)
+[![Coverage Status](http://img.shields.io/coveralls/neighborland/mobu.svg)](https://coveralls.io/r/neighborland/mobu)
+
+Mobu provides a Rails controller concern called `DetectMobile`.
+Mobu does server-side User Agent detection to categorize requests as mobile, tablet, or default.
+
+Mobu modifies your rails view paths based on the request type.
+It does not require custom MIME types or separate subdomains.
+
+_Disclaimer: It is rarely a good idea to use User Agent detection to render different HTML content. 
+Please read this first:_
+
+https://developer.mozilla.org/en-US/docs/Browser_detection_using_the_user_agent
+
+## Install
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'mobu'
+```
+
+Include the module in your ApplicationController:
+
+```ruby
+class ApplicationController
+  include Mobu::DetectMobile
+```
+
+Create directories for `views_mobile` and `views_tablet`:
+
+```sh
+mkdir app/views_mobile
+mkdir app/views_tablet
+```
+
+## Usage
+
+Put the view/partial files that you want to override in the appropriate directories.
+
+When you receive a mobile request, your app will first look for view files in `app/views_mobile`
+directory, then in `app/views`.
+
+Alternately, you can switch your rendering logic using the `mobile_request?` and `tablet_request?` helper methods
+in your view files or helpers:
+
+```haml
+- if mobile_request?
+  .small-thing Short Text
+- else
+  .regular-thing Much Longer Text
+```
+
+To allow mobile users to switch to the full site view, add a link to a mobile view. For example:
+
+##### app/views_mobile/_footer.haml
+```haml
+= link_to("View Full Site", prefer_full_site_url)
+```
+
+To allow full site users to switch to the mobile view, add a link to a default view. For example:
+
+##### app/views_mobile/_footer.haml
+```haml
+- if mobile_browser?
+  = link_to("View Mobile Site", prefer_mobile_site_url)
+```
+
+## Credits
+
+The view path modification technique was taken from 
+[this post by Scott W. Bradley](http://scottwb.com/blog/2012/02/23/a-better-way-to-add-mobile-pages-to-a-rails-site/).
+
+The user agent regex came from a similar project, Brendan Lim's 
+[mobile-fu](https://github.com/brendanlim/mobile-fu).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = %w(test/**/*.rb)
+  t.verbose = false
+end

data/fork_mobu.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fork_mobu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fork_mobu"
+  spec.version       = ForkMobu::VERSION
+  spec.authors       = ["Tee Parham"]
+  spec.email         = ["tee@neighborland.com"]
+  spec.description   = %q{Rails User Agent Dependent View Paths}
+  spec.summary       = %q{Rails server-side User Agent detection, plus view path modifications.}
+  spec.homepage      = "https://github.com/neighborland/mobu"
+  spec.license       = "MIT"
+  spec.metadata      = { "source_code_uri" => "https://github.com/neighborland/mobu" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+  spec.executables   = []
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_development_dependency "bundler", '~> 1.3', '>= 1.3.0'
+  spec.add_development_dependency "rake", '~> 2.0', '>= 2.0.0'
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha", "~> 1.0"
+
+  spec.add_dependency "rack", '~> 2.0', '>= 2.0.0'
+  spec.add_dependency "actionpack", ">= 3.2"
+end

data/lib/fork_mobu/detect_mobile.rb

@@ -0,0 +1,107 @@
+require 'active_support/concern'
+require 'active_support/core_ext/object/to_param'
+require 'active_support/core_ext/object/to_query'
+require 'rack/utils'
+require 'uri'
+
+module ForkMobu
+  module DetectMobile
+    extend ActiveSupport::Concern
+
+    # List of mobile agents from mobile_fu:
+    # https://github.com/brendanlim/mobile-fu/blob/master/lib/mobile_fu.rb
+    MOBILE_USER_AGENTS = 'palm|blackberry|nokia|phone|midp|mobi|symbian|chtml|ericsson|minimo|' +
+                         'audiovox|motorola|samsung|telit|upg1|windows ce|ucweb|astel|plucker|' +
+                         'x320|x240|j2me|sgh|portable|sprint|docomo|kddi|softbank|android|mmp|' +
+                         'pdxgw|netfront|xiino|vodafone|portalmmm|sagem|mot-|sie-|ipod|up\\.b|' +
+                         'webos|amoi|novarra|cdm|alcatel|pocket|iphone|mobileexplorer|mobile'
+
+    TABLET_USER_AGENTS = 'ipad|android 3.0|xoom|sch-i800|playbook|tablet|kindle|honeycomb|gt-p1000'
+
+    included do
+      before_filter :check_mobile_site
+
+      helper_method :mobile_request?,
+                    :mobile_browser?,
+                    :prefer_full_site_url,
+                    :prefer_mobile_site_url,
+                    :tablet_request?,
+                    :tablet_browser?
+    end
+
+  private
+
+    def mobile_views_path
+      @@mobile_views_path ||= Rails.root + 'app' + 'views_mobile'
+    end
+
+    def tablet_views_path
+      @@tablet_views_path ||= Rails.root + 'app' + 'views_tablet'
+    end
+
+    def prefer_full_site_url
+      _view_url "f"
+    end
+
+    def prefer_mobile_site_url
+      _view_url "m"
+    end
+
+    # preference: m, f (mobile, full)
+    def _view_url(preference)
+      uri = URI(request.url)
+      query = Rack::Utils.parse_nested_query(uri.query)
+      query["prefer"] = preference
+      uri.query = query.to_param
+      uri.to_s
+    end
+
+    def force_full_site
+      session[:prefer_full_site]
+    end
+
+    def mobile_request?
+      if defined?(@mobile_request)
+        @mobile_request
+      else
+        @mobile_request = !force_full_site && !tablet_request? && mobile_browser?
+      end
+    end
+
+    def mobile_browser?
+      user_agent_matches(MOBILE_USER_AGENTS)
+    end
+
+    def tablet_request?
+      if defined?(@tablet_request)
+        @tablet_request
+      else
+        @tablet_request = tablet_browser?
+      end
+    end
+
+    def tablet_browser?
+      user_agent_matches(TABLET_USER_AGENTS)
+    end
+
+    def check_mobile_site
+      case params.delete(:prefer)
+      when "f"
+        session[:prefer_full_site] = 1
+      when "m"
+        session.delete :prefer_full_site
+      end
+
+      if mobile_request?
+        prepend_view_path mobile_views_path
+      elsif tablet_request?
+        prepend_view_path tablet_views_path
+      end
+    end
+
+    def user_agent_matches(regex)
+      !!( request.user_agent.to_s.downcase =~ /(#{regex})/ )
+    end
+
+  end
+end

data/lib/fork_mobu/version.rb

@@ -0,0 +1,3 @@
+module ForkMobu
+  VERSION = "0.0.1"
+end

data/lib/fork_mobu.rb

@@ -0,0 +1,2 @@
+require 'fork_mobu/version'
+require 'fork_mobu/detect_mobile'

data/test/detect_mobile_test.rb

@@ -0,0 +1,173 @@
+require 'test_helper'
+
+class ForkMobuFake
+  class << self
+    def before_filter(*args) end
+    def helper_method(*methods) end
+  end
+
+  def params
+    {}
+  end
+
+  include ForkMobu::DetectMobile
+end
+
+class Rails
+end
+
+class ForkMobuTest < MiniTest::Spec
+
+  IPAD_USER_AGENT = "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"
+  IPHONE_USER_AGENT = "Mozilla/5.0 (iPhone; U; CPU iPhone OS 4_3_3 like Mac OS X; en-us) AppleWebKit/533.17.9 (KHTML, like Gecko) Version/5.0.2 Mobile/8J2 Safari/6533.18.5"
+  FIREFOX_USER_AGENT = "Mozilla/5.0 (Windows NT 6.2; rv:22.0) Gecko/20130405 Firefox/23.0"
+
+  describe "controller" do
+    before do
+      @request = mock
+      @session = MockCookies.new
+      @controller = MobuFake.new
+      @controller.stubs session: @session
+      @controller.stubs request: @request
+    end
+
+    it "set and cache mobile_request?" do
+      @controller.stubs :mobile_browser?
+      @controller.stubs :tablet_request?
+      refute @controller.send :mobile_request?
+      @controller.stubs mobile_browser?: true # it ignore
+      refute @controller.send :mobile_request?
+    end
+
+    it "detect tablet and not detect mobile for iPad user agent" do
+      @request.stubs user_agent: IPAD_USER_AGENT
+      assert @controller.send(:tablet_request?)
+      refute @controller.send(:mobile_request?)
+    end
+
+    describe "with mobile user agent" do
+      before do
+        @request.stubs user_agent: IPHONE_USER_AGENT
+      end
+
+      it "prepend mobile views" do
+        expect_mobile_views
+        expect_no_tablet_views
+        @controller.send :check_mobile_site
+      end
+
+      it "prepend mobile views with mobile preference" do
+        @controller.stubs params: {prefer: "m"}
+        expect_mobile_views
+        expect_no_tablet_views
+        @controller.send :check_mobile_site
+      end
+
+      it "not prepend mobile views with prefer_full_site cookie" do
+        @session[:prefer_full_site] = 1
+        expect_no_mobile_views
+        expect_no_tablet_views
+        @controller.send :check_mobile_site
+      end
+      
+      it "set session cookie to prefer full site with full site preference" do
+        @controller.stubs params: {prefer: "f"}
+        @controller.send :check_mobile_site
+        assert_equal 1, @session[:prefer_full_site]
+      end      
+    end
+
+    describe "with tablet user agent" do
+      before do
+        @request.stubs user_agent: IPAD_USER_AGENT
+      end
+
+      it "prepend tablet views" do
+        expect_tablet_views
+        expect_no_mobile_views
+        @controller.send :check_mobile_site
+      end
+    end
+
+    describe "with browser user agent" do
+      before do
+        @request.stubs user_agent: FIREFOX_USER_AGENT
+      end
+
+      it "prepend no views" do
+        expect_no_tablet_views
+        expect_no_mobile_views
+        @controller.send :check_mobile_site
+      end
+
+      it "prepend no views with prefer_full_site cookie" do
+        @session[:prefer_full_site] = 1
+        expect_no_tablet_views
+        expect_no_mobile_views
+        @controller.send :check_mobile_site
+      end
+    end
+
+    describe "#prefer_full_site_url" do
+      it "add prefer=f" do
+        @request.stubs url: "https://neighborland.com/xyz"
+        assert_equal "https://neighborland.com/xyz?prefer=f", @controller.send(:prefer_full_site_url)
+      end
+
+      it "keep existing query params" do
+        @request.stubs url: "https://neighborland.com/xyz?monkeys=true&bananas=yeller"
+        assert_equal "https://neighborland.com/xyz?bananas=yeller&monkeys=true&prefer=f", @controller.send(:prefer_full_site_url)
+      end
+    end
+
+    describe "#prefer_mobile_site_url" do
+      it "add prefer=m" do
+        @request.stubs url: "https://neighborland.com/xyz"
+        assert_equal "https://neighborland.com/xyz?prefer=m", @controller.send(:prefer_mobile_site_url)
+      end
+
+      it "strip existing prefer value" do
+        @request.stubs url: "https://neighborland.com/xyz?prefer=f"
+        assert_equal "https://neighborland.com/xyz?prefer=m", @controller.send(:prefer_mobile_site_url)
+      end
+    end
+
+    describe "with fake Rails" do
+      before do
+        Rails.stubs root: Pathname.new("/home/snoop/yer_app/")        
+      end
+      
+      describe "#mobile_views_path" do
+        it "build path" do
+          assert_equal "/home/snoop/yer_app/app/views_mobile", @controller.send(:mobile_views_path).to_s
+        end
+      end
+
+      describe "#tablet_views_path" do
+        it "build path" do
+          assert_equal "/home/snoop/yer_app/app/views_tablet", @controller.send(:tablet_views_path).to_s
+        end    
+      end          
+    end
+  end
+  
+private
+
+  def expect_mobile_views
+    @controller.expects(:mobile_views_path).returns("mobile_views_path").once
+    @controller.expects(:prepend_view_path).with("mobile_views_path")
+  end
+
+  def expect_tablet_views
+    @controller.expects(:tablet_views_path).returns("tablet_views_path").once
+    @controller.expects(:prepend_view_path).with("tablet_views_path")
+  end
+
+  def expect_no_mobile_views
+    @controller.expects(:mobile_views_path).never
+  end
+
+  def expect_no_tablet_views
+    @controller.expects(:tablet_views_path).never
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'minitest/autorun'
+require 'mocha/mini_test'
+require 'fork_mobu'
+
+class MockCookies < Hash
+  attr_accessor :permanent
+
+  def initialize
+    @permanent = {}
+    super
+  end
+
+  def delete(cookie, opts={})
+    super cookie
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: fork_mobu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tee Parham
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Rails User Agent Dependent View Paths
+email:
+- tee@neighborland.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fork_mobu.gemspec
+- lib/fork_mobu.rb
+- lib/fork_mobu/detect_mobile.rb
+- lib/fork_mobu/version.rb
+- test/detect_mobile_test.rb
+- test/test_helper.rb
+homepage: https://github.com/neighborland/mobu
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/neighborland/mobu
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Rails server-side User Agent detection, plus view path modifications.
+test_files:
+- test/detect_mobile_test.rb
+- test/test_helper.rb