uagent 0.0.3 → 0.0.4

data/README.rdoc

@@ -6,48 +6,85 @@ Helps you to develop web applications for desktop or mobile user agents.
 
     $ gem install uagent
 
-== Use
+== Usage
 
-    require 'rubygmes'
-    require 'uagent'
+When a browser sends a request to your web application the request has
+an HTTP_USER_AGENT attribute that identifies the device an
+browser. For example, the next string identifies an particular model
+of iPhone, that uses an specific mobile version for Safari.
 
-    # A parser distinguishes between disjoin user agent sets
+    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 = UAgent::Parser.new([:desktop, :mobile])
+Each mobile phone model will send you a particular user agent string,
+thus is a good idea classify the devices in groups an develop a
+specific interface for each group. For each group we define a key, so
+the user agent parser receive the user agent string and returns that
+key. For example, the answer for the string above could be :mobile or
+:iphone, depending on the parser configuration.
 
-    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"
+If you are developing web applications on top of rack, I recommend
+you to look the uagent_rack[http://github.com/danielhz/uagent_rack]
+gem.
 
-    parser.call({ 'HTTP_USER_AGENT' => 'ua })    # gets :mobile
+=== Code example
 
-    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"
+    require 'rubygmes'
+    require 'uagent'
 
+    # A parser distinguishes between disjoin user agent sets
+    
+    parser = UAgent::Parser.new
+    
+    env = {
+      ...
+      "HTTP_USER_AGENT" => "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(env)    # gets :mobile
+    
+    env = {
+      ...
+      "HTTP_USER_AGENT" => "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.
+=== Using specific user agent groups.
 
-    parser = UAgent::Parser.new([:desktop, :mobile, :iphone])
+The basic user agent groups are :desktop and :mobile. You can add more
+groups adding keys in the constructor function.
+
+    parser = UAgent::Parser.new(: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"
+The keys order in the constructor is relevant. Put the most specific
+keys first to indicate the parser to start for them.
+
+=== Using a custom device database.
 
-    parser.call({ 'HTTP_USER_AGENT' => 'ua })    # gets :mobile
+The parser uses a hash that associates terms to the user agent group
+keyword. That terms are searched in the HTTP_USER_AGENT string to
+analyze if a user agent is into a group. Now we support only the
+keywords :iphone and :blackberry, thus change the database if you need
+a more accurate parser.
 
-Now we are working with the keywords :desktop, :mobile, :iphone and
-:blackberry. Look the tests for more information.
+     parser.set_database my_custom_database
 
 == Install from code
 
 First download the code from the repository:
 
-    $ git clone git@github.com:danielhz/uagent.git
+    $ git clone git://github.com/danielhz/uagent.git
 
 This project uses jeweler to build the gem, so you can use this commands:
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/uagent.rb

@@ -11,9 +11,10 @@ module UAgent
                   'BlackBerry', 'CDM', 'Ericsson', 'LG', 'LGE', 'Motorola', 'MOT',
                   'NEC', 'Nokia', 'Panasonic', 'QCI', 'SAGEM', 'SAMSUNG', 'SEC',
                   'Sanyo', 'Sendo', 'SHARP', 'SonyEricsson', 'Telit',
-                  'Telit_mobile_Terminals', 'TSM', 'Palm'],
+                  'Telit_mobile_Terminals', 'TSM', 'Palm', 'ViewPad'],
       :iphone => ['iPhone'],
-      :blackberry => ['BlackBerry']
+      :blackberry => ['BlackBerry'],
+      :android => ['ViewPad7']
     }
 
     def initialize(*specific_keys)

data/rakefile

@@ -1,16 +1,24 @@
+# -*- coding: utf-8 -*-
 require 'rubygems'
 require 'rake'
-require 'spec/rake/spectask'
-require 'rake/rdoctask'
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'rcov'
 
 desc 'Default: run rspec tests.'
 task :default => :spec
 
 desc 'Run all tests'
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_files = Dir.glob('test/*_test.rb')
-  t.spec_opts << '--format specdoc'
+RSpec::Core::RakeTask.new(:specs) do |t|
+  t.rspec_opts = ["--colour", "--format", "documentation"]
+end
+
+desc 'Coverage for all specs'
+RSpec::Core::RakeTask.new(:rcov) do |t|
   t.rcov = true
+  t.rcov_opts =  %q[--exclude "spec"]
+  t.verbose = true
 end
 
 begin
@@ -27,25 +35,15 @@ begin
 rescue LoadError
 end
 
-begin
-  require 'darkfish-rdoc'
-  DARKFISH_ENABLED = true
-rescue LoadError => ex
-  DARKFISH_ENABLED = false
+YARD::Rake::YardocTask.new do |t|
+  t.options += ['--title', "Uagent documentation"]
 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')
+desc 'Build and upload the last gem file'
+task :gem_push => :build do
+  gem = Dir['pkg/*.gem'].map { |f|
+    [f, File.basename(f).gsub(/.gem$/, '').gsub(/^uagent-/, '').split('.').map{ |x| x.to_i}]
+  }.sort.last
+  puts "gem push #{gem[0]}"
+  system "gem push #{gem[0]}"
 end

data/{test/parser_test.rb → spec/parser_spec.rb}

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'rspec'
 require 'uagent'
 
 describe 'UAgent::Parser' do

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: uagent
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - "Daniel Hern\xC3\xA1ndez"
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 -04:00
+date: 2011-09-05 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -31,36 +32,40 @@ files:
 - VERSION
 - lib/uagent.rb
 - rakefile
-- test/parser_test.rb
+- spec/parser_spec.rb
 has_rdoc: true
 homepage: http://github.com/danielhz/uagent
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: uagent
-rubygems_version: 1.3.6
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Helps you to develop web applications for diferent user agents
 test_files: 
-- test/parser_test.rb
+- spec/parser_spec.rb