woothee 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09b0e8a02cd881ceac57d76d909c60037a27fbfd
-  data.tar.gz: 1f85b6347a45c3d5ecf630fa7752e5f2dd9b31d4
+  metadata.gz: 4f4e1e5a42b49a4f260eb1f1c589bc0c965b10c9
+  data.tar.gz: d39f942398a99af4a50e47349158c5423a5806c6
 SHA512:
-  metadata.gz: 8cda7085ef3464be2cd9eb540bc9e92e40a6b800fa302a59e84b52817d64e0829d21ac5e5c65086e03779d6cf1044e4e15596c61e1c5e7750e1df8612685ae02
-  data.tar.gz: daa17937da05ce2f9b5e8c25e3e0f37921bf0a435382d24ed5a26456c9d270f135ffb64e12713f945f2020dd21a57ecff5fba1d0c9a27442fd25b0d3f46e8e90
+  metadata.gz: 0a68ca9a4eea76d86486dbe85e8c3394761d2b8ee4c20b9cbf714b4656f108749f52c3b4b7a8cbffbfbfc75e5d7cbb1f18967cd55441db20dd4efe1300d6ba7f
+  data.tar.gz: fc9891b07bbac7a96b259418e96b98d1dae2b9a264b573404067597429cb4fc1e8bbf7794334827faeac652f46534f6836b811045a3a50e1e20a2de644b6236f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "woothee"]
+	path = woothee
+	url = https://github.com/woothee/woothee.git

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - "1.9"
+  - "2.0"
+  - "jruby-19mode"
+before_script:
+  - git submodule update --init
+  - bundle install
+  - bundle update
+script:
+  - make

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TAGOMORI Satoshi
+
+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/Makefile

@@ -1,13 +1,11 @@
 all: test
 
-TIMESTAMP=$(shell date +%Y%m%d-%H%M%S)
+testsets:
+	git submodule update --init
 
-checkyaml:
-	perl ../bin/dataset_checker.pl
-
-lib/woothee/dataset.rb: ../dataset.yaml
-	ruby ../bin/dataset_yaml2rb.rb
+lib/woothee/dataset.rb: testsets
+	ruby scripts/dataset_yaml2rb.rb
 	sync; sync; sync
 
 test: lib/woothee/dataset.rb
-	rspec spec
+	bundle exec rspec spec

data/README.md

@@ -0,0 +1,79 @@
+# Woothee ruby
+
+The Ruby implementation of Project Woothee, which is multi-language user-agent strings parsers.
+
+https://github.com/woothee/woothee
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'woothee'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install woothee
+
+## Usage
+
+Class 'Woothee' have no instance methods.
+
+### Parsing user-agent
+
+```ruby
+require 'woothee'
+Woothee.parse("Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0)")
+ # => {:name=>"Internet Explorer", :category=>:pc, :os=>"Windows 7", :version=>"8.0", :vendor=>"Microsoft"}
+```
+
+Parse user-agent string and returns Hash instance with keys `:name`, `:category`, `:os`, `:version` and `:vendor`.
+
+For unknown user-agent (or partially failed to parse), result Hash instance may have value 'UNKNOWN'.
+
+* `:category`
+ * labels of user terminal type, one of 'pc', 'smartphone', 'mobilephone', 'appliance', 'crawler' or 'misc' (or 'UNKNOWN')
+* `:name`
+ * the name of browser, like 'Internet Explorer', 'Firefox', 'GoogleBot'
+* `:version`
+ * version string, like '8.0' for IE, '9.0.1' for Firefix, '0.2.149.27' for Chrome, and so on
+* `:os`
+ * ex: 'Windows 7', 'Mac OSX', 'iPhone', 'iPad', 'Android'
+ * This field used to indicate cellar phone carrier for category 'mobilephone'
+* `:vendor`
+ * optional field, shows browser vendor
+
+### Finding crawlers (almost all, not all) in fast
+
+```ruby
+require 'woothee'
+Woothee.is_crawler("Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0)")
+ # => false
+```
+
+Try to see useragent's category is 'crawler' or not, by casual(fast) method. Minor case of crawlers is not tested in this method. To check crawler strictly, use `Woothee.parse(str)[:category] == 'crawler'`.
+
+* * * * *
+
+## Authors
+
+* TAGOMORI Satoshi <tagomoris@gmail.com>
+
+## License
+
+Copyright 2012- TAGOMORI Satoshi (tagomoris)
+
+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
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+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/Rakefile

