browserino 2.5.4 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e08c3808d746044e878ba7737b86d38b65e1c76a
-  data.tar.gz: 3eff20f91f4768ecd53ff13dc1678b0ee2bb7573
+  metadata.gz: 65c289d5a5a9bb3ee5e43234561564fa822bf171
+  data.tar.gz: 9cf47123d4f1a3c63dbee10faa9a66cff2a60052
 SHA512:
-  metadata.gz: 806f7ea91c5ada6d329bc371d2f3fcddc1876ceb1210479b2b875f86ddaab5961f16e1006599eabdd503a1ff3aee9e190d9c376c5f765dbae994bea8b23a1b85
-  data.tar.gz: a07a4116f54d82fd693535f9b0a876fe10d8ad4bbd31c1a0a537f0b3a50a15353340da04a9d74f9af9c13ec8401745d7db2385305b3e5253c505b77b7ad0ba3f
+  metadata.gz: 0235e781e44e41a482e742c25df79b4d3fe007fbfe8b3c346e708634b31fd7af619458329cb0e918c84e3386313ef1ee3ff921a051f25695ddc5c11a7cf75dc1
+  data.tar.gz: 290781a005d1f0d2b9b1d3e23568787e1ea6f8770b33c65ec0b8a05f98b9fe466eb2daf4e6fd742bd38786686a89c078a5524056fb6e7643ebfa6a77649c09da

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## CHANGELOG
-_dates are in dd-mm-yyyy format_  
+_dates are in dd-mm-yyyy format_
+
+#### 15-01-2016 VERSION 2.5.2
+
+- **DEPRECATE** Custom return values (passed through `Browserino.parse`) will no longer alter the output of the agent object
+- Added support for windows phone detection
+- Added `windows_phone?` method
 
 #### 12-01-2016 VERSION 2.5.1
 

data/README.md

@@ -1,14 +1,39 @@
 # Browserino
 
+A UserAgent sniffer with Rails >= 3.2.0 integration
+
+## Status
+
 [![Gem Version](https://badge.fury.io/rb/browserino.svg)](http://badge.fury.io/rb/browserino)
 [![Build Status](https://travis-ci.org/SidOfc/browserino.svg?branch=master)](https://travis-ci.org/SidOfc/browserino)
 [![Coverage Status](https://coveralls.io/repos/SidOfc/browserino/badge.svg?branch=master&service=github)](https://coveralls.io/github/SidOfc/browserino?branch=master)
 
-This gem aims to provide information about the browser that your visitor is using, it's main goal is not to let you exclude any browser from partying on your website (e.g. sniffing) but to provide you with more flexibility towards designing maybe a browser-themed website or knowledge of what your visitors are using to check out your website!
-
 ## Changelog
+
 _dates are in dd-mm-yyyy format_  
-_older changes can be found in the [CHANGELOG.md](https://github.com/SidOfc/browserino/blob/master/CHANGELOG.md)_
+_older changes can be found in the [CHANGELOG.md](/CHANGELOG.md)_
+
+#### 22-01-2016 VERSION 2.6.0
+
+- Fixed `to_a` method
+- Fixed `to_s` method
+- Removed **bot** suffixes from every bot name
+  - Replaced `googlebot?` with `google?`
+  - Replaced `msnbot?` with `msn?`
+  - Replaced `bingbot?` with `bing?`
+  - Replaced `yandexbot?` with `yandex?`
+  - Replaced `exabot?` with `exa?`
+- Added `platform?` method
+- Added `browser?` method
+- Added `social_media?` method
+- Added `facebook?` and `fb?` methods
+- Added `twitter?` method
+- Added `linkedin?` method
+- Added `instagram?` method
+- Added `pinterest?` method
+- Added `tumblr?` method
+- Added support for the Brave browser and the `brave?` method
+- Added `ff?` method
 
 #### 20-01-2016 VERSION 2.5.4
 
@@ -19,16 +44,9 @@ _older changes can be found in the [CHANGELOG.md](https://github.com/SidOfc/brow
 
 - Minor refactoring of code
 
-#### 15-01-2016 VERSION 2.5.2
-
-- **DEPRECATE** Custom return values (passed through `Browserino.parse`) will no longer alter the output of the agent object
-- Added support for windows phone detection
-- Added `windows_phone?` method
-
 ## Installation
 
-*supports ruby 1.9.3+*  
-Add this line to your application's Gemfile:
+Add the following to your applications Gemfile:
 
 ```ruby
 gem 'browserino'
@@ -36,11 +54,23 @@ gem 'browserino'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
+
+Or install it yourself with:
+
+```
+$ gem install browserino
+```
 
-Or install it yourself as:
+Browserino is tested with the following ruby versions
 
-    $ gem install browserino
+* 1.9.3
+* 2.0.0
+* 2.1.0
+* 2.2.1
+* 2.3.0
 
 ## Usage
 
@@ -49,413 +79,451 @@ After installing the gem globally or in your application you'll have to `require
 ```ruby
 require 'browserino'
 ```
-
-Afterwards you can simply call
+Afterwards, the gem is loaded and you can proceed by calling:
 
 ```ruby
-Browserino.parse('<user agent>')
+Browserino.parse '<user agent>'
 ```
 
-Or if you're using Rails *(>= 3.2.0)*, in your controllers you'll have access to an `agent` object
+### Rails (>= 3.2.0)
+
+If you're using Rails (>= 3.2.0) you'll have access to an `agent` object. Browserino will initialize itself using the `request.headers['User-Agent']`
+
 
+A quick example on how to get going:
 ```ruby
-class HomeController < ApplicationController
-  def index
+class ApplicationController < ActionController::Base
+  def some_method
     render json: agent
   end
 end
 ```
 
-The return value will always be `nil` if a value isn't found
+### General
 
-`Browserino.parse()` will return a `Browserino::Agent` object containing all the information parsed out of the supplied user agent.
-On this object there are a few method calls you can do to retrieve information.
+the `parse` method will **always** return a `Browserino::Agent` object.
 
 ```ruby
-require 'browserino'
+Browserino.parse '<user agent>' # => #<Browserino::Agent:0x007f9b09b1fae8 ... >
+```
+
+### Default return values
+
+If a property isn't available or not known to Browserino it's return value will always be `nil`, this can be tested by supplying an empty string (`''`) to `parse`:
+
+```ruby
+agent = Browserino.parse ''
+agent.browser_name
+# => nil
+```
 
-agent = Browserino.parse('user-agent')
+If a value *is* found then you'll recieve a *lowercase string* containing the information:
+
+```ruby
+agent = Browserino.parse 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/537.36 (KHTML, like Gecko) brave/0.7.7 Chrome/47.0.2526.73 Electron/0.36.2 Safari/537.36'
 
 agent.browser_name
-# => 'safari'
+# => 'brave'
 
-# always returns the real version (also with IE in compat)
 agent.browser_version
-# => '7.0.3'
-
-# if a user is running IE in compat mode this will return the compat version
-agent.browser_version compat: true
-# => '7.0'
+# => '0.7.7'
 
 agent.engine_name
 # => 'webkit'
+```
 
-agent.engine_version
-# => '537.75.14'
+Browserino also has some question methods, these will always return either `true` or `false`. The exceptions to this rule are methods that can take a name, for instance the `bot?` method:
 
-agent.system_name
-# => 'macintosh'
-# possibilities are macintosh, windows, blackberry, android, linux, bsd and ios
+```ruby
+agent = Browserino.parse ''
+agent.bot?
+# => true (empty UA's count as anonymous bots)
 
-# or optionally, the full name (guessed from OS version)
-agent.system_name full: true
-# => ['macintosh', 'mavericks']
+agent.googlebot?
+# => false
 
-agent.system_version
-# => '10.9.3'
+agent.non_supported_bot?
+# => NoMethodError
 
-agent.system_architecture
-# => 'x32'
+agent.bot? :non_supported_bot
+# => NoMethodError
+```
 
-# or through convenience methods:
-agent.x32?
-# => true
+### Functions
 
-agent.x64?
-# => false
+The samples below are all valid calls with their respective outputs, using the `agent` defined below.
 
-# get the locale, either 'aa' or 'aa-bb' format
-agent.locale
-# => 'en'
-# or if the UA supplies the information
-# => 'en-us'
+```ruby
+agent = Browserino.parse 'Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; AS; rv:11.0) like Gecko'
+```
 
+##### Quick usage
 
-# name of bot if the UA was identified as bot
-agent.bot_name
-# => 'googlebot'
+```ruby
+agent.browser_name
+# => 'ie'
 
-# returns true if the agent is a bot
-agent.bot?
-# => true
+# always returns real version, also when IE is in compat
+agent.browser_version
+# => '11.0'
 
-# returns true if the agent is the specified bot
-agent.bot? :googlebot
-# => true
+# to get the compat version that IE is running in
+# returns real version if not in compat mode
+agent.browser_version compat: true
+# => '11.0'
 
-# check IE compatibility mode
-agent.compat?
-# => true
+agent.engine_name
+# => 'trident'
 
-# true if browser_name or bot_name present
-agent.known?
-# => true
+agent.engine_version
+# => '7.0'
 
-# true if agent is a mobile device
-agent.mobile?
-# => true
+agent.system_name
+# => 'windows'
 
-# methods to convert object into a String, Array or hash
-agent.to_s
-# => 'safari safari7 webkit webkit537 macintosh macintosh10 en-us'
+# system_name attempts to find the operating systems version name
+# when full: true is used
+# returning an array with either the version name or nil if not found
+agent.system_name full: true
+# => ['windows', '7']
 
-# to_s can split version numbers from words if a seperator is supplied
-agent.to_s '-'
-# => 'safari safari-7 webkit webkit-537 macintosh macintosh-10 en-us'
+agent.system_version
+# => '6.1'
 
-agent.to_a
-# => [
-#      [:browser_name, 'safari'],
-#      [:browser_version, '7.0.3'],
-#      [:engine_name, 'webkit'],
-#      [:engine_version, '537.75.14'],
-#      [:system_name, 'macintosh'],
-#      [:system_version, '10'],
-#      [:system_architecture, nil],
-#      [:locale, nil],
-#      [:bot_name, nil]
-#    ]
+agent.system_architecture
+# => 'x64'
 
-agent.to_h
-# => {
-#      browser_name: 'safari',
-#      browser_version: '7.0.3',
-#      engine_name: 'webkit',
-#      engine_version: '537.75.14',
-#      system_name: 'macintosh',
-#      system_version: '10',
-#      system_architecture: nil,
-#      locale: nil,
-#      bot_name: nil
-#    }
+# two formats possible: 'aa' or `aa-bb`
+agent.locale
+# => 'as'
 ```
 
-It is now also possible to call methods to determine a specific OS or browser if it's supported, a `noMethodError` will be thrown otherwise
-The function uses the names of the `Browserino::Mapping` constants and the `Browserino::Core::PATTERNS` hashes `:browser` and `:bot` output to identify wether or not to throw this exception.
-Versions are also supported as an argument to the function, for operating systems versions could include a string, symbol or float / integer to indicate a version.
-_(examples given for windows, android and ios, for a full list of versions check the **maps** folder)_
-Browsers can also accept a float / integer to check for a specific version.
-
-### DEPRECATION NOTICE
-
-**Methods that include a version number in their name (`agent.android4?`) are deprecated as of version 2.0.0. Supply the version as argument instead `agent.android?(4)` or `agent.android('Ice Cream Sandwich')`**
+##### Question methods
 
-##### Supported systems
+Browserino also provides some question methods.
 
 ```ruby
-agent.android?
+# only for Internet Explorer
+agent.compat?
+# => false
 
-# check for android jellybean
-# agent.android?(:jellybean) or agent.android?('jellybean') or agent.android?(4.1)
+# returns true if browser_name or bot_name are present
+agent.known?
+# => true
 
-agent.ios?
+# returns true if browser is known
+agent.browser?
+# => true
 
-# check version of iOS (>= 1.0.0)
-# agent.ios9?
+# returns true if specific browser
+agent.browser? :ie
+# => true
 
-# check version of iOS (>= 2.0.0)
-# agent.ios?(9)
+# returns true if specific browser and version
+agent.browser? :ie, version: '11.0'
 
-agent.windows?
+# returns true if there is a social media bot on your website
+agent.social_media?
+# => false
 
-# check for windows Vista (>= 1.0.0)
-# agent.windows60?
+# returns true if platform is known
+agent.platform?
+# => true
 
-# check for windows Vista (>= 2.0.0)
-# agent.windows?(6) - based on NT version
-# agent.windows?(6.0) - based on NT version
-# agent.windows?(:vista) or agent.windows?('vista')
+# returns true if specific platform
+agent.platform? :windows
+# => true
 
-agent.macintosh?
+# returns true if specific platform and version
+agent.platform? :windows, version: '7'
+# => true
 
-agent.blackberry?
+# returns true if user agent is empty or a bot is recognized
+agent.bot?
+# => false
 
-agent.windows_phone?
+agent.x64?
+# => true
 
-agent.linux? # linux doesn't have versions
+agent.x32?
+# => false
 
-agent.bsd? # bsd also doesn't have versions
+agent.mobile?
+# => false
 ```
 
-You could also invert these questions by using the `.not` method
+The above methods are the base questions you can ask but there are a lot more methods you can call on the `agent`. Every supported browser, operating system or bot is basically a question method so you could do this:
 
 ```ruby
-agent.not.android?
-
-# check for android jellybean
-# agent.not.android?(:jelly_bean) or agent.not.android?('jelly bean') or agent.not.android?(4.1)
-
-agent.not.ios?
-
-# check if iOS version isn't 9 (>= 1.4.0)
-# agent.not.ios9?
-
-# check if iOS version isn't 9 (>= 2.0.0)
-# agent.not.ios?(9)
+agent.windows?
+# => true
 
-agent.not.windows?
+# based on full name
+agent.windows? '7'
+# => true
 
-# check if not windows vista (>= 1.4.0)
-# agent.not.windows60?
+# NT versions also work
+agent.windows? 6.1
+# => true
+```
 
-# check if not windows vista (v2.x.x)
-# agent.not.windows?(6) - based on NT version
-# agent.not.windows?(6.0) - based on NT version
-# agent.not.windows?(:vista) or agent.not.windows?('vista')
+##### Transformation
 
-agent.not.macintosh?
+Browserino implements `to_a`, `to_h` and `to_s` to allow for collected data to be moved around without attaching the entire object with methods.
 
-agent.not.blackberry?
+**to_s**
 
-agent.not.windows_phone?
+Returns a compiled string of properties based on available information.
 
-agent.not.linux?
+```ruby
+agent.to_s
+# => 'ie ie11 trident trident7 windows x64'
 
-agent.not.bsd?
+# a seperator can be passed to format the name + version combo's
+agent.to_s '-'
+# => 'ie ie-11 trident trident-7 windows x64'
 ```
 
-The `#windows?`, `#macintosh?` and `#blackberry?` each have a shortcut method to allow for easier access, `#win?`, `#osx?`, `#bb?`
-
-##### Supported browsers  
+If the agent object can't find a property in the user agent, that property will be excluded from the string.
+For instance, if the `browser_version` and `engine_version` of the `agent` object are `nil` then the following will be returned:
 
 ```ruby
-agent.vivaldi?
-
-agent.opera?
-
-agent.opera_mini?
-
-agent.bolt?
-
-agent.ucbrowser?
+agent.to_s
+# => ie trident windows x64
+```
 
-agent.maxthon?
+**to_a**
 
-agent.edge?
+Returns an array with key => value pairs.
 
-agent.ie?
+```ruby
+agent.to_a
+# => [[:browser_name, "ie"],
+#     [:browser_version, "11.0"],
+#     [:engine_name, "trident"],
+#     [:engine_version, "7.0"],
+#     [:system_name, "windows"],
+#     [:system_version, "6.1"],
+#     [:system_architecture, "x64"],
+#     [:locale, "as"],
+#     [:bot_name, nil]]
+```
 
-agent.firefox?
+**to_h**
 
-agent.chrome?
+Returns a hash with key => value pairs.
 
-agent.seamonkey?
+```ruby
+agent.to_h
+# => {:browser_name=>"ie",
+#     :browser_version=>"11.0",
+#     :engine_name=>"trident",
+#     :engine_version=>"7.0",
+#     :system_name=>"windows",
+#     :system_version=>"6.1",
+#     :system_architecture=>"x64",
+#     :locale=>"as",
+#     :bot_name=>nil}
+```
 
-agent.safari?
+##### Supplying versions
 
-# or with the .not method (>= 1.4.0)
-agent.not.vivaldi?
+Consider this parsed string:
 
-agent.not.opera?
+```ruby
+agent = Browserino.parse 'Mozilla/5.0 (Linux; U; Android 4.1.2; en-us; SM-T210R Build/JZO54K) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Safari/534.30 UCBrowser/2.3.2.300'
 
-agent.not.maxthon?
+# output for system_name
+agent.system_name
+# => 'android'
 
-# etc etc...
+# output for system_name full: true
+agent.system_name full: true
+# => ['android', 'Jelly Bean 16']
 ```
 
-##### Supported bots
-```ruby
-agent.msnbot?
-
-agent.yahoo_slurp?
-
-agent.googlebot?
+When supplying a version to a method that supports it, you have multiple options for the format of that version.
 
-agent.bingbot?
+* Using a symbol or string without version: `:jelly_bean` or `'jelly_bean'`
+* Using a symbol or string with version: `:jelly_bean_16` or `'jelly_bean_16'`
+* Using a string: `'4.1.2'`  
+* Using a float: `4.1`
+* Using an int: `4`
 
-agent.baiduspider?
+When calling the `platform?` or `android?` functions with the above examples, they would all match since the method that compares versions also checks how specific the version is that you want to compare against.
 
-agent.yandexbot?
+If you pass in `4.1` as a version the matcher will look for `x.x` in the extracted version and discard the unspecified value, this allows for you to be explicitly less specific to allow for a greater range of systems to be matched.
 
-agent.sosospider?
+* `4.1.2` will match `4.1.2`
+* `4.1` will match `4.1.x`
+* `4` will match `4.x.x`
 
-agent.exabot?
+**Examples using `platform?`**
 
-agent.sogou_spider?
+```ruby
+agent.platform? :android, version: '4.1.2'
+# => true
 
-# or with the .not method (>= v1.4.0)
+agent.platform? :android, version: 4.1
+# => true
 
-agent.not.msnbot?
+agent.platform? :android, version: 4
+# => true
 
-agent.not.yahoo_slurp?
+agent.platform? :android, version: :jelly_bean
+# => true
 
-# etc etc...
+agent.platform? :android, version: :jelly_bean_16
+# => true
 ```
 
-## Development
-
-The tests are dynamically produced and quite easy to write.
+##### `platform?`, `browser?`, `bot?` and `social_media?` methods
 
-The __/spec/user_agents_browsers.rb__ and __/spec/user_agents_bots.rb__ actually contain the test cases for both browsers and bots respectively, here you can see how they are setup and all you simply have to do is read the UA yourself and fill in the correct information for the test to run.
-the tests will lowercase most of the input to make sure there's no case mismatches, this happens mainly on the `*_name` properties
+As you've seen above, the `platform?` function can take two arguments, a symbol with the system name and optionally a hash with a `:version` key to supply a version, the `browser?` method works in exactly the same way.
 
-If I wanted to add a test case for a different browser for instance (just picking a random FF on windows that is already in the tests)
-
-```ruby
-module UserAgents
-  module Browsers
-    FIREFOX = {
-      win: {
-        'Mozilla/5.0 (Windows NT 6.1; WOW64; rv:40.0) Gecko/20100101 Firefox/40.1' => {
-          browser_name: 'Firefox',
-          browser_version: '40.1',
-          engine_name: 'Gecko',
-          engine_version: '40.0',
-          system_name: ['windows', '7'],
-          system_version: '6.1',
-          system_architecture: 'x64',
-          locale: nil,
-          x64?: true,
-          x32?: false,
-          known?: true,
-          mobile: false
-        }
-      }
-    }
-  end
-end
-```
+The `bot?` and `social_media?` methods however aren't that complex since you don't need to know a bot / social media version or anything other than it's name so inside these methods, only a name can be passed:
 
-Valid browser names are defined by __/lib/browserino/patterns.rb__ (the keys are the browser names)
+*Every social media match is automatically a bot, but a bot isn't automatically social media*
 
-#### browser_name examples
 ```ruby
-'ie'
+# when a bot UA gets parsed
+agent = Browserino.parse 'facebookexternalhit/1.1 (+http://www.facebook.com/externalhit_uatext.php)'
 
-`edge`
+agent.bot?
+# => true
 
-'firefox'
+agent.social_media?
+# => true
 
-'chrome'
+agent.bot? :facebook
+# => true
 
-`vivaldi`
+agent.social_media? :facebook
+# => true
 
-'opera'
+agent.bot? :facebook, version: 1.1
+# => ArgumentError
+```
 
-'opera_mini'
+##### Checking a specific browser, system, bot or social media
 
-'bolt'
+Every name you see in the below lists can be passed as symbol or string to their respective method
 
-'ucbrowser'
+**social media**
 
-'seamonkey'
+* `facebook` or `fb`
+* `twitter`
+* `linkedin`
+* `instagram`
+* `pinterest`
+* `tumblr`
 
-'maxthon'
-```
+Examples:
 
-#### engine_name examples
 ```ruby
+agent.facebook?
+agent.tumblr?
 
-'gecko'
+# using the social_media? method
+agent.social_media? :facebook
 
-'webkit'
+# using shorthand
+agent.social_media? :fb
 
-'trident'
+agent.social_media? :tumblr
 ```
 
-#### bot_name examples
-```ruby
-'googlebot'
+**bot**
 
-'yahoo_slurp'
+* `google`
+* `msn`
+* `bing`
+* `yahoo_slurp`
+* `baiduspider`
+* `yandex`
+* `sosospider`
+* `exa`
+* `sogou_spider`
 
-'msnbot'
+Examples:
 
-'bingbot'
+```ruby
+agent.google?
+agent.exa?
 
-'baiduspider'
+# using the bot? method
+agent.bot? :google
+agent.bot? :exa
+```
 
-'yandexbot'
+**browser**
 
-'sosospider'
+* `chrome`
+* `firefox` or `ff`
+* `seamonkey`
+* `opera`
+* `opera_mini`
+* `vivaldi`
+* `ucbrowser`
+* `maxthon`
+* `bolt`
+* `brave`
+* `safari`
+* `ie`
+* `edge`
 
-'exabot'
+Examples:
 
-'sogou_spider'
-```
+```ruby
+agent.firefox?
+agent.chrome? 42
 
-#### system_name examples
+# using the browser? method
+agent.browser? :firefox
 
-```ruby
-'windows'
+# using shorthand
+agent.browser? :ff
 
-'win'
+agent.browser? :chrome, version: 42
+```
 
-'macintosh'
+**operating system**
 
-'osx'
+* `windows` or `win`
+* `macintosh` or `osx`
+* `linux`
+* `bsd`
+* `android`
+* `ios`
+* `blackberry` or `bb`
+* `windows_phone`
 
-'blackberry'
+Examples:
 
-'bb'
+```ruby
+agent.macintosh?
+agent.windows_phone? 7
 
-'windows_phone'
+# to check for windows vista one could do
+agent.windows? 6
 
-'android'
+# a more readable equivelant
+agent.windows? :vista
 
-'ios'
+# using the platform? method
+agent.platform? :macintosh
 
-'linux'
+# using shorthand
+agent.platform? :osx
 
-`bsd`
+agent.platform? :windows_phone, version: 7
 ```
 
-#### system_architecture examples
-```ruby
-'x32'
+Notes:
 
-'x64'
-```
+* `linux?` doesn't support any versions
+* `bsd?` doesn't support any versions
+* *named versions* are only supported if they are present in a [map](/lib/browserino/maps)
 
 ## Contributing
 

data/bin/console

@@ -3,8 +3,7 @@
 require 'bundler/setup'
 require 'browserino'
 require 'pry'
-ua = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 \
-      (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9'
+ua = 'Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; AS; rv:11.0) like Gecko'
 @agent = Browserino.parse(ua)
 
 puts "> @agent variable available parsed with: '#{ua}'\n\n"

data/browserino.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Sidney Liebrand"]
   spec.email         = ["sidneyliebrand@gmail.com"]
 
-  spec.summary       = %q{A browser identification gem}
+  spec.summary       = %q{A browser identification gem with Rails (>= 3.2.0) integration}
   spec.homepage      = "https://github.com/SidOfc/browserino"
   spec.license       = "MIT"
 

data/lib/browserino/agent.rb

@@ -1,6 +1,6 @@
 module Browserino
   class Agent
-    include Core::Helpers
+    include Core::Helpers, Core::Questions
     attr_reader :ua
 
     def initialize(info, ua = nil)
@@ -53,76 +53,51 @@ module Browserino
       @info[:bot_name]
     end
 
-    def compat?
-      invert_if_not ie? && browser_version != browser_version(compat: true)
-    end
-
-    def known?
-      invert_if_not !browser_name.nil? || !bot_name.nil?
-    end
-
-    def mobile?
-      invert_if_not !ua.match(Core::PATTERNS[:operating_system][:mobile]).nil?
-    end
-
-    def x64?
-      invert_if_not system_architecture == 'x64'
-    end
-
-    def x32?
-      invert_if_not system_architecture == 'x32'
+    def not
+      @not = true
+      self
     end
 
-    def osx?(*arg)
-      invert_if_not macintosh?(*arg)
+    def to_s(sep = '')
+      prev = ''
+      s = hash_for_to_s.each_with_object([]) do |v, a|
+        a << case v[0]
+             when :browser_version, :engine_version
+               prev + sep + (v[1].split('.').first || '')
+             else v[1]
+             end
+        prev = v[1]
+      end
+      s.reject { |str| str == '' }.join ' '
     end
 
-    def win?(*arg)
-      invert_if_not windows?(*arg)
+    def hash_for_to_s
+      out = to_h.each_with_object({}) do |a, h|
+        h[a[0]] = a[1].to_s.gsub(/[\s_]/, '-')
+      end
+      [:locale, :system_version].each { |k| out.delete(k) }
+      out
     end
 
-    def bb?(*arg)
-      invert_if_not blackberry?(*arg)
+    def to_a
+      @info.keys.each_with_object([]) { |f, a| a.push([f, send(f)]) }.compact
     end
 
-    def bot?(name = nil)
-      is_bot = ua.strip.empty? || !bot_name.nil?
-      is_name = name.nil? || name.to_s.downcase.tr('_', ' ') == bot_name
-      invert_if_not is_bot && is_name
+    def to_h
+      to_a.each_with_object({}) { |a, h| h[a[0]] = a[1] }
     end
 
     def method_missing(method_sym, *args, &block)
       name = method_sym.to_s.tr('?', '')
-      invert_if_not case agent_or_system?(method_sym)
-                    when :system then correct_system?(name, *args)
-                    when :agent then correct_agent?(name, *args)
-                    else super
-                    end
+      invertable case agent_or_system?(method_sym)
+                 when :system then correct_system?(name, *args)
+                 when :agent then correct_agent?(name, *args)
+                 else super
+                 end
     end
 
     def respond_to?(method_sym)
       agent_or_system?(method_sym).nil? ? false : true
     end
-
-    def not
-      @not = true
-      self
-    end
-
-    def to_s(sep = '')
-      props = @info.map do |k, _|
-        y = [:system_version, :engine_version, :browser_version].include?(k)
-        y ? send(k) + sep + send(k).to_s.split('.').first : send(k)
-      end
-      props.compact.map { |v| v.tr(' ', '-') }.join(' ')
-    end
-
-    def to_a
-      @info.each_with_object([]) { |v, a| a.push(v) }
-    end
-
-    def to_h
-      to_a.each_with_object({}) { |v, h| h[v[0].to_sym] = v[1] }
-    end
   end
 end

data/lib/browserino/core/alias.rb

@@ -1,6 +1,6 @@
 module Browserino
   module Core
-    Core::ALIAS = {
+    ALIAS = {
       browser_name: { 'ie' => /msie/ },
       engine_name: { 'webkit' => /applewebkit/ },
       system_name: {

data/lib/browserino/core/helpers.rb

@@ -1,7 +1,9 @@
 module Browserino
   module Core
     module Helpers
-      def invert_if_not(res)
+      private
+
+      def invertable(res)
         if @not
           @not = false
           !res

data/lib/browserino/core/lies.rb

@@ -1,6 +1,6 @@
 module Browserino
   module Core
-    Core::LIES = [
+    LIES = [
       [%r{(Mozilla/[\d\.]+)}i, true],
       [/9\.80/, /opera/i],
       [%r{(?:apple)?webkit/[\d\.]+}i, /presto/i],

data/lib/browserino/core/patterns.rb

@@ -1,6 +1,6 @@
 module Browserino
   module Core
-    Core::PATTERNS = {
+    PATTERNS = {
       browser: {
         vivaldi: {
           name: /(?<name>vivaldi)/i,
@@ -54,6 +54,11 @@ module Browserino
                       |netscape)/?(?<version>[\d\.]+)}xi
         },
 
+        brave: {
+          name: /(?<name>brave)/i,
+          version: %r{brave/(?<version>[\d\.]+)}i
+        },
+
         chrome: {
           name: /(?<name>chrome?(ium|plus)?)/i,
           version: %r{chrome?(?:ium|plus)?/(?<version>[\d\.]+)}i
@@ -66,19 +71,25 @@ module Browserino
       },
 
       bot: {
-        googlebot: { name: /(?<name>googlebot)/i },
+        google: { name: /(?<name>googlebot)/i },
         yahoo_slurp: { name: /(?<name>yahoo\!\sslurp)/i },
-        msnbot: { name: /(?<name>msnbot)/i },
-        bingbot: { name: /(?<name>bingbot)/i },
+        msn: { name: /(?<name>msnbot)/i },
+        bing: { name: /(?<name>bingbot)/i },
         baiduspider: { name: /(?<name>baiduspider)/i },
-        yandexbot: { name: /(?<name>yandexbot)/i },
+        yandex: { name: /(?<name>yandexbot)/i },
         sosospider: { name: /(?<name>sosospider)/i },
-        exabot: { name: /(?<name>exabot)/i },
+        exa: { name: /(?<name>exabot)/i },
         sogou_spider: { name: /(?<name>sogou\s?spider)/i },
         nutch: { name: /(?<name>nutch)/i },
         scrapy: { name: /(?<name>scrapy)/i },
         dataparksearch: { name: /(?<name>dataparksearch)/i },
-        beslistbot: { name: /(?<name>beslistbot)/i }
+        beslist: { name: /(?<name>beslistbot)/i },
+        facebook: { name: /(?<name>face(?:bookexternalhit|bot))/i },
+        twitter: { name: /(?<name>twitterbot)/i },
+        linkedin: { name: /(?<name>linkedinbot)/i },
+        instagram: { name: /(?<name>instagram)/i },
+        pinterest: { name: /(?<name>pinterest)/i },
+        tumblr: { name: /(?<name>tumblr)/i }
       },
 
       engine: {

data/lib/browserino/core/questions.rb

@@ -0,0 +1,76 @@
+module Browserino
+  module Core
+    module Questions
+      SHORT_SYSTEM_NAMES = {
+        'osx' => 'macintosh',
+        'win' => 'windows',
+        'bb' => 'blackberry'
+      }.freeze
+
+      SOCIAL_MEDIA = [:facebook, :twitter, :linkedin,
+                      :instagram, :pinterest, :tumblr].freeze
+
+      def compat?
+        invertable ie? && browser_version != browser_version(compat: true)
+      end
+
+      def known?
+        invertable !browser_name.nil? || !bot_name.nil?
+      end
+
+      def mobile?
+        invertable !ua.match(Core::PATTERNS[:operating_system][:mobile]).nil?
+      end
+
+      def x64?
+        invertable system_architecture == 'x64'
+      end
+
+      def x32?
+        invertable system_architecture == 'x32'
+      end
+
+      def osx?(*arg)
+        macintosh?(*arg)
+      end
+
+      def win?(*arg)
+        windows?(*arg)
+      end
+
+      def bb?(*arg)
+        blackberry?(*arg)
+      end
+
+      def fb?(*arg)
+        facebook?(*arg)
+      end
+
+      def ff?(*arg)
+        firefox?(*arg)
+      end
+
+      def bot?(name = nil)
+        is_bot = ua.strip.empty? || !bot_name.nil?
+        is_name = name.nil? || name.to_s.downcase.tr('_', ' ') == bot_name
+        invertable is_bot && is_name
+      end
+
+      def social_media?(name = nil)
+        if name
+          invertable send("#{name}?")
+        else
+          invertable SOCIAL_MEDIA.include?(bot_name.to_s.to_sym)
+        end
+      end
+
+      def platform?(name = nil, opts = {})
+        invertable name ? send("#{name}?", opts[:version]) : !system_name.nil?
+      end
+
+      def browser?(name = nil, opts = {})
+        invertable name ? send("#{name}?", opts[:version]) : !browser_name.nil?
+      end
+    end
+  end
+end

data/lib/browserino/version.rb

@@ -1,3 +1,3 @@
 module Browserino
-  VERSION = '2.5.4'.freeze
+  VERSION = '2.6.0'.freeze
 end

data/lib/browserino.rb

@@ -1,4 +1,5 @@
 require 'browserino/core/helpers'
+require 'browserino/core/questions'
 require 'browserino/core/lies'
 require 'browserino/core/alias'
 require 'browserino/core/patterns'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browserino
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 2.6.0
 platform: ruby
 authors:
 - Sidney Liebrand
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,7 @@ files:
 - lib/browserino/core/helpers.rb
 - lib/browserino/core/lies.rb
 - lib/browserino/core/patterns.rb
+- lib/browserino/core/questions.rb
 - lib/browserino/engine.rb
 - lib/browserino/integrate/action_controller.rb
 - lib/browserino/integrate/rails.rb
@@ -175,5 +176,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A browser identification gem
+summary: A browser identification gem with Rails (>= 3.2.0) integration
 test_files: []