{"id":13880201,"url":"https://github.com/ua-parser/uap-ruby","last_synced_at":"2025-05-15T12:04:45.747Z","repository":{"id":37450980,"uuid":"4198247","full_name":"ua-parser/uap-ruby","owner":"ua-parser","description":"A simple, comprehensive Ruby gem for parsing user agent strings with the help of BrowserScope's UA database","archived":false,"fork":false,"pushed_at":"2024-12-11T00:48:50.000Z","size":229,"stargazers_count":257,"open_issues_count":7,"forks_count":42,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-08T09:40:53.170Z","etag":null,"topics":["browserscope","parse","ruby","useragent","useragentparser"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ua-parser.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2012-05-02T00:59:14.000Z","updated_at":"2025-04-13T15:20:40.000Z","dependencies_parsed_at":"2023-02-16T22:45:24.450Z","dependency_job_id":"d33f9faf-9bef-4707-b8bf-08848588f837","html_url":"https://github.com/ua-parser/uap-ruby","commit_stats":{"total_commits":217,"total_committers":26,"mean_commits":8.346153846153847,"dds":0.7649769585253456,"last_synced_commit":"3ad9cd7987e602cdf13531870c5ca8d2b7e03109"},"previous_names":["toolmantim/user_agent_parser"],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ua-parser%2Fuap-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ua-parser%2Fuap-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ua-parser%2Fuap-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ua-parser%2Fuap-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ua-parser","download_url":"https://codeload.github.com/ua-parser/uap-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253866006,"owners_count":21976020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browserscope","parse","ruby","useragent","useragentparser"],"created_at":"2024-08-06T08:02:51.773Z","updated_at":"2025-05-15T12:04:45.697Z","avatar_url":"https://github.com/ua-parser.png","language":"Ruby","readme":"# UserAgentParser [![Build Status](https://github.com/ua-parser/uap-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/ua-parser/uap-ruby/actions/workflows/ci.yml) [![Coverage Status](https://coveralls.io/repos/github/ua-parser/uap-ruby/badge.svg)](https://coveralls.io/github/ua-parser/uap-ruby)\n\nUserAgentParser is a simple, comprehensive Ruby gem for parsing user agent strings. It uses [BrowserScope](http://www.browserscope.org/)'s [parsing patterns](https://github.com/ua-parser/uap-core).\n\n## Supported Rubies\n\n* Ruby 3.2\n* Ruby 3.1\n* Ruby 3.0\n* JRuby\n\n## Installation\n\n```bash\n$ gem install user_agent_parser\n```\n\n## Example usage\n\n```ruby\nrequire 'user_agent_parser'\n=\u003e true\nuser_agent = UserAgentParser.parse 'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.0;)'\n=\u003e #\u003cUserAgentParser::UserAgent IE 9.0 (Windows Vista)\u003e\nuser_agent.to_s\n=\u003e \"IE 9.0\"\nuser_agent.family\n=\u003e \"IE\"\nuser_agent.version.to_s\n=\u003e \"9.0\"\nuser_agent.version.major\n=\u003e \"9\"\nuser_agent.version.minor\n=\u003e \"0\"\nuser_agent.family == \"IE\" \u0026\u0026 user_agent.version \u003e= \"9\"\n=\u003e true\noperating_system = user_agent.os\n=\u003e #\u003cUserAgentParser::OperatingSystem Windows Vista\u003e\noperating_system.to_s\n=\u003e \"Windows Vista\"\n\n# Device information can also be determined from some devices\nuser_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\"\n=\u003e #\u003cUserAgentParser::UserAgent Samsung Internet 5.0 (Android 7.0) (Samsung SM-G930T)\u003e\nuser_agent.device.family\n=\u003e \"Samsung SM-G930T\"\nuser_agent.device.brand\n=\u003e \"Samsung\"\nuser_agent.device.model\n=\u003e \"SM-G930T\"\n\nuser_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\"\n=\u003e #\u003cUserAgentParser::UserAgent Mobile Safari 10.2.1 (iOS 10.2.1) (iPad)\u003e\nirb(main):026:0\u003e user_agent.device.family\n=\u003e \"iPad\"\nirb(main):027:0\u003e user_agent.device.brand\n=\u003e \"Apple\"\nirb(main):028:0\u003e user_agent.device.model\n=\u003e \"iPad\"\n\n\n# The parser database will be loaded and parsed on every call to\n# UserAgentParser.parse. To avoid this, instantiate your own Parser instance.\nparser = UserAgentParser::Parser.new\nparser.parse 'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.0;)'\n=\u003e #\u003cUserAgentParser::UserAgent IE 9.0 (Windows Vista)\u003e\nparser.parse 'Opera/9.80 (Windows NT 5.1; U; ru) Presto/2.5.24 Version/10.53'\n=\u003e #\u003cUserAgentParser::UserAgent Opera 10.53 (Windows XP)\u003e\n```\n\nIn a larger application, you could store a parser in a global to avoid repeat pattern loading:\n\n```ruby\nmodule MyApplication\n\n  # Instantiate the parser on load as it's quite expensive\n  USER_AGENT_PARSER = UserAgentParser::Parser.new\n\n  def self.user_agent_parser\n    USER_AGENT_PARSER\n  end\n\nend\n```\n\n## The pattern database\n\nThe [ua-parser database](https://github.com/ua-parser/uap-core/blob/master/regexes.yaml) is included via a [git submodule](http://help.github.com/submodules/). To update the database the submodule needs to be updated and the gem re-released (pull requests for this are very welcome!).\n\nYou can also specify the path to your own, updated and/or customised `regexes.yaml` file as a second argument to `UserAgentParser.parse`:\n\n```ruby\nUserAgentParser.parse(ua_string, patterns_path: '/some/path/to/regexes.yaml')\n```\n\nor when instantiating a `UserAgentParser::Parser`:\n\n```ruby\nUserAgentParser::Parser.new(patterns_path: '/some/path/to/regexes.yaml').parse(ua_string)\n```\n\nExtending the standard database is possible by providing multiple files in `patterns_paths` (plural) array argument:\n```ruby\nUserAgentParser::Parser.new(patterns_paths: [UserAgentParser::DefaultPatternsPath, '/some/path/to/regexes.yaml'])\n```\n\n## Command line tool\n\nThe gem incldes a `user_agent_parser` bin command which will read from\nstandard input, parse each line and print the result, for example:\n\n```bash\n$ cat \u003e SOME-FILE-WITH-USER-AGENTS.txt\nUSER_AGENT_1\nUSER_AGENT_2\n...\n$ cat SOME-FILE-WITH-USER-AGENTS.txt | user_agent_parser --format '%f %M' | distribution\n```\n\nSee `user_agent_parser -h` for more information.\n\n## Contributing\n\n1. Fork\n2. Hack\n3. `rake test`\n4. Send a pull request\n\nAll accepted pull requests will earn you commit and release rights.\n\n## Releasing a new version\n\n1. Update the version in `user_agent_parser.gemspec`\n2. `git commit user_agent_parser.gemspec` with the following message format:\n\n        Version x.x.x\n\n        Changelog:\n        * Some new feature\n        * Some new bug fix\n3. `rake release`\n4. Create a [new Github release](https://github.com/ua-parser/uap-ruby/releases/new)\n\n## License\n\nMIT\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fua-parser%2Fuap-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fua-parser%2Fuap-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fua-parser%2Fuap-ruby/lists"}