@@ -3,11 +3,11 @@ Bundler::GemHelper.install_tasks
 
 require 'rake'
 $:.unshift  File.join(File.dirname(__FILE__), "lib")
- 
+
 require 'rspec/core'
 require 'rspec/core/rake_task'
- 
+
 task :default => :spec
- 
+
 desc "Run all specs in spec directory"
 RSpec::Core::RakeTask.new(:spec)

data/lib/woothee/appliance.rb

@@ -11,6 +11,7 @@ module Woothee::Appliance
            when ua.index('PSP (PlayStation Portable);') then Woothee::DataSet.get('PSP')
            when ua.index('PlayStation Vita') then Woothee::DataSet.get('PSVita')
            when ua.index('PLAYSTATION 3 ') || ua.index('PLAYSTATION 3;') then Woothee::DataSet.get('PS3')
+           when ua.index('PlayStation 4 ') then Woothee::DataSet.get('PS4')
            else nil
            end
     return false unless data

data/lib/woothee/dataset.rb

@@ -33,7 +33,7 @@ end
 
 module Woothee::DataSet
   DATASET = {}
-  # GENERATED from dataset.yaml at Tue Sep 10 14:45:24 JST 2013 by tagomoris
+  # GENERATED from dataset.yaml at Tue Dec  3 19:37:52 JST 2013 by tagomoris
   obj = {:label => 'MSIE', :name => 'Internet Explorer', :type => :browser}
   obj[:vendor] = 'Microsoft'
   DATASET[obj[:label]] = obj
@@ -195,6 +195,21 @@ module Woothee::DataSet
   obj[:category] = :appliance
   obj[:os] = 'PlayStation 3'
   DATASET[obj[:label]] = obj
+  obj = {:label => 'PS4', :name => 'PlayStation 4', :type => :full}
+  obj[:vendor] = 'Sony'
+  obj[:category] = :appliance
+  obj[:os] = 'PlayStation 4'
+  DATASET[obj[:label]] = obj
+  obj = {:label => 'Xbox360', :name => 'Xbox 360', :type => :full}
+  obj[:vendor] = 'Microsoft'
+  obj[:category] = :appliance
+  obj[:os] = 'Xbox 360'
+  DATASET[obj[:label]] = obj
+  obj = {:label => 'XboxOne', :name => 'Xbox One', :type => :full}
+  obj[:vendor] = 'Microsoft'
+  obj[:category] = :appliance
+  obj[:os] = 'Xbox One'
+  DATASET[obj[:label]] = obj
   obj = {:label => 'DigitalTV', :name => 'InternetTVBrowser', :type => :full}
   obj[:category] = :appliance
   obj[:os] = 'DigitalTV'

data/lib/woothee/os.rb

@@ -9,6 +9,18 @@ module Woothee::OS
   def self.challenge_windows(ua, result)
     return false if ua.index("Windows").nil?
 
+    # Xbox Series
+    if ua.index("Xbox")
+      data = if ua.index("Xbox; Xbox One)")
+               Woothee::DataSet.get("XboxOne")
+             else
+               Woothee::DataSet.get("Xbox360")
+             end
+      # update browser as appliance
+      update_map(result, data)
+      return true
+    end
+
     data = Woothee::DataSet.get('Win')
     unless ua =~ /Windows ([ .a-zA-Z0-9]+)[;\\)]/o
       # Windows, but version unknown

