platform_agent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37665e6536aba2833b93dc0f111046ecd115a57c49e914301e2cf81921e7ae18
+  data.tar.gz: a3601b3632b89ea98e8b3e5a1f8ea10b325de7c566811aa4b93a6ae5e59dbf2f
+SHA512:
+  metadata.gz: 62f9130310cc151af360e5720f53eb5319c156742e6b61c4ee1dc12c80e05c9e4e33c254cb07f48f72ffd69f8dbc763ee4798d98cb726f5c8b35c84300b4867d
+  data.tar.gz: 979a7288c0d77cdc4af9b121b32a188b3b0cb737bc498f6c4f20b1d5fb7fabfd137e34687a2077ed3d85318d0ee32ae0e26478b13d441b6279bd6eac9c145d03

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'byebug'

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    platform_agent (1.0.0)
+      activesupport (>= 5.2.0)
+      useragent (~> 0.16.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    byebug (10.0.2)
+    concurrent-ruby (1.0.5)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (12.3.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    useragent (0.16.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (>= 5.2.0)
+  bundler (~> 1.15)
+  byebug
+  platform_agent!
+  rake
+
+BUNDLED WITH
+   1.17.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Basecamp
+
+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,54 @@
+# Platform Agent
+
+Parse user agent to discern the common platforms that UIs are tailored for. Expected that you'll inherit from this to specify native apps.
+
+## Examples
+
+```ruby
+class ApplicationPlatform < PlatformAgent
+  def ios_app?
+    match? /BC3 iOS/
+  end
+
+  def android_app?
+    match? /BC3 Android/
+  end
+
+  def mac_app?
+    match?(/Electron/) && match?(/basecamp3/) && match?(/Macintosh/)
+  end
+
+  def windows_app?
+    match?(/Electron/) && match?(/basecamp3/) && match?(/Windows/)
+  end  
+end
+
+module SetPlatform
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :platform
+  end
+
+  private
+    def platform
+      @platform ||= ApplicationPlatform.new(request.user_agent)
+    end
+end
+
+class ApplicationController < ActionController::Base
+  include SetPlatform
+end
+
+<% if platform.phone? %>
+  Do phone specific stuff!
+<% end %>
+```
+
+## Maintenance Expectations
+
+This library is an extraction from Basecamp that's been sufficient in almost unaltered form for years. While contributions are always welcome, do not expect a lot of feature evolution beyond the basics. 
+
+## License
+
+Platform Agent is released under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.test_files = FileList["test/*_test.rb"]
+  test.warning = false
+end
+
+task default: :test

data/lib/platform_agent.rb

@@ -0,0 +1,119 @@
+require "user_agent"
+
+class PlatformAgent
+  def initialize(user_agent_string)
+    self.user_agent_string = user_agent_string
+  end
+
+  delegate :browser, :version, :product, to: :user_agent
+
+  def desktop?
+    !mobile?
+  end
+
+  def mobile?
+    phone? || tablet? || mobile_app?
+  end
+
+  def phone?
+    iphone? || android? || other_phones?
+  end
+
+  def iphone?
+    match? /iPhone/
+  end
+
+  def android_phone?
+    !android_app? && android?
+  end
+
+  def other_phones?
+    match? /(iPod|Windows Phone|BlackBerry|BB10.*Mobile|Mobile.*Firefox)/
+  end
+
+  def tablet?
+    ipad? || match?(/(Kindle|Silk)/)
+  end
+
+  def ipad?
+    match? /iPad/
+  end
+
+  def android?
+    match? /Android/
+  end
+
+  def native_app?
+    mobile_app? || desktop_app?
+  end
+
+  def mobile_app?
+    ios_app? || android_app?
+  end
+
+  def iphone_app?
+    iphone? && ios_app?
+  end
+
+  def ipad_app?
+    ipad? && ios_app?
+  end
+
+  # Must overwrite with app-specific match
+  def ios_app?
+    false
+  end
+
+  # Must overwrite with app-specific match
+  def android_app?
+    false
+  end
+
+  def desktop_app?
+    mac_app? || windows_app?
+  end
+
+  # Must overwrite with app-specific match
+  def mac_app?
+    false
+  end
+
+  # Must overwrite with app-specific match
+  def windows_app?
+    false
+  end
+
+  def missing?
+    user_agent_string.nil?
+  end
+
+  def app_version
+    # App user-agent string is parsed into two separate UserAgent instances, it's the last one that contains the right version
+    user_agent.last.version if native?
+  end
+
+  def to_s
+    case
+    when ipad_app?     then "iPad app"
+    when iphone_app?   then "iPhone app"
+    when android_app?  then "Android app"
+    when mac_app?      then "Mac app"
+    when windows_app?  then "Windows app"
+    when tablet?       then "tablet"
+    when phone?        then "phone"
+    when missing?      then "missing"
+    else                    "web"
+    end
+  end
+
+  private
+    attr_accessor :user_agent_string
+
+    def match?(pattern)
+      true if user_agent_string.to_s.match(pattern)
+    end
+
+    def user_agent
+      @user_agent ||= UserAgent.parse(user_agent_string)
+    end
+end

data/platform_agent.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name     = 'platform_agent'
+  s.version  = '1.0.0'
+  s.authors  = 'David Heinemeier Hansson'
+  s.email    = 'david@basecamp.com'
+  s.summary  = 'Parse user agent to deduce the platform.'
+  s.homepage = 'https://github.com/basecamp/platform_agent'
+  s.license  = 'MIT'
+
+  s.required_ruby_version = '>= 2.4.0'
+
+  s.add_dependency 'activesupport', '>= 5.2.0'
+  s.add_dependency 'useragent', '~> 0.16.3'
+
+  s.add_development_dependency 'activemodel', '>= 5.2.0'
+  s.add_development_dependency 'bundler', '~> 1.15'
+
+  s.files      = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+end

data/test/platform_agent_test.rb

@@ -0,0 +1,91 @@
+require 'active_support'
+require 'active_support/testing/autorun'
+
+require 'platform_agent'
+
+class BasecampAgent < PlatformAgent
+  def ios_app?
+    match?(/BC3 iOS/)
+  end
+
+  def android_app?
+    match? /BC3 Android/
+  end
+
+  def mac_app?
+    match?(/Electron/) && match?(/basecamp3/) && match?(/Macintosh/)
+  end
+
+  def windows_app?
+    match?(/Electron/) && match?(/basecamp3/) && match?(/Windows/)
+  end  
+end
+
+class PlatformAgentTest < ActiveSupport::TestCase
+  WINDOWS_PHONE    = 'Mozilla/5.0 (Mobile; Windows Phone 8.1; Android 4.0; ARM; Trident/7.0; Touch; rv:11.0; IEMobile/11.0; NOKIA; Lumia 520) like iPhone OS 7_0_3 Mac OS X AppleWebKit/537 (KHTML, like Gecko) Mobile Safari/537'
+  CHROME_DESKTOP   = 'Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36'
+  CHROME_ANDROID   = 'Mozilla/5.0 (Linux; Android 4.4; Nexus 5 Build/_BuildID_) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/30.0.0.0 Mobile Safari/537.36'
+  SAFARI_IPHONE    = 'Mozilla/5.0 (iPhone; CPU iPhone OS 8_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B410 Safari/600.1.4'
+  SAFARI_IPAD      = 'Mozilla/5.0 (iPad; CPU iPhone OS 8_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B410 Safari/600.1.4'
+  BASECAMP_MAC     = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_3) AppleWebKit/537.36 (KHTML, like Gecko) basecamp3/1.0.2 Chrome/47.0.2526.110 Electron/0.36.7 Safari/537.36'
+  BASECAMP_WINDOWS = 'Mozilla/5.0 (Windows NT 10.0) AppleWebKit/537.36 (KHTML, like Gecko) basecamp3/1.0.2 Chrome/49.0.2623.75 Electron/0.36.7 Safari/537.36'
+  BASECAMP_IPAD    = 'BC3 iOS/3.0.1 (build 13; iPad Air 2); iOS 9.3'
+  BASECAMP_IPHONE  = 'BC3 iOS/3.0.1 (build 13; iPhone 6S); iOS 9.3'
+  BASECAMP_ANDROID = 'BC3 Android/3.0.1 (build 13; Galaxy S3); Marshmallow'
+
+  test "chrome is via web" do
+    assert_equal "web", platform(CHROME_DESKTOP)
+  end
+
+  test "safari iOS is via phone" do
+    assert_equal "phone", platform(SAFARI_IPHONE)
+  end
+
+  test "safari iPad is via tablet" do
+    assert_equal "tablet", platform(SAFARI_IPAD)
+  end
+
+  test "basecamp iPhone is via iPhone app" do
+    assert_equal "iPhone app", platform(BASECAMP_IPHONE)
+  end
+
+  test "basecamp iPad is via iPad app" do
+    assert_equal "iPad app", platform(BASECAMP_IPAD)
+  end
+
+  test "basecamp Android is via Android app" do
+    assert_equal "Android app", platform(BASECAMP_ANDROID)
+  end
+
+  test "basecamp Mac is via Mac app" do
+    assert_equal "Mac app", platform(BASECAMP_MAC)
+  end
+
+  test "basecamp Windows is via Windows app" do
+    assert_equal "Windows app", platform(BASECAMP_WINDOWS)
+  end
+
+  test "blank user agent is via missing" do
+    assert_equal "missing", platform(nil)
+  end
+
+  test "other phones are via phone" do
+    assert_equal "phone", platform(WINDOWS_PHONE)
+  end
+
+  test "non-native app android detection" do
+    assert android_phone?(CHROME_ANDROID), "CHROME_ANDROID should be android phone"
+
+    assert_not android_phone?(SAFARI_IPHONE), "SAFARI_IPHONE should not be android phone"
+    assert_not android_phone?(BASECAMP_ANDROID), "BC3_ANDROID should not be android phone"
+  end
+
+  private
+    def platform(agent)
+      BasecampAgent.new(agent).to_s
+    end
+
+    def android_phone?(agent)
+      BasecampAgent.new(agent).android_phone?
+    end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: platform_agent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: useragent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: 
+email: david@basecamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/platform_agent.rb
+- platform_agent.gemspec
+- test/platform_agent_test.rb
+homepage: https://github.com/basecamp/platform_agent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Parse user agent to deduce the platform.
+test_files:
+- test/platform_agent_test.rb