device_map 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74af4b49ff3b832ea9e7ec021cdad0725b082318
-  data.tar.gz: 861c7beddeffa8e0cacab4cca54cf2bb8b42ac2a
+  metadata.gz: 85f3dc36e9ccf79015fe2c840d383d734e2a7758
+  data.tar.gz: 5a743460cb8cc085a1b75d83f158192a55ca784c
 SHA512:
-  metadata.gz: 51c2bd18f0c6e73ec7d0c9ea5207afb1849ea87631db1b4610f76b62f86bf6e6723c4d821da3464a5e7869c18800bf55e781588c1225331aec7e5dbd265caaf0
-  data.tar.gz: 60ed79f05b92e8f7c53df3fb45a2bd58b675703986d9f0348a4f1e86f8999b4a04fb7daf4efff19741fdb493dd2ecff17955397cb39ec4b9d237ed5cc749aba7
+  metadata.gz: 84ec35b4e0fae8acfd0da23b0394aaa97cc32282d65353094d1eb60ef6e01dc1b788ae83b9b4694ba6f7195ed9a38f6b17b05069d5996f5da4e4c6400fa2bd65
+  data.tar.gz: f909de648e1a309c6e9a8f8e7ee0036124173168728e66947313b85533db73ed33c1de7c8036fb8b2475380b02789428643a87dd915be513c3b5be42eec26247

data/.gitignore

@@ -1,14 +1,4 @@
-/.bundle/
-/.yardoc
 /Gemfile.lock
-/_yardoc/
 /coverage/
 /doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--warnings

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Style/WordArray:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/AlignParameters:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+before_install: bundle update --quiet

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in device_map.gemspec
 gemspec

data/LICENSE.txt

@@ -1,22 +1,13 @@
-Copyright (c) 2014 Konstantin Papkovskiy
+Copyright 2014 Konstantin Papkovskiy
 
-MIT License
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-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:
+ http://www.apache.org/licenses/LICENSE-2.0
 
