uagent 0.0.1 → 0.0.2

data/README.rdoc

@@ -2,12 +2,68 @@
 
 Helps you to develop web applications for desktop or mobile user agents.
 
+== Install
+
+    $ gem install uagent
+
 == Use
 
+    require 'rubygmes'
+    require 'uagent'
+
+    # A parser distinguishes between disjoin user agent sets
+
+    parser = UAgent::Parser.new([:desktop, :mobile])
+
+    ua = "Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_1_2 like Mac OS X; en-us) " +
+         "AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7D11 Safari/528.16"
+
+    parser.call({ 'HTTP_USER_AGENT' => 'ua })    # gets :mobile
+
+    ua = "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.10) " +
+         "Gecko/20100915 Ubuntu/10.04 (lucid) Firefox/3.6.10"
+
+    parser.call({ 'HTTP_USER_AGENT' => 'ua })    # gets :desktop
+
+Also you can add more keywords to get a more specific device
+classification.
+
+    parser = UAgent::Parser.new([:desktop, :mobile, :iphone])
+
+    ua = "Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_1_2 like Mac OS X; en-us) " +
+         "AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7D11 Safari/528.16"
+
+    parser.call({ 'HTTP_USER_AGENT' => 'ua })    # gets :iphone
+
+    ua = "Mozilla/5.0 (BlackBerry; U; BlackBerry 9800; en-US) " +
+         "AppleWebKit/530.17 (KHTML, like Gecko) Version/6.0.0.62 Mobile Safari/530.17"
+
+    parser.call({ 'HTTP_USER_AGENT' => 'ua })    # gets :mobile
+
+Now we are working with the keywords :desktop, :mobile, :iphone and
+:blackberry. Look the tests for more information.
+
+== Install from code
+
+First download the code from the repository:
+
+    $ git clone git@github.com:danielhz/uagent.git
+
+This project uses jeweler to build the gem, so you can use this commands:
+
+    $ rake build            # to build the gem
+    $ rake install          # to build and install the gem in one step
+
+Also, if you want test the gem you can use the spec task:
+
+    $ rake spec
+
+This project uses rcov so you can check the coverage opening the HTML
+file in the coverage directory after running the spec.
+
 == Other Stuff
 
 Author:: Daniel Hernández, daniel@degu.cl
-Version:: 0.0
 License:: GPL V3
 
 == Warranty

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/uagent.rb

@@ -1,9 +1,55 @@
+
+
 module UAgent
 
-  class Selector
+  class Parser
+
+    @@keys = [['Mobile', :mobile],
+              ['Opera Mini', :mobile],
+              ['iPhone', :iphone, :mobile],
+              ['ACER', :mobile],
+              ['Alcatel', :mobile],
+              ['AUDIOVOX', :mobile],
+              ['BlackBerry', :blackberry, :mobile],
+              ['CDM', :mobile],
+              ['Ericsson', :mobile],
+              ['LG', :mobile],
+              ['LGE', :mobile],
+              ['Motorola', :mobile],
+              ['MOT', :mobile],
+              ['NEC', :mobile],
+              ['Nokia', :mobile],
+              ['Panasonic', :mobile],
+              ['QCI', :mobile],
+              ['SAGEM', :mobile],
+              ['SAMSUNG', :mobile],
+              ['SEC', :mobile],
+              ['Sanyo', :mobile],
+              ['Sendo', :mobile],
+              ['SHARP', :mobile],
+              ['SonyEricsson', :mobile],
+              ['Telit', :mobile],
+              ['Telit_mobile_Terminals', :mobile],
+              ['TSM', :mobile],
+              ['Palm', :mobile]]
+    @@priority = [:iphone, :blackberry, :mobile]
+
+    def initialize(*keys)
+      @keys = [:desktop, :mobile] + keys
+    end
 
-    def initialize(keys)
-      @keys = keys
+    def call(env)
+      # Check devices in http user agent
+      http_user_agent = env['HTTP_USER_AGENT']
+      @@priority.select{ |k| @keys.include? k }.each do |key|
+        @@keys.each do |sample|
+          if /#{sample[0]}/ === http_user_agent
+            return key if sample[(1...sample.size)].include? key
+          end
+        end
+      end
+      # As device is not found, return the default
+      return @keys[0]
     end
 
   end

data/rakefile

@@ -1,16 +1,16 @@
 require 'rubygems'
 require 'rake'
-require 'rake/testtask'
+require 'spec/rake/spectask'
 require 'rake/rdoctask'
 
-desc 'Default: run unit tests.'
-task :default => :test
+desc 'Default: run rspec tests.'
+task :default => :spec
 
 desc 'Run all tests'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = Dir.glob('test/*_test.rb')
+  t.spec_opts << '--format specdoc'
+  t.rcov = true
 end
 
 begin
@@ -21,7 +21,31 @@ begin
     gemspec.email = "daniel@degu.cl"
     gemspec.homepage = "http://github.com/danielhz/uagent"
     gemspec.summary = "Helps you to develop web applications for diferent user agents"
-    gemspec.add_dependency('rack', '>= 0.9.1')
+    gemspec.rubyforge_project = "uagent"
+    gemspec.description = "Helps you to develop for diferent http user agents."
   end
 rescue LoadError
 end
+
+begin
+  require 'darkfish-rdoc'
+  DARKFISH_ENABLED = true
+rescue LoadError => ex
+  DARKFISH_ENABLED = false
+end
+
+BASE_RDOC_OPTIONS = [
+  '--line-numbers', '--inline-source',
+  '--main' , 'README.rdoc',
+  '--title', 'uagent'
+]
+
+rd = Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.title = "uagent"
+  rdoc.options = BASE_RDOC_OPTIONS.dup
+  rdoc.options << '-SHN' << '-f' << 'darkfish' if DARKFISH_ENABLED
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+end

data/test/parser_test.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'uagent'
+
+describe 'UAgent::Parser' do
+
+  before(:all) do
+  end
+
+  it 'distinguishes between basic user agent sets' do
+    parser = UAgent::Parser.new
+
+    ua = "Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_1_2 like Mac OS X; en-us) " +
+      "AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7D11 Safari/528.16"
+    env = { 'HTTP_USER_AGENT' => ua }
+    parser.call(env).should == :mobile
+
+    ua = "Mozilla/5.0 (BlackBerry; U; BlackBerry 9800; en-US) " +
+         "AppleWebKit/530.17 (KHTML, like Gecko) Version/6.0.0.62 Mobile Safari/530.17"
+    env = { 'HTTP_USER_AGENT' => ua }
+    parser.call(env).should == :mobile
+
+    ua = "Mozilla/5.0 (Linux; U; Android 2.1-update1; en-us; DROIDX Build/VZW) " +
+      "AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Mobile Safari/530.17 " +
+      "480X854 motorola DROIDX"
+    env = { 'HTTP_USER_AGENT' => ua }
+    parser.call(env).should == :mobile
+
+    ua = "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.10) " +
+      "Gecko/20100915 Ubuntu/10.04 (lucid) Firefox/3.6.10"
+    env = { 'HTTP_USER_AGENT' => ua }
+    parser.call(env).should == :desktop
+  end
+
+  it 'distinguishes user agent subsets' do
+    parser = UAgent::Parser.new(:iphone, :blackberry)
+
+    ua = "Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_1_2 like Mac OS X; en-us) " +
+      "AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7D11 Safari/528.16"
+    env = { 'HTTP_USER_AGENT' => ua }
+    parser.call(env).should == :iphone
+
+    ua = "Mozilla/5.0 (BlackBerry; U; BlackBerry 9800; en-US) " +
+         "AppleWebKit/530.17 (KHTML, like Gecko) Version/6.0.0.62 Mobile Safari/530.17"
+    env = { 'HTTP_USER_AGENT' => ua }
+    parser.call(env).should == :blackberry
+
+    ua = "Mozilla/5.0 (Linux; U; Android 2.1-update1; en-us; DROIDX Build/VZW) " +
+      "AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Mobile Safari/530.17 " +
+      "480X854 motorola DROIDX"
+    env = { 'HTTP_USER_AGENT' => ua }
+    parser.call(env).should == :mobile
+
+    ua = "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.2.10) " +
+      "Gecko/20100915 Ubuntu/10.04 (lucid) Firefox/3.6.10"
+    env = { 'HTTP_USER_AGENT' => ua }
+    parser.call(env).should == :desktop
+  end
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Daniel Hern\xC3\xA1ndez"
@@ -14,24 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-23 00:00:00 -04:00
+date: 2010-09-24 00:00:00 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 1
-        version: 0.9.1
-  type: :runtime
-  version_requirements: *id001
-description: 
+dependencies: []
+
+description: Helps you to develop for diferent http user agents.
 email: daniel@degu.cl
 executables: []
 
@@ -44,7 +31,7 @@ files:
 - VERSION
 - lib/uagent.rb
 - rakefile
-- test/uagent_test.rb
+- test/parser_test.rb
 has_rdoc: true
 homepage: http://github.com/danielhz/uagent
 licenses: []
@@ -70,10 +57,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: uagent
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Helps you to develop web applications for diferent user agents
 test_files: 
-- test/uagent_test.rb
+- test/parser_test.rb

data/test/uagent_test.rb

@@ -1 +0,0 @@
-# Rspec tests