utopia 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27fc0800c0d44763978e981de97541dbf2d0d2ef
-  data.tar.gz: 346b6f43e6e056667c8ab6c30b8b185bfb1cdd58
+  metadata.gz: 0fb046791da67c397e853162649620dc2b530d3e
+  data.tar.gz: 390a488937297cec03a267206d4a096d4c74a497
 SHA512:
-  metadata.gz: e9eedc27a561f991f9d3e637371d51770f31eeeb42d4a46a85f4461a2211b8985b5f86af4f3e5da8115ce45f6b13bfdd12fdc2eafc4b0fa9083dac44d1b6f0af
-  data.tar.gz: d9feff14bb7a57d3d0df656537751abe5e1fb9b1608f49e870a8a4e2f17650e80e41be6601b8411395b60b33faa9b980f75d3b3862455e9c77850d2a07886a4c
+  metadata.gz: 9bd0a3820ebe9422484bb3c1bf048c99b7f7d0e9907eb0cdfccf292ecb6c55e8927cbdeacf87f96b4ad759b7047290f7622639438997d2fa53c96ced3fd24e26
+  data.tar.gz: 9cca58be165173f26f72cee8bde2b7b5b1052018c2a1fff7946476228cc09c63eb48e4d51a85da50893e59894b33c504afede627b5cfeb51dd15c466af3b94fa

data/README.md

@@ -79,7 +79,7 @@ Then, Nginx is configured like so:
 Utopia builds on top of Rack with the following middleware:
 
 - `Utopia::Static`: Serve static files efficiently.
-- `Utopia::Redirector`: Redirect URL patterns and status codes.
+- `Utopia::Redirection`: Redirect URL patterns and status codes.
 - `Utopia::Localization`: Non-intrusive localization of resources.
 - `Utopia::Controller`: Dynamic behaviour with recursive execution.
 - `Utopia::Content`: XML-style template engine with powerful tag behaviours.
@@ -89,9 +89,9 @@ Utopia builds on top of Rack with the following middleware:
 
 This middleware serves static files using the `mime-types` library. By default, it works with `Rack::Sendfile` and `Rack::Cache` and supports `ETag` based caching.
 
-### Redirector
+### Redirection
 
-A flexible high level URI rewriting system which includes support for string mappings, regular expressions and status codes (e.g. 404 errors).
+A set of flexible URI rewriting middleware which includes support for string mappings, regular expressions and status codes (e.g. 404 errors).
 
 ### Localization
 

data/lib/utopia.rb

@@ -22,10 +22,9 @@ require_relative 'utopia/version'
 
 require_relative 'utopia/content'
 require_relative 'utopia/controller'
-require_relative 'utopia/exception_handler'
 require_relative 'utopia/localization'
-require_relative 'utopia/mail_exceptions'
-require_relative 'utopia/redirector'
+require_relative 'utopia/exceptions'
+require_relative 'utopia/redirection'
 require_relative 'utopia/static'
 
 require_relative 'utopia/tags/deferred'

data/lib/utopia/exceptions.rb

@@ -0,0 +1,27 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'exceptions/handler'
+require_relative 'exceptions/mailer'
+
+module Utopia
+	module Exceptions
+	end
+end

data/lib/utopia/exceptions/handler.rb

