mobu 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da134026fb867c20abc5643f4bcc92a6a8e2127a
+  data.tar.gz: 17fc0c55249510e0e3f6b7492f7fa2925258049c
+SHA512:
+  metadata.gz: b70d4036ed1820fcac7964d860cb25dbbd492158fd4cf478591bb2f44f74cf2cb39043fe49516620e5dcc30d82c28192924c25e7330d2d2fbfd9f59679a6fb6a
+  data.tar.gz: 1c70eaaac08ffaf397ef9d21edf3a9c1907da5d2a52d39028b66f02411e7b04a9f2706c086cc6bc5d3249b2453dae17ce50c10e18327b8663e1cef0c6515bf53

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+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,61 @@
+# Mobu
+
+[![Build Status](https://api.travis-ci.org/neighborland/mobu.png)](https://travis-ci.org/neighborland/mobu)
+[![Code Climate](https://codeclimate.com/github/neighborland/mobu.png)](https://codeclimate.com/github/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.
+
+## 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.
+
+To allow mobile users to switch to the full site view, add a link to a mobile view:
+
+```sh
+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:
+
+```sh
+app/views_mobile/_footer.haml
+```
+```haml
+- if mobile_browser?
+  = link_to("View Mobile Site", prefer_mobile_site_url)
+```
+
+## Credits
+
+The view path modification techinique was taken from Scott W. Bradley's post
+[here](http://scottwb.com/blog/2012/02/23/a-better-way-to-add-mobile-pages-to-a-rails-site/)
+
+A similar project is 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/lib/mobu.rb

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

data/lib/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 Mobu
+  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/mobu/version.rb

@@ -0,0 +1,3 @@
+module Mobu
+  VERSION = "0.0.2"
+end

data/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 'mobu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mobu"
+  spec.version       = Mobu::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.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.executables   = []
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_development_dependency "bundler", ">= 1.3"
+  spec.add_development_dependency "rake", ">= 10.1"
+  spec.add_development_dependency "test-unit", ">= 2.5"
+  spec.add_development_dependency "mocha", ">= 0.14"
+  spec.add_development_dependency "shoulda-context", ">= 1.1.5"
+
+  spec.add_runtime_dependency "rack", "~> 1.4"
+  spec.add_runtime_dependency "activesupport", ">= 3.2"
+end

data/test/detect_mobile_test.rb

@@ -0,0 +1,158 @@
+require 'test_helper'
+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'
+
+class MobuFake
+  class << self
+    def before_filter(*args) end
+    def helper_method(*methods) end
+  end
+
+  def params
+    {}
+  end
+
+  include Mobu::DetectMobile
+end
+
+class Rails
+  def self.root
+    Pathname.new("LIB_ROOT/..")
+  end
+end
+
+class MobuTest < Test::Unit::TestCase
+
+  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"
+
+  context "controller" do
+    setup do
+      @request = mock
+      @session = MockCookies.new
+      @controller = MobuFake.new
+      @controller.stubs session: @session
+      @controller.stubs request: @request
+    end
+
+    should "set and cache mobile_request?" do
+      @controller.stubs :mobile_browser?
+      @controller.stubs :tablet_request?
+      refute @controller.send :mobile_request?
+      @controller.stubs mobile_browser?: true # should ignore
+      refute @controller.send :mobile_request?
+    end
+
+
+    should "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
+
+    context "with mobile user agent" do
+      setup do
+        @request.stubs user_agent: IPHONE_USER_AGENT
+      end
+
+      should "prepend mobile views" do
+        expect_mobile_views
+        expect_no_tablet_views
+        @controller.send :check_mobile_site
+      end
+
+      should "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
+
+      should "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
+    end
+
+    context "with tablet user agent" do
+      setup do
+        @request.stubs user_agent: IPAD_USER_AGENT
+      end
+
+      should "prepend tablet views" do
+        expect_tablet_views
+        expect_no_mobile_views
+        @controller.send :check_mobile_site
+      end
+    end
+
+    context "with browser user agent" do
+      setup do
+        @request.stubs user_agent: FIREFOX_USER_AGENT
+      end
+
+      should "prepend no views" do
+        expect_no_tablet_views
+        expect_no_mobile_views
+        @controller.send :check_mobile_site
+      end
+
+      should "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
+
+    context "#prefer_full_site_url" do
+      should "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
+
+      should "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
+
+    context "#prefer_mobile_site_url" do
+      should "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
+
+      should "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
+  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,17 @@
+require 'test/unit'
+require 'shoulda-context'
+require 'mocha/setup'
+require 'mobu'
+
+class MockCookies < Hash
+  attr_accessor :permanent
+
+  def initialize
+    @permanent = {}
+    super
+  end
+
+  def delete(cookie, opts={})
+    super cookie
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: mobu
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tee Parham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-05 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mobu.rb
+- lib/mobu/detect_mobile.rb
+- lib/mobu/version.rb
+- mobu.gemspec
+- test/detect_mobile_test.rb
+- test/test_helper.rb
+homepage: https://github.com/neighborland/mobu
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+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