UAInspector

v1.0.0

UAInspector v1.0.0 UAInspector View Source

User agent parser library

Usage 

iex(1)> UAInspector.parse("Mozilla/5.0 (iPad; CPU OS 7_0_4 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11B554a Safari/9537.53")
%UAInspector.Result{
  user_agent: "Mozilla/5.0 (iPad; CPU OS 7_0_4 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11B554a Safari/9537.53"
  client: %UAInspector.Result.Client{
    engine: "WebKit",
    engine_version: "537.51.11",
    name: "Mobile Safari",
    type: "browser",
    version: "7.0"
  },
  device: %UAInspector.Result.Device{
    brand: "Apple",
    model: "iPad",
    type: "tablet"
  },
  os: %UAInspector.Result.OS{
    name: "iOS",
    platform: :unknown,
    version: "7.0.4"
  },
}

iex(2)> UAInspector.parse("Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; Googlebot/2.1; +http://www.google.com/bot.html) Safari/537.36")
%UAInspector.Result.Bot{
  user_agent: "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; Googlebot/2.1; +http://www.google.com/bot.html) Safari/537.36",
  category: "Search bot",
  name: "Googlebot",
  producer: %UAInspector.Result.BotProducer{
    name: "Google Inc.",
    url: "http://www.google.com"
  },
  url: "http://www.google.com/bot.html"
}

iex(3)> UAInspector.parse("generic crawler agent")
%UAInspector.Result.Bot{
  user_agent: "generic crawler agent",
  name: "Generic Bot"
}

iex(4)> UAInspector.parse("--- undetectable ---")
%UAInspector.Result{
  user_agent: "--- undetectable ---",
  client: :unknown,
  device: %UAInspector.Result.Device{ type: "desktop" },
  os: :unknown
}

The map key :user_agent will hold the unmodified passed user agent.

If the device type cannot be determined a "desktop" device type will be assumed (and returned). Both :brand and :model are set to :unknown.

When a bot agent is detected the result with be a UAInspector.Result.Bot struct instead of UAInspector.Result.

Link to this section Summary

Functions

bot?(ua)

Checks if a user agent is a known bot.

hbbtv?(ua)

Checks if a user agent is a HbbTV and returns its version if so.

parse(ua)

Parses a user agent.

parse_client(ua)

Parses a user agent without checking for bots.

ready?()

Checks if UAInspector is ready to perform lookups.

reload()

Reloads all databases.

Link to this section Functions

Link to this function

bot?(ua) View Source 
bot?(String.t() | nil) :: boolean()

Checks if a user agent is a known bot.

Link to this function

hbbtv?(ua) View Source 
hbbtv?(String.t() | nil) :: false | String.t()

Checks if a user agent is a HbbTV and returns its version if so.

Link to this function

parse(ua) View Source 
parse(String.t() | nil) :: UAInspector.Result.t() | UAInspector.Result.Bot.t()

Parses a user agent.

Link to this function

parse_client(ua) View Source 
parse_client(String.t() | nil) :: UAInspector.Result.t()

Parses a user agent without checking for bots.

Link to this function

ready?() View Source 
ready?() :: boolean()

Checks if UAInspector is ready to perform lookups.

The true == ready? definition is made on the assumption that if there is at least one entry in all databases then lookups can be performed.

Checking the state is done using the currently active databases. Any potentially concurrent reload requests are not considered.

Link to this function

reload() View Source 
reload() :: :ok

Reloads all databases.

This process is done asynchronously in the background, so be aware that for some time the old data will be used for lookups.