utopia 1.7.1 → 1.8.0

data/lib/utopia/controller/respond.rb

@@ -166,7 +166,7 @@ module Utopia
 			end
 			
 			# Rewrite the path before processing the request if possible.
-			def passthrough(request, path)
+			def process!(request, path)
 				if response = super
 					response = self.class.response_for(self, request, path, response)
 					

data/lib/utopia/controller/rewrite.rb

@@ -23,6 +23,12 @@ require_relative '../path/matcher'
 
 module Utopia
 	class Controller
+		# This controller layer rewrites the path before executing controller actions. When the rule matches, the supplied block is executed.
+		# @example
+		# prepend Rewrite
+		# rewrite.extract_prefix id: Integer do
+		#   @user = User.find(@id)
+		# end
 		module Rewrite
 			def self.prepended(base)
 				base.extend(ClassMethods)
@@ -86,6 +92,8 @@ module Utopia
 					@rules = []
 				end
 				
+				attr :rules
+				
 				def extract_prefix(**arguments, &block)
 					@rules << ExtractPrefixRule.new(arguments, block)
 				end
@@ -116,7 +124,7 @@ module Utopia
 			end
 			
 			# Rewrite the path before processing the request if possible.
-			def passthrough(request, path)
+			def process!(request, path)
 				catch_response do
 					self.class.rewrite_request(self, request, path)
 				end || super

data/lib/utopia/controller/variables.rb

@@ -20,6 +20,7 @@
 
 module Utopia
 	class Controller
+		# Provides a stack-based instance variable lookup mechanism. It can flatten a stack of controllers into a single hash.
 		class Variables
 			def initialize
 				@controllers = []

data/lib/utopia/localization.rb

@@ -68,7 +68,8 @@ module Utopia
 			
 			# Locales here are represented as an array of strings, e.g. ['en', 'ja', 'cn', 'de'].
 			unless @default_locales = options[:default_locales] 
-				@default_locales = @all_locales + [nil]
+				# We append nil, i.e. no localization.
+				@default_locales = @all_locales.names + [nil]
 			end
 			
 			if @default_locale = options[:default_locale]
@@ -123,6 +124,8 @@ module Utopia
 			end
 		end
 		
+		HTTP_HOST = 'HTTP_HOST'.freeze
+		
 		def host_preferred_locales(env)
 			http_host = env[Rack::HTTP_HOST]
 			

data/lib/utopia/middleware.rb

@@ -23,8 +23,6 @@ require 'logger'
 require_relative 'http'
 require_relative 'path'
 
-require_relative 'extensions/rack'
-
 module Utopia
 	PAGES_PATH = 'pages'.freeze
 	

data/lib/utopia/path.rb

@@ -133,6 +133,11 @@ module Utopia
 			end
 		end
 		
+		# This constructor takes a string and generates a relative path as efficiently as possible. This is a direct entry point for all controller invocations so it's designed to suit the requirements of that function.
+		def self.from_string(string)
+			self.new(unescape(string).split(SEPARATOR, -1))
+		end
+		
 		def self.create(path)
 			case path
 			when Path
@@ -178,6 +183,10 @@ module Utopia
 			end
 		end
 
+		def to_relative!
+			@components.shift if relative?
+		end
+
 		def to_str
 			if @components == ['']
 				SEPARATOR

data/lib/utopia/path/matcher.rb

@@ -63,7 +63,6 @@ module Utopia
 			end
 			
 			# This is a path prefix matching algorithm. The pattern is an array of String, Symbol, Regexp, or nil. The components is an array of String.
-			# As long as the components match the patterns, 
 			def match(path)
 				components = path.to_a
 				

data/lib/utopia/redirection.rb

@@ -21,6 +21,7 @@
 require_relative 'middleware'
 
 module Utopia
+	# A middleware which assists with redirecting from one path to another.
 	module Redirection
 		class RequestFailure < StandardError
 			def initialize(resource_path, resource_status, error_path, error_status)
@@ -123,9 +124,9 @@ module Utopia
 		end
 		
 		class DirectoryIndex < Redirection
-			def initialize(app, index = 'index')
+			def initialize(app, index: 'index')
 				@app = app
-				@index = 'index'
+				@index = index
 				
 				super(app)
 			end

data/lib/utopia/session.rb

@@ -1,4 +1,4 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 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
@@ -18,8 +18,125 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'openssl'
+require 'digest/sha2'
+
+require_relative 'session/lazy_hash'
+
 module Utopia
-	module Session
+	# Stores all session data client side using a private symmetric encrpytion key.
+	class Session
 		RACK_SESSION = "rack.session".freeze
+		CIPHER_ALGORITHM = "aes-256-cbc"
+		KEY_LENGTH = 32
+		
+		def initialize(app, secret:, **options)
+			@app = app
+			@cookie_name = options.delete(:cookie_name) || (RACK_SESSION + ".encrypted")
+			
+			salt = OpenSSL::Random.random_bytes(16)
+			@key = OpenSSL::PKCS5.pbkdf2_hmac_sha1(secret, salt, 1, KEY_LENGTH)
+			
+			@options = {
+				:domain => nil,
+				:path => "/",
+				:expires_after => nil
+			}.merge(options)
+		end
+
+		def call(env)
+			session_hash = prepare_session(env)
+
+			status, headers, body = @app.call(env)
+
+			if session_hash.changed?
+				commit(session_hash.values, headers)
+			end
+
+			return [status, headers, body]
+		end
+		
+		protected
+		
+		def prepare_session(env)
+			env[RACK_SESSION] = LazyHash.new do
+				self.load_session_values(env)
+			end
+		end
+		
+		# Constructs a valid session for the given request. These fields must match as per the checks performed in `valid_session?`:
+		def build_initial_session(request)
+			{
+				request_ip: request.ip,
+				request_user_agent: request.user_agent,
+			}
+		end
+		
+		# Load session from user supplied cookie. If the data is invalid or otherwise fails validation, `build_iniital_session` is invoked.
+		# @return hash of values.
+		def load_session_values(env)
+			request = Rack::Request.new(env)
+			
+			# Decrypt the data from the user if possible:
+			if data = request.cookies[@cookie_name]
+				if values = decrypt(data) and valid_session?(request, values)
+					return values
+				end
+			end
+			
+			# If we couldn't create a session
+			return build_initial_session(request)
+		end
+		
+		def valid_session?(request, values)
+			if values[:request_ip] != request.ip
+				return false
+			end
+			
+			if values[:request_user_agent] != request.user_agent
+				return false
+			end
+			
+			return true
+		end
+		
+		def commit(values, headers)
+			data = encrypt(values)
+			
+			cookie = {:value => data}
+			
+			cookie[:expires] = Time.now + @options[:expires_after] unless @options[:expires_after].nil?
+			
+			Rack::Utils.set_cookie_header!(headers, @cookie_name, cookie.merge(@options))
+		end
+		
+		def encrypt(hash)
+			c = OpenSSL::Cipher.new(CIPHER_ALGORITHM)
+			c.encrypt
+			
+			# your pass is what is used to encrypt/decrypt
+			c.key = @key
+			c.iv = iv = c.random_iv
+			
+			e = c.update(Marshal.dump(hash))
+			e << c.final
+			
+			return [iv, e].pack("m16m*")
+		end
+		
+		def decrypt(data)
+			iv, e = data.unpack("m16m*")
+			
+			c = OpenSSL::Cipher.new(CIPHER_ALGORITHM)
+			c.decrypt
+			
+			c.key = @key
+			c.iv = iv
+			
+			d = c.update(e)
+			d << c.final
+			
+			return Marshal.load(d)
+		end
 	end
 end

data/lib/utopia/session/lazy_hash.rb

@@ -18,10 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative '../session'
-
 module Utopia
-	module Session
+	class Session
 		# A simple hash table which fetches it's values only when required.
 		class LazyHash
 			def initialize(&block)

data/lib/utopia/setup.rb

