redirect 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.0.1 / 2009-02-08
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+example.rb
+lib/redirect.rb
+spec/helper.rb
+spec/rack_spec.rb

data/README.txt

@@ -0,0 +1,50 @@
+= Redirect
+
+http://github.com/p8/redirect/tree/master
+
+== DESCRIPTION:
+
+Redirect is a simple Ruby redirect DSL build on Rack
+
+== EXAMPLE
+
+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:
+
+(The MIT License)
+
+Copyright (c) 2009 Petrik de Heus
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,16 @@
+# -*- 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  
+end
+# 
+# require 'metric_fu'
+# 
+# MetricFu::Configuration.run do |config|
+#   config.coverage = { :test_files => ['test/**/test_*.rb'] }
+# end

data/example.rb

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

data/lib/redirect.rb

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'rack'
+require 'rack/showexceptions'
+require 'rack/request'
+require 'rack/response'
+
+module Redirect
+  VERSION = '0.0.1'
+  
+  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)
+
+  app = Rack::Redirect.new(*redirects)
+  Rack::Handler::WEBrick.run \
+    Rack::ShowExceptions.new(Rack::Lint.new(app)),
+    :Port => 3000
+  run app
+end
+
+module Rack
+
+  class Redirect
+    attr_reader :redirects
+    def initialize(*redirects)
+      @redirects = redirects.collect do |r|
+        ::Redirect::Data.new(*r)
+      end
+    end
+    
+    def call(env)
+      req = Request.new(env)
+      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
+  
+end

data/spec/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'test/spec'
+require 'mocha'
+
+$:.unshift File.dirname(File.dirname(__FILE__)) + "/lib"
+require 'redirect'

data/spec/rack_spec.rb

@@ -0,0 +1,116 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe "Rack::Redirect" do
+
+  it "should show 404 not found with if no redirect exists" do
+    @app = Rack::Redirect.new()
+    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
+  
+  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('/')
+    res.headers.should == { 'Location' => '/test', 'Content-Type' => 'text/html' }
+    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')
+    res.headers.should == { 'Location' => '/2008-new', 'Content-Type' => 'text/html' }
+    res.body.should == 'Redirecting to: /2008-new'
+  end
+
+  it "should redirect for a regular_expression" do
+    @app = Rack::Redirect.new(['^/old', '/new'])
+    res = Rack::MockRequest.new(@app).get('/old/2008')
+    res.headers.should == { 'Location' => '/new', 'Content-Type' => 'text/html' }
+    res.body.should == 'Redirecting to: /new'
+  end
+
+  it "should allow multiple redirects" do
+    @app = Rack::Redirect.new(['^/old3', '/new'], ['^/old2', '/new2'])
+    res = Rack::MockRequest.new(@app).get('/old2008')
+    res.headers.should == { 'Location' => '/new2', 'Content-Type' => 'text/html' }
+    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

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: redirect
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Petrik de Heus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+    version: 
+description: Redirect is a simple Ruby redirect DSL build on Rack
+email: 
+- FIX@example.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- example.rb
+- lib/redirect.rb
+- spec/helper.rb
+- spec/rack_spec.rb
+has_rdoc: true
+homepage: http://github.com/p8/redirect/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: redirect
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Redirect is a simple Ruby redirect DSL build on Rack
+test_files: []
+