GoodAnalytics.Devices (GoodAnalytics v0.1.1)

Copy Markdown View Source

User-agent intelligence for GoodAnalytics, wrapping :ua_inspector.

The single owner of UAInspector access in the library. Pure functions — no Ecto, no side effects:

  • parse/1 — normalize a user agent into a storable device map
  • label/1 — humanize a UA string or a stored device map
  • humanize_type/1 — collapse a raw device type into a coarse bucket
  • bot?/1 — crawler predicate

parse/1 stores raw :ua_inspector field values (names + versions); consumers group/humanize via label/1 and humanize_type/1.

Summary

Types

device_map()

Functions

bot?(ua)

True when the user agent is a known crawler/bot. Tolerates blanks.

humanize_type(type)

Collapse a raw :ua_inspector device type into a coarse breakdown bucket.

label(ua)

Humanize a UA string or a stored device map into a short label.

parse(ua)

Normalize a user agent into a device map. Empty map when blank/unknown.

to_event_attrs(device)

Maps a parse/1 device map onto event-grain column attrs.

Types

device_map()

@type device_map() :: %{optional(String.t()) => String.t()}

Functions

bot?(ua)

@spec bot?(String.t() | nil) :: boolean()

True when the user agent is a known crawler/bot. Tolerates blanks.

humanize_type(type)

@spec humanize_type(String.t() | nil) :: String.t()

Collapse a raw :ua_inspector device type into a coarse breakdown bucket.

label(ua)

@spec label(String.t() | map() | nil) :: String.t()

Humanize a UA string or a stored device map into a short label.

parse(ua)

@spec parse(String.t() | nil) :: device_map()

Normalize a user agent into a device map. Empty map when blank/unknown.

to_event_attrs(device)

@spec to_event_attrs(device_map() | nil) :: %{optional(atom()) => String.t()}

Maps a parse/1 device map onto event-grain column attrs.

Keys absent from the device map are omitted so the Event changeset leaves the corresponding column NULL. The raw :ua_inspector device type is stored verbatim (humanize_type/1 is applied at read time, not here). For bots, device_type is "bot" and bot_name carries the crawler name.