browserino 2.8.2 → 2.9.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NmRhZGNiNmJhOWU2YjY1NWJmYWY1NmNhNWU1MmJmZTkxOGQ1YjJjNg==
-  data.tar.gz: !binary |-
-    NGI4OGE0YjM1MjljZmI0NWRkMzdjODQ4NTQ1MGM1NTg2MjRjZDlmOQ==
+SHA1:
+  metadata.gz: 4540d5fa26815c5052d272b101023be2fb7d6fd4
+  data.tar.gz: f2e9b88a2952ab2658d30f4857675e21b7a7e9e0
 SHA512:
-  metadata.gz: !binary |-
-    NjNlMzUzNGMxNGQ1OGQ3MzU1NTQ1MDRhYWRlM2U0YmY3OGJmZjM2ZTc3ZjEw
-    MjhjYWJhYmRkYWFkZGRhZDcyMTBiYjhiMjYzMTU2MzAzNTUyMDQ1MjczYTY2
-    MGZmZjU3N2EyYmFhYzdlMzg3ZmI5NjFiYzg5NGEyZDg3YzBjMTM=
-  data.tar.gz: !binary |-
-    MWVlNmZiYThlMGU4MmFmYzNmYzk0YjVkZDM5NDhiYjAzODRkNGIwOWRhYTcy
-    MWQ4OWRjYTU4NWRlYTE0NWVkM2QxZjk5MTdiOWIyMzBmODcxOGJmMWVhNDc4
-    MmVjYWIxZGFhMmM2ZWM1Y2Y0OGE3MmFkOTRiM2RlOGZiZmIwMTc=
+  metadata.gz: cd7cfb069d12464a948d853de5b01f9a0bc82e3b9a7de594699d99281fa3a0f8fe638a57d85ee7f4473b370ebbcb83c4f4bc45bd8f83081103b1fdb582568567
+  data.tar.gz: 82f24724c735848c9d9607ae79db8160ddfe9c3e2cf3fcf03d185f949e63f88f3bc64c396942854fe0fb82698de80ae17eabd7a203549b2db6b16aa3cbbd183c

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## CHANGELOG
 _dates are in dd-mm-yyyy format_
 
+#### 02-03-2016 VERSION 2.7.0
+
+- Added `solaris?` method
+
 #### 22-01-2016 VERSION 2.6.0
 
 - Fixed `to_a` method

data/README.md

@@ -21,6 +21,25 @@ Useragent references:
 _dates are in dd-mm-yyyy format_  
 _older changes can be found in the [CHANGELOG.md](/CHANGELOG.md)_
 
+#### 29-05-2016 VERSION 2.9.0
+
+- Stricter checking for:
+  * `social_media?`
+  * `bot?`
+  * `browser?`
+  * `platform?`
+
+  These functions used to be callable with unrelated symbols
+  (e.g `agent.platform?(:firefox) # => true`). This is now also filtered.
+- Added support for consoles
+  * Added `console?` method
+  * Added `wii?`, `playstation?`, `xbox?` and `nintendo_ds?` methods
+- Added general `name` method to store any browser / bot / search engine / social media agent
+- `social_media_name`, `search_engine_name` and `bot_name` are now aliasses of `name`
+- removed `:bot_name` from data structure (now stored in a general `name` property)
+- removed `:browser_name` from data structure (now stored in a general `name` property)
+- Added `console_name` method to get the name of a console
+
 #### 27-05-2016 VERSION 2.8.2
 
 - Removed Guard gem dependency
@@ -34,10 +53,6 @@ _older changes can be found in the [CHANGELOG.md](/CHANGELOG.md)_
 - Fixed `respond_to?` method signature
 - Added executable for parsing useragents in terminal
 
-#### 02-03-2016 VERSION 2.7.0
-
-- Added `solaris?` method
-
 ## Installation
 
 Add the following to your applications Gemfile:
@@ -87,7 +102,7 @@ Browserino is also usable in the command line
 
 Output
 ```
-browser_name: chrome, browser_version: 50.0.2661.102, engine_name: webkit, engine_version: 537.36, system_name: macintosh, system_architecture: nil, bot_name: nil
+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)
@@ -118,7 +133,7 @@ If a property isn't available or not known to Browserino it's return value will
 
 ```ruby
 agent = Browserino.parse ''
-agent.browser_name
+agent.name
 # => nil
 ```
 
@@ -127,6 +142,11 @@ If a value *is* found then you'll recieve a *lowercase string* containing the in
 ```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'
 
@@ -162,10 +182,17 @@ The samples below are all valid calls with their respective outputs, using the `
 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.browser_name
+agent.name
 # => 'ie'
 
 # always returns real version, also when IE is in compat
@@ -198,6 +225,9 @@ agent.system_version
 agent.system_architecture
 # => 'x64'
 
+agent.console_name
+# => nil
+
 # two formats possible: 'aa' or `aa-bb`
 agent.locale
 # => 'as'
@@ -212,7 +242,7 @@ Browserino also provides some question methods.
 agent.compat?
 # => false
 
-# returns true if browser_name or bot_name are present
+# returns true if name is present
 agent.known?
 # => true
 
@@ -243,6 +273,14 @@ agent.platform? :windows
 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
@@ -303,15 +341,15 @@ Returns an array with key => value pairs.
 
 ```ruby
 agent.to_a
-# => [[:browser_name, "ie"],
+# => [[: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]]
+#     [:console_name, nil],
+#     [:locale, "as"]]
 ```
 
 **to_h**
@@ -320,15 +358,15 @@ Returns a hash with key => value pairs.
 
 ```ruby
 agent.to_h
-# => {:browser_name=>"ie",
+# => {: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}
+#     :console_name => nil,
+#     :locale=>"as"}
 ```
 
 ##### Supplying versions
@@ -382,7 +420,7 @@ agent.platform? :android, version: :jelly_bean_16
 # => true
 ```
 
-##### `platform?`, `browser?`, `bot?` `search_engine?` and `social_media?` methods
+##### `platform?`, `browser?`, `bot?`, `console?`, `search_engine?` 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?` method works in exactly the same way.
 
@@ -434,6 +472,24 @@ agent.search_engine? :google
 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`

data/lib/browserino/agent.rb

@@ -6,13 +6,18 @@ module Browserino
     def initialize(info, ua = nil)
       @ua = ua
       @not = false
-      @info = info
+      @info = post_process(info)
     end
 
-    def browser_name
-      @info[:browser_name]
+    def name
+      @info[:name]
     end
 
+    alias_method :browser_name, :name
+    alias_method :bot_name, :name
+    alias_method :search_engine_name, :name
+    alias_method :social_media_name, :name
+
     def browser_version(opts = {})
       if ie? && engine_version && !opts[:compat]
         (engine_version.to_f + 4.0).to_s
@@ -31,7 +36,8 @@ module Browserino
 
     def system_name(opts = {})
       if opts[:full]
-        [@info[:system_name], fetch_system_version_name(@info[:system_name])]
+        @full_sys_name ||= [@info[:system_name],
+                            fetch_system_version_name(@info[:system_name])]
       else
         @info[:system_name]
       end
@@ -45,16 +51,12 @@ module Browserino
       @info[:system_architecture]
     end
 
-    def locale
-      @info[:locale]
-    end
-
-    def bot_name
-      @info[:bot_name]
+    def console_name
+      @info[:console_name]
     end
 
-    def search_engine_name
-      @info[:bot_name]
+    def locale
+      @info[:locale]
     end
 
     def not
@@ -79,7 +81,7 @@ module Browserino
              end
         prev = v[1]
       end
-      s.reject { |str| str == '' }.join ' '
+      s.uniq.reject { |str| str == '' }.join ' '
     end
 
     def hash_for_to_s
@@ -91,7 +93,7 @@ module Browserino
     end
 
     def to_a
-      @info.keys.each_with_object([]) { |f, a| a.push([f, send(f)]) }.compact
+      @info.keys.each_with_object([]) { |f, a| a.push([f, send(f)]) }
     end
 
     def to_h
@@ -100,15 +102,29 @@ module Browserino
 
     def method_missing(method_sym, *args, &block)
       name = method_sym.to_s.tr('?', '')
-      invertable case agent_or_system?(method_sym)
+      invertable case type_id(method_sym)
                  when :system then correct_system?(name, *args)
                  when :agent then correct_agent?(name, *args)
+                 when :console then correct_console?(name, *args)
                  else super
                  end
     end
 
     def respond_to?(method_sym, *args, &block)
-      agent_or_system?(method_sym).nil? ? false : true
+      type_id(method_sym).nil? ? false : true
+    end
+
+    private
+
+    def post_process(h)
+      case h[:name]
+      when 'edge'
+        h[:engine_name] = 'edgehtml'
+        h[:engine_version] = h[:browser_version].to_s.split('.').shift.to_s
+      when 'ie'
+        h[:engine_name] = 'trident'
+      end
+      h
     end
   end
 end

data/lib/browserino/console.rb

@@ -0,0 +1,10 @@
+module Browserino
+  module Console
+    def self.name(ua)
+      Browserino.extract_match(
+        ua.match(Core::PATTERNS[:console][:name]),
+        :name
+      )
+    end
+  end
+end

data/lib/browserino/core/alias.rb

@@ -1,7 +1,7 @@
 module Browserino
   module Core
     ALIAS = {
-      browser_name: { 'ie' => /msie/ },
+      name: { 'ie' => /msie/ },
       engine_name: { 'webkit' => /applewebkit/ },
       system_name: {
         'solaris' => /s(?:unos|olaris)/,
@@ -9,6 +9,10 @@ module Browserino
         'windows_phone' => /windows\sphone/,
         'ios' => /ip(?:[ao]d|hone)/
       },
+      console_name: {
+        'nintendo_ds' => /nintendo\s\d?ds/,
+        'wii' => /wiiu?/
+      },
       system_architecture: {
         'x64' => /(?:x86_|amd|wow)?64/,
         'x32' => /(?:(?:x86_)?32|i[36]8[36])/

data/lib/browserino/core/helpers.rb

@@ -45,13 +45,19 @@ module Browserino
         end
       end
 
-      def agent_or_system?(method_sym)
+      def correct_console?(name)
+        Core::Questions::CONSOLES.include?(name.to_sym)
+      end
+
+      def type_id(method_sym)
         name = method_sym.to_s.tr('?', '')
         supported = Core::PATTERNS[:browser].merge(Core::PATTERNS[:bot]).keys
         if supported.include?(name.to_sym)
           :agent
         elsif Mapping.const?(name.upcase.to_sym)
           :system
+        elsif name == 'console'
+          :console
         end
       end
 

data/lib/browserino/core/patterns.rb

@@ -113,6 +113,10 @@ module Browserino
                 |blackberry|iemobile|fennec|bada|meego|vodafone
                 |t\-mobile|opera\sm(?:ob|in)i/xi,
         locale: /\s(?<locale>\w{2}(?:\-\w{2})?)[;\)]/
+      },
+
+      console: {
+        name: /(?<name>xbox|playstation|nintendo\s3?ds|wiiu?)/i,
       }
     }.freeze
   end

data/lib/browserino/core/questions.rb

@@ -1,11 +1,19 @@
 module Browserino
   module Core
     module Questions
-      SOCIAL_MEDIA = [:facebook, :twitter, :linkedin,
+      SOCIAL_MEDIA = [:facebook, :fb, :twitter, :linkedin,
                       :instagram, :pinterest, :tumblr].freeze
 
       SEARCH_ENGINES = [:google, :bing, :yahoo_slurp,
-                        :baiduspider, :duckduckgo].freeze
+                        :baiduspider, :duckduckgo, :ddg].freeze
+
+      BROWSERS = (Core::PATTERNS[:browser].keys + [:ff]).freeze
+
+      CONSOLES = [:xbox, :playstation, :nintendo_ds, :wii].freeze
+
+      OPERATING_SYSTEMS = (Browserino::Mapping
+                            .constants(:true)
+                            .map(&:downcase) + [:osx, :bb, :win]).freeze
 
       def compat?
         invertable ie? && browser_version != browser_version(compat: true)
@@ -51,34 +59,53 @@ module Browserino
         duckduckgo?(*arg)
       end
 
+      def playstation?
+        invertable console_name == 'playstation'
+      end
+
+      def nintendo_ds?
+        invertable console_name == 'nintendo_ds'
+      end
+
+      def xbox?
+        invertable console_name == 'xbox'
+      end
+
+      def wii?
+        invertable console_name == 'wii'
+      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 console?(name = nil)
+        arg = (name.nil? ? console_name : name).to_s.to_sym
+        invertable CONSOLES.include?(arg)
+      end
+
       def search_engine?(name = nil)
-        if name
-          invertable send("#{name}?")
-        else
-          invertable SEARCH_ENGINES.include?(search_engine_name.to_s.to_sym)
-        end
+        arg = (name.nil? ? search_engine_name : name).to_s.to_sym
+        invertable SEARCH_ENGINES.include?(arg)
       end
 
       def social_media?(name = nil)
-        if name
-          invertable send("#{name}?")
-        else
-          invertable SOCIAL_MEDIA.include?(bot_name.to_s.to_sym)
-        end
+        arg = (name.nil? ? bot_name : name).to_s.to_sym
+        invertable SOCIAL_MEDIA.include?(arg.to_s.to_sym)
       end
 
       def platform?(name = nil, opts = {})
-        invertable name ? send("#{name}?", opts[:version]) : !system_name.nil?
+        arg = (name.nil? ? system_name : name).to_s.to_sym
+        invertable OPERATING_SYSTEMS.include?(arg) &&
+                   (opts[:version].nil? ? true : send("#{name}?", opts[:version]))
       end
 
       def browser?(name = nil, opts = {})
-        invertable name ? send("#{name}?", opts[:version]) : !browser_name.nil?
+        arg = (name.nil? ? browser_name.tr(' ', '_') : name).to_s.to_sym
+        invertable BROWSERS.include?(arg) &&
+                   (opts[:version].nil? ? true : send("#{name}?", opts[:version]))
       end
     end
   end

data/lib/browserino/version.rb

@@ -1,3 +1,3 @@
 module Browserino
-  VERSION = '2.8.2'.freeze
+  VERSION = '2.9.0'.freeze
 end

data/lib/browserino.rb

@@ -1,9 +1,3 @@
-require 'browserino/core/helpers'
-require 'browserino/core/questions'
-require 'browserino/core/lies'
-require 'browserino/core/alias'
-require 'browserino/core/patterns'
-
 require 'browserino/maps/mapping'
 require 'browserino/maps/macintosh'
 require 'browserino/maps/blackberry'
@@ -15,6 +9,12 @@ require 'browserino/maps/android'
 require 'browserino/maps/windows'
 require 'browserino/maps/windows_phone'
 
+require 'browserino/core/patterns'
+require 'browserino/core/questions'
+require 'browserino/core/helpers'
+require 'browserino/core/lies'
+require 'browserino/core/alias'
+
 require 'browserino/integrate/rails' if defined?(::Rails)
 
 require 'browserino/unknown'
@@ -24,6 +24,7 @@ require 'browserino/version'
 require 'browserino/browser'
 require 'browserino/engine'
 require 'browserino/operating_system'
+require 'browserino/console'
 
 # require_relative "../spec/user_agents"
 # require_relative "../spec/user_agents_bots"
@@ -35,32 +36,22 @@ module Browserino
   def parse(ua, _ = nil) # _ = nil maintains backwards compatibility
     name = Browser.name(ua)
     info = fetch_info(strip_lies(ua), name)
-    tmp = info[:browser_name].to_s.tr('_', ' ')
-    info[:browser_name] = tmp.strip == '' ? nil : tmp
-    info = check_if_bot(name, info)
+    tmp = info[:name].to_s.tr('_', ' ')
+    info[:name] = tmp.strip == '' ? nil : tmp
 
     Agent.new check_for_aliases(info), ua
   end
 
   def fetch_info(ua, name)
-    { browser_name: name,
+    { name: name,
       browser_version: Browser.version(ua, Core::PATTERNS[:browser][name]),
       engine_name: Engine.name(ua),
       engine_version: Engine.version(ua),
       system_name: OperatingSystem.name(ua),
       system_version: OperatingSystem.version(ua),
       system_architecture: OperatingSystem.architecture(ua),
-      locale: OperatingSystem.locale(ua),
-      bot_name: nil }
-  end
-
-  def check_if_bot(name, info)
-    if Core::PATTERNS[:bot].include?(name)
-      info[:bot_name] = info[:browser_name]
-      info[:browser_name] = nil
-      info[:browser_version] = nil
-    end
-    info
+      console_name: Console.name(ua),
+      locale: OperatingSystem.locale(ua) }
   end
 
   def strip_lies(ua)

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: browserino
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 2.9.0
 platform: ruby
 authors:
 - Sidney Liebrand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2016-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -88,11 +88,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -103,9 +103,11 @@ files:
 - bin/console
 - bin/setup
 - browserino.gemspec
+- grep
 - lib/browserino.rb
 - lib/browserino/agent.rb
 - lib/browserino/browser.rb
+- lib/browserino/console.rb
 - lib/browserino/core/alias.rb
 - lib/browserino/core/helpers.rb
 - lib/browserino/core/lies.rb
@@ -137,17 +139,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A browser identification gem with Rails (>= 3.2.0) integration