data/scripts/dataset_yaml2rb.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'yaml'
+
+dataset_file = File.dirname(__FILE__) + '/../woothee/dataset.yaml';
+rb_file = File.dirname(__FILE__) + '/../lib/woothee/dataset.rb';
+
+generated_timestamp = open("|env LANG=C date") {|io|
+  io.readline().chomp
+}
+generated_username = open("|env LANG=C whoami") {|io|
+  io.readline().chomp
+}
+timestamp = "# GENERATED from dataset.yaml at #{generated_timestamp} by #{generated_username}"
+
+lines = [timestamp]
+
+YAML.load_file(dataset_file).each do |dataset|
+  label = dataset['label']
+  name = dataset['name']
+  type = dataset['type']
+
+  # obj = {:label => 'MSIE', :name => 'Internet Explorer', :type => :browser}
+  # obj[:vendor] = 'Microsoft'
+  # DATASET['MSIE'] = obj
+
+  lines.push "obj = {:label => '#{label}', :name => '#{name}', :type => :#{type}}"
+  case type
+  when 'browser'
+    lines.push "obj[:vendor] = '#{dataset['vendor']}'"
+  when 'os'
+    lines.push "obj[:category] = :#{dataset['category']}"
+  when 'full'
+    lines.push "obj[:vendor] = '#{dataset['vendor']}'" if dataset['vendor']
+    lines.push "obj[:category] = :#{dataset['category']}"
+    if dataset['os']
+      lines.push "obj[:os] = '#{dataset['os']}'"
+    end
+  else
+    raise StandardError, "unknown type #{type}"
+  end
+  lines.push "DATASET[obj[:label]] = obj"
+end
+
+dynamic_lines = lines.join("\n  ") + "\n"
+
+module_text = <<EOT
+# -*- coding: utf-8 -*-
+module Woothee
+  KEY_LABEL = :label
+  KEY_NAME = :name
+  KEY_TYPE = :type
+  KEY_CATEGORY = :category
+  KEY_OS = :os
+  KEY_VENDOR = :vendor
+  KEY_VERSION = :version
+
+  TYPE_BROWSER = :browser
+  TYPE_OS = :os
+  TYPE_FULL = :full
+
+  CATEGORY_PC = :pc
+  CATEGORY_SMARTPHONE = :smartphone
+  CATEGORY_MOBILEPHONE = :mobilephone
+  CATEGORY_CRAWLER = :crawler
+  CATEGORY_APPLIANCE = :appliance
+  CATEGORY_MISC = :misc
+
+  ATTRIBUTE_NAME = :name
+  ATTRIBUTE_CATEGORY = :category
+  ATTRIBUTE_OS = :os
+  ATTRIBUTE_VENDOR = :vendor
+  ATTRIBUTE_VERSION = :version
+
+  VALUE_UNKNOWN = "UNKNOWN"
+
+  CATEGORY_LIST = [CATEGORY_PC,CATEGORY_SMARTPHONE,CATEGORY_MOBILEPHONE,CATEGORY_CRAWLER,CATEGORY_APPLIANCE,CATEGORY_MISC,VALUE_UNKNOWN]
+  ATTRIBUTE_LIST = [ATTRIBUTE_NAME,ATTRIBUTE_CATEGORY,ATTRIBUTE_OS,ATTRIBUTE_VENDOR,ATTRIBUTE_VERSION]
+end
+
+module Woothee::DataSet
+  DATASET = {}
+  #{dynamic_lines}
+  DATASET.freeze
+
+  def self.get(label)
+    DATASET[label]
+  end
+end
+EOT
+
+open(rb_file, 'w') {|io|
+  io.write module_text
+}

data/spec/02_run_testsets_spec.rb

@@ -5,7 +5,7 @@ $LOAD_PATH.push '../lib' unless $LOAD_PATH.include?('../lib')
 require 'yaml'
 require 'woothee'
 
-TESTSET_DIR = File.dirname(__FILE__) + "/../../testsets/";
+TESTSET_DIR = File.dirname(__FILE__) + "/../woothee/testsets/";
 
 TARGETS = [
            ['crawler.yaml','Crawler'],['crawler_google.yaml','Crawler/Google'],

data/woothee.gemspec

@@ -1,12 +1,11 @@
 # encoding: utf-8
-# $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name        = "woothee"
   gem.description = "Cross-language UserAgent classifier library, ruby implementation"
-  gem.homepage    = "https://github.com/tagomoris/woothee"
+  gem.homepage    = "https://github.com/woothee/woothee-ruby"
   gem.summary     = gem.description
-  gem.version     = "0.3.4"
+  gem.version     = "0.3.5"
   gem.authors     = ["TAGOMORI Satoshi"]
   gem.email       = "tagomoris@gmail.com"
   gem.has_rdoc    = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: woothee
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - TAGOMORI Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,8 +30,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .gitmodules
+- .travis.yml
 - Gemfile
+- LICENSE.txt
 - Makefile
+- README.md
 - Rakefile
 - lib/woothee.rb
 - lib/woothee/appliance.rb
@@ -42,11 +47,12 @@ files:
 - lib/woothee/mobilephone.rb
 - lib/woothee/os.rb
 - lib/woothee/util.rb
+- scripts/dataset_yaml2rb.rb
 - spec/00_valid_spec.rb
 - spec/01_dataset_spec.rb
 - spec/02_run_testsets_spec.rb
 - woothee.gemspec
-homepage: https://github.com/tagomoris/woothee
+homepage: https://github.com/woothee/woothee-ruby
 licenses: []
 metadata: {}
 post_install_message: