device_wizard 0.3.0 → 1.0.0

data/lib/device_wizard/details.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'device_wizard/details/browser'
+require 'device_wizard/details/device'
+require 'device_wizard/details/operating_system'

data/lib/device_wizard/details/browser.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Details
+    class Browser
+      attr_accessor :name
+      attr_accessor :version
+
+      def initialize
+        @name = UNKNOWN
+        @version = UNKNOWN
+      end
+    end
+  end
+end

data/lib/device_wizard/details/device.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Details
+    class Device
+      attr_accessor :type
+      attr_accessor :browser
+      attr_accessor :os
+    end
+  end
+end

data/lib/device_wizard/details/operating_system.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Details
+    class OperatingSystem
+      attr_accessor :name
+      attr_accessor :type
+      attr_accessor :version
+    end
+  end
+end

data/lib/device_wizard/device_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  class DeviceType
+    DESKTOP = 'desktop'
+    TABLET  = 'tablet'
+    MOBILE  = 'mobile'
+    CRAWLER = 'crawler'
+    UNKNOWN = 'unknown'
+  end
+end

data/lib/device_wizard/resolvers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'device_wizard/resolvers/base'
+
+require 'device_wizard/resolvers/android'
+require 'device_wizard/resolvers/firefox'
+require 'device_wizard/resolvers/google_chrome'
+require 'device_wizard/resolvers/internet_explorer'
+require 'device_wizard/resolvers/ios'
+require 'device_wizard/resolvers/mac'
+require 'device_wizard/resolvers/safari'
+require 'device_wizard/resolvers/windows'

data/lib/device_wizard/resolvers/android.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Resolvers
+    class Android < Base
+      NAME = 'Android'
+      KEYWORD = 'android'
+      REGEX = Regexp.new('android (\d+(?:\.\d+)+)')
+
+      def details_klass
+        Details::OperatingSystem
+      end
+    end
+  end
+end

data/lib/device_wizard/resolvers/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Resolvers
+    class Base
+      def get_version(user_agent)
+        user_agent.downcase!
+        result = UNKNOWN
+        result = $1 if self.class::REGEX =~ user_agent
+      end
+
+      def identify(user_agent)
+        user_agent.downcase!
+
+        return unless user_agent.include? self.class::KEYWORD
+
+        result = details_klass.new
+        result.name = self.class::NAME
+        result.version = get_version(user_agent)
+        result
+      end
+
+      def details_klass
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/device_wizard/resolvers/firefox.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Resolvers
+    require 'device_wizard/resolvers/base'
+
+    class Firefox < Base
+      NAME = 'Firefox'
+      KEYWORD = 'firefox'
+      REGEX = Regexp.new('firefox/([0-9]+.[0-9])')
+
+      def details_klass
+        Details::Browser
+      end
+    end
+  end
+end

data/lib/device_wizard/resolvers/google_chrome.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Resolvers
+    class GoogleChrome < Base
+      NAME = 'Google Chrome'
+      KEYWORD = 'chrome'
+      REGEX = Regexp.new('chrome/([0-9]+.[0-9]+.[0-9]+.[0-9])')
+
+      def details_klass
+        Details::Browser
+      end
+    end
+  end
+end

data/lib/device_wizard/resolvers/internet_explorer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Resolvers
+    class InternetExplorer < Base
+      NAME = 'Internet Explorer'
+      KEYWORD = 'msie'
+      KEYWORD2 = ' rv:'
+      REGEX = Regexp.new('msie ([0-9]+.[0-9])')
+      REGEX2 = Regexp.new('rv:([0-9]+.[0-9])')
+
+      def get_version(user_agent)
+        user_agent.downcase!
+        result = UNKNOWN
+
+        return result = $1 if REGEX =~ user_agent
+        return result = $1 if REGEX2 =~ user_agent
+      end
+
+      def identify(user_agent)
+        user_agent.downcase!
+
+        unless user_agent.include? KEYWORD
+          return unless user_agent.include? KEYWORD2
+        end
+
+        result = details_klass.new
+        result.name = NAME
+        result.version = get_version(user_agent)
+        result
+      end
+
+      def details_klass
+        Details::Browser
+      end
+    end
+  end
+end

data/lib/device_wizard/resolvers/ios.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Resolvers
+    class IOS < Base
+      NAME = 'IOS'
+      IPHONE = 'iphone'
+      IPAD = 'ipad'
+      IPOD = 'ipod'
+      REGEX = Regexp.new('os ((\d+_?){2,3})\s')
+
+      def get_version(user_agent)
+        result = super(user_agent)
+        result.gsub('_','.')
+      end
+
+      def get_type(user_agent)
+        user_agent.downcase!
+
+        return 'IPod' if user_agent.include? IPOD
+        return 'IPad' if user_agent.include? IPAD
+        return 'IPhone' if user_agent.include? IPHONE
+        return UNKNOWN
+      end
+
+      def identify(user_agent)
+        user_agent.downcase!
+
+        return unless [IPHONE, IPAD, IPOD].any? { |i| user_agent.include? i }
+
+        result = details_klass.new
+        result.name = NAME
+        result.type = get_type(user_agent)
+        result.version = get_version(user_agent)
+        return result
+      end
+
+      def details_klass
+        Details::OperatingSystem
+      end
+    end
+  end
+end

data/lib/device_wizard/resolvers/mac.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Resolvers
+    class Mac < Base
+      NAME = 'Mac OSX'
+      KEYWORD = 'intel mac os x'
+      REGEX = Regexp.new('intel mac os x ([0-9]+_[0-9])')
+
+      def get_version(user_agent)
+        result = super(user_agent)
+        result.gsub('_','.')
+      end
+
+      def details_klass
+        Details::OperatingSystem
+      end
+    end
+  end
+end

data/lib/device_wizard/resolvers/safari.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Resolvers
+    class Safari < Base
+      NAME = 'Safari'
+      KEYWORD = 'safari'
+      REGEX = Regexp.new('safari/([\.0-9]{3,})')
+
+      def details_klass
+        Details::Browser
+      end
+    end
+  end
+end

data/lib/device_wizard/resolvers/windows.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  module Resolvers
+    class Windows < Base
+      NAME = 'Windows'
+      KEYWORD = 'windows nt'
+      REGEX = Regexp.new('windows nt ([0-9]{1,}[\.0-9]{0,})')
+      NTVERSION = [ '4.0', '5.0', '5.01', '5.1', '5.2', '6.0', '6.1', '6.2', '6.3' ]
+      NTNAME = [ 'NT 4.0', '2000', '2000 SP1', 'XP', 'XP x64', 'Vista', '7', '8', '8.1' ]
+
+      def get_version(user_agent)
+        user_agent.downcase!
+        result = UNKNOWN
+
+        if REGEX =~ user_agent
+          if NTVERSION.index($1)
+            result = NTNAME[NTVERSION.index($1)]
+          else
+            result = $1
+          end
+        end
+      end
+
+      def details_klass
+        Details::OperatingSystem
+      end
+    end
+  end
+end

