device_wizard 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd3307c63814550df7704a3af6895c3922d217b2
-  data.tar.gz: ab006265813b076d949f6079617785aebf923279
+SHA256:
+  metadata.gz: 8ee4a7895de008768c343a7825805b36cc7aca3214c6f636cbe943217bf82fd1
+  data.tar.gz: 89fcb5c82a9e451cff573c27db3ad28ffc9d67cc197b53c785f1914adb6da8ac
 SHA512:
-  metadata.gz: 3a9356d5ab9fdee5ec19e2a2d0bcfe176e988aa6950664448e44f74a113097b002bfbd00ff2b77d8903adb464172319db4e033ce865df8923ad7bdd4bc9b38a2
-  data.tar.gz: 933c9bc6cbd6fd1ffbd308476ff7fb4db53c0a4a9eb45ee8ae63151b528eed5833d55741208ebe729326f1c3e7cbec21a257f704c247b15a2cb47596b4391e95
+  metadata.gz: 962c9ab30dc9aceba9cc5109d72816324c6e4adce74cde2ad8d3cccd3cc61ad52f1cf915f63e906e200fd152c5d133fcee5b9046a6e45a01744dea2dfceb73c9
+  data.tar.gz: cfeb3693aebe1f7a5756b9c0750a4fca2643d8ad5bbb91e74413ae975175263938c493d908f9580cfd69325ae826d39a9fcb418e0a94ef8ee6f437c85c2b34bc

data/.gitignore

@@ -1,3 +1,4 @@
+.idea
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -7,3 +8,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --require spec_helper
---format doc

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+rvm:
+  - 2.3.5
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+    > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - "./cc-test-reporter before-build"
+after_script:
+  - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+env:
+  global:
+    secure: F6wCA9Gp7+vRRl/JzEqr2Lp0f/lGd+VnDVNX8ifOjQqOtCKvHNz5+9P+FaxCouDSicq5d1z7FdHGaGRsERDbo/oWfoDh81fNx/DaQoMaPC30xt4ihIP7d3AcPj15Y5WoqzNFejOCMFxkg2T0P8kiaj/0yQsiAXfiQmRC3jaemOaK2ashxj7MR7OXdPh0EwjZ4xKFiaFQVTau0vULqRAwe3IJ3XbrHsCl/mEimEPH3lse0/+ZnCbrmC6bRQf327gbOk53PWeagLH/mxXK188073Ju037d9w6b/5pkrfCSpTIaQ4Q0y7bhHp9CgmvU6xAzFW2QsglMUIefGKcpPeJ3RkA/iJH9dLGkTaVeRBwTleS4kAhQVHO/RdeTnJPAazm5KWX3WoTOo9Fd0B/ShJddHVEB2FpkVhNIQ3USxLMq8N8IExWLF99tLcIeM3kK1cMVW1wJMdEXe/v9ifzkrv3OCveKgfIuzULRFrlPxKSS9DLSQWtIFZKUFG6Doj4hw+679fNdfW3FvDUWgJNTjPskxMfxpsbn7IAqxx4dY2iLH4O1eHKoLIwsZ0KUZPr8O8HI6QM5YhtRJNPmukcAvdXtErl1w29YMorUmNDc/LM0gl1zjLEc8jt2/TTPsUNitzhqZiBZhMmFk9USrvpcTsik6HFw4vmfR4sCn4dygOV/P4k=
+deploy:
+  provider: rubygems
+  api_key:
+    secure: shl5iQVT11TYdOTEy9rXePLOukcInAIoYUdzeXEKwiszwxJ0XKC62DRBkXqIKf9goYyHnd96EQfYFBy9yjbtcwp/pJ9TUxOFBIIwr1OJduble8WduJgAgG3xIG7i7gUB7DnCDSC8jdKO28v03UzyvZw5zNFzzugzPy+H27BHcfp1KEoor31U0uMS/4qjfSAmS8mxejuPj5JmL8GKghMcGbLNOY8lqDLNfF5mCaYCBUrnFsqxlnbQsnymAsZKQXtdg3fUV6GHfV/YTOdA8rdmVUBaiQMV8JZZNE0PZG+neJ/3uIW+MHB8PZdz5Df5BwB/G1cw77A42pjO0UNTgImeDPXsGLkOmI5rl0hrxigLJ6GjV+Qur//kNlSusmbKIA6YMmnCd2NPVYt7BUejtS/kUIPBC9Lppq2BQTbkpXhy51a9e4kKH6zNw173XIHwLAj9c4+c/H5Pde7zfXNGp1pPQ17tk+Bk6G7Sosfb+ZBY0elmoZCNwr0DDi6icVujkg70CHTzEfzx/fI8ejZ/L0dVuB9kGZ9MZ3MWd38//Zp4jWzKD422nHdh1RlU7jR4M2rn9WKPW8l6mKJ9r1ozK/hyLqcQGKl/QqXNBc7oOL8rYLXszbmHqq99uE1+uw+oQP0e+SkX/F2w6gWHX4n9VY0hUMzz4y/QUG4iM3/1yIZtJgo=
+  gem: device_wizard
+  on:
+    tags: true
+    repo: Sage/device_wizard
+    condition: "$TRAVIS_RUBY_VERSION == 2.3.5"

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 vaughanbrittonsage
+Copyright (c) 2018 Sage Group Plc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,10 @@
 # DeviceWizard
 
