ua-utils 0.3.3

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Harald Walker
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# UA-UTILS
+
+Utilities to parse user-agent strings.
+
+First implementation is mainly focusing on most common operating systems and device types, so that content can be optimized.
+
+## Usage
+
+### Rails
+
+In your Gemfile:
+
+```ruby
+gem 'ua-utils'
+```
+
+`bundle install` and restart your server to make the files available.
+
+
+### Example
+
+user_agent = UaUtils::UserAgent.new(user_agent_string)  
+or  
+os = UaUtils::OperatingSystem.new(user_agent_string)  
+
+## Operating systems
+
+Following operating systems can be detected:  
+windows, windows phone, mac os x, iOS, android, bada, meego, symbian  
+
+## Devices
+
+Following device types can be detected:  
+desktop, tablet, mobile, tv, bot  
+

data/lib/ua-utils.rb

@@ -0,0 +1,23 @@
+require 'ua-utils/user_agent'
+require 'ua-utils/operating_system'
+
+module UaUtils
+
+  VERSION = '0.3.3'
+
+  def self.logger
+    @logger ||= (rails_logger || default_logger)
+  end
+
+  def self.default_logger
+    require 'logger'
+    l = Logger.new(STDOUT)
+    l.level = Logger::INFO
+    l
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+end

data/lib/ua-utils/operating_system.rb

@@ -0,0 +1,80 @@
+module UaUtils
+
+  # The operating system that can be detected based on the user agent string.
+  #
+  # === Example
+  #
+  #   os = UaUtils::OperatingSystem.new(
+  #     'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_5; en-us) AppleWebKit/533.19.4 (KHTML, like Gecko) Version/5.0.3 Safari/533.19.4')
+  #
+  #   if os.tablet?
+  #    (... do something for tablet devices ...)
+  #   end
+  #
+  #   if os.platform == :ios
+  #     render "/ios/show"
+  #   end
+
+  class OperatingSystem
+
+    attr_reader :platform, :device
+
+    # Initializes operating system for parsing with the given user agent string.
+    def initialize(user_agent_string)
+      @platform, @device = detect_device(user_agent_string)
+    end
+
+    # Returns string representation of the operating system.
+    # @return [String]
+    def to_s
+      @platform.to_s
+    end
+
+    # Returns true if the operating system is a mobile device.
+    # @return [Boolean]
+    def mobile?
+      @device == :mobile
+    end
+
+    # Returns true if the operating system is a tablet device.
+    # @return [Boolean]
+    def tablet?
+      @device == :tablet
+    end
+
+    # Returns true if the operating system is a desktop device.
+    # @return [Boolean]
+    def desktop?
+      @device == :desktop
+    end
+
+    # Returns true if the operating system is a webTV device.
+    # @return [Boolean]
+    def webtv?
+      @device == :webtv
+    end
+
+    private
+
+      def detect_device(ua_string) #:nodoc:
+        case ua_string
+          when /(windows nt).*(touch)/i                         ; return :windows, :tablet
+          when /windows nt/i                                    ; return :windows, :desktop
+          when /ipad/i                                          ; return :ios, :tablet
+          when /iphone/i                                        ; return :ios, :mobile
+          when /mac os x/i                                      ; return :macosx, :desktop #after ios
+          when /android(?!.*kindle).*(mobile safari)/i          ; return :android, :mobile
+          when /(android).*(safari)/i                           ; return :android, :tablet #after mobile android
+          when /windows phone/i                                 ; return :windows_phone, :mobile
+          when /bada/i                                          ; return :bada, :mobile
+          when /meego/i                                         ; return :meego, :mobile
+          when /symbian|s60/i                                   ; return :symbian, :mobile
+          when /googletv/i                                      ; return :android, :tv
+          when /bot/i                                           ; return :unknown, :bot
+          else                                                  ; return :unknown, :unknown
+        end
+      end
+
+  end
+
+end

data/lib/ua-utils/user_agent.rb

@@ -0,0 +1,36 @@
+module UaUtils
+
+  # The user agent object.
+  #
+  # === Example
+  #
+  #   user_agent = UaUtils::UserAgent.new(
+  #     'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_5; en-us) AppleWebKit/533.19.4 (KHTML, like Gecko) Version/5.0.3 Safari/533.19.4')
+  #
+  #   if user_agent.os.tablet?
+  #    (... do something for tablet devices ...)
+  #   end
+  #
+  #   if user_agent.os.platform == :ios
+  #     render "/ios/show"
+  #   end
+  #
+  class UserAgent
+
+    attr_reader :os
+
+    # Initializes a user agent for parsing with a given user agent string
+    # @param [Object] user_agent_string
+    def initialize(user_agent_string)
+      @user_agent_string = user_agent_string
+    end
+
+    # Returns operating system of the user agent.
+    # @return [UaUtils::OperatingSystem] the detected operating system of the user agent string
+    def os
+      @os ||= UaUtils::OperatingSystem.new(@user_agent_string) # operating system
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib/ua-utils')
+require 'user_agent'
+require 'operating_system'