data/lib/device_wizard/user_agent_detector.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module DeviceWizard
+  class UserAgentDetector
+    #########
+    ##CONST Keywords
+    MOBILE = 'mobile'
+    IPAD = 'ipad'
+    IPHONE = 'iphone'
+    ANDROID = 'android'
+    TABLET = 'tablet'
+    SILK = 'silk'
+    #########
+
+    #########
+    ##CONST Regex Patterns
+    #########
+    REGEX_OS = /(windows|linux|os\s+[x9]|solaris|bsd)/
+    REGEX_MOBILE = /(iphone|ipod|blackberry|android|palm|windows\s+ce|mobile|symbian|phone)/
+    REGEX_CRAWLER = /(spider|crawl|slurp|bot)/
+    #########
+
+    def initialize
+      @browser_resolvers = []
+      @browser_resolvers.push(Resolvers::Firefox.new)
+      @browser_resolvers.push(Resolvers::GoogleChrome.new)
+      @browser_resolvers.push(Resolvers::InternetExplorer.new)
+      @browser_resolvers.push(Resolvers::Safari.new)
+
+      @os_resolvers = []
+      @os_resolvers.push(Resolvers::Android.new)
+      @os_resolvers.push(Resolvers::IOS.new)
+      @os_resolvers.push(Resolvers::Mac.new)
+      @os_resolvers.push(Resolvers::Windows.new)
+    end
+
+    def unknown
+      UNKNOWN
+    end
+
+    def get_device_type(user_agent)
+      if user_agent.to_s.strip.length == 0
+        return DeviceType::UNKNOWN
+      end
+
+      user_agent.downcase!
+
+      if user_agent.include? TABLET
+        return DeviceType::TABLET
+      end
+
+      type = determine_type(user_agent)
+      type || DeviceType::UNKNOWN
+    end
+
+    def get_browser(user_agent)
+      @browser_resolvers.each do |r|
+        browser = r.identify(user_agent)
+        return browser unless browser.nil?
+      end
+
+      Details::Browser.new
+    end
+
+    def get_os(user_agent)
+      @os_resolvers.each do |r|
+        os = r.identify(user_agent)
+        return os unless os.nil?
+      end
+
+      Details::OperatingSystem.new
+    end
+
+    def get_details(user_agent)
+      details = Details::Device.new
+      details.type = get_device_type(user_agent)
+      details.browser = get_browser(user_agent)
+      details.os = get_os(user_agent)
+      details
+    end
+
+    private
+
+    def determine_type(user_agent)
+      return DeviceType::TABLET if user_agent.include? TABLET
+
+      if user_agent.include? MOBILE
+        if user_agent.include? IPAD
+          return DeviceType::TABLET
+        else
+          return DeviceType::MOBILE
+        end
+      elsif user_agent.include? ANDROID
+        return DeviceType::TABLET
+      end
+
+      return DeviceType::MOBILE if REGEX_MOBILE =~ user_agent
+      return DeviceType::TABLET if user_agent.include? SILK
+      return DeviceType::DESKTOP if REGEX_OS =~ user_agent
+      return DeviceType::CRAWLER if REGEX_CRAWLER =~ user_agent
+    end
+  end
+end

data/lib/device_wizard/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeviceWizard
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: device_wizard
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,46 +42,69 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: '3.0'
+        version: '0'
 description: A device detection framework that is not based on lookup dictionaries,
   which makes this framework extra light weight, ultra fast and future proof as new
   devices don't need to be added into the framework.
 email:
-- vaughanbritton@gmail.com
+- vaughan.britton@sage.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".idea/.name"
-- ".idea/.rakeTasks"
-- ".idea/device_wizard.iml"
-- ".idea/encodings.xml"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
-- ".idea/vcs.xml"
-- ".idea/workspace.xml"
 - ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - device_wizard.gemspec
 - lib/device_wizard.rb
+- lib/device_wizard/details.rb
+- lib/device_wizard/details/browser.rb
+- lib/device_wizard/details/device.rb
+- lib/device_wizard/details/operating_system.rb
+- lib/device_wizard/device_type.rb
+- lib/device_wizard/resolvers.rb
+- lib/device_wizard/resolvers/android.rb
+- lib/device_wizard/resolvers/base.rb
+- lib/device_wizard/resolvers/firefox.rb
+- lib/device_wizard/resolvers/google_chrome.rb
+- lib/device_wizard/resolvers/internet_explorer.rb
+- lib/device_wizard/resolvers/ios.rb
+- lib/device_wizard/resolvers/mac.rb
+- lib/device_wizard/resolvers/safari.rb
+- lib/device_wizard/resolvers/windows.rb
+- lib/device_wizard/user_agent_detector.rb
 - lib/device_wizard/version.rb
-homepage: https://github.com/vaughanbrittonsage/device_wizard
+homepage: https://github.com/sage/device_wizard
 licenses:
 - MIT
 metadata: {}
@@ -101,9 +124,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A fast & lightweight device detection framework.
 test_files: []
-has_rdoc: