UserAgentParser

UserAgentParser is a simple, comprehensive Ruby gem for parsing user agent strings. It uses BrowserScope's parsing patterns.

Supported Rubies

• Ruby 3.4
• Ruby 3.3
• Ruby 3.2
• Ruby 3.1
• JRuby

Installation

$ gem install user_agent_parser

Example usage

require'user_agent_parser'=>trueuser_agent=UserAgentParser.parse'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.0;)'=>#<UserAgentParser::UserAgent IE 9.0 (Windows Vista)>user_agent.to_s=>"IE 9.0"user_agent.family=>"IE"user_agent.version.to_s=>"9.0"user_agent.version.major=>"9"user_agent.version.minor=>"0"user_agent.family == "IE" && user_agent.version >= "9"=>trueoperating_system=user_agent.os=>#<UserAgentParser::OperatingSystem Windows Vista>operating_system.to_s=>"Windows Vista"# Device information can also be determined from some devicesuser_agent=UserAgentParser.parse"Mozilla/5.0 (Linux; Android 7.0; SAMSUNG SM-G930T Build/NRD90M) AppleWebKit/537.36 (KHTML, like Gecko) SamsungBrowser/5.0 Chrome/51.0.2704.106 Mobile Safari/537.36"=>#<UserAgentParser::UserAgent Samsung Internet 5.0 (Android 7.0) (Samsung SM-G930T)>user_agent.device.family=>"Samsung SM-G930T"user_agent.device.brand=>"Samsung"user_agent.device.model=>"SM-G930T"user_agent=UserAgentParser.parse"Mozilla/5.0 (iPad; CPU OS 10_2_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) GSA/23.1.148956103 Mobile/14D27 Safari/600.1.4"=>#<UserAgentParser::UserAgent Mobile Safari 10.2.1 (iOS 10.2.1) (iPad)>irb(main):026:0> user_agent.device.family=>"iPad"irb(main):027:0> user_agent.device.brand=>"Apple"irb(main):028:0> user_agent.device.model=>"iPad"# The parser database will be loaded and parsed on every call to# UserAgentParser.parse. To avoid this, instantiate your own Parser instance.parser=UserAgentParser::Parser.newparser.parse'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.0;)'=>#<UserAgentParser::UserAgent IE 9.0 (Windows Vista)>parser.parse'Opera/9.80 (Windows NT 5.1; U; ru) Presto/2.5.24 Version/10.53'=>#<UserAgentParser::UserAgent Opera 10.53 (Windows XP)>

In a larger application, you could store a parser in a global to avoid repeat pattern loading:

moduleMyApplication# Instantiate the parser on load as it's quite expensiveUSER_AGENT_PARSER=UserAgentParser::Parser.newdefself.user_agent_parserUSER_AGENT_PARSERendend

The pattern database

The ua-parser database is included via a git submodule. To update the database the submodule needs to be updated and the gem re-released (pull requests for this are very welcome!).

You can also specify the path to your own, updated and/or customised regexes.yaml file as a second argument to UserAgentParser.parse:

UserAgentParser.parse(ua_string,patterns_path: '/some/path/to/regexes.yaml')

or when instantiating a UserAgentParser::Parser:

UserAgentParser::Parser.new(patterns_path: '/some/path/to/regexes.yaml').parse(ua_string)

Extending the standard database is possible by providing multiple files in patterns_paths (plural) array argument:

UserAgentParser::Parser.new(patterns_paths: [UserAgentParser::DefaultPatternsPath,'/some/path/to/regexes.yaml'])

Command line tool

The gem incldes a user_agent_parser bin command which will read from standard input, parse each line and print the result, for example:

$ cat > SOME-FILE-WITH-USER-AGENTS.txt
USER_AGENT_1
USER_AGENT_2
...
$ cat SOME-FILE-WITH-USER-AGENTS.txt | user_agent_parser --format '%f %M'| distribution

See user_agent_parser -h for more information.

Contributing

1. Fork
2. Hack
3. rake test
4. Send a pull request

All accepted pull requests will earn you commit and release rights.

Releasing a new version

1. Update the version in user_agent_parser.gemspec

2. git commit user_agent_parser.gemspec with the following message format:

    Version x.x.x
   Changelog:
   * Some new feature
   * Some new bug fix
   

3. rake release

4. Create a new Github release

License

MIT