wurfl_client 0.4.0 → 0.5.1

data/README

@@ -22,45 +22,83 @@ The WURFL Client can then be implemented f.i. as a thin Rack service, see Exampl
 
 == Requirements
 
-Ruby 1.9: (.ord!) -> http://gist.github.com/251465
-wurfl gem (http://github.com/pwim/wurfl): Handset, UserAgentMatcher, WURFL Loader
+Ruby 1.9: (.ord!) -> Possibly integrate http://gist.github.com/251465 as a fix
+WURFL gem (http://github.com/pwim/wurfl): Handset, UserAgentMatcher, WURFL Loader
+
 
 == Installation
 
-sudo gem install wurfl_client
+    sudo gem install wurfl_client
+
 
 == Setup
 
 To setup the environment, you have to execute following steps:
 1.) download and extract the latest WURFL file
-* curl -L -o wurfl-latest.xml.gz 
-* gunzip wurfl-latest.xml.gz
+
+    curl -L -o wurfl-latest.xml.gz 
+    gunzip wurfl-latest.xml.gz
 
 2.) minimize the WURFL XML file. You can adapt wurfl_minimize.yml to your needs, see http://wurfl.sourceforge.net/help_doc.php for a list of available capabilities)
-* wurfl_minimize.rb 
 
+    wurfl_minimize.rb 
+ 
 3.) prepare the lookup tables (builds them into ./lookup directory by default). This will take some time!
-* lookup_prepare.rb 
+
+    lookup_prepare.rb 
 
 Now, you are ready for device detection. If you make an automated script to do this update regularly, you must not forget to clear the lookup directory first. 
 The preparation script doesn't overwrite files. For minimal effect on your running webservice, you should use another lookup directory there and copy the 
 new data after the update is complete. 
 
 Here is an example automatic update script:
-* #!/bin/sh
-* curl -L -o wurfl-latest.xml.gz 
-* gunzip wurfl-latest.xml.gz
-* wurfl_minimize.rb 
-* rm lookup/*
-* lookup_prepare.rb
-* cp lookup/* /path/to/production/lookup
 
-== Examples
+    #!/bin/sh
+    curl -L -o wurfl-latest.xml.gz 
+    gunzip wurfl-latest.xml.gz
+    wurfl_minimize.rb 
+    rm lookup/*
+    lookup_prepare.rb
+    cp lookup/* /path/to/production/lookup
+
 
-TODO: simple detection example
-TODO: rack application
+== Examples
 
-== Authors
+The device detection is as simple as this call:
+
+    require "wurfl_client"
+    
+    user_agent = 'Mozilla/5.0 (iPhone; U; CPU iPhone like Mac OS X; en-us)'
+    device = WurflClient::detectMobileDevice(user_agent)
+    
+    puts "DEVICE: #{hs["brand_name"]} #{hs["model_name"]}"
+    
+You can easily put the WURFL detection into a Rack (http://rack.rubyforge.org/) middleware. 
+Using following 'config.ru', you can put this online using 'rackup':
+
+    require "wurfl_client"
+
+    class RackInterface
+  
+      def call(env)
+        user_agent = env["HTTP_USER_AGENT"]
+        
+        hs = WurflClient.detectMobileDevice(user_agent)
+        hsinfo = flash.collect { |k, v| "#{k}: #{v};" }.join
+  
+        [200, {"Content-Type" => "text/plain"}, ["#{hsinfo}"] ]
+      end
+  
+    end
+
+    run RackInterface.new
+
+  
+This can be further extended by a caching mechanism to reduce the server load. Being a Rack layer, it should 
+also be possible to integrate this into a rails app. If you know, how to do so, I would really appreciate your 
+contribution.
+
+== Author
 
 * Guido Pinkas (Original Author)
 

data/Rakefile

@@ -17,7 +17,7 @@ begin
     gemspec.email = "guido.pinkas@bindertrittenwein.com"
     gemspec.homepage = "http://github.com/bluecat76/wurfl_client"
     gemspec.authors = ["Guido Pinkas"]
-    gemspec.add_dependency 'wurfl'
+    gemspec.add_dependency 'wurfl', '>=1.3.6'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.1

data/test/wurfl_client_test.rb

@@ -1,6 +1,6 @@
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'test/unit'
-require 'wurfl_client/wurfl_client'
+require 'wurfl_client'
 
 class WurflClientTest < Test::Unit::TestCase
   def setup

data/wurfl_client.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wurfl_client}
-  s.version = "0.4.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Guido Pinkas"]
-  s.date = %q{2010-09-27}
+  s.date = %q{2010-09-28}
   s.description = %q{WURFL Client is a library to do WURFL (http://wurfl.sourceforge.net/) mobile device detection for web applications. Included are tools to keep the WURFL file up to date automatically and to prepare a customized lookup tables, which allow a fast device detection.}
   s.email = %q{guido.pinkas@bindertrittenwein.com}
-  s.executables = ["prepare_lookup.rb", "wurfl_minimize.rb"]
+  s.executables = ["wurfl_minimize.rb", "wurfl_prepare_lookup.rb"]
   s.extra_rdoc_files = [
     "README"
   ]
@@ -21,14 +21,18 @@ Gem::Specification.new do |s|
      "README",
      "Rakefile",
      "VERSION",
-     "bin/prepare_lookup.rb",
      "bin/wurfl_minimize.rb",
+     "bin/wurfl_prepare_lookup.rb",
+     "lib/wurfl_client.rb",
      "lib/wurfl_client/device_profile.rb",
      "lib/wurfl_client/lookup_helper.rb",
      "lib/wurfl_client/lookup_preparer.rb",
      "lib/wurfl_client/ua_device_detector.rb",
-     "lib/wurfl_client/wurfl_client.rb",
+     "test/data/iphone.pstore",
      "test/device_profile_test.rb",
+     "test/lookup_helper_test.rb",
+     "test/ua_device_detector_test.rb",
+     "test/wurfl_client_test.rb",
      "wurfl_client.gemspec"
   ]
   s.homepage = %q{http://github.com/bluecat76/wurfl_client}
@@ -48,12 +52,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<wurfl>, [">= 0"])
+      s.add_runtime_dependency(%q<wurfl>, [">= 1.3.6"])
     else
-      s.add_dependency(%q<wurfl>, [">= 0"])
+      s.add_dependency(%q<wurfl>, [">= 1.3.6"])
     end
   else
-    s.add_dependency(%q<wurfl>, [">= 0"])
+    s.add_dependency(%q<wurfl>, [">= 1.3.6"])
   end
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 0
-  version: 0.4.0
+  - 5
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Guido Pinkas
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 +02:00
+date: 2010-09-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,15 +26,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 3
+        - 6
+        version: 1.3.6
   type: :runtime
   version_requirements: *id001
 description: WURFL Client is a library to do WURFL (http://wurfl.sourceforge.net/) mobile device detection for web applications. Included are tools to keep the WURFL file up to date automatically and to prepare a customized lookup tables, which allow a fast device detection.
 email: guido.pinkas@bindertrittenwein.com
 executables: 
-- prepare_lookup.rb
 - wurfl_minimize.rb
+- wurfl_prepare_lookup.rb
 extensions: []
 
 extra_rdoc_files: 
@@ -44,18 +46,19 @@ files:
 - README
 - Rakefile
 - VERSION
-- bin/prepare_lookup.rb
 - bin/wurfl_minimize.rb
+- bin/wurfl_prepare_lookup.rb
+- lib/wurfl_client.rb
 - lib/wurfl_client/device_profile.rb
 - lib/wurfl_client/lookup_helper.rb
 - lib/wurfl_client/lookup_preparer.rb
 - lib/wurfl_client/ua_device_detector.rb
-- lib/wurfl_client/wurfl_client.rb
+- test/data/iphone.pstore
 - test/device_profile_test.rb
-- wurfl_client.gemspec
 - test/lookup_helper_test.rb
-- test/wurfl_client_test.rb
 - test/ua_device_detector_test.rb
+- test/wurfl_client_test.rb
+- wurfl_client.gemspec
 has_rdoc: true
 homepage: http://github.com/bluecat76/wurfl_client
 licenses: []