fir 0.0.9 → 0.0.10

data/example/users.yml

@@ -1,5 +1,4 @@
 --- 
 johndoe: 
   salt: b64e9a6e7e2c187a81a30de2d0
-  # Password is "foo"
   crypted_password: f8463d3c8d229f4daec934d23db3b6f1d5b5eedc56a965c6721ed8b697e60a7d4dfe7a9e249eb3fc02d00c9528852b20bda276ff6ec05e972e7f5f338b1aa59e

data/lib/fir/admin.rb

@@ -53,12 +53,14 @@ module Fir
 				if match
 					page = Fir.sanitize_page(match[1])
 					page_path = File.join(FIR_ROOT, 'pages', page)
-					if File.exists?(page_path)
+					if env['REQUEST_METHOD'].downcase == 'post'
+						update_page(page_path, env)
+					elsif File.exists?(page_path)
 						case env['REQUEST_METHOD'].downcase
 						when 'get'
 							retrieve_page(page_path)
-						when 'post'
-							update_page(page_path, env)
+						when 'delete'
+							return method_not_allowed('DELETE not yet implemented')
 						else
 							return method_not_allowed('Only GET and POST are allowed')
 						end
@@ -109,7 +111,7 @@ module Fir
 			if File.readable?(page_path)
 				source = File.read(page_path)
 				directory, filename, ext = Fir.split_path(page_path)
-				filename_with_ext = filename + '.' + ext
+				filename_with_ext = filename + ext
 				[200, {'Content-Type' => 'text/plain', 'Content-Disposition' => "attachment; #{filename_with_ext}"}, source]
 			else
 				internal_server_error('File exists on disk, but is not readable. Are the permissions wrong?')
@@ -117,12 +119,13 @@ module Fir
 		end
 		
 		def update_page(page_path, env)
-			if File.writable?(page_path)
+			if File.writable?(page_path) or (!File.exists?(page_path) and File.writable?(File.dirname(page_path)))
 				File.open(page_path, 'w') do |file|
 					request = ::Rack::Request.new(env)
 					file.write(request.POST['content'])
 				end
-				Fir.clear_cache(page_path)
+				# page_path will be an absolute path at this point, but clear_cache expects it to be relative to the pages directory
+				Fir.clear_cache(page_path.sub(File.join(FIR_ROOT, 'pages'), ''))
 				[200, {'Content-Type' => 'text/plain'}, "#{page_path} has been saved."]
 			else
 				internal_server_error('File exists on disk, but is not writeable. Are the permissions wrong?')

data/lib/fir/generator.rb

@@ -0,0 +1,33 @@
+module Fir
+	def self.generate!(args)
+		::Fir::Generator.new.generate!(args)
+	end
+	
+	class Generator
+		def generate!(args)
+			unless args.length >= 1
+				raise 'Usage: fir path'
+			end
+			
+			fir_root = args.shift
+			
+			if File.exists?(fir_root)
+				raise "#{fir_root} already exists! Aborting."
+			end
+			FileUtils.cp_r FIR_SKELETON_ROOT, fir_root
+			# What's the deal with .htaccess being renamed, you ask? Rubygems doesn't want to include .htaccess
+			# in the package, so we have to distribute it as htaccess and then rename it at the last moment.
+			FileUtils.mv File.join(fir_root, 'public', 'htaccess'), File.join(fir_root, 'public', '.htaccess')
+			puts "Created new Fir site in #{fir_root}"
+			
+			[
+				['--with-dispatch-cgi', 'public/dispatch.cgi'],
+				['--with-htaccess', 'public/.htaccess']
+			].each do |option, file|
+				unless args.include?(option)
+					FileUtils.rm File.join(fir_root, file)
+				end
+			end
+		end
+	end
+end

data/lib/fir/tasks.rb

@@ -8,7 +8,8 @@ module Fir
 					require 'fir'
 					require 'active_support/secure_random'
 					unless (ENV.has_key?('user') or ENV.has_key?('USER')) and (ENV.has_key?('pass') or ENV.has_key?('PASS'))
-						raise 'usage: rake users:add user=username pass=password'
+						puts 'usage: rake users:add user=username pass=password'
+						exit
 					end
 					user = ENV['user'] || ENV['USER']
 					pass = ENV['pass'] || ENV['PASS']
@@ -27,13 +28,20 @@ module Fir
 					end
 				end
 			end
-			desc 'Export the site to static HTML. (For web hosts that can\'t support Rack. But mod_rewrite must be enabled for .htaccess!) ' +
+			desc 'Export the site to static HTML. (For web hosts that don\'t support Rack. Creates an .htaccess file for pretty URLs. mod_rewrite must be enabled!) ' +
 				'Usage: rake export dir=path_to_export_to'
 			task :export do
 				require 'fileutils'
 				
 				if !ENV.has_key?('dir') or ENV['dir'].empty?
-					raise(ArgumentError, 'Usage: rake export dir=path_to_export_to')
+					puts 'Usage: rake export dir=path_to_export_to'
+					exit
+				end
+				
+				copy_to = ENV['dir']
+				unless ENV['force'] or !File.exists?(copy_to) or Dir.entries(copy_to).length == 2
+					puts 'Directory is not empty. Export aborted. Use "rake export dir=path force=1" to override. This will delete everything in the directory!'
+					exit
 				end
 				
 				page_config = YAML.load(File.read(File.join(FIR_ROOT, 'pages.yml')))
@@ -54,7 +62,7 @@ module Fir
 					result
 				end + path_mappings.keys
 				
-				puts 'Iniitalizing Fir site...'
+				puts "Iniitalizing Fir site in #{copy_to}..."
 				
 				Fir.config.force_caching = true
 				require File.expand_path(File.join(FIR_ROOT, 'config.rb'))
@@ -67,10 +75,10 @@ module Fir
 				end
 				
 				copy_from = File.join(FIR_ROOT, 'public', '.')
-				copy_to = ENV['dir']
-				unless File.exists?(copy_to)
-					Dir.mkdir(copy_to)
+				if File.exists?(copy_to)
+					FileUtils.rm_rf(copy_to)
 				end
+				Dir.mkdir(copy_to)
 				FileUtils.cp_r(copy_from, copy_to)
 				FileUtils.cp_r(File.join(copy_to, 'cache', '.'), copy_to)
 				FileUtils.rm_rf(File.join(copy_to, 'cache'))
@@ -91,6 +99,49 @@ module Fir
 					f.write(htaccess)
 				end
 			end
+			
+			desc "Export the site to static HTML and transfer it to the server using rsync and SSH. (For web hosts that don't support Rack. " +
+				"Creates an .htaccess file for pretty URLs. mod_rewrite must be enabled!) " +
+				"Example usage: rake export_to_server dest=username@example.com:/home/username/public_html\n\n" +
+				"Obviously, dest should be set to the correct rsync destination for your deploy environment. " +
+				"Note that dest is NOT a URI, even though it sort of looks like one. It's a destination string in the form that rsync accepts."
+			task :export_to_server do
+				begin
+					ENV['dir'] = '.server_export_tmp'
+					Rake::Task['export'].execute
+					if ENV['dest']
+						dest = ENV['dest']
+					elsif File.exists?(File.join(FIR_ROOT, 'deploy.yml'))
+						yaml = YAML.load(File.read(File.join(FIR_ROOT, 'deploy.yml')))
+						['host', 'user', 'path'].each do |param|
+							unless yaml.has_key?(param)
+								puts "deploy.yml must specify #{param}"
+								exit
+							end
+						end
+						dest = "#{yaml['user']}@#{yaml['host']}:#{yaml['path']}"
+					else
+						puts "Example usage: rake export_to_server dest=username@example.com/home:/username/public_html"
+						exit
+					end
+					Rsyncer.new.run(dest)
+				ensure
+					FileUtils.rm_rf '.server_export_tmp'
+				end
+			end
+		end
+		
+		class Rsyncer
+			def run(dest)
+				run_command("rsync -ave ssh .server_export_tmp/* #{dest}")
+			end
+			
+			private
+			
+			# Stupid indirection to make it testable with should_receive and/or stub. (We don't want to run the real rsync from our test suite.)
+			def run_command(command)
+				system command
+			end
 		end
 	end
 end

