browser 2.7.1 → 5.3.1

data/README.md

@@ -1,8 +1,7 @@
 # Browser
 
-[![Travis-CI](https://travis-ci.org/fnando/browser.svg)](https://travis-ci.org/fnando/browser)
+[![Tests](https://github.com/fnando/browser/workflows/Tests/badge.svg)](https://github.com/fnando/browser)
 [![Code Climate](https://codeclimate.com/github/fnando/browser/badges/gpa.svg)](https://codeclimate.com/github/fnando/browser)
-[![Test Coverage](https://codeclimate.com/github/fnando/browser/badges/coverage.svg)](https://codeclimate.com/github/fnando/browser/coverage)
 [![Gem](https://img.shields.io/gem/v/browser.svg)](https://rubygems.org/gems/browser)
 [![Gem](https://img.shields.io/gem/dt/browser.svg)](https://rubygems.org/gems/browser)
 
@@ -25,6 +24,7 @@ browser = Browser.new("Some User Agent", accept_language: "en-us")
 browser.bot?
 browser.chrome?
 browser.core_media?
+browser.duck_duck_go?
 browser.edge?                # Newest MS browser
 browser.electron?            # Electron Framework
 browser.firefox?
@@ -33,8 +33,8 @@ browser.ie?
 browser.ie?(6)               # detect specific IE version
 browser.ie?([">8", "<10"])   # detect specific IE (IE9).
 browser.known?               # has the browser been successfully detected?
+browser.unknown?             # the browser wasn't detected.
 browser.meta                 # an array with several attributes
-browser.modern?              # Webkit, Firefox 17+, IE 9+ and Opera 12+
 browser.name                 # readable browser name
 browser.nokia?
 browser.opera?
@@ -43,6 +43,7 @@ browser.phantom_js?
 browser.quicktime?
 browser.safari?
 browser.safari_webapp_mode?
+browser.samsung_browser?
 browser.to_s            # the meta info joined by space
 browser.uc_browser?
 browser.version         # major version number
@@ -50,20 +51,24 @@ browser.webkit?
 browser.webkit_full_version
 browser.yandex?
 browser.wechat?
+browser.qq?
 browser.weibo?
 browser.yandex?
 browser.sputnik?
+browser.sougou_browser?
 
 # Get bot info
 browser.bot.name
 browser.bot.search_engine?
 browser.bot?
-Browser::Bot.why?(ua) # shows which user agent was the offender
+browser.bot.why? # shows which matcher detected this user agent as a bot.
+Browser::Bot.why?(ua)
 
 # Get device info
 browser.device
 browser.device.id
 browser.device.name
+browser.device.unknown?
 browser.device.blackberry_playbook?
 browser.device.console?
 browser.device.ipad?
@@ -84,6 +89,7 @@ browser.device.tv?
 browser.device.vita?
 browser.device.wii?
 browser.device.wiiu?
+browser.device.samsung?
 browser.device.switch?
 browser.device.xbox?
 browser.device.xbox_360?
@@ -109,7 +115,7 @@ browser.platform.ios_app?     # detect webview in an iOS app
 browser.platform.ios_webview? # alias for ios_app?
 browser.platform.linux?
 browser.platform.mac?
-browser.platform.other?
+browser.platform.unknown?
 browser.platform.windows10?
 browser.platform.windows7?
 browser.platform.windows8?
@@ -124,11 +130,14 @@ browser.platform.windows_wow64?
 browser.platform.windows_x64?
 browser.platform.windows_x64_inclusive?
 browser.platform.windows_xp?
+browser.platform.kai_os?
 ```
 
 ### Aliases
 
-To add aliases like `mobile?` and `tablet?` to the base object (e.g `browser.mobile?`), require the `browser/aliases` file and extend the Browser::Base object like the following:
+To add aliases like `mobile?` and `tablet?` to the base object (e.g
+`browser.mobile?`), require the `browser/aliases` file and extend the
+Browser::Base object like the following:
 
 ```ruby
 require "browser/aliases"
@@ -140,27 +149,35 @@ browser.mobile? #=> false
 
 ### What's being detected?
 
-- For a list of platform detections, check [lib/browser/platform.rb](https://github.com/fnando/browser/blob/master/lib/browser/platform.rb)
-- For a list of device detections, check [lib/browser/device.rb](https://github.com/fnando/browser/blob/master/lib/browser/device.rb)
-- For a list of bot detections, check [bots.yml](https://github.com/fnando/browser/blob/master/bots.yml)
+- For a list of platform detections, check
+  [lib/browser/platform.rb](https://github.com/fnando/browser/blob/master/lib/browser/platform.rb)
+- For a list of device detections, check
+  [lib/browser/device.rb](https://github.com/fnando/browser/blob/master/lib/browser/device.rb)
+- For a list of bot detections, check
+  [bots.yml](https://github.com/fnando/browser/blob/master/bots.yml)
 
-### What defines a modern browser?
+### Detecting modern browsers
 
-The current rules that define a modern browser are pretty loose:
-
-* Webkit
-* IE9+
-* Microsoft Edge
-* Firefox 17+
-* Firefox Tablet 14+
-* Opera 12+
-
-You can define your own rules. A rule must be a proc/lambda or any object that implements the method === and accepts the browser object. To redefine all rules, clear the existing rules before adding your own.
+To detect whether a browser can be considered as modern or not, create a method
+that abstracts your versioning constraints. The following example will consider
+any of the following browsers as a modern:
 
 ```ruby
-# Only Chrome Canary is considered modern.
-Browser.modern_rules.clear
-Browser.modern_rules << -> b { b.chrome? && b.version.to_i >= 37 }
+# Expects an Browser instance,
+# like in `Browser.new(user_agent, accept_language: language)`.
+def modern_browser?(browser)
+  [
+    browser.chrome?(">= 65"),
+    browser.safari?(">= 10"),
+    browser.firefox?(">= 52"),
+    browser.ie?(">= 11") && !browser.compatibility_view?,
+    browser.edge?(">= 15"),
+    browser.opera?(">= 50"),
+    browser.facebook?
+      && browser.safari_webapp_mode?
+      && browser.webkit_full_version.to_i >= 602
+  ].any?
+end
 ```
 
 ### Rails integration
@@ -171,7 +188,8 @@ Just add it to the Gemfile.
 gem "browser"
 ```
 
-This adds a helper method called `browser`, that inspects your current user agent.
+This adds a helper method called `browser`, that inspects your current user
+agent.
 
 ```erb
 <% if browser.ie?(6) %>
@@ -179,7 +197,8 @@ This adds a helper method called `browser`, that inspects your current user agen
 <% end %>
 ```
 
-If you want to use Browser on your Rails app but don't want to taint your controller, use the following line on your Gemfile:
+If you want to use Browser on your Rails app but don't want to taint your
+controller, use the following line on your Gemfile:
 
 ```ruby
 gem "browser", require: "browser/browser"
@@ -187,7 +206,8 @@ gem "browser", require: "browser/browser"
 
 ### Accept Language
 
-Parses the accept-language header from an HTTP request and produces an array of language objects sorted by quality.
+Parses the accept-language header from an HTTP request and produces an array of
+language objects sorted by quality.
 
 ```ruby
 browser = Browser.new("Some User Agent", accept_language: "en-us")
@@ -213,16 +233,22 @@ language.name
 #=> "English/United States"
 ```
 
-Result is always sorted in quality order from highest -> lowest. As per the HTTP spec:
+Result is always sorted in quality order from highest to lowest. As per the HTTP
+spec:
 
 - omitting the quality value implies 1.0.
 - quality value equal to zero means that is not accepted by the client.
 
 ### Internet Explorer
 
-Internet Explorer has a compatibility view mode that allows newer versions (IE8+) to run as an older version. Browser will always return the navigator version, ignoring the compatibility view version, when defined. If you need to get the engine's version, you have to use `Browser#msie_version` and `Browser#msie_full_version`.
+Internet Explorer has a compatibility view mode that allows newer versions
+(IE8+) to run as an older version. Browser will always return the navigator
+version, ignoring the compatibility view version, when defined. If you need to
+get the engine's version, you have to use `Browser#msie_version` and
+`Browser#msie_full_version`.
 
-So, let's say an user activates compatibility view in a IE11 browser. This is what you'll get:
+So, let's say an user activates compatibility view in a IE11 browser. This is
+what you'll get:
 
 ```ruby
 browser.version
@@ -239,16 +265,16 @@ browser.msie_full_version
 
 browser.compatibility_view?
 #=> true
-
-browser.modern?
-#=> false
 ```
 
-This behavior changed in `v1.0.0`; previously there wasn't a way of getting the real browser version.
+This behavior changed in `v1.0.0`; previously there wasn't a way of getting the
+real browser version.
 
 ### Safari
 
-iOS webviews and web apps aren't detected as Safari anymore, so be aware of that if that's your case. You can use a combination of platform and webkit detection to do whatever you want.
+iOS webviews and web apps aren't detected as Safari anymore, so be aware of that
+if that's your case. You can use a combination of platform and webkit detection
+to do whatever you want.
 
 ```ruby
 # iPad's Safari running as web app mode.
@@ -266,62 +292,78 @@ browser.platform.ios?
 
 ### Bots
 
-Browser used to detect empty user agents as bots, but this behavior has changed. If you want to bring this detection back, you can activate it through the following call:
+The bot detection is quite aggressive. Anything that matches at least one of the
+following requirements will be considered a bot.
+
+- Empty user agent string
+- User agent that matches `/crawl|fetch|search|monitoring|spider|bot/`
+- Any known bot listed under
+  [bots.yml](https://github.com/fnando/browser/blob/master/bots.yml)
+
+To add custom matchers, you can add a callable object to
+`Browser::Bot.matchers`. The following example matches everything that has a
+`externalhit` substring on it. The bot name will always be `General Bot`.
 
 ```ruby
-Browser::Bot.detect_empty_ua!
+Browser::Bot.matchers << ->(ua, _browser) { ua.match?(/externalhit/i) }
 ```
 
-### Middleware
+To clear all matchers, including the ones that are bundled, use
+`Browser::Bot.matchers.clear`. You can re-add built-in matchers by doing the
+following:
 
-You can use the `Browser::Middleware` to redirect user agents.
+```ruby
+Browser::Bot.matchers += Browser::Bot.default_matchers
+```
+
+To restore v2's bot detection, remove the following matchers:
 
 ```ruby
-use Browser::Middleware do
-  redirect_to "/upgrade" unless browser.modern?
-end
+Browser::Bot.matchers.delete(Browser::Bot::KeywordMatcher)
+Browser::Bot.matchers.delete(Browser::Bot::EmptyUserAgentMatcher)
 ```
 
-If you're using Rails, you can use the route helper methods. Just add something like the following to a initializer file (`config/initializers/browser.rb`).
+### Middleware
+
+You can use the `Browser::Middleware` to redirect user agents.
 
 ```ruby
-Rails.configuration.middleware.use Browser::Middleware do
-  redirect_to upgrade_path unless browser.modern?
+use Browser::Middleware do
+  redirect_to "/upgrade" if browser.ie?
 end
 ```
 
-Notice that you can have multiple conditionals.
+If you're using Rails, you can use the route helper methods. Just add something
+like the following to a initializer file (`config/initializers/browser.rb`).
 
 ```ruby
 Rails.configuration.middleware.use Browser::Middleware do
-  next if browser.bot.search_engine?
-  redirect_to upgrade_path(browser: "oldie") if browser.ie? && !browser.modern?
-  redirect_to upgrade_path(browser: "oldfx") if browser.firefox? && !browser.modern?
+  redirect_to upgrade_path if browser.ie?
 end
 ```
 
-If you need access to the `Rack::Request` object (e.g. to exclude a path), you can do so with `request`.
+If you need access to the `Rack::Request` object (e.g. to exclude a path), you
+can do so with `request`.
 
 ```ruby
 Rails.configuration.middleware.use Browser::Middleware do
-  redirect_to upgrade_path unless browser.modern? || request.env["PATH_INFO"] == "/exclude_me"
+  redirect_to upgrade_path if browser.ie? && request.env["PATH_INFO"] != "/exclude_me"
 end
 ```
 
-### Migrating to v2
-
-#### Troubleshooting
-
-##### `TypeError: no implicit conversion of Hash into String`
+### Restrictions
 
-The class constructor now has a different signature. Change the instantiation from `Browser.new(options)` to `Browser.new(ua, options)`, where:
+- User agent has a size limit of 2048 bytes. This can be customized through
+  `Browser.user_agent_size_limit=(size)`.
+- Accept-Language has a size limit of 2048 bytes. This can be customized through
+  `Browser.accept_language_size_limit=(size)`.
 
-- `ua`: must be a string representing the user agent.
-- `options`: must be a hash (for now it only accepts the `accept_language` option).
+If size is not respected, then `Browser::Error` is raised.
 
-##### `NoMethodError: undefined method 'user_agent'`
-
-`.ua` can now be used to retrieve the full User Agent string.
+```ruby
+Browser.user_agent_size_limit = 4096
+Browser.accept_language_size_limit = 4096
+```
 
 ## Development
 
@@ -339,25 +381,28 @@ Once you've made your great commits (include tests, please):
 4. Create a pull request
 5. That's it!
 
-Please respect the indentation rules and code style.
-And use 2 spaces, not tabs. And don't touch the version thing.
+Please respect the indentation rules and code style. And use 2 spaces, not tabs.
+And don't touch the version thing.
 
 ## Configuring environment
 
-To configure your environment, you must have Ruby and bundler installed. Then run `bundle install` to install all dependencies.
+To configure your environment, you must have Ruby and bundler installed. Then
+run `bundle install` to install all dependencies.
 
 To run tests, execute `./bin/rake`.
 
 ### Adding new features
 
-Before using your time to code a new feature, open a ticket asking if it makes sense and if it's on this project's scope.
+Before using your time to code a new feature, open a ticket asking if it makes
+sense and if it's on this project's scope.
 
 Don't forget to add a new entry to `CHANGELOG.md`.
 
 #### Adding a new bot
 
 1. Add the user agent to `test/ua_bots.yml`.
-2. Add the readable name to `bots.yml`. The key must be something that matches the user agent, in lowercased text.
+2. Add the readable name to `bots.yml`. The key must be something that matches
+   the user agent, in lowercased text.
 3. Run tests.
 
 Don't forget to add a new entry to `CHANGELOG.md`.
@@ -366,42 +411,43 @@ Don't forget to add a new entry to `CHANGELOG.md`.
 
 1. Add the user agent to `test/ua_search_engines.yml`.
 2. Add the same user agent to `test/ua_bots.yml`.
-3. Add the readable name to `search_engines.yml`. The key must be something that matches the user agent, in lowercased text.
+3. Add the readable name to `search_engines.yml`. The key must be something that
+   matches the user agent, in lowercased text.
 4. Run tests.
 
 Don't forget to add a new entry to `CHANGELOG.md`.
 
 #### Wrong browser/platform/device detection
 
-If you know how to fix it, follow the "Writing code" above. Open an issue otherwise; make sure you fill in the issue template with all the required information.
+If you know how to fix it, follow the "Writing code" above. Open an issue
+otherwise; make sure you fill in the issue template with all the required
+information.
 
 ## Maintainer
 
-* Nando Vieira - http://nandovieira.com
+- Nando Vieira - http://nandovieira.com
 
 ## Contributors
 
-* https://github.com/fnando/browser/contributors
+- https://github.com/fnando/browser/contributors
 
 ## License
 
 (The MIT License)
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -16,7 +16,14 @@ end
 require "rubocop/rake_task"
 desc "Run rubocop"
 task :rubocop do
-  RuboCop::RakeTask.new
+  RuboCop::RakeTask.new do |t|
+    t.options += %w[
+      --display-style-guide
+      --display-cop-names
+      --extra-details
+      --auto-correct
+    ]
+  end
 end
 
 desc "Run specs against all gemfiles"

data/bot_exceptions.yml

@@ -1,3 +1,4 @@
+---
 - ruby build
 - pinterest/android
 - pinterest/ios