@@ -0,0 +1,73 @@
+# 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
+	class Bootstrap
+		def initialize(config_root)
+			@config_root = config_root
+		end
+		
+		def setup
+			setup_encoding
+			
+			setup_environment
+			
+			setup_load_path
+			
+			require_relative '../utopia'
+		end
+		
+		def environment_path
+			File.expand_path('environment.yaml', @config_root)
+		end
+		
+		def setup_encoding
+			# If you don't specify these, it's possible to have issues when encodings mismatch on the server.
+			Encoding.default_external = Encoding::UTF_8
+			Encoding.default_internal = Encoding::UTF_8
+		end
+		
+		def setup_environment
+			if File.exist? environment_path
+				require 'yaml'
+				
+				# Load the YAML environment file:
+				environment = YAML.load_file(environment_path)
+				
+				# Update the process environment:
+				ENV.update(environment)
+			end
+		end
+		
+		def setup_load_path
+			# Allow loading library code from lib directory:
+			$LOAD_PATH << File.expand_path('../lib', @config_root)
+		end
+	end
+	
+	def self.setup(config_root = nil, **options)
+		# We extract the directory of the caller to get the path to $root/config
+		if config_root.nil?
+			config_root = File.dirname(caller[0])
+		end
+		
+		Bootstrap.new(config_root).setup
+	end
+end

data/lib/utopia/static.rb

@@ -27,8 +27,9 @@ require 'digest/sha1'
 require 'mime/types'
 
 module Utopia
-	# Serve static files and include recursive name resolution using @rel@ directory entries.
+	# Serve static files from the specified root directory.
 	class Static
+		# Default mime-types which are common for files served over HTTP:
 		MIME_TYPES = {
 			:xiph => {
 				"ogx" => "application/ogg",
@@ -62,6 +63,7 @@ module Utopia
 			]
 		}
 		
+		# A class to assist with loading mime-type metadata.
 		class MimeTypeLoader
 			def initialize(library)
 				@extensions = {}
@@ -116,7 +118,8 @@ module Utopia
 		end
 		
 		private
-
+		
+		# Represents a local file on disk which can be served directly, or passed upstream to sendfile.
 		class LocalFile
 			def initialize(root, path)
 				@root = root
@@ -216,6 +219,10 @@ module Utopia
 
 		DEFAULT_CACHE_CONTROL = 'public, max-age=3600'.freeze
 
+		# Initialize the middleware with the provided options.
+		# @option options [String] :root The root directory to serve files from.
+		# @option options [Array] :types The mime-types (and file extensions) to recognize/serve.
+		# @option options [String] :cache_control The cache-control header to set.
 		def initialize(app, **options)
 			@app = app
 			@root = (options[:root] || Utopia::default_root).freeze

data/lib/utopia/version.rb

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

data/setup/examples/wiki/controller.rb

@@ -0,0 +1,41 @@
+
+prepend Actions
+
+on '**' do |request, path|
+	@page_path = path.components[0..-2]
+	
+	if @page_path.empty?
+		goto! "welcome/index"
+	end
+	
+	@page_file = File.join(BASE_PATH, @page_path, "content.md")
+	@page_title = Trenni::Strings::to_title @page_path.last
+end
+
+def read_contents
+	if File.exist? @page_file
+		File.read(@page_file)
+	else
+		"This page is empty."
+	end
+end
+
+on '**/edit' do |request, path|
+	puts "Editing..."
+	
+	if request.post?
+		FileUtils.mkdir_p File.dirname(@page_file)
+		File.write(@page_file, request.params['content'])
+		goto! @page_path
+	else
+		@content = read_contents
+	end
+	
+	path.components = ["edit"]
+end
+
+on '**/index' do |request, path|
+	@content = read_contents
+	
+	path.components = ["index"]
+end

data/setup/examples/wiki/edit.xnode

@@ -0,0 +1,15 @@
+<page>
+	<?r response.do_not_cache! ?>
+	
+	<heading>Editing #{self[:page_title].inspect}</heading>
+	<form action="#" method="post">
+		<fieldset>
+			<legend>Page Content</legend>
+			<textarea name="content">#{Strings::to_html self[:content]}</textarea>
+		</fieldset>
+		
+		<fieldset class="footer">
+			<input type="submit" />
+		</fieldset>
+	</form>
+</page>