utopia 2.8.2 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40f8fb67b26f53edba8a76b91c2dddc730127641e918c5f8b9f79b5f20a5275
-  data.tar.gz: 57ff2d40871d3a5b8e76e4ddf25a0aafc2bebe87e11e15469b08419e78e3124e
+  metadata.gz: 05f9ea2c2313177fe0ddab9681776ce465160016ba76ddf961ce32c90613031d
+  data.tar.gz: 24cc21d33830e008f34354bf95eaf52bce0a83bde857ba59a03c3e120e1a84e7
 SHA512:
-  metadata.gz: 0cf61f5628b5bf6e7386059238d14f141f27a2eea1f7b5f2f0204156fba2538caf8f0850ecd13646fe663a3b7b3044790f3744799abfa3ad5bea13ffc4ac8ab9
-  data.tar.gz: 43796a9d6ebde85e159139c4dbdecac570c1c07e1f162c214a092cc3b726781bcae4d4834cf0e22d5327eff58473687cbc869138e0ea4fe055d41af57bbdae36
+  metadata.gz: 076044052516cd4bf26f476e2dbca23fcf5f9e49673b5f169f317d70ae1b6d560e5c2bf4578e8cdcd0ed368fe4eb328e7d1d083269406f67459c4a7f48f37b33
+  data.tar.gz: 07056aba9f2533e1fee4e60f337a2d1cf2b048bca510488c447c1b528ab7d0ee2df37dc8ab32d5d8e4387197eefdc66663efca291d00359134758b158cb73702

data/.travis.yml

@@ -9,13 +9,14 @@ before_install:
 
 matrix:
   include:
-    - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
       env: BENCHMARK=true
     - rvm: 2.6
       env: COVERAGE=BriefSummary,Coveralls
+    - rvm: 2.6
+      os: osx
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: truffleruby

data/README.md

@@ -41,7 +41,7 @@ Create a new site:
 
 ## Usage
 
-There is an excellent documentation wiki included with the source code. Simply clone this repository and `rake documentation:server`. This documentation wiki is editable, so feel free to submit a PR with improvements.
+There is an excellent [documentation wiki](https://ioquatix.github.io/utopia/) included with the source code. Simply clone this repository and `rake documentation:server`. This documentation wiki is editable, so feel free to submit a PR with improvements.
 
 ## Contributing
 

data/documentation/Gemfile

@@ -14,6 +14,7 @@ gem "kramdown-parser-gfm"
 group :development do
 	# For `rake server`:
 	gem "guard-falcon"
+	gem "falcon"
 	
 	# For `rake console`:
 	gem "pry"
@@ -22,8 +23,3 @@ group :development do
 	# For `rspec` testing:
 	gem "rspec"
 end
-
-group :production do
-	# Used for passenger-config to restart server after deployment:
-	gem "passenger"
-end

data/documentation/pages/wiki/server-setup/content.md

@@ -4,7 +4,7 @@ Utopia is designed to make deployment to remote servers easy.
 
 ## Deployment
 
-The preferred method of deployment to a production server is via git. The `utopia` command assists with setup of a remote git repository on the server. It will setup a `git` `post-update` hook which will deploy the site correctly and restart passenger for that site.
+The preferred method of deployment to a production server is via git. The `utopia` command assists with setup of a remote git repository on the server. It will setup a `git` `post-update` hook which will deploy the site correctly and restart the application server for that site.
 
 To setup a server for deployment:
 
@@ -37,31 +37,7 @@ When you run `rake` tasks or spawn a server, the values in `config/environment.y
 
 ## Platform
 
-The best deployment platform for Utopia is Linux. Specifically, [Arch Linux](https://www.archlinux.org/) with the following packages:
-
-- [nginx-mainline-passenger](https://aur.archlinux.org/packages/nginx-mainline-passenger/)
-- [passenger-nginx-module](https://aur.archlinux.org/packages/passenger-nginx-module/)
-
-There have been issues with the official packages and thus these packages were developed and tested with Utopia deployment in mind.
-
-### Sample Nginx Configuration
-
-Create a configuration file for your site, e.g. `/etc/nginx/sites/www.example.com`:
-
-```nginx
-server {
-	listen 80;
-	server_name www.example.com;
-	root /srv/http/www.example.com/public;
-	passenger_enabled on;
-}
-
-server {
-	listen 80;
-	server_name example.com;
-	rewrite ^ http://www.example.com$uri permanent;
-}
-```
+The best deployment platform for Utopia is Linux, using [falcon](https://github.com/socketry/falcon).
 
 ### Sudo Setup
 

data/documentation/pages/wiki/testing/content.md

@@ -1,6 +1,6 @@
 # Testing
 
-Utopia websites include a default set of tests, and associated `rake test` tasks. These specs can test against the actual running website. By default, `simplecov` is included for coverage testing.
+Utopia websites include a default set of tests, and associated `rake test` tasks. These specs can test against the actual running website. By default, [covered](https://github.com/socketry/covered) is included for coverage testing.
 
 ```bash
 $ rake coverage test

data/lib/utopia/content/link.rb

@@ -97,13 +97,13 @@ module Utopia
 			def to_anchor(**options)
 				Trenni::Builder.fragment(options[:builder]) do |builder|
 					if href?
-						a_attributes = {
+						attributes = {
 							:class => options.fetch(:class, 'link'),
 							:href => relative_href(options[:base]),
 							:target => options.fetch(:target, @info[:target])
 						}
 						
-						builder.inline('a', a_attributes) do
+						builder.inline('a', attributes) do
 							builder.text(options[:content] || title)
 						end
 					else

data/lib/utopia/content_length.rb

@@ -36,7 +36,7 @@ module Utopia
 		def call(env)
 			response = @app.call(env)
 			
-			unless response[2].empty? or response[1].include?(Rack::CONTENT_LENGTH)
+			unless response[2]&.empty? or response[1].include?(Rack::CONTENT_LENGTH)
 				if content_length = self.content_length_of(response[2])
 					response[1][Rack::CONTENT_LENGTH] = content_length
 				end

data/lib/utopia/controller/base.rb

@@ -81,7 +81,12 @@ module Utopia
 			def respond!(response)
 				throw :response, response
 			end
-
+			
+			# Respond with the response, but only if it's not nil.
+			def respond?(response)
+				respond!(response) if response
+			end
+			
 			# This will cause the controller middleware to pass on the request.
 			def ignore!
 				throw :response, nil

data/lib/utopia/localization.rb

@@ -180,14 +180,10 @@ module Utopia
 		
 		# Set the Vary: header on the response to indicate that this response should include the header in the cache key.
 		def vary(env, response)
-			headers = response[1]
+			headers = response[1].to_a
 			
 			# This response was based on the Accept-Language header:
-			if headers['Vary']
-				headers['Vary'] += ',Accept-Language'
-			else
-				headers['Vary'] = 'Accept-Language'
-			end
+			headers << ['Vary', 'Accept-Language']
 			
 			# Althought this header is generally not supported, we supply it anyway as it is useful for debugging:
 			if locale = env[CURRENT_LOCALE_KEY]

data/lib/utopia/middleware.rb

@@ -18,8 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'logger'
-
 require_relative 'http'
 require_relative 'path'
 

data/lib/utopia/session.rb

@@ -126,7 +126,7 @@ module Utopia
 				
 				data = encrypt(session_hash.values)
 				
-				commit(data, headers)
+				commit(data, values[:updated_at], headers)
 			end
 		end
 		
@@ -165,20 +165,26 @@ module Utopia
 			if values[:user_agent] != request.user_agent
 				raise PayloadError, "Invalid session because supplied user agent #{request.user_agent.inspect} does not match session user agent #{values[:user_agent].inspect}!"
 			end
+
+			if expires_at = expires(values[:updated_at])
+				if expires_at < Time.now.utc
+					raise PayloadError, "Expired session cookie, user agent submitted a cookie that should have expired at #{expires_at}."
+				end
+			end
 			
 			return true
 		end
 		
-		def expires
+		def expires(updated_at=Time.now.utc)
 			if @expires_after
-				return Time.now.utc + @expires_after
+				return updated_at + @expires_after
 			end
 		end
 		
-		def commit(value, headers)
+		def commit(value, updated_at, headers)
 			cookie = {
 				value: value,
-				expires: expires
+				expires: expires(updated_at)
 			}.merge(@cookie_defaults)
 			
 			Rack::Utils.set_cookie_header!(headers, @cookie_name, cookie)

data/lib/utopia/version.rb

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

data/setup/site/Gemfile

@@ -23,8 +23,3 @@ group :development do
 	gem "rspec"
 	gem "covered"
 end
-
-group :production do
-	# Used for passenger-config to restart server after deployment:
-	gem "passenger"
-end

data/setup/site/falcon.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env -S falcon host
+
+load :rack, :self_signed_tls, :supervisor
+
+rack 'utopia.localhost', :self_signed_tls
+supervisor

data/setup/site/pages/welcome/index.xnode

@@ -23,7 +23,7 @@
 		<div>
 			<i class="fa fa-server"></i>
 			<h2>Batteries included</h2>
-			<p>Utopia includes both a recommended development model and a server deployment model out of the box. This is exposed via the <code>utopia</code> command. We recommend use of <a href="https://www.nginx.com">Nginx</a> and <a href="https://www.phusionpassenger.com">Passenger</a> for server side deployment.</p>
+			<p>Utopia includes both a recommended development model and a server deployment model out of the box. This is exposed via the <code>utopia</code> command. We recommend use of <a href="https://github.com/socketry/falcon">Falcon</a> for server side deployment.</p>
 		</div>
 		
 		<div>

data/setup/site/tasks/deploy.rake

@@ -6,8 +6,7 @@ end
 
 desc 'Restart the application server'
 task :restart do
-	# This task is run after the deployment task above.
-	if passenger_config = `which passenger-config`.chomp!
-		sh(passenger_config, 'restart-app', '--ignore-passenger-not-running', SITE_ROOT.to_s)
+	if falcon = `which falcon`.chomp! and File.exist?("supervisor.ipc")
+		sh(falcon, 'supervisor', 'restart')
 	end
 end

data/setup/site/tasks/development.rake

@@ -1,12 +1,10 @@
 
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:test) do |task|
-	task.rspec_opts = %w{--require simplecov} if ENV['COVERAGE']
-end
+RSpec::Core::RakeTask.new(:test)
 
 task :coverage do
-	ENV['COVERAGE'] = 'y'
+	ENV['COVERAGE'] = 'PartialSummary'
 end
 
 desc 'Start the development server.'

data/setup/site/tasks/environment.rake

@@ -1,6 +1,6 @@
 
 desc 'Set up the environment for running your web application'
-task :environment do |task|
+task :environment => :log do |task|
 	require SITE_ROOT + 'config/environment'
 	
 	# We ensure this is part of the shell environment so if other commands are invoked they will work correctly.
@@ -11,7 +11,7 @@ task :environment do |task|
 	if ENV['UTOPIA_SESSION_SECRET'].nil?
 		require 'securerandom'
 		
-		warn 'Generating transient session key for development...'
+		Utopia.logger.warn 'Generating transient session key for development...'
 		ENV['UTOPIA_SESSION_SECRET'] = SecureRandom.hex(32)
 	end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 
 require 'covered/rspec'
+require 'async/rspec'
 
 RSpec.configure do |config|
 	# Enable flags like --only-failures and --next-failure

data/spec/utopia/controller/websocket_spec.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env rspec
+
+# 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 'rack/test'
+require 'utopia/controller'
+
+require 'async/websocket/client'
+require 'async/websocket/adapters/rack'
+
+require 'falcon/server'
+require 'falcon/adapters/rack'
+
+require 'async/http/client'
+require 'async/http/endpoint'
+
+RSpec.describe Utopia::Controller do
+	context Async::WebSocket::Client do
+		include Rack::Test::Methods
+		include_context Async::RSpec::Reactor
+		
+		let(:endpoint) {Async::HTTP::Endpoint.parse("http://localhost:7050/server/events")}
+		let(:app) {Rack::Builder.parse_file(File.expand_path('websocket_spec.ru', __dir__)).first}
+		let(:server) {Falcon::Server.new(Falcon::Server.middleware(app), endpoint)}
+		let(:client) {Async::HTTP::Client.new(endpoint)}
+		
+		let!(:server_task) do
+			reactor.async do
+				server.run
+			end
+		end
+		
+		after do
+			server_task.stop
+		end
+		
+		it "fails for normal requests" do
+			get "/server/events"
+			
+			expect(last_response.status).to be == 400
+		end
+		
+		it "can connect to websocket" do
+			Async::WebSocket::Client.connect(endpoint) do |connection|
+				expect(connection.read).to be == {type: "test", data: "Hello World"}
+			end
+		end
+	end
+end

data/spec/utopia/controller/websocket_spec.ru

@@ -0,0 +1,4 @@
+
+use Utopia::Controller, root: File.expand_path('websocket_spec', __dir__)
+
+run lambda {|env| [404, {}, []]}

data/spec/utopia/controller/websocket_spec/server/controller.rb

@@ -0,0 +1,10 @@
+
+prepend Actions
+
+on 'events' do |request|
+	upgrade = Async::WebSocket::Adapters::Rack.open(request.env) do |connection|
+		connection.write({type: "test", data: "Hello World"})
+	end
+	
+	respond?(upgrade) or fail!
+end

data/spec/utopia/session_spec.rb

@@ -102,6 +102,15 @@ module Utopia::SessionSpec
 			get "/session-get?key=foo"
 			expect(last_response.body).to be == ""
 		end
+
+		it "should fail if expired cookie is sent with the request" do
+			session_cookie = last_response['Set-Cookie'].split(';')[0]
+			sleep 6 # sleep longer than the session timeout
+			header 'Cookie', session_cookie
+
+			get "/session-get?key=foo"
+			expect(last_response.body).to be == ""
+		end
 		
 		it "shouldn't fail if ip address is changed" do
 			# Change user agent:

data/spec/utopia/session_spec.ru

@@ -1,7 +1,7 @@
 
 use Utopia::Session,
 	secret: "97111cabf4c1a5e85b8029cf7c61aa44424fc24a",
-	expires_after: 3600 * 48,
+	expires_after: 5,
 	update_timeout: 1
 
 run lambda { |env|

data/utopia.gemspec

@@ -38,9 +38,12 @@ Gem::Specification.new do |spec|
 	
 	spec.add_dependency 'concurrent-ruby', '~> 1.0'
 	
+	spec.add_development_dependency 'falcon'
+	spec.add_development_dependency 'async-rspec'
+	spec.add_development_dependency 'async-websocket'
+	
 	spec.add_development_dependency 'covered'
 	spec.add_development_dependency 'bundler'
 	spec.add_development_dependency 'rspec', '~> 3.6'
-	spec.add_development_dependency 'falcon'
 	spec.add_development_dependency 'rake'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 2.9.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: falcon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: async-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,21 +165,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: async-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: falcon
+  name: covered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -617,6 +645,7 @@ files:
 - setup/site/config.ru
 - setup/site/config/README.md
 - setup/site/config/environment.rb
+- setup/site/falcon.rb
 - setup/site/lib/readme.txt
 - setup/site/pages/_heading.xnode
 - setup/site/pages/_page.xnode
@@ -701,6 +730,9 @@ files:
 - spec/utopia/controller/rewrite_spec.rb
 - spec/utopia/controller/sequence_spec.rb
 - spec/utopia/controller/variables_spec.rb
+- spec/utopia/controller/websocket_spec.rb
+- spec/utopia/controller/websocket_spec.ru
+- spec/utopia/controller/websocket_spec/server/controller.rb
 - spec/utopia/exceptions/handler_spec.rb
 - spec/utopia/exceptions/handler_spec.ru
 - spec/utopia/exceptions/handler_spec/controller.rb
@@ -760,7 +792,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Utopia is a framework for building dynamic content-driven websites.
@@ -828,6 +860,9 @@ test_files:
 - spec/utopia/controller/rewrite_spec.rb
 - spec/utopia/controller/sequence_spec.rb
 - spec/utopia/controller/variables_spec.rb
+- spec/utopia/controller/websocket_spec.rb
+- spec/utopia/controller/websocket_spec.ru
+- spec/utopia/controller/websocket_spec/server/controller.rb
 - spec/utopia/exceptions/handler_spec.rb
 - spec/utopia/exceptions/handler_spec.ru
 - spec/utopia/exceptions/handler_spec/controller.rb