@@ -0,0 +1,99 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Utopia
+	module Exceptions
+		# Catches exceptions and performs an internal redirect.
+		class Handler
+			def initialize(app, location = '/errors/exception')
+				@app = app
+				
+				@location = location
+			end
+			
+			def freeze
+				@location.freeze
+				
+				super
+			end
+			
+			# Generate a very simple fatal error response. This function should be unlikely to fail. Additionally, it generates a lowest common denominator response which should be suitable as a response to any kind of request. Ideally, this response is also not good or useful for any kind of higher level browser or API client, as this is not a normal error path but one that represents broken behaviour.
+			def fatal_error(env, exception)
+				body = StringIO.new
+				
+				write_exception_to_stream(body, env, exception)
+				body.rewind
+				
+				return [500, {HTTP::CONTENT_TYPE => "text/plain"}, body]
+			end
+			
+			def log_exception(env, exception)
+				# An error has occurred, log it:
+				output = env['rack.errors'] || $stderr
+				write_exception_to_stream(output, env, exception, true)
+			end
+			
+			def call(env)
+				begin
+					return @app.call(env)
+				rescue Exception => exception
+					log_exception(env, exception)
+					
+					# If the error occurred while accessing the error handler, we finish with a fatal error:
+					if env[Rack::PATH_INFO] == @location
+						return fatal_error(env, exception)
+					else
+						begin
+							# We do an internal redirection to the error location:
+							error_request = env.merge(Rack::PATH_INFO => @location, Rack::REQUEST_METHOD => Rack::GET)
+							error_response = @app.call(error_request)
+							
+							return [500, error_response[1], error_response[2]]
+						rescue Exception
+							# If redirection fails, we also finish with a fatal error:
+							return fatal_error(env, exception)
+						end
+					end
+				end
+			end
+			
+			private def write_exception_to_stream(stream, env, exception, include_backtrace = false)
+				buffer = []
+				
+				buffer << "While requesting resource #{env[Rack::PATH_INFO].inspect}, a fatal error occurred:"
+				
+				while exception != nil
+					buffer << "\t#{exception.class.name}: #{exception.to_s}"
+					
+					if include_backtrace
+						exception.backtrace.each do |line|
+							buffer << "\t\t#{line}"
+						end
+					end
+					
+					exception = exception.cause
+				end
+				
+				# We do this in one go so that lines don't get mixed up.
+				stream.puts buffer.join("\n")
+			end
+		end
+	end
+end

data/lib/utopia/exceptions/mailer.rb

@@ -0,0 +1,138 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'net/smtp'
+require 'mail'
+
+module Utopia
+	module Exceptions
+		# Catches all exceptions raised from the app it wraps and sends a useful email with the exception, stacktrace, and contents of the environment.
+		class Mailer
+			# A basic local non-authenticated SMTP server.
+			LOCAL_SMTP = [:smtp, {
+				:address => "localhost",
+				:port => 25,
+				:enable_starttls_auto => false
+			}]
+			
+			def initialize(app, config = {})
+				@app = app
+				
+				@to = config[:to] || "postmaster"
+				@from = config.fetch(:from) {(ENV['USER'] || 'rack') + "@localhost"}
+				@subject = config[:subject] || '%{exception} [PID %{pid} : %{cwd}]'
+				@delivery_method = config.fetch(:delivery_method, LOCAL_SMTP)
+				
+				@dump_environment = config.fetch(:dump_environment, false)
+			end
+
+			def call(env)
+				begin
+					return @app.call(env)
+				rescue => exception
+					send_notification exception, env
+					
+					raise
+				end
+			end
+			
+			private
+			
+			REQUEST_KEYS = [:ip, :referrer, :path, :user_agent]
+			
+			def generate_body(exception, env)
+				io = StringIO.new
+				
+				# Dump out useful rack environment variables:
+				request = Rack::Request.new(env)
+				
+				io.puts "#{request.request_method} #{request.url}"
+				
+				io.puts
+				
+				REQUEST_KEYS.each do |key|
+					value = request.send(key)
+					io.puts "request.#{key}: #{value.inspect}"
+				end
+				
+				request.params.each do |key, value|
+					io.puts "request.params.#{key}: #{value.inspect}"
+				end
+				
+				io.puts
+				
+				io.puts "#{exception.class.name}: #{exception.to_s}"
+				
+				if exception.respond_to?(:backtrace)
+					io.puts exception.backtrace
+				else
+					io.puts exception.to_s
+				end
+				
+				return io.string
+			end
+			
+			def generate_mail(exception, env)
+				attributes = {
+					exception: exception.class.name,
+					pid: $$,
+					cwd: Dir.getwd,
+				}
+				
+				mail = Mail.new(
+					:from => @from,
+					:to => @to,
+					:subject => @subject % attributes
+				)
+				
+				mail.text_part = Mail::Part.new
+				mail.text_part.body = generate_body(exception, env)
+			
+				if body = extract_body(env) and body.size > 0
+					mail.attachments['body.bin'] = body
+				end
+				
+				if @dump_environment
+					mail.attachments['environment.yaml'] = YAML::dump(env)
+				end
+
+				return mail
+			end
+
+			def send_notification(exception, env)
+				mail = generate_mail(exception, env)
+				
+				mail.delivery_method(*@delivery_method) if @delivery_method
+				
+				mail.deliver
+			rescue => mail_exception
+				$stderr.puts mail_exception.to_s
+				$stderr.puts mail_exception.backtrace
+			end
+
+			def extract_body(env)
+				if io = env['rack.input']
+					io.rewind if io.respond_to?(:rewind)
+					io.read
+				end
+			end
+		end
+	end
+end