-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.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,57 @@
+# DeviceMap
+
+Apache DeviceMap is a project to create a data repository containing device
+information, images and other relevant information for all sorts of mobile
+devices, e.g. smartphones and tablets.
+
+[Apache DeviceMap](http://devicemap.apache.org/)
+
+[![Build Status](https://travis-ci.org/soylent/device_map.svg?branch=master)](https://travis-ci.org/soylent/device_map)
+[![Code Climate](https://codeclimate.com/github/soylent/device_map/badges/gpa.svg)](https://codeclimate.com/github/soylent/device_map)
+
+## Installation
+
+Add `device_map` to your `Gemfile` and execute `bundle install`.
+
+## Basic example
+
+```ruby
+require 'device_map'
+
+user_agent = <<USERAGENT
+Mozilla/5.0 (Linux; U; Android 2.3.4; en-gb; GT-I9100 Build/GINGERBREAD)
+AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Mobile Safari/533.1
+USERAGENT
+
+device = DeviceMap.classify(user_agent)
+
+device.ajax_manipulate_css         # => true
+device.ajax_manipulate_dom         # => true
+device.ajax_support_event_listener # => true
+device.ajax_support_events         # => true
+device.ajax_support_getelementbyid # => true
+device.ajax_support_inner_html     # => true
+device.ajax_support_javascript     # => true
+device.device_os                   # => "Android"
+device.device_os_version           # => "2.3"
+device.display_height              # => 800
+device.display_width               # => 480
+device.dual_orientation            # => true
+device.from                        # => "open_db_modified"
+device.id                          # => "GT-I9100"
+device.image_inlining              # => true
+device.input_devices               # => "touchscreen"
+device.marketing_name              # => "Galaxy S II"
+device.mobile_browser              # => "Android Webkit"
+device.mobile_browser_version      # => "4.0"
+device.model                       # => "GT-I9100"
+```
+
+## Contributing
+
+Pull requests are very welcome. Please make sure that your changes
+don't break the tests by running:
+
+```sh
+$ bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+load 'ext/Rakefile'
+
+desc 'Run tests and static code analyzer'
+task ci: :prepare do
+  Rake::Task['spec'].invoke
+  Rake::Task['rubocop'].invoke
+end
+
+task default: :ci

data/device_map.gemspec

@@ -1,23 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'device_map/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "device_map"
+  spec.name          = 'device_map'
   spec.version       = DeviceMap::VERSION
-  spec.authors       = ["Konstantin Papkovskiy"]
-  spec.email         = ["konstantin@papkovskiy.com"]
-  spec.summary       = %q{Ruby client for Apache DeviceMap}
-  spec.description   = %q{Ruby client for Apache DeviceMap}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Konstantin Papkovskiy']
+  spec.email         = ['konstantin@papkovskiy.com']
+  spec.summary       = 'Ruby client for Apache DeviceMap'
+  spec.description   = <<-EOD
+    Ruby implementation of client for Apache DeviceMap repository
+    containing device information, images and other relevant
+    information for all sorts of mobile devices.
+  EOD
+
+  spec.homepage      = 'https://github.com/soylent/device_map'
+  spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+  spec.extensions    = ['ext/Rakefile']
+
+  spec.add_dependency 'nokogiri', '~> 1.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rubocop', '~> 0.28'
 end

data/ext/Rakefile

@@ -0,0 +1,28 @@
+# This task runs during installation of the gem
+desc 'Prepare database dumps'
+task :prepare do
+  lib = File.expand_path('../lib', __dir__)
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+  require 'device_map'
+
+  # TODO: Refactor
+
+  # Parse builder data and create inverted index
+  builder_xml = File.open(DeviceMap::BUILDER_DATA_SOURCE)
+  patterns = DeviceMap::DeviceData::Patterns.parse(builder_xml)
+
+  # Dump parsed builder data for later usage in <tt>DeviceMap::Classifier</tt>
+  patterns_dump = Marshal.dump(patterns)
+  File.write(DeviceMap::PATTERNS_DUMP, patterns_dump)
+
+  # Parse devices data
+  devices_xml = File.open(DeviceMap::DEVICE_DATA_SOURCE)
+  devices = DeviceMap::DeviceData::Devices.parse(devices_xml)
+
+  # Dump devices for later usage in <tt>DeviceMap::Classifier</tt>
+  devices_dump = Marshal.dump(devices)
+  File.write(DeviceMap::DEVICES_DUMP, devices_dump)
+end
+
+task default: :prepare

data/lib/device_map/classifier.rb

@@ -0,0 +1,38 @@
+require 'singleton'
+
+module DeviceMap
+  class Classifier
+    include Singleton
+
+    KEYWORD_NGRAM_SIZE = 4
+
+    attr_reader :patterns, :devices
+
+    def initialize
+      # TODO: Refactor
+      @patterns = Marshal.load(File.open(PATTERNS_DUMP))
+      @devices = Marshal.load(File.open(DEVICES_DUMP))
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def find_device(ua)
+      user_agent = UserAgent.new(ua)
+      keyword_ngrams = user_agent.keyword_ngrams(KEYWORD_NGRAM_SIZE)
+
+      search_hits = keyword_ngrams.each_with_object(Set.new) do |ngram, hits|
+        hits.merge patterns.find(ngram.join)
+      end
+
+      matched_pattern = search_hits.sort.reverse.find do |pattern|
+        # FIXME: Match only against keyword hits
+        pattern.matches?(keyword_ngrams.map(&:join))
+      end
+
+      if matched_pattern
+        devices.find(matched_pattern.device_id)
+      else
+        DeviceData::Device.unknown
+      end
+    end
+  end
+end

data/lib/device_map/device_data/builder.rb

@@ -0,0 +1,67 @@
+module DeviceMap
+  module DeviceData
+    module Builder
+      class BuilderNotFound < StandardError; end
+
+      class << self
+        def find(builder_node_class)
+          builders.fetch(builder_node_class) do
+            fail BuilderNotFound,
+              "Could not find builder for #{builder_node_class}"
+          end
+        end
+
+        def register(klass, builder_class)
+          builders[builder_class] = klass
+        end
+
+        private
+
+        def builders
+          @builders ||= {}
+        end
+      end
+
+      class Simple < Struct.new(:priority)
+        def patterns(device_id, keywords)
+          keywords.map do |keyword|
+            Pattern.new(keyword, device_id, priority)
+          end
+        end
+      end
+
+      class TwoStep < Struct.new(:priority)
+        def patterns(device_id, keywords)
+          joined_keywords = Keyword.join(keywords)
+
+          [
+            Pattern.new(keywords, device_id, priority),
+            Pattern.new(joined_keywords, device_id, priority)
+          ]
+        end
+      end
+
+      # Creates OR patterns with normal priority
+      SIMPLE_BUILDER = Simple.new(1)
+
+      # Creates OR patterns with lower priority
+      GENERIC_BUILDER = Simple.new(0)
+
+      # Creates AND patterns with normal priority
+      TWO_STEP_BUILDER = TwoStep.new(1)
+
+      # rubocop:disable Metrics/LineLength
+
+      register SIMPLE_BUILDER,   'org.apache.devicemap.simpleddr.builder.device.DesktopOSDeviceBuilder'
+      register GENERIC_BUILDER,  'org.apache.devicemap.simpleddr.builder.device.SimpleDeviceBuilder'
+      register SIMPLE_BUILDER,   'org.apache.devicemap.simpleddr.builder.device.BotDeviceBuilder'
+      register SIMPLE_BUILDER,   'org.apache.devicemap.simpleddr.builder.device.AndroidDeviceBuilder'
+      register SIMPLE_BUILDER,   'org.apache.devicemap.simpleddr.builder.device.SymbianDeviceBuilder'
+      register SIMPLE_BUILDER,   'org.apache.devicemap.simpleddr.builder.device.WinPhoneDeviceBuilder'
+      register SIMPLE_BUILDER,   'org.apache.devicemap.simpleddr.builder.device.IOSDeviceBuilder'
+      register TWO_STEP_BUILDER, 'org.apache.devicemap.simpleddr.builder.device.TwoStepDeviceBuilder'
+
+      # rubocop:enable Metrics/LineLength
+    end
+  end
+end

data/lib/device_map/device_data/device.rb

@@ -0,0 +1,52 @@
+module DeviceMap
+  module DeviceData
+    class Device
+      include Properties::DSL
+
+      property :ajax_manipulate_css, type: :boolean
+      property :ajax_manipulate_dom, type: :boolean
+      property :ajax_support_event_listener, type: :boolean
+      property :ajax_support_events, type: :boolean
+      property :ajax_support_getelementbyid, type: :boolean
+      property :ajax_support_inner_html, type: :boolean
+      property :ajax_support_javascript, type: :boolean
+      property :device_os, type: :string
+      property :device_os_version, type: :string
+      property :displayHeight, type: :integer, attr_name: :display_height
+      property :displayWidth, type: :integer, attr_name: :display_width
+      property :dual_orientation, type: :boolean
+      property :from, type: :string
+      property :id, type: :string
+      property :image_inlining, type: :boolean
+      property :inputDevices, type: :string, attr_name: :input_devices
+      property :is_bot, type: :boolean
+      property :is_desktop, type: :boolean
+      property :is_tablet, type: :boolean
+      property :is_wireless_device, type: :boolean
+      property :marketing_name, type: :string
+      property :mobile_browser, type: :string
+      property :mobile_browser_version, type: :string
+      property :model, type: :string
+      property :nokia_edition, type: :string
+      property :nokia_series, type: :string
+      property :vendor, type: :string
+      property :xhtml_format_as_attribute, type: :boolean
+      property :xhtml_format_as_css_property, type: :boolean
+
+      UNKNOWN_ID = 'unknown'
+
+      def self.parse(device_node)
+        properties = device_node.xpath('property')
+        attrs = properties.each_with_object({}) do |property, result|
+          result[property[:name]] = property[:value]
+        end
+
+        new(attrs.merge(id: device_node[:id]))
+      end
+
+      def self.unknown
+        new(id: UNKNOWN_ID)
+      end
+    end
+  end
+end

data/lib/device_map/device_data/devices.rb

@@ -0,0 +1,29 @@
+module DeviceMap
+  module DeviceData
+    class Devices
+      class DeviceNotFound < StandardError; end
+
+      def self.parse(devices_xml)
+        devices_doc = Nokogiri::XML(devices_xml)
+        devices = devices_doc.xpath('//device').map do |device_node|
+          Device.parse(device_node)
+        end
+
+        new(devices)
+      end
+
+      def initialize(devices)
+        @device_index = devices.each_with_object({}) do |device, device_index|
+          device_index[device.id] = device
+        end
+      end
+
+      def find(device_id)
+        # TODO: Return copy of <tt>Device</tt> object
+        @device_index.fetch(device_id) do
+          fail DeviceNotFound, "Cound not find device: #{device_id}"
+        end
+      end
+    end
+  end
+end

data/lib/device_map/device_data/patterns.rb

@@ -0,0 +1,44 @@
+require 'set'
+
+module DeviceMap
+  module DeviceData
+    class Patterns
+      # rubocop:disable Metrics/MethodLength
+      def self.parse(openddr_builder_xml)
+        builders_doc = Nokogiri::XML(openddr_builder_xml)
+        openddr_builders = builders_doc.xpath('//builder')
+
+        all_patterns = openddr_builders.flat_map do |builder_node|
+          builder_node_class = builder_node[:class]
+          builder = Builder.find(builder_node_class)
+
+          builder_node.xpath('device').flat_map do |device_node|
+            device_id = device_node[:id]
+            keywords = device_node.xpath('list/value').map(&:content)
+            builder.patterns(device_id, keywords)
+          end
+        end
+
+        new(all_patterns)
+      end
+
+      def initialize(all_patterns)
+        @pattern_index = {}
+
+        all_patterns.each do |pattern|
+          pattern.keywords.each do |keyword|
+            @pattern_index[keyword] ||= Set.new
+            @pattern_index[keyword] << pattern
+          end
+        end
+      end
+
+      def find(keyword)
+        # TODO: Return copy of the set
+        @pattern_index.fetch(keyword) do
+          Set.new
+        end
+      end
+    end
+  end
+end

data/lib/device_map/keyword.rb

@@ -0,0 +1,37 @@
+module DeviceMap
+  module Keyword
+    # Deletes all non-alphanumeric characters from the given keywords
+    def self.normalize(keywords)
+      keywords.map do |keyword|
+        # HACK: <tt>BUILDER_DATA_SOURCE</tt> contains keywords like:
+        #     <device id="BlackBerry 9650">
+        #         <list>
+        #             <value>[Bb]lack.?[Bb]erry</value>
+        #             <value>blackberry 9650</value>
+        #         </list>
+        #     </device>
+        # In such cases we want to replace patterns with simple keywords.
+        keyword.downcase.gsub('[bb]', 'b').gsub(/[\W_]+/, '')
+      end
+    end
+
+    # Concatenate all keywords together and skip duplicates
+    def self.join(keywords)
+      # HACK: This function handles the case when we want to concatenate all
+      # keywords without duplication.
+      #     <device id="BlackBerry 9700">
+      #         <list>
+      #             <value>blackberry</value>
+      #             <value>blackberry 9700</value>
+      #         </list>
+      #     </device>
+      normalize(keywords).reduce('') do |result, keyword|
+        if keyword.include?(result)
+          keyword
+        else
+          result.concat(keyword)
+        end
+      end
+    end
+  end
+end

data/lib/device_map/pattern.rb

@@ -0,0 +1,32 @@
+module DeviceMap
+  class Pattern
+    include Comparable
+
+    attr_reader :keywords, :device_id, :priority
+
+    def initialize(keywords, device_id, priority)
+      @keywords = Keyword.normalize(Array(keywords))
+      @device_id = device_id
+      @priority = priority
+    end
+
+    def matches?(other_keywords)
+      diff = keywords - other_keywords
+      diff.empty?
+    end
+
+    def <=>(other)
+      if priority == other.priority
+        keywords.join.size <=> other.keywords.join.size
+      else
+        priority <=> other.priority
+      end
+    end
+
+    def ==(other)
+      keywords == other.keywords &&
+        device_id == other.device_id &&
+        priority == other.priority
+    end
+  end
+end

data/lib/device_map/properties/dsl.rb

@@ -0,0 +1,48 @@
+module DeviceMap
+  module Properties
+    class UnknownProperty < StandardError; end
+
+    module DSL
+      module ClassMethods
+        def property(name, type: :string, attr_name: name)
+          attr_reader attr_name
+          properties[name] = Property.new(name, type, attr_name)
+        end
+
+        # FIXME: This method should not be public
+        def properties
+          @properties ||= {}
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def initialize(attrs)
+        attrs.each do |name, value|
+          property = properties.fetch(name.to_sym) do
+            fail UnknownProperty, "Property #{name} is not defined"
+          end
+
+          attr_name = property.attr_name
+          casted_value = property.cast(value)
+          instance_variable_set(:"@#{attr_name}", casted_value)
+        end
+      end
+
+      def ==(other)
+        properties.all? do |_, property|
+          attr_name = property.attr_name
+          public_send(attr_name) == other.public_send(attr_name)
+        end
+      end
+
+      private
+
+      def properties
+        self.class.properties
+      end
+    end
+  end
+end

data/lib/device_map/properties/property.rb

@@ -0,0 +1,18 @@
+module DeviceMap
+  module Properties
+    class Property < Struct.new(:name, :type_name, :attr_name)
+      TYPE_MAPPING = {
+        integer: Types::Integer,
+        boolean: Types::Boolean,
+        string:  Types::String
+      }
+
+      def cast(value)
+        return if value.nil?
+
+        type = TYPE_MAPPING.fetch(type_name)
+        type.cast(value)
+      end
+    end
+  end
+end

data/lib/device_map/properties/types.rb

@@ -0,0 +1,27 @@
+module DeviceMap
+  module Properties
+    module Types
+      module Integer
+        def self.cast(value)
+          value.to_i
+        end
+      end
+
+      module Boolean
+        def self.cast(value)
+          case value
+          when 'true' then true
+          when 'false' then false
+          else fail ArgumentError, "Cannot cast #{value} to boolean"
+          end
+        end
+      end
+
+      module String
+        def self.cast(value)
+          value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/device_map/user_agent.rb

@@ -0,0 +1,19 @@
+module DeviceMap
+  class UserAgent
+    def initialize(user_agent)
+      @user_agent = user_agent
+    end
+
+    def keyword_ngrams(size)
+      keywords = @user_agent.split(/[\s;\-_\/()\[\]\\]+/)
+      normalized_keywords = Keyword.normalize(keywords)
+
+      normalized_keywords.flat_map.with_index do |keyword, i|
+        size.times.map do |j|
+          next_keywords = normalized_keywords[i + 1..-1] || []
+          Array(keyword).concat next_keywords.take(j)
+        end
+      end.uniq
+    end
+  end
+end

data/lib/device_map/version.rb

@@ -1,3 +1,4 @@
 module DeviceMap
-  VERSION = "0.0.1"
+  VERSION = '0.1.0'
+  DATA_VERSION = '1.0.1'
 end