browserino 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f392dc373a4a65f8091c0a80772e098d93a7132
-  data.tar.gz: f6d67b00f1d80d5a9dad9f99234bded0fa5358be
+  metadata.gz: acb8ac94ab2c1c344c35baadf3a9b4c2467895af
+  data.tar.gz: 805054e5d7704be888eee25548d813d8d448ff41
 SHA512:
-  metadata.gz: b0e4b698e954091489aba295f223d4cb6c48cb7d438db514c04731de975416215420ddcaf261cbe3321ba45dc2d16d1f766516d5a5b3b5ca8730f9e4ad90e5e5
-  data.tar.gz: 562b3de888cf132cfe05200590478293c6bbf20433354dbdd60447259ffa86b823b9b7f6b70e0ed9875d38218219bbbf856dc37ac9c5a6dd4cf4cbef710f5198
+  metadata.gz: 1617ffc71a77a90e28bec8d4fb77a5e94491d0930449d0b68ae689a75f5168669e7c6dbaceee6ca8a905938a90a0e18044ef343bf79f156dbb356f3d6381994f
+  data.tar.gz: 37f7b4465efe6a522c3e1127b0b2911fbbe81ead5039d82ca73f0a35f33ba60723ad055a22fcf4af08df1eda4de43b2bc9b584adb54faf8f5d9964a3a688a396

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 ## CHANGELOG
 _dates are in dd-mm-yyyy format_  
 
+#### 31-12-2015 VERSION 1.5.3
+
+- Added blackberry support
+- Added tests for blackberry user agent strings
+
 #### 31-12-2015 VERSION 1.5.2
 
 - Added user agents

data/README.md

@@ -10,6 +10,14 @@ This gem aims to provide information about the browser that your visitor is usin
 _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)_
 
+#### 04-01-2016 VERSION 2.1.0
+
+- Small restructuring of test suite
+- Added bot detection
+- Added `#bot?` method
+- Added dynamic method support for bots
+- Added support for the seamonkey browser
+
 #### 03-01-2016 VERSION 2.0.0
 
 - **IMPORTANT** Changed behaviour of all dynamic methods to include version as an argument rather than in the method name.
@@ -29,11 +37,6 @@ _older changes can be found in the [CHANGELOG.md](https://github.com/SidOfc/brow
 - Changed `#to_s` to add dashes (`-`) between browser names if they have a space
 - `#to_s` now has an optional (`sep = ''`) parameter that allows info and version numbers to be seperated
 
-#### 31-12-2015 VERSION 1.5.3
-
-- Added blackberry support
-- Added tests for blackberry user agent strings
-
 ## Installation
 
 *supports ruby 1.9.3+*  
@@ -96,7 +99,10 @@ agent.system_architecture # => 'x32' or 'x64' if known
 agent.x32? # => true for 32bit UA's
 agent.x64? # => true for 64bit UA's
 
-agent.known? # => true if browser_name present
+agent.bot_name # => name of bot if the UA was identified as bot
+agent.bot? # => returns true or false depending on if the agent is a bot
+
+agent.known? # => true if browser_name or bot_name present
 agent.mobile? # => true if agent is a mobile device
 
 # methods to convert object into a String, Array or hash
@@ -132,9 +138,9 @@ 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)`**
+**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')`**
 
-Supported systems
+##### Supported systems
 
 ```ruby
 agent.android?
@@ -182,7 +188,7 @@ agent.not.linux?
 
 The `#windows?`, `#macintosh?` and `#blackberry?` each have a shortcut method to allow for easier access, `#win?`, `#osx?`, `#bb?`
 
-Supported browsers  
+##### Supported browsers  
 
 ```ruby
 agent.opera?
@@ -196,42 +202,56 @@ agent.firefox?
 agent.chrome?
 agent.safari?
 
-# or with the .not method
+# or with the .not method (v1.4.0+)
 
 agent.not.opera?
 agent.not.maxthon?
 # etc etc...
+```
 
+##### Supported bots
+```ruby
+agent.msnbot?
+agent.yahoo_slurp?
+agent.googlebot?
+agent.bingbot?
+
+# or with the .not method (v1.4.0+)
+agent.not.msnbot?
+agent.not.yahoo_slurp?
+# etc etc...
 ```
 
 ## Development
 
 The tests are dynamically produced and quite easy to write.
 
-The __/spec/user_agents.rb__ actually contains the testcases, 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.
-tests will convert all input to a string and downcase it for easier comparison (since the checks need to filter words and numbers, not types).
+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
 
 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
-  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',
-        x64?: true,
-        x32?: false,
-        known?: true,
-        mobile: false
+  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',
+          x64?: true,
+          x32?: false,
+          known?: true,
+          mobile: false
+        }
       }
     }
-  }
+  end
 end
 ```
 
@@ -246,6 +266,7 @@ Valid browser names are defined by __/lib/browserino/patterns.rb__ (the keys are
 'opera_mini'
 'bolt'
 'ucbrowser'
+'seamonkey'
 'maxthon'
 ```
 
@@ -256,6 +277,14 @@ Valid browser names are defined by __/lib/browserino/patterns.rb__ (the keys are
 'trident'
 ```
 
+#### bot_name examples
+```ruby
+'googlebot'
+'yahoo_slurp'
+'msnbot'
+'bingbot'
+```
+
 #### system_name examples
 
 _The main reason for not having Linux distro's / versions is because of the fact that there are MANY different distro's with no real structured release system. The best I can do here is allow a `linux?` system to be found atleast_

data/bin/console

@@ -3,7 +3,7 @@
 require "bundler/setup"
 require "browserino"
 require "pry"
-ua = 'UCBROWSER -> 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'
+ua = 'msnbot/2.1'
 @agent = Browserino::parse(ua)
 
 puts "> @agent variable available parsed with: '#{ua}'\n\n"

data/lib/browserino/agent.rb

@@ -6,16 +6,21 @@ module Browserino
       @not = false
 
       cleansed_ua = Browserino::cleanse @ua
-      name = Browserino::find_browser_name cleansed_ua
-      @info = Browserino::check_for_aliases({
+      name = Browserino::agent_id cleansed_ua
+      info = {
         browser_name: name,
         browser_version: Browser::version(cleansed_ua, PATTERNS[:browser][name]),
         engine_name: Engine::name(cleansed_ua),
         engine_version: Engine::version(cleansed_ua),
         system_name: OperatingSystem::name(cleansed_ua),
         system_version: OperatingSystem::version(cleansed_ua),
-        system_architecture: OperatingSystem::architecture(cleansed_ua)
-      })
+        system_architecture: OperatingSystem::architecture(cleansed_ua),
+        bot_name: nil
+      }
+      if Browserino::PATTERNS[:bot].include? name
+        info.merge!({browser_name: nil, browser_version: nil, bot_name: name})
+      end
+      @info = Browserino::check_for_aliases(info)
     end
 
     def browser_name
@@ -66,52 +71,60 @@ module Browserino
       end
     end
 
+    def bot_name
+      with_valid(@info[:bot_name]) do |v|
+        v.to_s.downcase.gsub(/_/, ' ')
+      end
+    end
+
     def ua
       @ua
     end
 
     def known?
-      res = !@not && browser_name != @unknown
-      @not = false
-      res
+      allow_inverted_return (browser_name != @unknown || bot_name != @unknown)
     end
 
     def mobile?
-      allow_inverted_return !!(ua =~ /bolt|nokia|samsung|mobi(?:le)?|android|ip(?:[ao]d|hone)|bb\d+|blackberry|iemobile|fennec|bada|meego|vodafone|t\-mobile|opera\sm(?:ob|in)i/i)
+      allow_inverted_return !!(ua =~ Browserino::PATTERNS[:operating_system][:mobile])
     end
 
     def x64?
-      allow_inverted_return(system_architecture == 'x64')
+      allow_inverted_return system_architecture == 'x64'
     end
 
     def x32?
-      allow_inverted_return(system_architecture == 'x32')
+      allow_inverted_return system_architecture == 'x32'
     end
 
     def osx?(*arg)
-      macintosh?(*arg)
+      allow_inverted_return macintosh?(*arg)
     end
 
     def win?(*arg)
-      windows?(*arg)
+      allow_inverted_return windows?(*arg)
     end
 
     def bb?(*arg)
-      blackberry?(*arg)
+      allow_inverted_return blackberry?(*arg)
+    end
+
+    def bot?
+      allow_inverted_return (bot_name.nil? ? false : true)
     end
 
     def method_missing(method_sym, *args, &block)
       name = method_sym.to_s.gsub('?', '')
-      res = case browser_or_system?(method_sym)
+      res = case agent_or_system?(method_sym)
       when :system then correct_system?(name, *args)
-      when :browser then correct_browser?(name, *args)
+      when :agent then correct_agent?(name, *args)
       else super
       end
       allow_inverted_return res
     end
 
     def respond_to?(method_sym)
-      browser_or_system?(method_sym).nil? ? false : true
+      agent_or_system?(method_sym).nil? ? false : true
     end
 
     def not
@@ -178,8 +191,9 @@ module Browserino
       end
     end
 
-    def correct_browser?(name, version = nil)
-      browser_equal = (name.gsub(/_/, ' ') == browser_name)
+    def correct_agent?(name, version = nil)
+      name = name.gsub(/_/, ' ')
+      browser_equal = (name == browser_name || name == bot_name)
       if version
         browser_equal && compare_versions(version, browser_version)
       else
@@ -187,14 +201,14 @@ module Browserino
       end
     end
 
-    def browser_or_system?(method_sym)
-      name = method_sym.to_s.gsub('?', '').split(/_/).first
+    def agent_or_system?(method_sym)
+      name = method_sym.to_s.gsub('?', '')
       sys = Browserino::Mapping.constants(true).include?(name.upcase.to_sym)
-      browser = Browserino::PATTERNS[:browser].keys.include?(name.to_sym)
+      agent = Browserino::PATTERNS[:browser].merge(Browserino::PATTERNS[:bot]).keys.include?(name.to_sym)
       if sys
         :system
-      elsif browser
-        :browser
+      elsif agent
+        :agent
       else
         nil
       end

data/lib/browserino/alias.rb

@@ -1,30 +1,21 @@
 module Browserino
   ALIAS = {
     browser_name: {
-      'ie' => ['msie'],
-      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
-    },
-    browser_version: {
-      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
+      'ie' => ['msie']
     },
+    browser_version: {},
     engine_name: {
-      'webkit' => ['applewebkit'],
-      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
-    },
-    engine_version: {
-      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
+      'webkit' => ['applewebkit']
     },
+    engine_version: {},
     system_name: {
-      Browserino::UNKNOWN => ['unknown', :unknown, '', nil],
       'linux' => ['ubuntu', 'x11']
     },
-    system_version: {
-      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
-    },
+    system_version: {},
     system_architecture: {
       'x64' => ['64', 'x86_64', 'amd64', 'wow64'],
-      'x32' => ['32', 'i686', 'i383', 'x86_32'],
-      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
-    }
+      'x32' => ['32', 'i686', 'i383', 'x86_32']
+    },
+    bot_name: {}
   }
 end

data/lib/browserino/patterns.rb

@@ -36,6 +36,11 @@ module Browserino
         version: /(?:(?:ms)?ie\s|rv\:)(?<version>[\d\.b]+)/i
       },
 
+      seamonkey: {
+        name: /(?<name>seamonkey)/i,
+        version: /seamonkey\/(?<version>[\d\.]+)/i
+      },
+
       firefox: {
         name: /(?<name>(?:fire|water)(?:fox|bird)|ice(?:weasel|cat)|netscape)/i,
         version: /(?:(?:fire|water)(?:fox|bird)|ice(?:weasel|cat)|netscape)[\/]?(?<version>[\d\.]+)/i
@@ -52,6 +57,13 @@ module Browserino
       }
     },
 
+    bot: {
+      googlebot: { name: /(?<name>googlebot)/i },
+      yahoo_slurp: { name: /(?<name>yahoo\!\sslurp)/i },
+      msnbot: { name: /(?<name>msnbot)/i },
+      bingbot: { name: /(?<name>bingbot)/i }
+    },
+
     engine: {
       name: /(?<name>((apple)?webkit|presto|gecko|trident))/i,
       version: /(?:(?:apple)?webkit|presto|rv:|trident)[\/\s]?(?<version>[\d\.]+)/i
@@ -60,7 +72,8 @@ module Browserino
     operating_system: {
       name: /(?<name>windows|macintosh|android|ios|blackberry|linux|ubuntu|x11)/i,
       version: /(?:nt|mac\sos\sx|android|(cpu\s|i)os|blackberry)\s?(?<version>[\d\._]+)/i,
-      architecture: /(?<architecture>((?:x|x86_|amd|wow)64)|i(3|6)86)/i
+      architecture: /(?<architecture>((?:x|x86_|amd|wow)64)|i(3|6)86)/i,
+      mobile: /bolt|nokia|samsung|mobi(?:le)?|android|ip(?:[ao]d|hone)|bb\d+|blackberry|iemobile|fennec|bada|meego|vodafone|t\-mobile|opera\sm(?:ob|in)i/i
     }
   }
 end

data/lib/browserino/version.rb

@@ -1,3 +1,3 @@
 module Browserino
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/browserino.rb

@@ -16,6 +16,10 @@ require "browserino/browser"
 require "browserino/engine"
 require "browserino/operating_system"
 
+# require_relative "../spec/user_agents"
+# require_relative "../spec/user_agents_bots"
+# require_relative "../spec/user_agents_browsers"
+
 module Browserino
   def self.parse(ua, unknown_alt = Browserino::UNKNOWN)
     Agent.new(ua, unknown_alt)
@@ -37,19 +41,20 @@ module Browserino
   end
 
   def self.check_for_aliases(hash)
-    h = {}
-    hash.each do |prop, val|
-      h[prop] = ALIAS[prop].select { |k, m| true if m.include?(val) }.keys.first || val
+    hash.inject({}) do |memo, kv|
+      ls = ALIAS[kv.first].select { |k, m| true if m.include?(kv.last) }.keys.first || kv.last
+      memo[kv.first] = ls
+      memo
     end
-    h
   end
 
-  def self.find_browser_name(ua)
+  def self.agent_id(ua)
     name = nil
-    browsers = PATTERNS[:browser].keys
+    patterns = PATTERNS[:browser].merge(PATTERNS[:bot])
+    browsers = patterns.keys
     until browsers.empty? || !name.nil?
       tmp = browsers.shift
-      name = tmp if (ua.match(PATTERNS[:browser][tmp][:name]))
+      name = tmp if (ua.match(patterns[tmp][:name]))
     end
     name ||= Browserino::UNKNOWN
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browserino
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sidney Liebrand
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler