p8-redirect 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.0.2 / 2009-02-21
+
+* 1 major enhancement
+
+  * Only require Hoe if installed
+  
 === 0.0.1 / 2009-02-08
 
 * 1 major enhancement

data/README.txt

@@ -4,11 +4,25 @@ http://github.com/p8/redirect/tree/master
 
 == DESCRIPTION:
 
-Redirect is a ruby redirect server build on Rack
+Redirect is a simple Ruby redirect DSL build on Rack
 
 == EXAMPLE
 
-% ruby example.rb
+Create a file and pass an array to the redirect method:
+
+  require 'redirect'
+  redirect  ['/catch_url', '/redirect_url'],
+            ['/catch_url2', '/redirect_url2', {:code => 307, :name => 'redirect link'}],  
+            ['^/some_regexp', '/all']
+            
+The catch_url can be a regular expression.
+You can overwrite the default 301 http code in the options.
+
+The default redirect code can be changed:
+  
+  Redirect.default_code = 307
+
+A sitemap.xml is generated for all redirects that have a name.
 
 == LICENSE:
 

data/Rakefile

@@ -1,12 +1,14 @@
 # -*- ruby -*-
 
 require 'rubygems'
-require 'hoe'
 require 'lib/redirect.rb'
 
-Hoe.new('redirect', Redirect::VERSION) do |p|
-  p.developer('Petrik de Heus', 'FIX@example.com')
-  p.remote_rdoc_dir = '' # Release to root  
+require 'hoe' rescue nil
+if defined? Hoe
+  Hoe.new('redirect', Redirect::VERSION) do |p|
+    p.developer('Petrik de Heus', 'FIX@example.com')
+    p.remote_rdoc_dir = '' # Release to root  
+  end
 end
 # 
 # require 'metric_fu'

data/example.rb

@@ -1,3 +1,4 @@
 require 'lib/redirect'
 
-redirect(['/old_url', '/new_url'], ['^/some_regexp', '/all'])
+redirect  ['/old_url', '/new_url', {:code => 307, :name => 'test'}],
+          ['^/some_regexp', '/all']

data/lib/redirect.rb

@@ -5,7 +5,26 @@ require 'rack/request'
 require 'rack/response'
 
 module Redirect
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
+  
+  class Data
+    attr_reader :catch_url, :redirect_url, :code, :name
+    def initialize(catch_url, redirect_url, options = {})
+      @catch_url = catch_url
+      @redirect_url = redirect_url
+      @code = options[:code] || Redirect.default_code
+      @name = options[:name]
+    end
+  end
+  
+  def self.default_code= default_code
+    @default_code = default_code
+  end
+  
+  def self.default_code
+    @default_code ||= 301
+  end
+    
 end
 
 def redirect(*redirects)
@@ -20,23 +39,48 @@ end
 module Rack
 
   class Redirect
-          
+    attr_reader :redirects
     def initialize(*redirects)
-      @redirects = redirects
+      @redirects = redirects.collect do |r|
+        ::Redirect::Data.new(*r)
+      end
     end
     
     def call(env)
       req = Request.new(env)
-      @redirects.each do |pair|
-        key, redirect_url = pair
-        if req.fullpath.match(key)
-          puts "Match found for #{key}."
-          puts "Redirecting to #{redirect_url}"
-          return [301, {"Location" => redirect_url, "Content-Type" => "text/html"}, "Redirecting to: #{redirect_url}"]
+      if req.fullpath == '/sitemap.xml'
+        return [200, {"Content-Type" => "text/xml"}, sitemap(req.host)]
+      end
+      if req.fullpath == '/' && index
+        return [200, {"Content-Type" => "text/html"}, index]
+      end      
+      @redirects.each do |r|
+        if req.fullpath.match(r.catch_url)
+          puts "Match found for #{r.catch_url}."
+          puts "Redirecting to #{r.redirect_url}"
+          return [r.code, {"Location" => r.redirect_url, "Content-Type" => "text/html"}, "Redirecting to: #{r.redirect_url}"]
         end
       end
       [404, {"Content-Type" => "text/html"}, "not found"]
     end
+   
+    def sitemap(host)
+      %(<?xml version="1.0" encoding="UTF-8"?>\n) +
+      %(<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n) +
+      @redirects.select{|r| r.name }.collect { |r|
+        %(<url>\n) +
+          %(<loc>http://#{host}#{r.redirect_url}</loc>\n) +
+        %(</url>\n)}.join +
+      %(</urlset>\n)
+    end
+    
+    def index
+      @index
+    end
+    
+    def index= index
+      @index = index
+    end
     
   end
   

data/spec/rack_spec.rb

@@ -11,6 +11,15 @@ describe "Rack::Redirect" do
     res.body.should == "not found"
   end
   
+  it "should show index if no redirect exists but index does" do
+    @app = Rack::Redirect.new()
+    @app.index = "index"
+    res = Rack::MockRequest.new(@app).get("/")
+    # res.not_found?.should be_true
+    res["Content-Type"].should == "text/html"
+    res.body.should == "index"
+  end  
+  
   it "should redirect '/' if redirect exists" do
     @app = Rack::Redirect.new(['/', '/test'])
     res = Rack::MockRequest.new(@app).get('/')
@@ -18,6 +27,29 @@ describe "Rack::Redirect" do
     res.body.should == 'Redirecting to: /test'
   end  
   
+  it "should show sitemap.xml" do
+    @app = Rack::Redirect.new(['/', '/test', {:name => 'test'}])
+    res = Rack::MockRequest.new(@app).get('/sitemap.xml')
+    res.headers.should == {'Content-Type' => 'text/xml' }
+    res.body.should == %(<?xml version="1.0" encoding="UTF-8"?>\n) +
+    %(<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n) +
+    %(<url>\n) +
+      %(<loc>http://example.org/test</loc>\n) +
+      %(</url>\n) +
+    %(</urlset>\n)
+  end
+  
+  it "should show sitemap.xml only for named redirects" do
+    @app = Rack::Redirect.new(['/', '/test', {:name => 'test'}], ['/a', '/hidden'])
+    res = Rack::MockRequest.new(@app).get('/sitemap.xml')
+    res.body.should == %(<?xml version="1.0" encoding="UTF-8"?>\n) +
+    %(<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n) +
+    %(<url>\n) +
+      %(<loc>http://example.org/test</loc>\n) +
+      %(</url>\n) +
+    %(</urlset>\n)
+  end  
+  
   it "should redirect if redirect exists" do
     @app = Rack::Redirect.new(['/old/2008', '/2008-new'])
     res = Rack::MockRequest.new(@app).get('/old/2008')
@@ -39,4 +71,46 @@ describe "Rack::Redirect" do
     res.body.should == 'Redirecting to: /new2'
   end
 
+  it "should turn redirects array into Redirect Objects" do
+    @app = Rack::Redirect.new(['^/old3', '/new', {:code => 307}], ['^/old2', '/new2', {:name => 'test'}])
+    res = Rack::MockRequest.new(@app).get("/test")
+
+    res.not_found?.should be_true
+    res["Content-Type"].should == "text/html"
+    res.body.should == "not found"
+  end
+
+end
+
+describe "Redirect::Data" do
+  it "should turn an array into an Object" do
+    data = Redirect::Data.new('^/old3', '/new', {:code => 307, :name => 'test'})
+    data.catch_url.should == '^/old3'
+    data.redirect_url.should == '/new'
+    data.code.should == 307    
+    data.name.should == 'test'
+  end
+  
+  it "should turn an dafault array into an Object" do
+    data = Redirect::Data.new('^/old3', '/new')
+    data.catch_url.should == '^/old3'
+    data.redirect_url.should == '/new'
+    data.code.should == 301
+    data.name.should == nil
+  end  
+end
+
+describe "Redirect" do
+  after do
+    Redirect.default_code = 301
+  end
+  
+  it "Should be able to configure the default http code" do
+    data = Redirect::Data.new('/a', '/b')
+    data.code.should == 301    
+    Redirect.default_code = 307
+    data = Redirect::Data.new('/a', '/b')
+    data.code.should == 307
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: p8-redirect
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Petrik de Heus
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-10 00:00:00 -08:00
+date: 2009-02-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -21,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.3
     version: 
-description: Redirect is a ruby redirect server build on Rack
+description: Redirect is a simple Ruby redirect DSL build on Rack
 email: 
 - FIX@example.com
 executables: []
@@ -67,6 +68,6 @@ rubyforge_project: redirect
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Redirect is a ruby redirect server build on Rack
+summary: Redirect is a simple Ruby redirect DSL build on Rack
 test_files: []