data/spec/ua-utils/user_agent_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+module UaUtils
+  describe 'UserAgent' do
+
+    describe 'detects mobile devices' do
+
+      it 'recognizes iOS phones' do
+          test([
+                   'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; nl-nl) AppleWebKit/420.1 (KHTML, like Gecko)',
+                   'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko)',
+                   'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420.1 (KHTML, like Gecko) Version/3.0 Mobile/4A93 Safari/419.3'
+               ],
+               { platform: :ios, device: :mobile })
+
+      end
+
+      it 'recognizes Android phones' do
+          test([
+                  'Mozilla/5.0 (Linux; U; Android 2.0; en-gb; Milestone Build/SHOLS_U2_01.03.1) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Mobile Safari/530.17',
+                  'Mozilla/5.0 (Linux; U; Android 4.0.1; en-us; Galaxy Nexus Build/ICL41) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30'
+               ],
+               { platform: :android, device: :mobile })
+      end
+
+      it 'recognizes Windows phones' do
+          test([
+                   'Mozilla/4.0 (compatible; MSIE 7.0; Windows Phone OS 7.0; Trident/3.1; IEMobile/7.0) Asus;Galaxy6',
+                   'Mozilla/5.0 (compatible; MSIE 9.0; Windows Phone OS 7.5; Trident/5.0; IEMobile/9.0)',
+                   'Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 920)',
+                   'Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 820)'
+               ],
+               { platform: :windows_phone, device: :mobile })
+      end
+
+      it 'recognizes Samsung bada phones' do
+        test([
+                 'Mozilla/5.0 (SAMSUNG; SAMSUNG-GT-S8500/S8500NEJE5; U; Bada/1.0; fr-fr) AppleWebKit/533.1 (KHTML, like Gecko) Dolfin/2.0 Mobile WVGA SMM-MMS/1.2.0 NexPlayer/3.0 profile/MIDP-2.1 configuration/CLDC-1.1 OPN-B',
+                 'Mozilla/5.0 (SAMSUNG; SAMSUNG-GT-S8500/S8500XXJL2; U; Bada/1.2; de-de) AppleWebKit/533.1 (KHTML, like Gecko) Dolfin/2.2 Mobile WVGA SMM-MMS/1.2.0 OPN-B'
+             ],
+             { platform: :bada, device: :mobile })
+      end
+
+      it 'recognizes Nokia MeeGo phones' do
+        test([
+                 'Mozilla/5.0 (MeeGo; NokiaN9) AppleWebKit/534.13 (KHTML, like Gecko) NokiaBrowser/8.5.0 Mobile Safari/534.13'
+             ],
+             { platform: :meego, device: :mobile })
+      end
+
+      it 'recognizes Symbian phones' do
+        test([
+                 'Mozilla/5.0 (SymbianOS/9.2; U; Series60/3.1 NokiaN95/10.0.018; Profile/MIDP-2.0 Configuration/CLDC-1.1 ) AppleWebKit/413 (KHTML, like Gecko) Safari/413',
+                 'NokiaN80-3/1.0552.0.7Series60/3.0Profile/MIDP-2.0Configuration/CLDC-1.1',
+                 'NokiaN90-1/3.0545.5.1 Series60/2.8 Profile/MIDP-2.0 Configuration/CLDC-1.1'
+             ],
+             { platform: :symbian, device: :mobile })
+      end
+
+    end
+
+    describe 'detects tablet devices' do
+      it 'recognized iPads' do
+          test([
+                   'Mozilla/5.0 (iPad; U; CPU OS 3_2 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Version/4.0.4 Mobile/7B367 Safari/531.21.10',
+                   'Mozilla/5.0 (iPad; U; CPU OS 3_2 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Version/4.0.4 Mobile/7B334b Safari/531.21.10',
+                   'Mozilla/5.0 (iPad; U; CPU OS 4_2_1 like Mac OS X; ja-jp) AppleWebKit/533.17.9 (KHTML, like Gecko) Version/5.0.2 Mobile/8C148 Safari/6533.18.5',
+                   'Mozilla/5.0 (iPad; CPU OS 5_0 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9A334 Safari/7534.48.3' ],
+               { platform: :ios, device: :tablet })
+      end
+
+      it 'recognized popular android tablets' do
+        test([
+                 'Mozilla/5.0 (Linux; U; Android 3.0; en-us; Xoom Build/HRI39) AppleWebKit/534.13 (KHTML, like Gecko) Version/4.0 Safari/534.13',
+                 'Mozilla/5.0 (Linux; U; Android 3.0.1; en-us; Xoom Build/HRI66) AppleWebKit/534.13 (KHTML, like Gecko) Version/4.0 Safari/534.13',
+                 'Mozilla/5.0 (Linux; U; Android 3.1; en-us; GT-P7510 Build/HMJ37) AppleWebKit/534.13 (KHTML, like Gecko) Version/4.0 Safari/534.13',
+                 'Mozilla/5.0 (Linux; U; Android 4.0.3; en-us; Transformer TF101 Build/IML74K) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Safari/534.30',
+                 'Mozilla/5.0 (Linux; U; Android-4.0.3; en-us; Xoom Build/IML77) AppleWebKit/535.7 (KHTML, like Gecko) CrMo/16.0.912.75 Safari/535.7',
+                 'Mozilla/5.0 (Linux; U; Android 4.1.1; en-gb; ASUS Transformer Pad TF700T Build/JRO03C) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Safari/534.30',
+                 'Mozilla/5.0 (Linux; U; Android 2.3.4; en-us; Kindle Fire Build/GINGERBREAD) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Mobile Safari/533.1'
+              ],
+             { platform: :android, device: :tablet })
+      end
+
+      it 'recognized windows 8 devices with touch support' do
+        test([
+                'Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0; Touch)'
+             ],{ platform: :windows, device: :tablet })
+      end
+    end
+
+    describe 'detect web-tv devices' do
+
+      it 'recognizes Google TV devices' do
+        test([
+                 'Mozilla/5.0 (X11; U; Linux i686; en-US) AppleWebKit/533.4 (KHTML, like Gecko) Chrome/5.0.375.127 Large Screen Safari/533.4 GoogleTV/161242',
+                 'Mozilla/5.0 (X11; U: Linux i686; en-US) AppleWebKit/533.4 (KHTML, like Gecko) Chrome/5.0.375.127 Large Screen Safari/533.4 GoogleTV/162671', # Sony
+                 'Mozilla/5.0 (X11; U: Linux i686; en-US) AppleWebKit/533.4 (KHTML, like Gecko) Chrome/5.0.375.127 Large Screen Safari/533.4 GoogleTV/b39389' #Logitech Revue
+             ],
+             { platform: :android, device: :tv })
+      end
+
+    end
+
+    describe 'detect desktop devices' do
+
+      it 'recognizes Windows computers' do
+        test([
+            'Mozilla/5.0 (Windows; U; Windows NT 5.1; de; rv:1.9.2.8) Gecko/20100722 Firefox/3.6.8 ( .NET CLR 3.5.30729)',
+            'Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 5.2; WOW64; .NET CLR 2.0.50727)',
+            'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; SLCC1; .NET CLR 2.0.50727; .NET CLR 3.0.04506)',
+            'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; WOW64; Trident/4.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; MDDC; MSOffice 12)',
+            'Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0; Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1) ; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; Media Center PC 5.0; SLCC1; InfoPath.2)'
+            ],
+            { platform: :windows, device: :desktop })
+      end
+
+      it 'recognizes Mac OS X computers' do
+        test([
+                 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_5; en-us) AppleWebKit/533.19.4 (KHTML, like Gecko) Version/5.0.3 Safari/533.19.4',
+                 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_7; da-dk) AppleWebKit/533.21.1 (KHTML, like Gecko) Version/5.0.5 Safari/533.21.1'
+             ],
+             { platform: :macosx, device: :desktop })
+      end
+    end
+
+    # helper method to perform the tests for user-agent strings
+    def test(user_agent_strings, expect = { })
+      user_agent_strings.each do |user_agent_string|
+        user_agent = UserAgent.new(user_agent_string)
+        user_agent.os.platform.should == expect[:platform]
+        case expect[:device]
+          when :mobile
+            user_agent.os.mobile?.should be_true
+            user_agent.os.tablet?.should_not be_true
+            user_agent.os.desktop?.should_not be_true
+            user_agent.os.webtv?.should_not be_true
+          when :tablet
+            user_agent.os.tablet?.should be_true
+            user_agent.os.mobile?.should_not be_true
+            user_agent.os.desktop?.should_not be_true
+            user_agent.os.webtv?.should_not be_true
+          when :desktop
+            user_agent.os.desktop?.should be_true
+            user_agent.os.mobile?.should_not be_true
+            user_agent.os.tablet?.should_not be_true
+            user_agent.os.webtv?.should_not be_true
+          when :webtv
+            user_agent.os.webtv?.should be_true
+            user_agent.os.mobile?.should_not be_true
+            user_agent.os.tablet?.should_not be_true
+            user_agent.os.desktop?.should_not be_true
+        end
+        user_agent.os.device.should == expect[:device]
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ua-utils
+version: !ruby/object:Gem::Version
+  version: 0.3.3
+  prerelease: 
+platform: ruby
+authors:
+- ! '''Harald'
+- Walker'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Utility for parsing and handling user-agent strings.
+email:
+- ! '''harald.walker@gmail.com'''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ua-utils/operating_system.rb
+- lib/ua-utils/user_agent.rb
+- lib/ua-utils.rb
+- spec/spec_helper.rb
+- spec/ua-utils/user_agent_spec.rb
+- LICENSE
+- README.md
+homepage: https://github.com/HaraldWalker/ua-utils
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Utility for parsing and handling user-agent strings.
+test_files:
+- spec/spec_helper.rb
+- spec/ua-utils/user_agent_spec.rb
+has_rdoc: