uagent_rack 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+coverage
+html
+pkg
+uagent.gemspec
+*~

data/README.rdoc

@@ -0,0 +1,98 @@
+= uagent_rack
+
+== Install
+
+    gem install uagent_rack
+
+== Usage
+
+Helps you to deal with user agents on top of rack. 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.
+
+    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
+
+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. To known how to
+configure the parser read the
+uagent[http://http://github.com/danielhz/uagent] documentation.
+
+This gem adds the RackParse class to the UAgent module, that extends
+the Parser class. Unlike Parser, that analyzes the HTTP_USER_AGENT
+variable every time, uagent_rack parse the user_agent only the first
+time and store it in the session. Thus, the following requests will be
+answered using the data in the session. Also, an user can change the
+user agent adding a value for the parameter +user_agent+ in the URI
+query.
+
+=== Code example
+
+    require 'rubygmes'
+    require 'uagent_rack'
+
+    parser = UAgent::Parser.new
+
+    # We create an environment with a mobile user agent.
+
+    env1 = {
+      ...
+      "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(env1)    # gets :mobile
+
+    # We create another that changes the user agent
+
+    env2 = {
+      ...
+      "QUERY_STRING" => "user_agent=dektop",
+      "REQUEST_URI" => "/index?user_agent=desktop",
+      ...
+    })
+
+    parser.call(env2)    # gets :dektop
+    parser.call(env1)    # gets :dektop
+
+== Install from code
+
+First you need uagent
+
+    $ gem install uagent
+
+Then download the code from the repository:
+
+    $ git clone git@github.com:danielhz/uagent_rack.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
+License:: GPL V3
+
+== Warranty
+
+This software is provided "as is" and without any express or implied
+warranties, including, without limitation, the implied warranties of
+merchantability and fitness for a particular purpose.
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/uagent_rack.rb

@@ -0,0 +1,20 @@
+
+require 'rubygems'
+require 'uagent'
+require 'rack'
+
+module UAgent
+
+  class RackParser < Parser
+
+    def call(env)
+      req = Rack::Request.new(env)
+      unless req.params['user_agent'].nil?
+        req.session[:user_agent] = req.params['user_agent'].to_sym
+      end
+      req.session[:user_agent] || super(env)
+    end
+
+  end
+
+end

data/rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+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'
+  t.rcov = true
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "uagent_rack"
+    gemspec.authors = ["Daniel Hernández"]
+    gemspec.email = "daniel@degu.cl"
+    gemspec.homepage = "http://github.com/danielhz/uagent_rack"
+    gemspec.summary = "Helps you to deal with user agents on top of rack"
+    gemspec.rubyforge_project = "uagent_rack"
+    gemspec.description = "Helps you to deal with user agents on top of rack"
+    gemspec.add_dependency('uagent', '>= 0.0.3')
+    gemspec.add_dependency('rack', '>= 0.9.1')
+  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_rack"
+  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/uagent_rack_test.rb

@@ -0,0 +1,72 @@
+# Rspec tests
+
+require 'rubygems'
+require 'uagent_rack'
+require 'stringio'
+
+describe 'UAgent::RackParser' do
+
+  before(:all) do
+    @env = {
+      "SERVER_NAME" => "localhost",
+      "HTTP_ACCEPT" => "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+      "HTTP_HOST" => "localhost:3001",
+      "rack.session" => {},
+      "HTTP_KEEP_ALIVE" => "115",
+      "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",
+      "REQUEST_PATH" => "/index",
+      "rack.url_scheme"=>"http",
+      "rack.request.cookie_hash" => {"rack.session"=>"cab867c36b7fc7385f5716cc5c793ac7"},
+      "SERVER_PROTOCOL" => "HTTP/1.1",
+      "HTTP_ACCEPT_LANGUAGE" => "en-us,en;q=0.5",
+      "rack.errors" => IO.new(0),
+      "REMOTE_ADDR" => "127.0.0.1",
+      "PATH_INFO" => "/index",
+      "SERVER_SOFTWARE" => "Mongrel 1.1.5",
+      "rack.run_once" => false,
+      "rack.version" => [1, 1],
+      "SCRIPT_NAME" => "",
+      "rack.request.cookie_string" => "rack.session=cab867c36b7fc7385f5716cc5c793ac7",
+      "HTTP_COOKIE" => "rack.session=cab867c36b7fc7385f5716cc5c793ac7",
+      "HTTP_VERSION" => "HTTP/1.1",
+      "rack.multithread" => true,
+      "REQUEST_URI" => "/index",
+      "rack.multiprocess" => false,
+      "SERVER_PORT" => "3001",
+      "HTTP_ACCEPT_CHARSET" => "ISO-8859-1,utf-8;q=0.7,*;q=0.7",
+      "REQUEST_METHOD" => "GET",
+      "rack.session.options" => {
+        :domain => nil,
+        :expire_after => 2592000,
+        :defer => false,
+        :sidbits => 128,
+        :secure => false,
+        :key => "rack.session",
+        :httponly => true,
+        :renew => false,
+        :id => "cab867c36b7fc7385f5716cc5c793ac7",
+        :path => "/",
+        :drop => false
+      },
+      "GATEWAY_INTERFACE" => "CGI/1.2",
+      "HTTP_CONNECTION" => "keep-alive",
+      "HTTP_ACCEPT_ENCODING" => "gzip,deflate",
+      "QUERY_STRING" => "",
+      "rack.input" => StringIO.new
+    }
+  end
+
+  it 'get the user agent' do
+    parser = UAgent::RackParser.new()
+    env = @env.clone
+    parser.call(env).should == :desktop
+    env.merge!({
+      "QUERY_STRING" => "user_agent=mobile",
+      "REQUEST_URI" => "/index?user_agent=mobile",
+    })
+    parser.call(env).should == :mobile
+    env = @env.clone
+    parser.call(env).should == :mobile
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: uagent_rack
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Daniel Hern\xC3\xA1ndez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uagent
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id002
+description: Helps you to deal with user agents on top of rack
+email: daniel@degu.cl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- VERSION
+- lib/uagent_rack.rb
+- rakefile
+- test/uagent_rack_test.rb
+has_rdoc: true
+homepage: http://github.com/danielhz/uagent_rack
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: uagent_rack
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Helps you to deal with user agents on top of rack
+test_files: 
+- test/uagent_rack_test.rb