browserino 2.13.0 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cd18f87571cf993db2a622396ebbbcf1dd5285f
-  data.tar.gz: c075f89285dc8b08654ddd29d468b2932d57e73f
+  metadata.gz: f7199d14c4ac2db60bbc6ba1be03789ea29567cb
+  data.tar.gz: 5b028cf38dbc8d9ea29f68ba5ef60cafced8c931
 SHA512:
-  metadata.gz: 3cfa196f9d7225e8876513b8857cedda14880b3693751fd9d46c887e47ed8ebd7787a65e44b973c3e4fa4dac08610c4d0d5a921c29b4512011a7ee9f7a948aa8
-  data.tar.gz: aa6bb6cfbb1e7f3cda0dde31497ba723c55ab98fa31d4fe613b51406013c67bd6ea0aa098298287f6eb5d7d5515c002f5525df6b5df7e40c0415b2270bed13b6
+  metadata.gz: b23a6c4211ab6e8875e72e9fdf908a71b442ccee3a77cb846c76e8fb3729bdf3110bc359422a8537da628e0e44544e3c529bc5919325a4715dd8d4c6236a2cfe
+  data.tar.gz: c7b454d7eb0d602b634a6cddd73cccc4df9950cf3a62343b674939fc2da2caf31153c5bde1774ae3eb9f036be7f8f7f5b957ffdb488d72a248be1c4596ad52e9

data/README.md

@@ -1,684 +1,3 @@
-# Browserino
+# Readme
 