+[![Build Status](https://travis-ci.org/Sage/device_wizard.svg?branch=master)](https://travis-ci.org/Sage/device_wizard)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f0d6439302f953419f93/maintainability)](https://codeclimate.com/github/Sage/device_wizard/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f0d6439302f953419f93/test_coverage)](https://codeclimate.com/github/Sage/device_wizard/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/device_wizard.svg)](https://badge.fury.io/rb/device_wizard)
+
 Welcome to DeviceWizard!
 
 The super fast, ultra light weight device detection framework.
@@ -16,53 +21,63 @@ gem 'device_wizard'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install device_wizard
+```bash
+$ gem install device_wizard
+```
 
 ## Usage
 
 **Identify All Details**
 
-    #create the user agent detector
-    detector = DeviceWizard::UserAgentDetector.new
-    
-    #pass the user agent to the detector
-    details = detector.get_details(user_agent)
-    
+```ruby
+#create the user agent detector
+detector = DeviceWizard::UserAgentDetector.new
+
+#pass the user agent to the detector
+details = detector.get_details(user_agent)
+```
+
 The detected details will return the following:
 - **Type** This is the device type of the request [mobile/tablet/desktop etc]
 - **Browser** This is the browser of the request {name, version}
 
+```ruby
+browser = details.browser
+
+browser_name = details.browser.name
+
+browser_version = details.browser.version
+```
 
-    browser = details.browser
-    
-    browser_name = details.browser.name
-    
-    browser_version = details.browser.version
-    
 - **OS** This is the operating system of the request {name, type, version}
 
+```ruby
+os = details.os
+
+os_name = details.os.name
 
-    os = details.os
-    
-    os_name = details.os.name
-    
-    os_type = details.os.type
-    
-    os_version = details.os.version
+os_type = details.os.type
+
+os_version = details.os.version
+```
 
 
 **Identify Device Type**
 
-    #create the user agent detector
-    detector = DeviceWizard::UserAgentDetector.new
-    
-    #pass the user agent to the detector
-    device_type = detector.get_device_type(user_agent_string)
-    
+```ruby
+#create the user agent detector
+detector = DeviceWizard::UserAgentDetector.new
+
+#pass the user agent to the detector
+device_type = detector.get_device_type(user_agent_string)
+```
+
 The detected device type will be one of the following:
 - **desktop**
 - **tablet**
@@ -80,10 +95,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/vaughanbrittonsage/device_wizard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sage/device_wizard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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).
+This gem is available as open source under the terms of the
+[MIT licence](LICENSE).
 
+Copyright (c) 2018 Sage Group Plc. All rights reserved.

data/Rakefile

@@ -1,2 +1,6 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/device_wizard.gemspec

@@ -1,25 +1,25 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'device_wizard/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "device_wizard"
+  spec.name          = 'device_wizard'
   spec.version       = DeviceWizard::VERSION
-  spec.authors       = ["vaughanbrittonsage"]
-  spec.email         = ["vaughanbritton@gmail.com"]
+  spec.authors       = ['vaughanbrittonsage']
+  spec.email         = ['vaughan.britton@sage.com']
 
   spec.summary       = 'A fast & lightweight device detection framework.'
   spec.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."
-  spec.homepage      = "https://github.com/vaughanbrittonsage/device_wizard"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/sage/device_wizard'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/device_wizard.rb

@@ -1,435 +1,11 @@
-require "device_wizard/version"
+# frozen_string_literal: true
 
-module DeviceWizard
-
-  UNKNOWN = 'Unknown'.freeze
-
-  class DeviceType
-    DESKTOP='desktop'
-    TABLET='tablet'
-    MOBILE='mobile'
-    CRAWLER='crawler'
-    UNKNOWN='unknown'
-  end
-
-  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(FirefoxResolver.new)
-      @browser_resolvers.push(GoogleChromeResolver.new)
-      @browser_resolvers.push(InternetExplorerResolver.new)
-      @browser_resolvers.push(SafariResolver.new)
-
-      @os_resolvers = []
-      @os_resolvers.push(AndroidResolver.new)
-      @os_resolvers.push(IOSResolver.new)
-      @os_resolvers.push(MacResolver.new)
-      @os_resolvers.push(WindowsResolver.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
-
-      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
-
-      if REGEX_MOBILE =~ user_agent
-        return DeviceType::MOBILE
-      end
-
-      if user_agent.include? SILK
-        return DeviceType::TABLET
-      end
-
-      if REGEX_OS =~ user_agent
-        return DeviceType::DESKTOP
-      end
-
-      if REGEX_CRAWLER =~ user_agent
-        return DeviceType::CRAWLER
-      end
-
-      return DeviceType::UNKNOWN
-
-    end
-
-    def get_browser(user_agent)
-
-      @browser_resolvers.each do |r|
-
-        browser = r.identify(user_agent)
-
-        if browser != nil
-          return browser
-        end
-
-      end
-
-      return BrowserDetails.new
-
-    end
-
-    def get_os(user_agent)
-
-      @os_resolvers.each do |r|
-
-        os = r.identify(user_agent)
-
-        if os != nil
-          return os
-        end
-
-      end
-
-      return OperatingSystemDetails.new
-
-    end
-
-    def get_details(user_agent)
-      details = DeviceDetails.new
-
-      details.type = get_device_type(user_agent)
-      details.browser = get_browser(user_agent)
-      details.os = get_os(user_agent)
-
-      return details
-    end
-
-  end
-
-  class DeviceDetails
-    attr_accessor :type
-    attr_accessor :browser
-    attr_accessor :os
-  end
-
-  class BrowserDetails
-    attr_accessor :name
-    attr_accessor :version
-
-    def initialize
-      @name = UNKNOWN
-      @version = UNKNOWN
-    end
-  end
-
-  class FirefoxResolver
-
-    KEYWORD = 'firefox'
-    REGEX = Regexp.new('firefox/([0-9]+.[0-9])')
-
-    def get_version(user_agent)
-      user_agent.downcase!
-      result = UNKNOWN
-
-      if REGEX =~ user_agent
-        result = $1
-      end
-    end
-
-    def identify(user_agent)
-      user_agent.downcase!
-
-      if !user_agent.include? KEYWORD
-        return nil
-      end
-
-      result = BrowserDetails.new
-      result.name = 'Firefox'
-      result.version = get_version(user_agent)
-      return result
-    end
-  end
-
-  class GoogleChromeResolver
-
-    KEYWORD = 'chrome'
-    REGEX = Regexp.new('chrome/([0-9]+.[0-9]+.[0-9]+.[0-9])')
-
-    def get_version(user_agent)
-      user_agent.downcase!
-      result = UNKNOWN
-
-      if REGEX =~ user_agent
-        result = $1
-      end
-    end
-
-    def identify(user_agent)
-      user_agent.downcase!
-
-      if !user_agent.include? KEYWORD
-        return nil
-      end
-
-      result = BrowserDetails.new
-      result.name = 'Google Chrome'
-      result.version = get_version(user_agent)
-      return result
-    end
-
-  end
-
-  class InternetExplorerResolver
-    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
-
-      if REGEX =~ user_agent
-        return result = $1
-      end
-      if REGEX2 =~ user_agent
-        return result = $1
-      end
-    end
-
-    def identify(user_agent)
-      user_agent.downcase!
-
-      if !user_agent.include? KEYWORD
-        if !user_agent.include? KEYWORD2
-          return nil
-        end
-      end
-
-      result = BrowserDetails.new
-      result.name = 'Internet Explorer'
-      result.version = get_version(user_agent)
-      return result
-    end
-
-  end
-
-  class SafariResolver
-
-    KEYWORD = 'safari'
-    REGEX = Regexp.new('safari/([\.0-9]{3,})')
-
-    def get_version(user_agent)
-      user_agent.downcase!
-      result = UNKNOWN
-
-      if REGEX =~ user_agent
-        result = $1
-      end
-    end
-
-    def identify(user_agent)
-      user_agent.downcase!
-
-      if !user_agent.include? KEYWORD
-        return nil
-      end
-
-      result = BrowserDetails.new
-      result.name = 'Safari'
-      result.version = get_version(user_agent)
-      return result
-    end
-
-  end
-
-  class OperatingSystemDetails
-
-    attr_accessor :name
-    attr_accessor :type
-    attr_accessor :version
-
-  end
-
-  class AndroidResolver
-
-    KEYWORD = 'android'
-    REGEX = Regexp.new('android (\d+(?:\.\d+)+)')
-
-    def get_version(user_agent)
-      user_agent.downcase!
-      result = UNKNOWN
-
-      if REGEX =~ user_agent
-        result = $1
-      end
-    end
-
-    def identify(user_agent)
-      user_agent.downcase!
-
-      if !user_agent.include? KEYWORD
-        return nil
-      end
-
-      result = OperatingSystemDetails.new
-      result.name = 'Android'
-      result.version = get_version(user_agent)
-      return result
-    end
-
-  end
-
-  class IOSResolver
-
-    IPHONE = 'iphone'
-    IPAD = 'ipad'
-    IPOD = 'ipod'
-    REGEX = Regexp.new('os ((\d+_?){2,3})\s')
-
-    def get_version(user_agent)
-      user_agent.downcase!
-      result = UNKNOWN
-
-      if REGEX =~ user_agent
-        result = $1
-      end
-
-      return result.gsub('_','.')
-    end
-
-    def get_type(user_agent)
-      user_agent.downcase!
-
-      if user_agent.include? IPOD
-        return 'IPod'
-      end
-
-      if user_agent.include? IPAD
-        return 'IPad'
-      end
-
-      if user_agent.include? IPHONE
-        return 'IPhone'
-      end
-
-      return UNKNOWN
-    end
-
-    def identify(user_agent)
-      user_agent.downcase!
-
-      if !user_agent.include? IPHONE
-        if !user_agent.include? IPAD
-          if !user_agent.include? IPOD
-            return nil
-          end
-        end
-      end
-
-      result = OperatingSystemDetails.new
-      result.name = 'IOS'
-      result.type = get_type(user_agent)
-      result.version = get_version(user_agent)
-      return result
-    end
-
-  end
-
-  class MacResolver
-
-    KEYWORD = 'intel mac os x'
-    REGEX = Regexp.new('intel mac os x ([0-9]+_[0-9])')
-
-    def get_version(user_agent)
-      user_agent.downcase!
-      result = UNKNOWN
-
-      if REGEX =~ user_agent
-        result = $1
-      end
-
-      return result.gsub('_','.')
-    end
-
-    def identify(user_agent)
-      user_agent.downcase!
-
-      if !user_agent.include? KEYWORD
-        return nil
-      end
-
-      result = OperatingSystemDetails.new
-      result.name = 'Mac OSX'
-      result.version = get_version(user_agent)
-      return result
-    end
-
-  end
-
-  class WindowsResolver
-
-    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 identify(user_agent)
-      user_agent.downcase!
-
-      if !user_agent.include? KEYWORD
-        return nil
-      end
-
-      result = OperatingSystemDetails.new
-      result.name = 'Windows'
-      result.version = get_version(user_agent)
-      return result
-    end
-
-  end
+require 'device_wizard/details'
+require 'device_wizard/device_type'
+require 'device_wizard/resolvers'
+require 'device_wizard/user_agent_detector'
+require 'device_wizard/version'
 
+module DeviceWizard
+  UNKNOWN = 'Unknown'
 end