ruil 0.0.1 → 0.1.0

data/lib/ruil/session_widget.rb

@@ -0,0 +1,43 @@
+# module Ruil
+
+#   class SessionWidget < Ruil::Widget
+
+#     # Initialize a new RuilSessionWidget
+#     def initialize(options = {})
+#       if Hash === options
+#         # Set @path_prefix
+#         @path_prefix = options[:path_prefix] || "/session_widget/"
+#         # Set @logout_redirects_to
+#         @logout_redirects_to = options[:logout_redirects_to] || "/front.html"
+#         # Set @users_collection
+#         @users_collection = options[:users_collection]
+#         if @users_collection.nil?
+#           if defined?(DB).nil?
+#             raise "DB undefined"
+#           else
+#             @users_collection = DB['users']
+#           end
+#         end
+#       end
+#       super
+#     end
+
+#     def setup_actions
+#       render "stylesheet", "stylesheet"
+#       render "script", "script"
+#       redirect "logout", @logout_redirects_to do
+#         # Clean session
+#       end
+#       render "login", "login" do
+#         # Authenticate
+#       end
+#       render "request", "request" do
+#       end
+#       render "check", "check" do
+#         # Check code
+#       end
+#       render "update", "update" do
+#       end
+#     end
+
+#   end

data/lib/ruil/static_resource.rb

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rack'
+require 'ruil/register'
+
+
+module Ruil
+
+  # {Ruil::StaticResource} objects answer requests with static files.
+  class StaticResource
+
+    # Initialize a new {Ruil::StaticResource}.
+    #
+    # @param authorizer [lambda(Ruil::Request)]
+    #   A procedure that checks if the user is allowed to access the resource.
+    def initialize(authorizer = nil, &block)
+      # Setup
+      @authorizer = authorizer
+      @files = {}
+      yield self if block_given?
+      # Register
+      Ruil::Register << self
+    end
+
+    # Methods that a resource responds.
+    # 
+    # @return [Array<String>]
+    def request_methods
+      ['GET']
+    end
+
+    # Add a static file
+    #
+    # @param file_name [String] the path in the file system.
+    # @param file_uri [String] the path from client request.
+    # @param content_type [String] the mime type.
+    def add(file_name, file_uri, content_type)
+      file = File.new(file_name)
+      body = file.read
+      file.close
+      @files[file_uri] = {
+        :body => [body],
+        :content_type => content_type
+      }
+    end
+
+    # Respond a request
+    #
+    # @param request [Rack::Request] a request to the resource.
+    # @return [Rack::Response] a response for the request.
+    def call(rack_request)
+      path_info = rack_request.path_info
+      file = @files[path_info]
+      return false if file.nil?
+      unless @authorizer.nil?
+        request = Ruil::Request.new(rack_request)
+        return @autorizer.unauthorized unless @authorizer.authorize(request)
+      end
+      Rack::Response.new(file[:body], 200, {'Content-Type' => file[:content_type]})
+    end
+
+  end
+
+end

data/lib/ruil/widget.rb

@@ -0,0 +1,39 @@
+# module Ruil
+
+#   class Widget
+#     def initialize(options = {})
+#       if Hash === options
+#         @templates_dir = options[:templates_dir]
+#         if @templates_dir.nil?
+#           if defined?(APPLICATION_PATH).nil?
+#             raise "APPLICATION_PATH is undefinded"
+#           else
+#             @templates_dir = File.join(APPLICATION_PATH, "dynamic", "templates", "session_widget")
+#           end
+#         end
+#       end
+#       setup_actions
+#     end
+
+#     def setup_actions
+#     end
+
+#     def render(method, url_pattern_suffix, template, layout = nil)
+#       Ruil::Resource.new(method, "#{@url_pattern_prefix}/#{url_pattern_suffix}", layout) do |resource|
+#         Dir[File.join(@templates_dir, "#{template}.*.*.*")].each do |file|
+#           resource << Ruil::Template.new(file, layout) if /\.(html|xhtml|css|js)$/ === file
+#         end
+#         if block_given?
+#           resource.content_generator = Proc.new { |e| yield e }
+#         end
+#       end
+#     end
+
+#     def redirect(request_methods, url_pattern_suffix, redirect_to)
+#       Ruil::Register << Ruil::Redirector.new(request_methods, redirect_to) do |env|
+#         yield env if block_given?
+#       end
+#     end
+#   end
+
+# end

data/lib/ruil.rb

@@ -0,0 +1,5 @@
+require 'rack'
+
+Dir[File.dirname(File.expand_path(__FILE__)) + '/**/*.rb'].each do |f|
+  require f
+end

data/rakefile

@@ -1,16 +1,23 @@
+# -*- 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
+task :default => :specs
 
-desc 'Run all tests'
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_files = Dir.glob('test/*_test.rb')
-  t.spec_opts << '--format specdoc'
+desc 'Run all specs'
+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
@@ -20,7 +27,7 @@ begin
     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.summary = "Minimalist library to 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" +
@@ -29,25 +36,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', "Ruil 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 = "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')
+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(/^ruil-/, '').split('.').map{ |x| x.to_i}]
+  }.sort.last
+  puts "gem push #{gem[0]}"
+  system "gem push #{gem[0]}"
 end

data/spec/html_responder_spec.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'ruil'
+require 'json'
+require 'rspec'
+
+describe Ruil::HTMLResponder do
+
+  before(:all) do
+    # Templates
+    Dir.mkdir '/tmp/spec'
+    ['html', 'xhtml'].each do |suffix|
+      file = File.new("/tmp/spec/ruil.desktop.tenjin.#{suffix}", 'w')
+      file << '<p id="' + suffix + '">#{@x}</p>'
+      file.close
+    end
+    # Test a request
+    @test_request = lambda do |responder, path_info, generated_data, content_type, layout|
+      # Defining request
+      request = Ruil::Request.new(Rack::Request.new({'rack.input' => ''}))
+      request.rack_request.path_info = path_info
+      request.generated_data = {:x => generated_data}
+      # Checking response
+      response = responder.call(request)
+      response.status.should == 200
+      suffix = path_info.sub(/^.*\./, '')
+      suffix = 'html' if suffix == path_info
+      response.body.should == ["<p id=\"#{suffix}\">#{generated_data}</p>"]
+      response.header['Content-Type'].should == content_type
+    end
+  end
+
+  after(:all) do
+    Dir['/tmp/spec/*'].each { |f| File.delete f }
+    Dir.delete '/tmp/spec'
+  end
+
+  it 'should respond files without layout' do
+    responder = Ruil::HTMLResponder.new('/tmp/spec/ruil')
+    @test_request.call(responder, '/ruil.html', 'x', 'text/html', nil)
+    @test_request.call(responder, '/ruil', 'x', 'text/html', nil)
+    @test_request.call(responder, '/ruil/', 'x', 'text/html', nil)
+    @test_request.call(responder, '/ruil/#', 'x', 'text/html', nil)
+    @test_request.call(responder, '/ruil.xhtml', 'x', 'application/xhtml+xml', nil)
+  end
+
+  it 'should respond using a html file with layout' do
+    # TODO
+  end
+
+end

data/spec/json_responder_spec.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'ruil'
+require 'json'
+require 'rspec'
+
+describe Ruil::JSONResponder do
+
+  before(:all) do
+    request = Ruil::Request.new(Rack::Request.new({'PATH_INFO' => 'foo.js'}))
+    @data = { :r => (1...10).map { |x| rand } }
+    request.generated_data = @data
+    @response = Ruil::JSONResponder.instance.call(request)
+  end
+
+  it 'should get an OK status' do
+    @response.status.should == 200
+  end
+
+  it 'should get the JSON media type' do
+    @response.header['Content-Type'].should == 'application/json'
+  end
+
+  it 'should render json files' do
+    rendered = JSON.parse(@response.body.join)
+    rendered['r'].each_index do |i|
+      rendered['r'][i].to_s.should == @data[:r][i].to_s
+    end
+  end
+
+end

data/spec/path_info_parser_spec.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'ruil'
+require 'rspec'
+
+describe "Ruil::PathInfoParser" do
+
+  it 'should parse paths' do
+    parser = Ruil::PathInfoParser.new('/foo/:type/:id')
+    (parser === '/foo/bar/1').should    == {:type => 'bar', :id => '1'}
+    (parser === '/foo/bar/3.js').should == {:type => 'bar', :id => '3'}
+    (parser === '/foo').should          == false
+    (parser === '/bar').should          == false
+  end
+
+end

data/spec/redirector_spec.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'ruil'
+require 'rspec'
+
+describe Ruil::Redirector do
+  before(:all) do
+    @url = '/unauthorized_url'
+    rack_request = Rack::Request.new({})
+    rack_request.path_info = @url
+    ruil_request = Ruil::Request.new(rack_request)
+    @response = Ruil::Redirector.new('/login').call(ruil_request)
+  end
+
+  it 'should get an redirection status' do
+    @response.status.should == 302
+  end
+
+  it 'should get the url to be redirected' do
+    @response.header['Location'].should == "/login?redirected_from=" + @url
+  end
+
+end

data/spec/register_spec.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'ruil'
+require 'rspec'
+
+describe Ruil::Register do
+
+  before(:all) do
+    class MockResponse
+      def initialize(value)
+        @value = value
+      end
+      def finish
+        @value
+      end
+    end
+    class MockResource
+      def initialize(value)
+        @value = value
+      end
+      def call(request)
+        request.path_info == @value ? MockResponse.new(@value) : false
+      end
+      def request_methods
+        ['GET']
+      end
+    end
+    (0..9).each do |value|
+      Ruil::Register << MockResource.new(value.to_s)
+    end
+  end
+
+  it 'should get responses for requests' do
+    (1..10).each do
+      value = rand(10).to_s
+      request = Rack::Request.new({
+        'REQUEST_METHOD' => 'GET',
+        'PATH_INFO'      => value
+      })
+      Ruil::Register.call(request).should == value
+    end
+  end
+
+end

data/spec/request_spec.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'ruil'
+require 'rspec'
+
+describe "Ruil::Request" do
+
+  before(:all) do
+    @rack_request = Rack::Request.new({})
+    @ruil_request = Ruil::Request.new(@rack_request)
+  end
+
+  it 'should contain the rack request' do
+    @ruil_request.rack_request.should == @rack_request
+  end
+
+  it 'should allow access to generated data' do
+    @ruil_request.generated_data.should == {}
+    @ruil_request.generated_data[:x] = "y"
+    @ruil_request.generated_data.should == {:x => "y"}
+  end
+
+  it 'should get the default html mode' do
+    @ruil_request.html_mode.should == :desktop
+  end
+
+end

data/spec/resource_spec.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'ruil'
+require 'rspec'
+
+describe Ruil::Resource do
+
+  before(:all) do
+    @resource = Ruil::Resource.new('GET', '/test/:id') do |request|
+      request.generated_data = request.generated_data[:path_info_params]
+    end
+  end
+
+  it 'should get responses for requests' do
+    request = Rack::Request.new({
+      'REQUEST_METHOD'  => 'GET',
+      'HTTP_USER_AGENT' => 'Mobile',
+      'PATH_INFO'       => '/test/12.js'
+    })
+    response = @resource.call(request)
+    response.status.should == 200
+    response.headers["Content-Type"].should == "application/json"
+    response.body.should == ['{"id":"12"}']
+    request = Rack::Request.new({
+      'REQUEST_METHOD'  => 'GET',
+      'HTTP_USER_AGENT' => 'Mobile',
+      'PATH_INFO'       => '/test/12/aaa'
+    })
+    @resource.call(request).should == false
+  end
+
+end

data/spec/static_resource_spec.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'ruil'
+require 'rspec'
+
+describe Ruil::StaticResource do
+
+  before(:all) do
+    @resource = Ruil::StaticResource.new do |resource|
+      Dir.mkdir '/tmp/spec'
+      ['foo', 'bar'].each do |f|
+        file_name = "/tmp/spec/#{f}.html"
+        file = File.new(file_name, 'w')
+        file << f
+        file.close
+        resource.add(file_name, "/#{f}.html", 'text/html')
+      end
+    end
+  end
+
+  after(:all) do
+    Dir['/tmp/spec/*'].each { |f| File.delete f }
+    Dir.delete '/tmp/spec'
+  end
+
+  it 'should respond files without layout' do
+    ['foo', 'bar'].each do |f|
+      request = Rack::Request.new({
+        'REQUEST_METHOD' => 'GET',
+        'PATH_INFO'      => "/#{f}.html"
+      })
+      response = @resource.call(request)
+      response.status.should == 200
+      response.body.should == ["#{f}"]
+      response.header['Content-Type'].should == 'text/html'
+    end
+  end
+
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruil
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - "Daniel Hern\xC3\xA1ndez"
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-26 00:00:00 -04:00
+date: 2011-05-25 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -30,49 +31,69 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- .gitignore
 - README.rdoc
 - VERSION
-- lib/ruil/delegator.rb
+- lib/ruil.rb
+- lib/ruil/html_responder.rb
+- lib/ruil/json_responder.rb
+- lib/ruil/mongo_resource.rb
+- lib/ruil/path_info_parser.rb
+- lib/ruil/redirector.rb
+- lib/ruil/register.rb
+- lib/ruil/request.rb
 - lib/ruil/resource.rb
-- lib/ruil/tenjin_template.rb
+- lib/ruil/session_widget.rb
+- lib/ruil/static_resource.rb
+- lib/ruil/widget.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
+- spec/html_responder_spec.rb
+- spec/json_responder_spec.rb
+- spec/path_info_parser_spec.rb
+- spec/redirector_spec.rb
+- spec/register_spec.rb
+- spec/request_spec.rb
+- spec/resource_spec.rb
+- spec/static_resource_spec.rb
 has_rdoc: true
 homepage: http://github.com/danielhz/ruil
 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: ruil
-rubygems_version: 1.3.6
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: Basic tools for build web appplications on top of rack
+summary: Minimalist library to build web appplications on top of rack
 test_files: 
-- test/resource_test.rb
-- test/delegator_test.rb
+- spec/html_responder_spec.rb
+- spec/json_responder_spec.rb
+- spec/path_info_parser_spec.rb
+- spec/redirector_spec.rb
+- spec/register_spec.rb
+- spec/request_spec.rb
+- spec/resource_spec.rb
+- spec/static_resource_spec.rb

data/.gitignore

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

data/lib/ruil/delegator.rb

@@ -1,42 +0,0 @@
-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/tenjin_template.rb

@@ -1,20 +0,0 @@
-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