ruil 0.0.1

data/.gitignore

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

data/README.rdoc

@@ -0,0 +1,40 @@
+= ruil
+
+Basic tools for build web appplications on top of rack
+
+== Install
+
+    $ gem install ruil
+
+== Usage
+
+=== Code example
+
+== Install from code
+
+First download the code from the repository:
+
+    $ git clone git@github.com:danielhz/ruil.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/ruil/delegator.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+
+module Ruil
+
+  class Delegator
+
+    # Initialize a delegator
+    def initialize(user_agent_parser, template_dir, template_engine, &block)
+      @user_agent_parser = user_agent_parser
+      @template_engine   = template_engine
+      @template_dir      = template_dir
+      @resources         = []
+      yield self
+    end
+
+    # Default action
+    def default(env)
+      [ 302, {"Content-Type" => "text/html", 'Location'=> '/' }, [] ]
+    end
+
+    def add_resource(resource_class)
+      resource_class.new(@user_agent_parser) do |r|
+        Dir[File.join(@template_dir, r.template_pattern)].each do |file|
+          user_agent = File.basename(file).split('.')[1]
+          template = @template_engine.new(file)
+          r.add_template user_agent.to_sym, template
+        end
+        @resources << [r.path_pattern, r]
+      end
+    end
+
+    # Call method
+    def call(env)
+      @resources.each do |path_pattern, proc|
+        return proc.call(env) if path_pattern === env['PATH_INFO']
+      end
+      default(env)
+    end
+
+  end
+
+end

data/lib/ruil/resource.rb

@@ -0,0 +1,84 @@
+require 'rubygems'
+
+module Ruil
+
+  class Resource
+    
+    # Initialize a new resource.
+    #
+    # Parameters:
+    # - templates: a hash with procedures or objects with method call(options),
+    #     used to generate the resource.
+    # - user_agent_parser: is an object with a method call that analize the
+    #     request to get the key for the template to use.
+    def initialize(user_agent_parser, &block)
+      @templates         = {}
+      @user_agent_parser = user_agent_parser
+      yield self
+    end
+
+    def add_template(key, template)
+      @templates[key] = template
+    end
+
+    # The regular expression for the url of this resource.
+    def path_pattern
+      '/'
+    end
+
+    # The regular expression for the url of this resource.
+    def template_pattern
+      '*.*.html'
+    end
+
+    # Authorize the access to this resource.
+    def authorize(env)
+      true
+    end
+
+    # Build options to render the resource.
+    def options(env)
+      {
+        :env => env,
+        :template_key => template_key(env)
+      }
+    end
+
+    # Selects the template key
+    def template_key(env)
+      @user_agent_parser.call(env) || @templates.keys.sort.first
+    end
+
+    # Selectes a template to render the resource
+    def template(env)
+      @templates[template_key(env)]
+    end
+
+    # Call the resource
+    def call(env)
+      if authorize(env)
+        render_html(env)
+      else
+        unauthorized(env)
+      end
+    end
+
+    # Action if the resource is unauthorized
+    def unauthorized(env)
+      redirect("/unauthorized")      
+    end
+
+    # Render
+    def render_html(env)
+      content = template(env).call(options(env))
+      [200, {"Content-Type" => "text/html"}, [content]]
+    end
+
+    # Redirect
+    def redirect(url)
+      [ 302, {"Content-Type" => "text/html", 'Location'=> url }, [] ]
+    end
+
+  end
+
+end

data/lib/ruil/tenjin_template.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'tenjin'
+
+module Ruil
+
+  class TenjinTemplate
+
+    @@engine = Tenjin::Engine.new
+
+    def initialize(file)
+      @file = file
+    end
+
+    def call(options)
+      @@engine.render(@file, options)
+    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 = "ruil"
+    gemspec.authors = ["Daniel Hernández"]
+    gemspec.email = "daniel@degu.cl"
+    gemspec.homepage = "http://github.com/danielhz/ruil"
+    gemspec.summary = "Basic tools for build web appplications on top of rack"
+    gemspec.rubyforge_project = "ruil"
+    gemspec.description = "It provides a class to derivate the application resources\n" +
+      "and a delegator that select the appropiate resource to answer\n" +
+      "a request. Also, it include a templating adapter based on Tenjin."
+  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 = "ruil"
+  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/delegator_test.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'ruil/delegator'
+require 'ruil/resource'
+require 'ruil/tenjin_template'
+
+describe 'Delegator' do
+
+  before(:all) do
+    a_resource = Class.new(Ruil::Resource) do
+      def path_pattern
+        /^\/a/
+      end
+      def template_pattern
+        'a.*.html'
+      end
+    end
+    b_resource = Class.new(Ruil::Resource) do
+      def path_pattern
+        /^\/b/
+      end
+      def template_pattern
+        'b.*.html'
+      end
+    end
+    user_agent_parser = Proc.new do |env|
+      /Mobile/ === env['HTTP_USER_AGENT'] ? :mobile : :desktop
+    end
+    template_dir = File.join(File.dirname(__FILE__), 'templates')
+    @delegator = Ruil::Delegator.new(user_agent_parser, template_dir, Ruil::TenjinTemplate) do |d|
+      d.add_resource a_resource
+      d.add_resource b_resource
+    end
+  end
+
+  it 'delegate a request' do
+    env = { 'PATH_INFO' => '/a', 'HTTP_USER_AGENT' => 'Mobile' }
+    exp = [200, {"Content-Type" => "text/html"}, ["a mobile\n"]]
+    @delegator.call(env).should == exp
+    env = { 'PATH_INFO' => '/a', 'HTTP_USER_AGENT' => 'Desktop' }
+    exp = [200, {"Content-Type" => "text/html"}, ["a desktop\n"]]
+    @delegator.call(env).should == exp
+    env = { 'PATH_INFO' => '/b', 'HTTP_USER_AGENT' => 'Desktop' }
+    exp = [200, {"Content-Type" => "text/html"}, ["b desktop\n"]]
+    @delegator.call(env).should == exp
+    env = { 'PATH_INFO' => '/c', 'HTTP_USER_AGENT' => 'Desktop' }
+    exp =[ 302, {"Content-Type" => "text/html", 'Location'=> '/' }, [] ]
+    @delegator.call(env).should == exp
+  end
+
+end

data/test/resource_test.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'ruil/resource'
+
+describe 'Resource' do
+
+  before(:all) do
+    user_agent_parser = Proc.new do |env|
+      /Mobile/ === env['HTTP_USER_AGENT'] ? :mobile : :desktop
+    end
+    @resource = Ruil::Resource.new(user_agent_parser) do |r|
+      r.add_template :mobile, Proc.new { |opt| opt[:template_key].to_s }
+      r.add_template :desktop, Proc.new { |opt| opt[:template_key].to_s }
+    end
+  end
+
+  it 'should display a content' do
+    env = { 'HTTP_USER_AGENT' => 'Mobile' }
+    @resource.call(env).should == [200, {"Content-Type" => "text/html"}, ['mobile']]
+    env = { 'HTTP_USER_AGENT' => 'Desktop' }
+    @resource.call(env).should == [200, {"Content-Type" => "text/html"}, ['desktop']]
+  end
+
+end

data/test/templates/a.desktop.html

@@ -0,0 +1 @@
+a #{@template_key}

data/test/templates/a.mobile.html

@@ -0,0 +1 @@
+a #{@template_key}

data/test/templates/b.desktop.html

@@ -0,0 +1 @@
+b #{@template_key}

data/test/templates/b.mobile.html

@@ -0,0 +1 @@
+b #{@template_key}

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: ruil
+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-26 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: |-
+  It provides a class to derivate the application resources
+  and a delegator that select the appropiate resource to answer
+  a request. Also, it include a templating adapter based on Tenjin.
+email: daniel@degu.cl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- VERSION
+- lib/ruil/delegator.rb
+- lib/ruil/resource.rb
+- lib/ruil/tenjin_template.rb
+- rakefile
+- test/delegator_test.rb
+- test/resource_test.rb
+- test/templates/a.desktop.html
+- test/templates/a.mobile.html
+- test/templates/b.desktop.html
+- test/templates/b.mobile.html
+has_rdoc: true
+homepage: http://github.com/danielhz/ruil
+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: ruil
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Basic tools for build web appplications on top of rack
+test_files: 
+- test/resource_test.rb
+- test/delegator_test.rb