data/skeleton/public/dispatch.cgi

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby
+
+# This script is called when running Fir as a CGI, which isn't recommended.
+# Still, here it is, in case you want to try.
+# 
+# This script will not be operational unless the webserver is configured properly.
+# In Apache, you need to enable mod_rewrite in .htaccess files for this directory.
+# That usually means setting AllowOverride to All (http://httpd.apache.org/docs/1.3/mod/core.html#allowoverride).
+# Apache must also be told that CGI is allowed in this directory. This is done with the ExecCGI option
+# (http://httpd.apache.org/docs/1.3/mod/core.html#options).
+# 
+# Learn more about CGI under Apache: http://httpd.apache.org/docs/1.3/howto/cgi.html
+# 
+# You must also set up rewrite rules so the requests get sent to this script.
+# See how it's done in .htaccess in this directory.
+# 
+# Besides the performance issues, CGI has another disadvantage. Apache (and perhaps others) unescapes
+# URLs before sending them to your CGI script. Passenger does not. Fir, being designed for Passenger,
+# unescapes URLs. So, when running Fir as a CGI, all URLs will be escaped twice. This breaks certain URLs.
+# For example:
+#
+#   http://example.com/the%2Bsign
+#
+# ...will break. Apache will unescape the path to "the+sign." Fir will then unescape it again to "the sign."
+
+require 'rubygems'
+require 'fir'
+
+FIR_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+require File.expand_path(File.join(FIR_ROOT, 'config.rb'))
+
+builder = Rack::Builder.new(&Fir.boot_proc)
+
+Rack::Handler::CGI.run builder

data/skeleton/public/htaccess

@@ -0,0 +1,3 @@
+RewriteEngine On
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi/$1 [QSA,L]

data/spec/admin_spec.rb

