search

ua-parser / uap-scala

Scala port of ua-parser
Do What The F*ck You Want To Public License
98 stars 49 forks source link

readme

uap-scala

Codecov status Maven Central

A Scala user-agent string parser based on ua-parser/uap-core. It extracts browser, OS and device information.

Usage

To use this library in your own project, add the following dependency in build.sbt:

libraryDependencies += "org.uaparser" %% "uap-scala" % "0.16.0"

Note about these examples

Instantiating Parser.default also instantiates secondary classes and reads in YAML files. This is slow. If performance is critical or you are handling user agents in real time, be sure not to do this on the critical path for processing requests.

Retrieve data on a user-agent string

import org.uaparser.scala.Parser

val ua = "Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3"
val client = Parser.default.parse(ua) // you can also use CachingParser
println(client) // Client(UserAgent(Mobile Safari,Some(5),Some(1),None),OS(iOS,Some(5),Some(1),Some(1),None),Device(iPhone))

Extract partial data from user-agent string

The time costs of parsing all the data may be high. To reduce the costs, we can just parse partial data.

import org.uaparser.scala.Parser

val raw = "Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3"
val parser = Parser.default

val os = parser.osParser.parse(raw)
println(os) // OS(iOS,Some(5),Some(1),Some(1),None)

val userAgent = parser.userAgentParser.parse(raw)
println(userAgent) // UserAgent(Mobile Safari,Some(5),Some(1),None)

val device = parser.deviceParser.parse(raw)
println(device) // Device(iPhone,Some(Apple),Some(iPhone))

Development

The code for this repository can be checked out normally. It uses a git submodule to include the files needed from uap-core so care must be taken to make sure the core directory is properly checked out and initialized.

Checking out the repo for the first time

git clone --recursive https://github.com/ua-parser/uap-scala.git

If uap-scala was checked out and core was not properly initialized, the following can be done

cd uap-scala
git submodule update --init --recursive

Build

To build and publish locally for the default Scala (currently 2.13.11):

sbt publishLocal

To cross-build for different Scala versions:

sbt +publishLocal

Maintainers