-A UserAgent sniffer with Rails >= 3.2.0 integration.
-The sniffer can currently identify 22 bots (of which 6 social media and 5 search engines), 17 browsers, 11 operating systems, 6 programming language UA's and 4 consoles.
-
-# DEPRECATION WARNING: Ruby < 2
-
-Browserino will be dropping support for Ruby versions less than 2 with the release of version `3`
-The planned release date for version `3` is on new years day (Jan 01, 2017).
-
-This breaking update will also remove the deprecated (and no longer used) second value that can be passed to `Browserino.new` which allowed you to return a custom value instead of the default `nil` if a property isn't set.
-**Rails** users can simply upgrade their version as long as they use Ruby `>= 2` or above since the custom return value was never used during initialization.
-
-## 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)
-
----
-
-Useragent references:
-
-* http://useragentstring.com/
-* http://www.zytrax.com/tech/web/mobile_ids.html
-* http://www.user-agents.org/
-
-## Changelog
-
-_dates are in dd-mm-yyyy format_  
-_older changes can be found in the [CHANGELOG.md](CHANGELOG.md)_
-
-#### 09-12-2016 VERSION 2.13.0
-
-- Added support for Colibri
-  - Added `colibri?` method
-  - Added support for `:colibri` (`Symbol` and `String`) in methods
-- Added `agent.internet_explorer?` method as alias for `agent.ie?`
-  - Added support for `:internet_explorer` (`Symbol` and `String`) in methods
-- Test aliasses if they exist for a certain browser (used to be tested by hand)
-- Test aliasses if they exist for a certain user (used to be tested by hand)
-- Add a roadmap
-
-#### 14-11-2016 VERSION 2.12.0
-
-- Added support for SamsungBrowser
-  - Added `samsungbrowser?` method
-  - Added support for `:samsungbrowser` (`Symbol` and `String`) in methods
-- Added support for Tizen
-  - Added `tizen?` method
-  - Added support for `:tizen` (`Symbol` and `String`) in methods
-- Added support for WebOS
-  - Added `webos?` method
-  - Added support for `:webos` (`Symbol` and `String`) in methods
-- Added support for WebOSBrowser
-  - Added `webosbrowser?` method
-  - Added support for `:webosbrowser` (`Symbol` and `String`) in methods
-- Added Android Nougat (7.0 and 7.1) detection
-- merged OS map files into _/core/mappings.rb_ and removed the _lib/maps_ folder
-- Reduced amount of (overkill) tests
-
-#### 13-11-2016 VERSION 2.11.0
-
-- Add `:macos` alias for `:macintosh` systems.
-- Added support for MacOS `:sierra` alias in methods.
-- Added deprecation notice for dropping support of Ruby < 2.0.0
-
-## Installation
-
-Add the following to your applications Gemfile:
-
-```ruby
-gem 'browserino'
-```
-
-And then execute:
-
-```
-$ bundle
-```
-
-Or install it yourself with:
-
-```
-$ gem install browserino
-```
-
-Browserino is tested with the following ruby versions
-
-* 1.9.3 - **SUPPORT WILL BE DROPPED IN THE NEXT MAJOR VERSION RELEASE**
-* 2.0.0
-* 2.1.0
-* 2.2.1
-* 2.3.0
-* 2.3.1
-
-## Usage
-
-After installing the gem globally or in your application you'll have to `require` the gem before being able to use it.
-
-```ruby
-require 'browserino'
-```
-Afterwards, the gem is loaded and you can proceed by calling:
-
-```ruby
-Browserino.parse '<user agent>'
-```
-
-Browserino is also usable in the command line
-
-```
-~$ browserino parse <ua>
-```
-
-Output
-```
-name: chrome, browser_version: 50.0.2661.102, engine_name: webkit, engine_version: 537.36, system_name: macintosh, system_architecture: nil
-```
-
-### 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 ApplicationController < ActionController::Base
-  def some_method
-    render json: agent
-  end
-end
-```
-
-### General
-
-the `parse` method will **always** return a `Browserino::Agent` object.
-
-```ruby
-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.name
-# => nil
-```
-
-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.name
-# => 'brave'
-
-# or using browser_name
-
-agent.browser_name
-# => 'brave'
-
-agent.browser_version
-# => '0.7.7'
-
-agent.engine_name
-# => 'webkit'
-```
-
-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:
-
-```ruby
-agent = Browserino.parse ''
-agent.bot?
-# => true (empty UA's count as anonymous bots)
-
-agent.googlebot?
-# => false
-
-agent.non_supported_bot?
-# => NoMethodError
-
-agent.bot? :non_supported_bot
-# => NoMethodError
-```
-
-### Functions
-
-The samples below are all valid calls with their respective outputs, using the `agent` defined below.
-
-```ruby
-agent = Browserino.parse 'Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; AS; rv:11.0) like Gecko'
-```
-
-#### Note
-
-The methods `social_media_name`, `search_engine_name`, `bot_name` and `browser_name`
-are *all* aliasses of the general `name` method.
-
-The exceptions to this rule are `system_name` and `console_name`. They each have their own method.
-
-##### Quick usage
-
-```ruby
-agent.name
-# => 'ie'
-
-# always returns real version, also when IE is in compat
-agent.browser_version
-# => '11.0'
-
-# 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'
-
-agent.library_name
-# => nil
-
-agent.library_version
-# => nil
-
-agent.engine_name
-# => 'trident'
-
-agent.engine_version
-# => '7.0'
-
-agent.system_name
-# => 'windows'
-
-# 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']
-
-agent.system_version
-# => '6.1'
-
-agent.system_architecture
-# => 'x64'
-
-agent.console_name
-# => nil
-
-# two formats possible: 'aa' or `aa-bb`
-agent.locale
-# => 'as'
-```
-
-##### Question methods
-
-Browserino also provides some question methods.
-
-```ruby
-# only for Internet Explorer
-agent.compat?
-# => false
-
-# returns true if name is present
-agent.known?
-# => true
-
-# returns true if browser is known
-agent.browser?
-# => true
-
-# returns true if specific browser
-agent.browser? :ie
-# => true
-
-# returns true if specific browser and version
-agent.browser? :ie, version: '11.0'
-
-# returns true if library is known
-agent.library?
-
-# returns true if specific library
-agent.library? :php
-
-# returns true if specific library and version
-agent.library? :php, version: '5.9.0'
-
-# returns true if there is a social media bot on your website
-agent.social_media?
-# => false
-
-# returns true if platform is known
-agent.platform?
-# => true
-
-# returns true if specific platform
-agent.platform? :windows
-# => true
-
-# returns true if specific platform and version
-agent.platform? :windows, version: '7'
-# => true
-
-# returns true if console is known
-agent.console?
-# => false
-
-# returns true if specific console
-agent.console? :xbox
-# => false
-
-# returns true if user agent is empty or a bot is recognized
-agent.bot?
-# => false
-
-agent.x64?
-# => true
-
-agent.x32?
-# => false
-
-agent.mobile?
-# => false
-```
-
-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.windows?
-# => true
-
-# based on full name
-agent.windows? '7'
-# => true
-
-# NT versions also work
-agent.windows? 6.1
-# => true
-```
-
-##### Transformation
-
-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.
-
-**to_s**
-
-Returns a compiled string of properties based on available information.
-
-```ruby
-agent.to_s
-# => 'ie ie11 trident trident7 windows x64'
-
-# a seperator can be passed to format the name + version combo's
-agent.to_s '-'
-# => 'ie ie-11 trident trident-7 windows x64'
-```
-
-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.to_s
-# => ie trident windows x64
-```
-
-**to_a**
-
-Returns an array with key => value pairs.
-
-```ruby
-agent.to_a
-# => [[:name, "ie"],
-#     [:browser_version, "11.0"],
-#     [:engine_name, "trident"],
-#     [:engine_version, "7.0"],
-#     [:system_name, "windows"],
-#     [:system_version, "6.1"],
-#     [:system_architecture, "x64"],
-#     [:console_name, nil],
-#     [:locale, "as"]]
-```
-
-**to_h**
-
-Returns a hash with key => value pairs.
-
-```ruby
-agent.to_h
-# => {:name=>"ie",
-#     :browser_version=>"11.0",
-#     :engine_name=>"trident",
-#     :engine_version=>"7.0",
-#     :system_name=>"windows",
-#     :system_version=>"6.1",
-#     :system_architecture=>"x64",
-#     :console_name => nil,
-#     :locale=>"as"}
-```
-
-##### Supplying versions
-
-Consider this parsed string:
-
-```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'
-
-# output for system_name
-agent.system_name
-# => 'android'
-
-# output for system_name full: true
-agent.system_name full: true
-# => ['android', 'Jelly Bean 16']
-```
-
-When supplying a version to a method that supports it, you have multiple options for the format of that version.
-
-* 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`
-
-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.
-
-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.
-
-* `4.1.2` will match `4.1.2`
-* `4.1` will match `4.1.x`
-* `4` will match `4.x.x`
-
-**Examples using `platform?`**
-
-```ruby
-agent.platform? :android, version: '4.1.2'
-# => true
-
-agent.platform? :android, version: 4.1
-# => true
-
-agent.platform? :android, version: 4
-# => true
-
-agent.platform? :android, version: :jelly_bean
-# => true
-
-agent.platform? :android, version: :jelly_bean_16
-# => true
-```
-
-##### `platform?`, `browser?`, `bot?`, `console?`, `search_engine?`, `library` and `social_media?` methods
-
-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?` and `library?` method works in exactly the same way.
-
-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:
-
-*Every social media match is automatically a bot, but a bot isn't automatically social media, __This is also true for the `search_engine?` method__*
-
-```ruby
-# when a bot UA gets parsed
-agent = Browserino.parse 'facebookexternalhit/1.1 (+http://www.facebook.com/externalhit_uatext.php)'
-
-agent.bot?
-# => true
-
-agent.social_media?
-# => true
-
-agent.bot? :facebook
-# => true
-
-agent.social_media? :facebook
-# => true
-
-agent.bot? :facebook, version: 1.1
-# => ArgumentError
-```
-
-##### Checking a specific browser, system, bot, library or social media
-
-Every name you see in the below lists can be passed as symbol or string to their respective method
-
-**search engine**
-* `google`
-* `bing`
-* `yahoo_slurp`
-* `baiduspider`
-* `duckduckgo` or `ddg`
-
-Examples:
-
-```ruby
-agent.google?
-agent.baiduspider?
-
-# using the search_engine? method
-agent.search_engine? :google
-
-# using shorthand
-agent.search_engine? :ddg
-```
-
-**consoles**
-
-* `xbox`
-* `nintendo_ds`
-* `wii`
-* `playstation`
-
-Examples:
-
-```ruby
-agent.playstation?
-agent.wii?
-
-agent.console?
-
-agent.console? :facebook
-```
-
-**social media**
-
-* `facebook` or `fb`
-* `twitter`
-* `linkedin`
-* `instagram`
-* `pinterest`
-* `tumblr`
-
-Examples:
-
-```ruby
-agent.facebook?
-agent.tumblr?
-
-# using the social_media? method
-agent.social_media? :facebook
-
-# using shorthand
-agent.social_media? :fb
-
-agent.social_media? :tumblr
-```
-
-**bot**
-
-* `google`
-* `msn`
-* `bing`
-* `yahoo_slurp`
-* `baiduspider`
-* `yandex`
-* `sosospider`
-* `exa`
-* `sogou_spider`
-
-Examples:
-
-```ruby
-agent.google?
-agent.exa?
-
-# using the bot? method
-agent.bot? :google
-agent.bot? :exa
-```
-
-**library**
-
-* `php`
-* `perl`
-* `curl`
-* `python`
-* `java`
-* `pycurl`
-
-Examples:
-
-```ruby
-agent.php?
-agent.pycurl?
-
-agent.library?
-
-agent.library? :curl
-
-agent.library? :curl, version: 7.21
-```
-
-**browser**
-
-* `chrome`
-* `firefox` or `ff`
-* `servo`
-* `seamonkey`
-* `opera`
-* `opera_mini`
-* `vivaldi`
-* `ucbrowser`
-* `maxthon`
-* `bolt`
-* `brave`
-* `safari`
-* `ie`
-* `edge`
-* `samsungbrowser`
-* `webosbrowser`
-* `colibri`
-
-Examples:
-
-```ruby
-agent.firefox?
-agent.chrome? 42
-
-# using the browser? method
-agent.browser? :firefox
-
-# using shorthand
-agent.browser? :ff
-
-agent.browser? :chrome, version: 42
-```
-
-**operating system**
-
-* `windows` or `win`
-* `macintosh` or `osx`
-* `linux`
-* `bsd`
-* `solaris`
-* `android`
-* `ios`
-* `blackberry` or `bb`
-* `windows_phone`
-* `tizen`
-* `webos`
-
-Examples:
-
-```ruby
-agent.macintosh?
-agent.windows_phone? 7
-
-# to check for windows vista one could do
-agent.windows? 6
-
-# a more readable equivelant
-agent.windows? :vista
-
-# using the platform? method
-agent.platform? :macintosh
-
-# using shorthand
-agent.platform? :osx
-
-agent.platform? :windows_phone, version: 7
-```
-
-Notes:
-
-* `linux?` doesn't support any versions
-* `bsd?` doesn't support any versions
-* `solaris?` only supports numeric versions
-* *named versions* are only supported if they are present in a [map](https://github.com/SidOfc/browserino/tree/master/lib/browserino/core/mapping.rb)
-
-## Roadmap
-
-Browserino will always be a work in progress, I will do my best to maintain and update the gem regularly as I have so far, below are some points of interest on what could / should be improved, rewritten or removed.
-There is no steady schedule for these changes however these are the changes I deemed most important, the value in them being here is that you, as a developer using Browserino have the possibility to see what might be added, changed or removed in the near(est) future of change.
-
-* Drop ruby `< 2` support and remove custom return value from constructor
-* Refactor test suite entirely to improve readability and structure of tests.
-* Add more bot identification
-* Rewrite aliassing and UA lie detection
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/SidOfc/browserino. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The documentation has been moved here: [https://sidofc.github.io/projects/browserino/](https://sidofc.github.io/projects/browserino/)

data/browserino.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["sidneyliebrand@gmail.com"]
 
   spec.summary       = %q{A browser identification gem with command line and Rails (>= 3.2.0) integration}
-  spec.homepage      = "http://sidofc.github.io/browserino/"
+  spec.homepage      = "https://sidofc.github.io/projects/browserino/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/browserino/version.rb

@@ -1,3 +1,3 @@
 module Browserino
-  VERSION = '2.13.0'.freeze
+  VERSION = '2.13.1'.freeze
 end