@@ -0,0 +1,172 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'admin interface' do
+	before :each do
+		load_config
+	end
+	
+	it 'returns 404 for bad URLs' do
+		authorize 'johndoe', 'foo'
+		get '/-admin/doesnt_exist'
+		last_response.should be_not_found
+	end
+	
+	describe 'GET pages' do
+		it 'requires HTTP auth' do
+			get '/-admin/pages'
+			last_response.status.should == 401
+		end
+		
+		it 'does not accept bad user/pass combos' do
+			authorize 'johndoe', 'wrong'
+			get '/-admin/pages'
+			last_response.status.should == 401
+		end
+		
+		it 'returns an XML feed with each directory and page' do
+			require 'test/unit/xml'
+			include Test::Unit::XML
+			authorize 'johndoe', 'foo'
+			get '/-admin/pages'
+			expected =
+				'<?xml version="1.0" encoding="UTF-8"?>
+				<pages>
+				  <page>
+					<name>404.html.erb</name>
+				  </page>
+				  <page>
+					<name>contact-us.markdown</name>
+				  </page>
+				  <page>
+				
+					<name>index.markdown</name>
+				  </page>
+				  <folder>
+					<name>products</name>
+					<pages>
+					  <page>
+						<name>dynamite-plus.html.erb</name>
+				
+					  </page>
+					  <page>
+						<name>dynamite.html.erb</name>
+					  </page>
+					  <page>
+						<name>index.markdown</name>
+					  </page>
+					  <page>
+				
+						<name>mouse-trap.html.erb</name>
+					  </page>
+					</pages>
+				  </folder>
+				</pages>'.gsub(/\s/, '')
+			
+				last_response.body.gsub(/\s/, '').should == expected
+		end
+	end
+	
+	describe 'GET page/pagename' do
+		it 'requires HTTP auth' do
+			get '/-admin/pages/index.markdown'
+			last_response.status.should == 401
+		end
+		
+		it 'does not accept bad user/pass combos' do
+			authorize 'johndoe', 'wrong'
+			get '/-admin/pages/index.markdown'
+			last_response.status.should == 401
+		end
+		
+		context 'with balid login' do
+			before :each do
+				authorize 'johndoe', 'foo'
+				get '/-admin/pages/index.markdown'
+			end
+			
+			it 'returns the source code of the page' do
+				last_response.body.should == File.read(File.join(FIR_ROOT, 'pages', 'index.markdown'))
+			end
+			
+			it 'sets Content-Type to text/plain' do
+				last_response.content_type.should == 'text/plain'
+			end
+			
+			it 'sets Content-Disposition to attachment with the source filename' do
+				last_response.headers['Content-Disposition'].should == 'attachment; index.markdown'
+			end
+			
+			it 'works for pages in sub-directories' do
+				get '/-admin/pages/products/index.markdown'
+				last_response.body.should == File.read(File.join(FIR_ROOT, 'pages', 'products', 'index.markdown'))
+			end
+		end
+	end
+	
+	describe 'POST page/pagename' do
+		it 'requires HTTP auth' do
+			post '/-admin/pages/index.markdown'
+			last_response.status.should == 401
+		end
+		
+		it 'does not accept bad user/pass combos' do
+			authorize 'johndoe', 'wrong'
+			post '/-admin/pages/index.markdown'
+			last_response.status.should == 401
+		end
+		
+		context 'with balid login' do
+			before :each do
+				authorize 'johndoe', 'foo'
+			end
+			
+			it 'creates the page if none exists' do
+				path = File.join(FIR_ROOT, 'pages', 'new-page.markdown')
+				begin
+					post '/-admin/pages/new-page.markdown', 'content' => 'New page content'
+					File.read(path).should == 'New page content'
+				ensure
+					File.delete(path)
+				end
+			end
+			
+			it 'overwrites the page if it exists' do
+				path = File.join(FIR_ROOT, 'pages', 'new-page.markdown')
+				begin
+					File.open(path, 'w') do |file|
+						file.write 'Old page content'
+					end
+					post '/-admin/pages/new-page.markdown', 'content' => 'New page content'
+					File.read(path).should == 'New page content'
+				ensure
+					File.delete(path)
+				end
+			end
+			
+			def assert_cache_cleared_after_post
+				cached_path = File.join(FIR_ROOT, 'public', 'cache', 'cached-page.html')
+				page_path = File.join(FIR_ROOT, 'pages', 'cached-page.markdown')
+				begin
+					File.open(cached_path, 'w') do |file|
+						file.write 'This is a cached page'
+					end
+					post '/-admin/pages/cached-page.markdown', 'content' => 'New page content'
+					File.exists?(cached_path).should be_false
+				ensure
+					File.delete(cached_path) if File.exists?(cached_path)
+					File.delete(page_path) if File.exists?(page_path)
+				end
+			end
+			
+			it 'clears the cache if caching is on' do
+				Fir.config.perform_caching = true
+				assert_cache_cleared_after_post
+			end
+			
+			it "clears the cache even if caching is off (in case it's off temporarily)" do
+				Fir.config.perform_caching = false
+				assert_cache_cleared_after_post
+			end
+		end
+	end
+end

data/spec/fir_spec.rb

@@ -1,71 +1,98 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe 'Fir' do
-	it 'returns static files in the public directory'
+	before :each do
+		load_config
+	end
+	
+	it 'allows access to the home page' do
+		# Basic sanity check
+		get '/'
+		last_response.should contain('Welcome to Acme Company!')
+	end
+	
+	it 'returns static files in the public directory' do
+		get '/static.txt'
+		last_response.should contain('This is static.txt.')
+	end
 	
-	it 'returns static files in subdirectories of the public directory'
+	it 'returns static files in subdirectories of the public directory' do
+		get '/stylesheets/style.css'
+		last_response.should contain('General typography')
+	end
 	
-	it 'does not allow access to files above the pages directory'
+	it 'does not allow access to files above the pages directory' do
+		get '/../pages.yml'
+		last_response.should_not be_ok
+		last_response.should_not include('index')
+	end
 	
-	it 'maps pretty URLs to files in the pages directory'
+	it 'maps pretty URLs to files in the pages directory' do
+		get '/contact-us'
+		last_response.should contain('Contact Us')
+	end
 	
-	it 'maps pretty URLs to files in subdirectories of the pages directory'
+	it 'maps pretty URLs to files in subdirectories of the pages directory' do
+		get '/products/dynamite'
+		last_response.should contain('Dynamite')
+	end
 	
-	it 'returns 404 for bad URLs'
+	it 'returns 404 for bad URLs' do
+		get '/doesnt-exist'
+		last_response.should be_not_found
+		last_response.should contain('Sorry, there is nothing at this address.')
+	end
 	
 	context 'with caching on' do
-		it 'uses the cached page for pages in the root directory'
+		before :each do
+			Fir.config.perform_caching = true
+		end
 		
-		it 'uses the cached page for pages in subdirectories'
+		it 'uses the cached page for pages in the root directory' do
+			with_cache('index', '<p>This is the cached index.</p>') do
+				get '/'
+				last_response.should contain('This is the cached index.')
+			end
+		end
 		
-		it 'writes to the cache when a page is accessed'
-	end
-	
-	describe 'page_config.yml' do
-		it 'can override URL mappings'
+		it 'uses the cached page for pages in subdirectories' do
+			with_cache('products/dynamite', '<p>Dynamite is cached</p>') do
+				get '/products/dynamite'
+				last_response.should contain('Dynamite is cached')
+			end
+		end
 		
-		it 'can specify page titles (if implemented in the layout)'
+		it 'writes to the cache when a page is accessed' do
+			get '/'
+			File.read(File.join(FIR_ROOT, 'public', 'cache', 'index.html')).should contain('Welcome to Acme Company!')
+		end
 		
-		it 'can specify meta descriptions (if implemented in the layout)'
+		it 'creates the cache directory if none exists' do
+			begin
+				cache_path = File.join(FIR_ROOT, 'public', 'cache')
+				FileUtils.rm_rf(cache_path)
+				get '/'
+				File.directory?(cache_path).should be_true
+			ensure
+				File.delete File.join(cache_path, 'index.html')
+			end
+		end
 	end
 	
-	describe 'admin interface' do
-		it 'returns 404 for bad URLs'
-		
-		describe 'GET pages' do
-			it 'requires HTTP auth'
-			
-			it 'does not accept bad user/pass combos'
-			
-			it 'returns an XML feed with each directory and page'
+	describe 'page_config.yml' do
+		it 'can override URL mappings' do
+			get '/products/dynamite%2B'
+			last_response.should contain('Dynamite Plus!')
 		end
 		
-		describe 'GET page/pagename' do
-			it 'requires HTTP auth'
-			
-			it 'does not accept bad user/pass combos'
-			
-			it 'returns the source code of the page'
-			
-			it 'sets Content-Type to text/plain'
-			
-			it 'sets Content-Disposition to attachment'
-			
-			it 'sets Content-Disposition filename to the source filename'
+		it 'can specify page titles (if implemented in the layout)' do
+			get '/products'
+			last_response.should have_selector('title', :content => 'Products')
 		end
 		
-		describe 'POST page/pagename' do
-			it 'requires HTTP auth'
-			
-			it 'does not accept bad user/pass combos'
-			
-			it 'creates the page if none exists'
-			
-			it 'overwrites the page if it exists'
-			
-			it 'clears the cache if caching is on'
-			
-			it "clears the cache even if caching is off (in case it's off temporarily)"
+		it 'can specify meta descriptions (if implemented in the layout)' do
+			get '/products'
+			last_response.should have_selector('meta[content="Acme Company\'s products"]', :name => 'description')
 		end
 	end
 end