data/lib/utopia/redirection.rb

@@ -0,0 +1,176 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'middleware'
+
+module Utopia
+	module Redirection
+		class RequestFailure < StandardError
+			def initialize(resource_path, resource_status, error_path, error_status)
+				@resource_path = resource_path
+				@resource_status = resource_status
+
+				@error_path = error_path
+				@error_status = error_status
+				
+				super "Requested resource #{@resource_path} resulted in a #{@resource_status} error. Requested error handler #{@error_path} resulted in a #{@error_status} error."
+			end
+		end
+		
+		class Errors
+			# Maps an error code to a given string
+			def initialize(app, codes = {})
+				@codes = codes
+				
+				@app = app
+			end
+			
+			def freeze
+				@codes.freeze
+				
+				super
+			end
+			
+			def call(env)
+				response = @app.call(env)
+				
+				if response[0] >= 400 and location = @codes[response[0]]
+					error_request = env.merge(Rack::PATH_INFO => location, Rack::REQUEST_METHOD => Rack::GET)
+					error_response = @app.call(error_request)
+
+					if error_response[0] >= 400
+						raise RequestFailure.new(env[Rack::PATH_INFO], response[0], location, error_response[0])
+					else
+						# Feed the error code back with the error document:
+						error_response[0] = response[0]
+						return error_response
+					end
+				else
+					return response
+				end
+			end
+		end
+		
+		class FileNotFound < Errors
+			def initialize(uri = '/errors/file-not-found')
+				super(404 => uri)
+			end
+		end
+		
+		# We cache 301 redirects for 24 hours.
+		DEFAULT_MAX_AGE = 3600*24
+		
+		class Redirection
+			def initialize(app, status: 307, max_age: DEFAULT_MAX_AGE)
+				@app = app
+				@status = status
+				@max_age = max_age
+			end
+			
+			def freeze
+				@status.freeze
+				@max_age.freeze
+				
+				super
+			end
+			
+			attr :status
+			attr :max_age
+			
+			def cache_control
+				# http://jacquesmattheij.com/301-redirects-a-dangerous-one-way-street
+				"max-age=#{self.max_age}"
+			end
+			
+			def headers(location)
+				{HTTP::LOCATION => location, HTTP::CACHE_CONTROL => self.cache_control}
+			end
+			
+			def redirect(location)
+				return [self.status, self.headers(location), []]
+			end
+			
+			def [] path
+				false
+			end
+			
+			def call(env)
+				path = env[Rack::PATH_INFO]
+				
+				if redirection = self[path]
+					return redirection
+				end
+				
+				return @app.call(env)
+			end
+		end
+		
+		class DirectoryIndex < Redirection
+			def initialize(app, index = 'index')
+				@app = app
+				@index = 'index'
+				
+				super(app)
+			end
+			
+			def [] path
+				if path.end_with?('/')
+					return redirect(path + @index)
+				end
+			end
+		end
+		
+		class Rewrite < Redirection
+			def initialize(app, patterns, status: 301)
+				@patterns = patterns
+				
+				super(app, status: status)
+			end
+			
+			def [] path
+				if location = @patterns[path]
+					return redirect(location)
+				end
+			end
+		end
+		
+		class Moved < Redirection
+			def initialize(app, pattern, prefix, status: 301, flatten: false)
+				@app = app
+				
+				@pattern = pattern
+				@prefix = prefix
+				@flatten = flatten
+				
+				super(app, status: status)
+			end
+			
+			def [] path
+				if path.start_with?(@pattern)
+					if @flatten
+						return redirect(@prefix)
+					else
+						return redirect(path.sub(@pattern, @prefix))
+					end
+				end
+			end
+		end
+	end
+end

data/lib/utopia/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Utopia
-	VERSION = "1.3.2"
+	VERSION = "1.4.0"
 end

data/setup/site/config.ru

@@ -14,10 +14,11 @@ require 'utopia'
 require 'rack/cache'
 
 if RACK_ENV == :production
-	use Utopia::ExceptionHandler, "/errors/exception"
-	use Utopia::MailExceptions
+	use Utopia::Exceptions::Handler
+	use Utopia::Exceptions::Mailer
 elsif RACK_ENV == :development
 	use Rack::ShowExceptions
+	use Utopia::Static, root: 'public'
 end
 
 use Rack::Sendfile
@@ -31,16 +32,13 @@ end
 
 use Rack::ContentLength
 
-use Utopia::Redirector,
-	patterns: [
-		Utopia::Redirector::DIRECTORY_INDEX
-	],
-	strings: {
-		'/' => '/welcome/index',
-	},
-	errors: {
-		404 => "/errors/file-not-found"
-	}
+use Utopia::Redirection::Rewrite,
+	'/' => '/welcome/index'
+
+use Utopia::Redirection::DirectoryIndex
+
+use Utopia::Redirection::Errors,
+	404 => '/errors/file-not-found'
 
 use Utopia::Localization,
 	:default_locale => 'en',
@@ -52,6 +50,12 @@ use Utopia::Controller,
 
 use Utopia::Static
 
+if RACK_ENV != :production
+	# Serve static files from public/ when not running in a production environment:
+	use Utopia::Static, root: 'public'
+end
+
+# Serve dynamic content
 use Utopia::Content,
 	cache_templates: (RACK_ENV == :production),
 	tags: {

data/setup/site/public/_static/utopia.svg

@@ -0,0 +1 @@
+<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg width="100%" height="100%" viewBox="0 0 420 80" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421;"><g><rect x="0" y="0" width="420" height="56" style="fill:#f79433;"/><rect x="0" y="56" width="420" height="24" style="fill:#4e8dd8;"/><g><path d="M75.145,70.819c2.37,-3.097 4.173,-6.921 5.111,-11.365c0.91,-4.318 1.498,-9.261 1.498,-14.692l0,-44.762l-62.754,0l0,44.762c0,2.628 0.244,5.333 0.407,8.035c0.168,2.782 0.674,5.515 1.345,8.118c0.68,2.644 1.739,5.173 3.067,7.517c1.363,2.405 3.263,4.526 5.609,6.303c2.319,1.755 5.245,3.163 8.677,4.172c1.617,0.478 3.416,1.093 5.354,1.093l13.856,0c3.071,0 5.797,-1.058 8.131,-2.001c4.042,-1.631 7.305,-4.049 9.699,-7.18Z" style="fill:#fff;fill-rule:nonzero;"/><path d="M151.481,18.701l0,-18.701l-62.754,-0.022l0,18.723l22.246,0l0.02,61.299l17.93,0l-0.02,-61.299l22.578,0Z" style="fill:#fff;fill-rule:nonzero;"/><path d="M229.926,39.999c0,-22.051 -16.979,-39.992 -37.852,-39.992c-20.872,0 -37.851,17.942 -37.851,39.992c0,22.054 16.979,39.994 37.851,39.994c20.873,0 37.852,-17.94 37.852,-39.994Z" style="fill:#fff;fill-rule:nonzero;"/><path d="M269.238,50.909c9.717,0 17.181,-2.066 22.183,-6.395c5.087,-4.399 7.667,-10.942 7.667,-19.575c0,-3.257 -0.393,-5.962 -1.167,-8.476c-0.778,-2.528 -1.883,-4.934 -3.281,-6.814c-1.401,-1.882 -3.098,-3.458 -5.045,-4.703c-1.895,-1.21 -4.003,-2.198 -6.264,-2.943c-2.239,-0.737 -4.64,-1.263 -7.139,-1.56c-2.464,-0.292 -5.016,-0.443 -7.587,-0.443l-29.468,0l0,80l17.93,0l0,-29.091l12.171,0Z" style="fill:#fff;fill-rule:nonzero;"/><rect x="304.879" y="0" width="17.93" height="80" style="fill:#fff;"/><path d="M362.589,0l-29.477,80l75.888,0l-31.247,-80l-15.164,0Z" style="fill:#fff;fill-rule:nonzero;"/></g></g></svg>

data/setup/site/public/readme.txt

@@ -1 +1 @@
-This directory is required by Apache/Phusion Passenger.
+This directory is required by Apache/Phusion Passenger and contains static assets that are typically served using sendfile.

data/spec/utopia/{exception_handler_spec.rb → exceptions/handler_spec.rb}

@@ -20,33 +20,25 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'rack/mock'
-require 'rack/test'
+require_relative '../rack_helper'
+require 'utopia/exceptions'
 
-require 'utopia/controller'
-require 'utopia/exception_handler'
-
-module Utopia::ExceptionHandlerSpec
-	describe Utopia::ExceptionHandler do
-		include Rack::Test::Methods
-		
-		let(:app) {Rack::Builder.parse_file(File.expand_path('exception_handler_spec.ru', __dir__)).first}
+RSpec.describe Utopia::Exceptions::Handler do
+	include_context "rack app", File.expand_path("handler_spec.ru", __dir__)
+	
+	it "should successfully call the controller method" do
+		# This request will raise an exception, and then redirect to the /exception url which will fail again, and cause a fatal error.
+		get "/blow?fatal=true"
 		
-		it "should successfully call the controller method" do
-			# This request will raise an exception, and then redirect to the /exception url which will fail again, and cause a fatal error.
-			
-			get "/blow?fatal=true"
-			
-			expect(last_response.status).to be == 500
-			expect(last_response.headers['Content-Type']).to be == 'text/plain'
-			expect(last_response.body).to be_include 'fatal error'
-		end
+		expect(last_response.status).to be == 500
+		expect(last_response.headers['Content-Type']).to be == 'text/plain'
+		expect(last_response.body).to be_include 'fatal error'
+	end
+	
+	it "should fail with a 500 error" do
+		get "/blow"
 		
-		it "should fail with a 500 error" do
-			get "/blow"
-			
-			expect(last_response.status).to be == 500
-			expect(last_response.body).to be_include 'Error Will Robertson'
-		end
+		expect(last_response.status).to be == 500
+		expect(last_response.body).to be_include 'Error Will Robertson'
 	end
 end

data/spec/utopia/exceptions/handler_spec.ru

@@ -0,0 +1,6 @@
+
+use Utopia::Exceptions::Handler, '/exception'
+
+use Utopia::Controller, root: File.expand_path('handler_spec', __dir__)
+
+run lambda {|env| [404, {}, []]}

data/spec/utopia/{redirector_spec.rb → redirection_spec.rb}

@@ -19,10 +19,18 @@
 # THE SOFTWARE.
 
 require_relative 'rack_helper'
-require 'utopia/redirector'
+require 'utopia/redirection'
 
-RSpec.describe Utopia::Redirector do
-	include_context "rack app", "redirector_spec.ru"
+RSpec.describe Utopia::Redirection do
+	include_context "rack app", "redirection_spec.ru"
+	
+	it "should redirect directory to index" do
+		get "/welcome/"
+		
+		expect(last_response.status).to be == 307
+		expect(last_response.headers['Location']).to be == '/welcome/index'
+		expect(last_response.headers['Cache-Control']).to include("max-age=86400")
+	end
 	
 	it "should be permanently moved" do
 		get "/a"
@@ -36,7 +44,7 @@ RSpec.describe Utopia::Redirector do
 		get "/"
 		
 		expect(last_response.status).to be == 301
-		expect(last_response.headers['Location']).to be == '/c'
+		expect(last_response.headers['Location']).to be == '/welcome/index'
 		expect(last_response.headers['Cache-Control']).to include("max-age=86400")
 	end
 	
@@ -48,6 +56,20 @@ RSpec.describe Utopia::Redirector do
 	end
 	
 	it "should blow up if internal error redirect also fails" do
-		expect{get "/teapot"}.to raise_error Utopia::FailedRequestError
+		expect{get "/teapot"}.to raise_error Utopia::Redirection::RequestFailure
+	end
+	
+	it "should redirect deep url to top" do
+		get "/hierarchy/a/b/c/d/e"
+		
+		expect(last_response.status).to be == 301
+		expect(last_response.headers['Location']).to be == '/hierarchy'
+	end
+	
+	it "should get a weird status" do
+		get "/weird"
+		
+		expect(last_response.status).to be == 333
+		expect(last_response.headers['Location']).to be == '/status'
 	end
 end

data/spec/utopia/redirection_spec.ru

@@ -0,0 +1,25 @@
+
+use Utopia::Redirection::Rewrite, "/" => "/welcome/index"
+
+use Utopia::Redirection::DirectoryIndex
+
+use Utopia::Redirection::Errors,
+	404 => '/error',
+	418 => '/teapot'
+
+use Utopia::Redirection::Moved, "/a", "/b"
+use Utopia::Redirection::Moved, "/hierarchy/", "/hierarchy", flatten: true
+use Utopia::Redirection::Moved, "/weird", "/status", status: 333
+
+def error_handler(env)
+	request = Rack::Request.new(env)
+	if request.path_info == "/error"
+		[200, {}, ["File not found :("]]
+	elsif request.path_info == "/teapot"
+		[418, {}, ["I'm a teapot!"]]
+	else
+		[404, {}, []]
+	end
+end
+
+run self.method(:error_handler)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -199,7 +199,9 @@ files:
 - lib/utopia/controller/respond.rb
 - lib/utopia/controller/rewrite.rb
 - lib/utopia/controller/variables.rb
-- lib/utopia/exception_handler.rb
+- lib/utopia/exceptions.rb
+- lib/utopia/exceptions/handler.rb
+- lib/utopia/exceptions/mailer.rb
 - lib/utopia/extensions/array.rb
 - lib/utopia/extensions/date.rb
 - lib/utopia/extensions/rack.rb
@@ -210,7 +212,7 @@ files:
 - lib/utopia/middleware.rb
 - lib/utopia/path.rb
 - lib/utopia/path/matcher.rb
-- lib/utopia/redirector.rb
+- lib/utopia/redirection.rb
 - lib/utopia/session.rb
 - lib/utopia/session/encrypted_cookie.rb
 - lib/utopia/session/lazy_hash.rb
@@ -234,16 +236,14 @@ files:
 - setup/site/lib/readme.txt
 - setup/site/pages/_heading.xnode
 - setup/site/pages/_page.xnode
-- setup/site/pages/_static/icon.png
-- setup/site/pages/_static/site.css
-- setup/site/pages/_static/utopia-background.svg
-- setup/site/pages/_static/utopia.svg
-- setup/site/pages/errors/controller.rb
 - setup/site/pages/errors/exception.xnode
 - setup/site/pages/errors/file-not-found.xnode
 - setup/site/pages/links.yaml
 - setup/site/pages/welcome/index.xnode
-- setup/site/public/_static
+- setup/site/public/_static/icon.png
+- setup/site/public/_static/site.css
+- setup/site/public/_static/utopia-background.svg
+- setup/site/public/_static/utopia.svg
 - setup/site/public/readme.txt
 - setup/site/tmp/readme.txt
 - spec/utopia/content/link_spec.rb
@@ -291,9 +291,9 @@ files:
 - spec/utopia/controller/rewrite_spec.rb
 - spec/utopia/controller/sequence_spec.rb
 - spec/utopia/controller/variables_spec.rb
-- spec/utopia/exception_handler_spec.rb
-- spec/utopia/exception_handler_spec.ru
-- spec/utopia/exception_handler_spec/controller.rb
+- spec/utopia/exceptions/handler_spec.rb
+- spec/utopia/exceptions/handler_spec.ru
+- spec/utopia/exceptions/handler_spec/controller.rb
 - spec/utopia/extensions_spec.rb
 - spec/utopia/http/status_spec.rb
 - spec/utopia/locale_spec.rb
@@ -316,8 +316,8 @@ files:
 - spec/utopia/path_spec.rb
 - spec/utopia/rack_helper.rb
 - spec/utopia/rack_spec.rb
-- spec/utopia/redirector_spec.rb
-- spec/utopia/redirector_spec.ru
+- spec/utopia/redirection_spec.rb
+- spec/utopia/redirection_spec.ru
 - spec/utopia/session_spec.rb
 - spec/utopia/session_spec.ru
 - spec/utopia/static_spec.rb
@@ -392,9 +392,9 @@ test_files:
 - spec/utopia/controller/rewrite_spec.rb
 - spec/utopia/controller/sequence_spec.rb
 - spec/utopia/controller/variables_spec.rb
-- spec/utopia/exception_handler_spec.rb
-- spec/utopia/exception_handler_spec.ru
-- spec/utopia/exception_handler_spec/controller.rb
+- spec/utopia/exceptions/handler_spec.rb
+- spec/utopia/exceptions/handler_spec.ru
+- spec/utopia/exceptions/handler_spec/controller.rb
 - spec/utopia/extensions_spec.rb
 - spec/utopia/http/status_spec.rb
 - spec/utopia/locale_spec.rb
@@ -417,8 +417,8 @@ test_files:
 - spec/utopia/path_spec.rb
 - spec/utopia/rack_helper.rb
 - spec/utopia/rack_spec.rb
-- spec/utopia/redirector_spec.rb
-- spec/utopia/redirector_spec.ru
+- spec/utopia/redirection_spec.rb
+- spec/utopia/redirection_spec.ru
 - spec/utopia/session_spec.rb
 - spec/utopia/session_spec.ru
 - spec/utopia/static_spec.rb

data/lib/utopia/exception_handler.rb

@@ -1,104 +0,0 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
-
-require_relative 'middleware'
-
-require 'trenni/strings'
-
-module Utopia
-	class ExceptionHandler
-		def initialize(app, location)
-			@app = app
-			
-			@location = location
-			
-			self.freeze
-		end
-
-		def freeze
-			@location.freeze
-			
-			super
-		end
-		
-		private def write_exception_to_stream(stream, env, exception, include_backtrace = false)
-			buffer = []
-			
-			buffer << "While requesting resource #{env[Rack::PATH_INFO].inspect}, a fatal error occurred:"
-			
-			while exception != nil
-				buffer << "\t#{exception.class.name}: #{exception.to_s}"
-				
-				if include_backtrace
-					exception.backtrace.each do |line|
-						buffer << "\t\t#{line}"
-					end
-				end
-				
-				exception = exception.cause
-			end
-			
-			# We do this in one go so that lines don't get mixed up.
-			stream.puts buffer.join("\n")
-		end
-		
-		# Generate a very simple fatal error response. This function should be unlikely to fail. Additionally, it generates a lowest common denominator response which should be suitable as a response to any kind of request. Ideally, this response is also not good or useful for any kind of higher level browser or API client, as this is not a normal error path but one that represents broken behaviour.
-		def fatal_error(env, exception)
-			body = StringIO.new
-			
-			write_exception_to_stream(body, env, exception)
-			body.rewind
-			
-			return [500, {HTTP::CONTENT_TYPE => "text/plain"}, body]
-		end
-		
-		def log_exception(env, exception)
-			# An error has occurred, log it:
-			output = env['rack.errors'] || $stderr
-			write_exception_to_stream(output, env, exception, true)
-		end
-		
-		def redirect(env, exception)
-			response = @app.call(env.merge(Rack::PATH_INFO => @location, Rack::REQUEST_METHOD => Rack::GET))
-			
-			return [500, response[1], response[2]]
-		end
-		
-		def call(env)
-			begin
-				return @app.call(env)
-			rescue Exception => exception
-				log_exception(env, exception)
-				
-				# If the error occurred while accessing the error handler, we finish with a fatal error:
-				if env[Rack::PATH_INFO] == @location
-					return fatal_error(env, exception)
-				else
-					# If redirection fails, we also finish with a fatal error:
-					begin
-						return redirect(env, exception)
-					rescue
-						return fatal_error(env, exception)
-					end
-				end
-			end
-		end
-	end
-end

data/lib/utopia/redirector.rb

@@ -1,164 +0,0 @@
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
-
-require_relative 'middleware'
-
-module Utopia
-	class FailedRequestError < StandardError
-		def initialize(resource_path, resource_status, error_path, error_status)
-			@resource_path = resource_path
-			@resource_status = resource_status
-
-			@error_path = error_path
-			@error_status = error_status
-		end
-
-		def to_s
-			"Requested resource #{@resource_path} resulted in a #{@resource_status} error. Requested error handler #{@error_path} resulted in a #{@error_status} error."
-		end
-	end
-
-	class Redirector
-		# This redirects directories to the directory + 'index' 
-		DIRECTORY_INDEX = [/^(.*)\/$/, lambda{|prefix| [307, {HTTP::LOCATION => "#{prefix}index"}, []]}].freeze
-		
-		# Redirects a whole source tree to a destination tree, given by the roots.
-		def self.moved(source_root, destination_root, max_age = 3600*24)
-			return [/^#{Regexp.escape(source_root)}(.*)$/, lambda{|match| destination_root + match[1]}]
-		end
-		
-		def self.starts_with(source_root, destination_uri)
-			return [/^#{Regexp.escape(source_root)}/, destination_uri]
-		end
-		
-		private
-		
-		def normalize_strings(strings)
-			normalized = {}
-			
-			strings.each_pair do |key, value|
-				if Array === key
-					key.each { |s| normalized[s] = value }
-				else
-					normalized[key] = value
-				end
-			end
-			
-			return normalized
-		end
-
-		def normalize_patterns(patterns)
-			normalized = []
-			
-			patterns.each do |pattern|
-				*keys, uri = *pattern
-				
-				keys.each do |key|
-					normalized.push([key, uri])
-				end
-			end
-			
-			return normalized
-		end
-
-		public
-		
-		def initialize(app, **options)
-			@app = app
-
-			@strings = options[:strings] || {}
-			@patterns = options[:patterns] || []
-
-			@patterns.collect! do |rule|
-				if Symbol === rule[0]
-					self.class.send(*rule)
-				else
-					rule
-				end
-			end
-
-			@strings = normalize_strings(@strings)
-			@patterns = normalize_patterns(@patterns)
-
-			@errors = options[:errors]
-			
-			self.freeze
-		end
-
-		def freeze
-			@strings.freeze
-			@patterns.freeze
-			@errors.freeze
-			
-			super
-		end
-		
-		def cache_control(max_age)
-			# http://jacquesmattheij.com/301-redirects-a-dangerous-one-way-street
-			"max-age=#{max_age}"
-		end
-		
-		# We cache 301 redirects for 24 hours.
-		DEFAULT_MAX_AGE = 3600*24
-		
-		def redirect(uri, match_data, status: 301, max_age: DEFAULT_MAX_AGE)
-			cache_control = self.cache_control(max_age)
-			
-			if uri.respond_to? :call
-				uri = uri.call(match_data)
-			end
-			
-			return [status, {HTTP::LOCATION => uri.to_s, HTTP::CACHE_CONTROL => cache_control}, []]
-		end
-
-		def call(env)
-			base_path = env[Rack::PATH_INFO]
-
-			if uri = @strings[base_path]
-				return redirect(@strings[base_path], base_path)
-			end
-
-			@patterns.each do |pattern, uri|
-				if match_data = pattern.match(base_path)
-					result = redirect(uri, match_data)
-
-					return result if result != nil
-				end
-			end
-
-			response = @app.call(env)
-
-			if @errors && response[0] >= 400 && uri = @errors[response[0]]
-				error_request = env.merge(Rack::PATH_INFO => uri, Rack::REQUEST_METHOD => Rack::GET)
-				error_response = @app.call(error_request)
-
-				if error_response[0] >= 400
-					raise FailedRequestError.new(env[Rack::PATH_INFO], response[0], uri, error_response[0])
-				else
-					# Feed the error code back with the error document
-					error_response[0] = response[0]
-					return error_response
-				end
-			else
-				return response
-			end
-		end
-	end
-end

data/setup/site/pages/_static/utopia.svg

@@ -1 +0,0 @@
-../../../../materials/utopia.svg

data/setup/site/pages/errors/controller.rb

@@ -1,9 +0,0 @@
-
-prepend Respond
-
-respond.with_json
-respond.otherwise_passthrough
-
-on 'file-not-found' do
-	fail! 404, {message: 'File not found'}
-end

data/setup/site/public/_static

@@ -1 +0,0 @@
-../pages/_static

data/spec/utopia/exception_handler_spec.ru

@@ -1,6 +0,0 @@
-
-use Utopia::ExceptionHandler, '/exception'
-
-use Utopia::Controller, root: File.expand_path('exception_handler_spec', __dir__)
-
-run lambda {|env| [404, {}, []]}

data/spec/utopia/redirector_spec.ru

@@ -1,26 +0,0 @@
-
-use Utopia::Redirector,
-	patterns: [
-		Utopia::Redirector::DIRECTORY_INDEX,
-		[:moved, "/a", "/b"],
-	],
-	strings: {
-		'/' => '/c',
-	},
-	errors: {
-		404 => "/error",
-		418 => "/teapot",
-	}
-
-def error_handler(env)
-	request = Rack::Request.new(env)
-	if request.path_info == "/error"
-		[200, {}, ["File not found :("]]
-	elsif request.path_info == "/teapot"
-		[418, {}, ["I'm a teapot!"]]
-	else
-		[404, {}, []]
-	end
-end
-
-run self.method(:error_handler)