browserslist_useragent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15741b25153c98f5e6574f6de9b3f1540a841baacb5bd08d5a2b8463f3720293
+  data.tar.gz: 4828985519727b646a2cea17342b705029ed2ff27afd592a01a31742f1b53e54
+SHA512:
+  metadata.gz: 1280aec42639fa3a8f0c46a22c55d2f522b6698afee2607ac390d96ff2063767f8bf27300b1aff2bdc8a9a0f558f11b3375e6de16806d12f33f1682c25d6f198
+  data.tar.gz: f3c52c63ca90946ceb44cf50f1dee533ba4a661234cec2a0da08b9d76445bbf5c90473deb6fe0684874f75743d52a85c432761e098b843b9716e86b8ed187ad9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 110
+  Exclude:
+    - 'spec/**/*'
+      
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in browserslist-useragent.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Salahutdinov Dmitry
+
+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,137 @@
+# browserslist_useragent gem [![Build Status](https://travis-ci.org/browserslist/browserslist-useragent-ruby.svg?branch=master)](https://travis-ci.org/browserslist/browserslist-useragent-ruby)
+
+<img align="right" width="120" height="120"
+     src="https://github.com/browserslist/browserslist/blob/master/logo.svg" alt="Browserslist logo by Anton Lovchikov">
+
+Find if a given user agent string satisfies a [Browserslist](https://github.com/ai/browserslist) browsers.
+
+[Browserslist](https://github.com/browserslist/browserslist) is a popular config in many front-end tools like [Autoprefixer](https://github.com/postcss/autoprefixer) or [Babel](https://github.com/babel/babel/tree/master/packages/babel-preset-env). This gem allow you to use this config in Ruby project to check user agent string and, for examplle, show “Your browsers is outdated” warning for user with old browser.
+
+## Usage
+
+### 1. Setup Browserslist
+
+Run in webpack directory to install `browserslist` npm package:
+
+```sh
+npm install --save-dev browserslist
+```
+
+Put this lines of code to webpack config to generate `browsers.json` during build step:
+
+```javascript
+const browserslist = require('browserslist')
+const fs = require('fs')
+
+fs.writeFileSync('./browsers.json', JSON.stringify(browserslist()))
+```
+
+Put `browsers.js` file to `.gitignore`.
+
+### 2. Install gem
+
+Add this line to `Gemfile`
+
+```ruby
+gem 'browserslist_useragent'
+```
+
+Run `bundle install`.
+
+### 3. Add helper
+
+Define new helper in `app/helpers/application_helper.rb`:
+
+```ruby
+def outdated_browser?
+  @browsers ||= JSON.parse(File.read(PATH_TO_BROWSERS_JSON))
+  matcher = BrowserslistUseragent::Match.new(@browsers, request.user_agent)
+  matcher.browser? && !matcher.version?(allow_higher: true)
+end
+```
+
+### 4. Use helper in template
+
+Put some text for user with outdated browser in `app/views/layout` and add this check in application layout:
+
+```haml
+body
+  - if outdated_browser?
+    render 'outdated_browser_warning'
+```
+
+### Separated projects
+
+If you have separated projects for Ruby backend and Node.js frontend, you will prefer to get `browsers.json` over HTTP.
+
+```javascript
+fs.writeFileSync(
+  path.join(__dirname, 'public', 'browsers.json'),
+  JSON.stringify(browserslist(undefined, { path: path.join(__dirname, '..') }))
+)
+```
+
+Gets `browserslist.json` over HTTP (with caching) once (per web application instance) and use it to match user agent for every request:
+
+```ruby
+# caches http response locally with etag
+http_client = Faraday.new do |builder|
+  builder.use Faraday::HttpCache, store: Rails.cache
+  builder.adapter Faraday.default_adapter
+end
+
+@browsers = JSON.parse(
+  http_client.get(FRONTEND_HOST + '/browsers.json').body
+)
+```
+
+## API
+`BrowserslistUseragent::Match` is the main class performing matching user agent string to browserslist.
+
+It provides 2 methods:
+ - `version?(allow_higher: false)` - determines matching browser and it's version
+ - `browser?` - determines matching only borwser family
+
+```ruby
+require 'browserslist_useragent'
+
+matcher = BrowserslistUseragent::Match.new(
+  ['Firefox 53'],
+  'Mozilla/5.0 (Windows NT 10.0; rv:54.0) Gecko/20100101 Firefox/53.0'
+)
+matcher.browser? # returns true
+matcher.version? # return true
+
+matcher = BrowserslistUseragent::Match.new(
+  ['Firefox 54'],
+  'Mozilla/5.0 (Windows NT 10.0; rv:54.0) Gecko/20100101 Firefox/53.0'
+)
+matcher.browser? # returns true
+matcher.version? # return false
+```
+
+## Supported browsers
+
+Chrome, Firefox, Safari, IE, Edge
+ 
+PRs to add more _browserslist supported_ browsers are welcome 👋
+
+## Notes
+
+* All browsers on iOS (Chrome, Firefox etc) use Safari's WebKit as the underlying engine, and hence will be resolved to Safari. Since `browserslist` is usually used for
+  transpiling / autoprefixing for browsers, this behaviour is what's intended in most cases, but might surprise you otherwise.
+* Right now, Chrome for Android and Firefox for Android are resolved to their desktop equivalents. The `caniuse` database does not currently store historical data for these browsers separately (except the last version) See [#156](https://github.com/ai/browserslist/issues/156)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/browserslist-useragent-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %w[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'browserslist_useragent'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/browserslist_useragent.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'browserslist_useragent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'browserslist_useragent'
+  spec.version       = BrowserslistUseragent::VERSION
+  spec.authors       = ['Salahutdinov Dmitry']
+  spec.email         = ['dsalahutdinov@gmail.com']
+
+  spec.summary       = 'Find if a given user agent string satisfies a browserslist query.'
+  spec.description   = 'Provides easy way to match browser user agent string with specified set of rules (from browserslist tool)'
+  spec.homepage      = 'https://github.com/dsalahutdinov/browserlist-useragent-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'semantic'
+  spec.add_runtime_dependency 'user_agent_parser'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.55'
+end

data/lib/browserslist_useragent.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'browserslist_useragent/version'
+
+require 'browserslist_useragent/version_normalizer'
+require 'browserslist_useragent/query_normalizer'
+require 'browserslist_useragent/match'
+require 'browserslist_useragent/resolver'

data/lib/browserslist_useragent/match.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'semantic'
+
+module BrowserslistUseragent
+  # Checks matching of browserslist queies array to the user agent string
+  class Match
+    attr_reader :queries, :user_agent_string
+
+    def initialize(queries, user_agent_string)
+      @user_agent_string = user_agent_string
+      @queries = queries.each_with_object({}) do |query, hash|
+        query = BrowserslistUseragent::QueryNormalizer.new(query).call
+        family = query[:family].downcase
+        hash[family] ||= []
+        hash[family].push(query[:version])
+      end
+    end
+
+    def version?(allow_higher: false)
+      return false unless browser?
+
+      user_agent_version = user_agent[:version]
+      return false if user_agent_version.nil? || user_agent_version == ''
+
+      semantic = Semantic::Version.new(user_agent[:version])
+      match_semantic_version(semantic, allow_higher: allow_higher)
+    end
+
+    def browser?
+      target_browser = user_agent[:family].downcase
+      queries.key?(target_browser)
+    end
+
+    private
+
+    def user_agent
+      Resolver.new(user_agent_string).call
+    end
+
+    def match_semantic_version(semantic, allow_higher:)
+      queries[user_agent[:family].downcase].any? do |version|
+        if allow_higher
+          match_higher_version?(semantic, version)
+        else
+          match_version?(semantic, version)
+        end
+      end
+    end
+
+    def match_version?(semantic, query_version)
+      if query_version.include?('-')
+        low_version, high_version = query_version.split('-', 2)
+        semantic.satisfied_by?([">= #{low_version}", "<= #{high_version}"])
+      else
+        semantic.satisfies?(query_version)
+      end
+    end
+
+    def match_higher_version?(semantic, query_version)
+      low_version = query_version.split('-', 2).first
+      semantic.satisfies?(">= #{low_version}")
+    end
+  end
+end

data/lib/browserslist_useragent/query_normalizer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BrowserslistUseragent
+  # Normalizes browserslist query to existing browser family names
+  class QueryNormalizer
+    NORMALIZED_NAMES = {
+      bb: 'BlackBerry',
+      and_chr: 'Chrome',
+      ChromeAndroid: 'Chrome',
+      FirefoxAndroid: 'Firefox',
+      ff: 'Firefox',
+      ie: 'Explorer',
+      ie_mob: 'ExplorerMobile',
+      and_ff: 'Firefox',
+      ios_saf: 'iOS',
+      op_mini: 'OperaMini',
+      op_mob: 'OperaMobile',
+      and_qq: 'QQAndroid',
+      and_uc: 'UCAndroid'
+    }.freeze
+
+    attr_reader :query
+
+    def initialize(query)
+      @query = query
+    end
+
+    def call
+      browser_name, browser_version = query.split(' ', 2)
+      normalized_name = NORMALIZED_NAMES[browser_name.to_sym] || browser_name
+
+      { family: normalized_name, version: browser_version }
+    end
+  end
+end

data/lib/browserslist_useragent/resolver.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# rubocop: disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+# rubocop: disable Metrics/MethodLength, Metrics/PerceivedComplexity
+module BrowserslistUseragent
+  # Resolves uaser agent string to {family, version} hash
+  class Resolver
+    attr_reader :user_agent_string
+
+    def initialize(user_agent_string)
+      @user_agent_string = user_agent_string
+    end
+
+    def call
+      agent = UserAgentParser.parse(user_agent_string)
+
+      family = agent.family
+      version = VersionNormalizer.new(agent.version.to_s).call
+
+      # Case A: For Safari, Chrome and others browsers
+      # that report as Safari after stripping tags
+      family = 'iOS' if agent.family.include?('Safari')
+
+      # Case B: The browser on iOS didn't report as safari,
+      # so we use the iOS version as a proxy to the browser
+      # version. This is based on the assumption that the
+      # underlying Safari Engine used will be *atleast* equal
+      # to the iOS version it's running on.
+      if agent.os.family == 'iOS'
+        return {
+          family: 'iOS',
+          version: VersionNormalizer.new(agent.os.version.to_s).call
+        }
+      end
+
+      # Case C: The caniuse database does not contain
+      # historical browser versions for so called `minor`
+      # browsers like Chrome for Android, Firefox for Android etc
+      # In this case, we proxy to the desktop version
+      # @see https://github.com/Fyrd/caniuse/issues/3518
+      family = 'Chrome' if agent.family.include?('Chrome Mobile')
+
+      family = 'Firefox' if agent.family == 'Firefox Mobile'
+      family = 'Explorer' if agent.family == 'IE'
+      family = 'ExplorerMobile' if agent.family == 'IE Mobile'
+      family = 'QQAndroid' if agent.family == 'QQ Browser Mobile'
+      family = 'UCAndroid' if agent.family == 'UC Browser'
+
+      { family: family, version: version }
+    end
+  end
+end
+# rubocop: enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+# rubocop: enable Metrics/MethodLength, Metrics/PerceivedComplexity

data/lib/browserslist_useragent/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BrowserslistUseragent
+  VERSION = '0.1.0'
+end

data/lib/browserslist_useragent/version_normalizer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'user_agent_parser'
+
+module BrowserslistUseragent
+  # Normalizes user agent version to semantically valid state
+  class VersionNormalizer
+    attr_reader :version
+
+    def initialize(version)
+      @version = version
+    end
+
+    def call
+      agent_version = ::UserAgentParser::Version.new(version)
+      return nil if agent_version.major.nil?
+
+      [
+        agent_version.major,
+        agent_version.minor || 0,
+        agent_version.patch || 0
+      ].join('.')
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: browserslist_useragent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salahutdinov Dmitry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semantic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: user_agent_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.55'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.55'
+description: Provides easy way to match browser user agent string with specified set
+  of rules (from browserslist tool)
+email:
+- dsalahutdinov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- browserslist_useragent.gemspec
+- lib/browserslist_useragent.rb
+- lib/browserslist_useragent/match.rb
+- lib/browserslist_useragent/query_normalizer.rb
+- lib/browserslist_useragent/resolver.rb
+- lib/browserslist_useragent/version.rb
+- lib/browserslist_useragent/version_normalizer.rb
+homepage: https://github.com/dsalahutdinov/browserlist-useragent-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Find if a given user agent string satisfies a browserslist query.
+test_files: []