browserino 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f08ae3900de04e818da158b3f213e35d7ea8559
-  data.tar.gz: d9a2ae06194faf027c91de73569e2d9054e8e970
+  metadata.gz: 09967128c9c89bc6bb97b7cd455ddf0a91f8947e
+  data.tar.gz: 57fff14bb77564131996b23d066764746692f8bf
 SHA512:
-  metadata.gz: bac6047a73c354f69e1a3b6d95747381e61d8fa69e3773c231432d0b7f8b2adfa3db760bdbcb61d6bcc20f8a104235caf895c642fb9876be603a8f5776afbd6d
-  data.tar.gz: 654765d84f9e822dd886ceb393bd7e4ba12831aaece76851689a27ffd4e7d320516769dac020ff4756b9a3759ce620102e249617585e7a816e05611fea42b5ec
+  metadata.gz: d55c9c93837fcfce61caf28ac2c845313b05c8aa6378b25ca0217fab37c919754a5d23972dfa947ade7b4a3b6fac71f5906b5bd77a805157883319b452c60ade
+  data.tar.gz: 0756df1c2c34208293f74aba43e670312e4a6ced67f03eb4bab2b78479e6096315736365a3f803617d7717c2856c1eefb240b2690dc3a861c29eb22a7174ffb7

data/README.md

@@ -1,5 +1,6 @@
 # Browserino
 
+[![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)
 
@@ -30,19 +31,6 @@ Or install it yourself as:
 
 ## Usage
 
-*Currently this gem has only functionality - On my list of tasks so far:*
-
-- Extract browser
-  * name __- done__
-  * version __- done__
-- Extract engine
-  * name __- done__
-  * version __- done__
-- Extract operating system
-  * name __- done__
-  * version __- done__
-  * architecture
-
 After installing the gem globally or in your application you'll have to `require` the gem before being able to use it.
 
 ```ruby
@@ -57,26 +45,95 @@ Browserino::parse('<user agent>')
 Which 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.
 
-### general
 ```ruby
 require 'browserino'
 
-agent = Browserino::parse('Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5355d Safari/8536.25')
+agent = Browserino::parse('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.75.14 (KHTML, like Gecko) Version/7.0.3 Safari/7046A194A')
 
-agent.browser_name # => safari
-agent.browser_version # => 6.0
+agent.browser_name # => 'safari'
+agent.browser_version # => 7.0.3
 
-agent.engine_name # => webkit
-agent.engine_version # => 536.26
+agent.engine_name # => 'webkit'
+agent.engine_version # => 537.75.14
 
-agent.system_name # => ios
+agent.system_name # => 'macintosh'
+# or optionally, the full name (guessed from OS version)
+agent.system_name full: true # => ['macintosh', 'mavericks']
 agent.system_version # => 6.0
-agent.system_architecture # => unknown (though it will make an attempt)
+agent.system_architecture # => 'x32' or 'x64' or 'unknown'
 ```
 
 ## Development
 
-*Should you want to contribute to the project the instructions for it will be here when version 1 releases (PENDING)*
+Currently things are actually going quite well besides the fact that I am trying to learn multiple techniques at the same time thus causing code to sometimes... well be messy at best.
+What I would not want you all to do is dive in there and try to understand it (tho if you do and want in, let me know!) but I would greatly appriciate help regarding the testing of this sniffer.
+
+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).
+
+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 = {
+    mac: {},
+    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'
+      },
+    },
+    linux: {}
+  }
+end
+```
+
+Valid browser names are defined by __/lib/browserino/patterns.rb__ (the keys are the browser names)
+
+#### browser_name examples
+```ruby
+'unknown'
+'ie'
+'firefox'
+'chrome'
+'opera'
+'maxthon'
+```
+
+#### engine_name examples
+```ruby
+'unknown'
+'gecko'
+'webkit'
+'trident'
+```
+
+#### system_name examples
+
+_The main reason for not having Linux distro's / versions yet is because of the fact that there are MANY different distro's with no real structured release system (going to work on that whenever there's free time!)_
+
+```ruby
+['windows', '7'] # where the 'windows' part is the name of the OS and the '7' is the actual version release (e.g. NT 6.1)
+['macintosh', 'yosemite'] # same as above but OSX has different names ofcourse.
+['android', 'lollipop'] # etcetera...
+['unknown', 'unknown'] # in case it isn't known or in case of Linux
+```
+
+#### system_architecture examples
+```ruby
+'unknown'
+'x32'
+'x64'
+```
+
+__The value of unknown is a default error value that will always be available to test against. If it ain't known it's unknown__
 
 ## Contributing
 

data/lib/browserino/agent.rb

@@ -7,19 +7,19 @@ module Browserino
     end
 
     def browser_name
-      @info[:browser_name].downcase
+      @info[:browser_name].downcase || Browserino::UNKNOWN
     end
 
     def browser_version
-      @info[:browser_version].gsub('_', '.').downcase
+      @info[:browser_version].gsub('_', '.').downcase || Browserino::UNKNOWN
     end
 
     def engine_name
-      @info[:engine_name].downcase
+      @info[:engine_name].downcase || Browserino::UNKNOWN
     end
 
     def engine_version
-      @info[:engine_version].gsub('_', '.').downcase
+      @info[:engine_version].gsub('_', '.').downcase || Browserino::UNKNOWN
     end
 
     def system_name(opts = {})
@@ -28,16 +28,16 @@ module Browserino
       if opts[:full]
         [name, fetch_system_version_name(name).downcase]
       else
-        name
+        name || Browserino::UNKNOWN
       end
     end
 
     def system_version
-      @info[:system_version].gsub('_', '.').downcase
+      @info[:system_version].gsub('_', '.').downcase || Browserino::UNKNOWN
     end
 
     def system_architecture
-      @info[:system_architecture].downcase
+      @info[:system_architecture].downcase || Browserino::UNKNOWN
     end
 
     private
@@ -53,7 +53,7 @@ module Browserino
       if version && defined? const
         Browserino::Mapping.const_get(const).select { |name, versions| true if versions.include?(version) }.keys.first
       else
-        'unknown'
+         Browserino::UNKNOWN
       end
     end
   end

data/lib/browserino/agent_manipulator.rb

@@ -18,7 +18,7 @@ module Browserino
     end
 
     def strip_fake_opera_version!
-      @ua = @ua.gsub(/ope?ra?(\/|\s)?[\d\.]+/i, '')
+      @ua = @ua.gsub(/ope?ra?(\/|\s)?9\.80/i, '')
     end
 
     def ua

data/lib/browserino/alias.rb

@@ -2,28 +2,28 @@ module Browserino
   ALIAS = {
     browser_name: {
       'ie' => ['msie'],
-      'unknown' => ['unknown', :unknown, '']
+      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
     },
     browser_version: {
-      'unknown' => ['unknown', :unknown, '']
+      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
     },
     engine_name: {
       'webkit' => ['applewebkit'],
-      'unknown' => ['unknown', :unknown, '']
+      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
     },
     engine_version: {
-      'unknown' => ['unknown', :unknown, '']
+      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
     },
     system_name: {
-      'unknown' => ['unknown', :unknown, '']
+      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
     },
     system_version: {
-      'unknown' => ['unknown', :unknown, '']
+      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
     },
     system_architecture: {
       'x64' => ['64', 'x86_64'],
-      'x32' => ['32', 'i686', 'i383'],
-      'unknown' => ['unknown', :unknown, '', nil]
+      'x32' => ['32', 'i686', 'i383', 'x86_32'],
+      Browserino::UNKNOWN => ['unknown', :unknown, '', nil]
     }
   }
 end

data/lib/browserino/browser.rb

@@ -2,7 +2,7 @@ module Browserino
   module Browser
     def self.version(ua, patterns)
       out = MatchExtractor::extract(ua.match(patterns[:version]), :version).to_s.downcase unless patterns.nil?
-      out ||= ''
+      out ||= Browserino::UNKNOWN
     end
   end
 end

data/lib/browserino/engine.rb

@@ -1,11 +1,11 @@
 module Browserino
   module Engine
     def self.name(ua)
-      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:engine][:name]), :name).to_s.downcase
+      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:engine][:name]), :name).to_s.downcase || Browserino::UNKNOWN
     end
 
     def self.version(ua)
-      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:engine][:version]), :version).to_s.downcase
+      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:engine][:version]), :version).to_s.downcase || Browserino::UNKNOWN
     end
   end
 end

data/lib/browserino/match_extractor.rb

@@ -2,12 +2,12 @@ module Browserino
   module MatchExtractor
     def self.extract(match, sym, trim = true)
       if match.nil?
-        :unknown
+        Browserino::UNKNOWN
       elsif match.names.map(&:to_sym).include?(sym)
         match[sym].strip! if trim
         match[sym]
       else
-        :unknown
+        Browserino::UNKNOWN
       end
     end
   end

data/lib/browserino/operating_system.rb

@@ -1,15 +1,15 @@
 module Browserino
   module OperatingSystem
     def self.name(ua)
-      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:operating_system][:name]), :name).to_s.downcase
+      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:operating_system][:name]), :name).to_s.downcase || Browserino::UNKNOWN
     end
 
     def self.version(ua)
-      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:operating_system][:version]), :version).to_s.downcase
+      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:operating_system][:version]), :version).to_s.downcase || Browserino::UNKNOWN
     end
 
     def self.architecture(ua)
-      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:operating_system][:architecture]), :architecture).to_s.downcase
+      MatchExtractor::extract(ua.match(Browserino::PATTERNS[:operating_system][:architecture]), :architecture).to_s.downcase || Browserino::UNKNOWN
     end
   end
 end

data/lib/browserino/unknown.rb

@@ -0,0 +1,3 @@
+module Browserino
+    UNKNOWN = 'unknown'
+end

data/lib/browserino/version.rb

@@ -1,3 +1,3 @@
 module Browserino
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/browserino.rb

@@ -3,9 +3,11 @@ require "browserino/maps/ios"
 require "browserino/maps/android"
 require "browserino/maps/windows"
 
+require "browserino/unknown"
+require "browserino/agent"
+
 require "browserino/alias"
 require "browserino/agent_manipulator"
-require "browserino/agent"
 require "browserino/version"
 require "browserino/match_extractor"
 require "browserino/patterns"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browserino
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Sidney Liebrand
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,6 +142,7 @@ files:
 - lib/browserino/match_extractor.rb
 - lib/browserino/operating_system.rb
 - lib/browserino/patterns.rb
+- lib/browserino/unknown.rb
 - lib/browserino/version.rb
 homepage: https://github.com/SidOfc/browserino
 licenses: