class MobileDetect

Constants

VERSION: mobile_detect version

Attributes

http_headers[R]

user_agent[W]

Public Class Methods

new(http_headers = {}, user_agent = nil) click to toggle source

Construct an instance of this class. @param [hash] http_headers Specify the http headers of the request. @param [string] user_agent Specify the User-Agent header. If null, will use HTTP_USER_AGENT

from the http_headers hash instead.

# File lib/mobile_detect/core.rb, line 12
def initialize(http_headers = {}, user_agent = nil)
  @@data ||= load_json_data
  self.http_headers = http_headers
  self.user_agent = user_agent
end

Public Instance Methods

data() click to toggle source

# File lib/mobile_detect/core.rb, line 18
def data
  @@data
end

http_headers=(env) click to toggle source

set the hash of http headers, from env in rails or sinatra used to get the UA and also to get some mobile headers

# File lib/mobile_detect/core.rb, line 38
def http_headers=(env)
  @http_headers = env.select {|header, value| header.to_s.start_with? "HTTP_"}
end

is?(key) click to toggle source

Checks if the device is conforming to the provided key e.g detector.is?(“ios”) / detector.is?(“androidos”) / detector.is?(“iphone”) @return bool

# File lib/mobile_detect/core.rb, line 62
def is?(key)
  # Make the keys lowercase so we can match: is?("Iphone"), is?("iPhone"), is?("iphone"), etc.
  key = key.downcase

  lc_rules = Hash[rules.map do |k, v|
    [k.downcase, v.downcase]
  end]

  unless lc_rules[key]
    raise NoMethodError, "Provided key, #{key}, is invalid"
  end

  match lc_rules[key]
end

method_missing(name, *args, &blk) click to toggle source

Checks if the device is conforming to the provided key e.g detector.ios? / detector.androidos? / detector.iphone? @return bool

Calls superclass method

# File lib/mobile_detect/core.rb, line 80
def method_missing(name, *args, &blk)
  unless(Array(args).empty?)
    puts "Args to #{name} method ignored"
  end

  unless(name[-1] == "?")
    super
  end

  is? name[0..-2]
end

mobile?() click to toggle source

not including deprecated params Check if the device is mobile. Returns true if any type of mobile device detected, including special ones @return bool

# File lib/mobile_detect/core.rb, line 31
def mobile?
  (check_http_headers_for_mobile or
  match_detection_rules_against_UA)
end

tablet?() click to toggle source

Check if the device is a tablet. Return true if any type of tablet device is detected. not including deprecated params @return bool

# File lib/mobile_detect/core.rb, line 55
def tablet?
  match_detection_rules_against_UA tablets
end

user_agent() click to toggle source

To access the user agent, retrieved from http_headers if not explicitly set

# File lib/mobile_detect/core.rb, line 43
def user_agent
  @user_agent ||= parse_headers_for_user_agent

  raise "User agent needs to be set before this module can function" unless @user_agent

  @user_agent
end

Protected Instance Methods

check_http_headers_for_mobile() click to toggle source

Check the HTTP headers for signs of mobile. This is the fastest mobile check possible; it’s used inside isMobile() method.

@return bool

# File lib/mobile_detect/core.rb, line 125
def check_http_headers_for_mobile
  data["headerMatch"].each do |mobile_header, match_type|
    if(http_headers[mobile_header])
      return false if match_type.nil? || !match_type["matches"].is_a?(Array)

      Array(match_type["matches"]).each do |match|
        return true if http_headers[mobile_header].include? match
      end

      return false
    end
  end
  false
end

load_json_data() click to toggle source

# File lib/mobile_detect/core.rb, line 93
def load_json_data
  File.open(File.expand_path("../../../data/Mobile_Detect.json", __FILE__), "r") do |file|
    JSON.load(file)
  end
end

match(key_regex, ua_string = user_agent) click to toggle source

This method will be used to check custom regexes against the User-Agent string. @return bool

# File lib/mobile_detect/core.rb, line 148
def match key_regex, ua_string = user_agent
  # Escape the special character which is the delimiter.
  # _, regex = key_regex
  regex = Array(key_regex).last # accepts a plain regex or a pair of key,regex
  regex.gsub!("/", "\/")
  !! (ua_string =~ /#{regex}/iu)
end

match_detection_rules_against_UA(rules = self.rules) click to toggle source

Find a detection rule that matches the current User-agent. not including deprecated params @return bool

# File lib/mobile_detect/core.rb, line 159
def match_detection_rules_against_UA rules = self.rules
  # not sure why the empty check is needed here.. not doing it
  rules.each do |regex|
    return true if match regex
  end
  false
end

parse_headers_for_user_agent() click to toggle source

Parse the headers for the user agent - uses a list of possible keys as provided by upstream @return (String) A concatenated list of possible user agents, should be just 1

# File lib/mobile_detect/core.rb, line 105
def parse_headers_for_user_agent
  ua_http_headers.map{|header| http_headers[header]}.compact.join(" ").strip
end

rules() click to toggle source

# File lib/mobile_detect/core.rb, line 116
def rules
  @rules ||= phones.merge(tablets.merge(browsers.merge(operating_systems)))
end

ua_http_headers() click to toggle source

# File lib/mobile_detect/core.rb, line 99
def ua_http_headers
  data["uaHttpHeaders"]
end