wsoc 0.1.0

data/Rakefile

@@ -0,0 +1,27 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'hoe/signing'
+require './tasks/yard.rb'
+
+Hoe.spec('wsoc') do
+  self.developer('Postmodern', 'postmodern.mod3@gmail.com')
+
+  self.readme_file = 'README.rdoc'
+  self.history_file = 'History.rdoc'
+  self.remote_rdoc_dir = '/'
+
+  self.extra_deps = [
+    ['json', '>=1.2.0'],
+    ['sinatra', '>=0.9.4']
+  ]
+
+  self.extra_dev_deps = [
+    ['yard', '>=0.5.2']
+  ]
+
+  self.spec_extras = {:has_rdoc => 'yard'}
+end
+
+# vim: syntax=ruby

data/bin/wsoc_server

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'wsoc/runner'
+
+WSOC::Runner.start

data/config.ru

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift ::File.expand_path(::File.join(::File.dirname(__FILE__),'lib'))
+
+require 'rubygems'
+require 'wsoc/app'
+
+WSOC::App.set :environment, (ENV['RACK_ENV'] || :production)
+
+run WSOC::App

data/lib/wsoc.rb

@@ -0,0 +1,21 @@
+#
+# WSOC - The Web Spider Obstacle Course
+#
+# Copyright (c) 2009-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'wsoc/version'

data/lib/wsoc/app.rb

@@ -0,0 +1,147 @@
+#
+# WSOC - The Web Spider Obstacle Course
+#
+# Copyright (c) 2009-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'wsoc/course'
+require 'wsoc/course_specs'
+require 'wsoc/helpers'
+require 'wsoc/version'
+
+require 'rubygems'
+require 'sinatra'
+require 'nokogiri'
+
+module WSOC
+  class App < Sinatra::Base
+
+    include Course
+
+    get '/' do
+      show :welcome
+    end
+
+    get '/specs' do
+      @specs = specs
+
+      show :specs
+    end
+
+    get Config::SPECS_PATHS[:json] do
+      json specs
+    end
+
+    get Config::SPECS_PATHS[:yaml] do
+      yaml specs
+    end
+
+    course_template '/course/start.html'
+
+    get '/course/fail' do
+      status 404
+      show :course_fail
+    end
+
+    course_template '/course/relative/start.html'
+    course_pass '/course/relative/same_directory.html'
+    course_pass '/course/relative/current_directory.html'
+    course_pass '/course/relative/normal.html'
+
+    course_template '/course/absolute/start.html'
+    course_pass '/course/absolute/next.html'
+
+    course_template '/course/empty/start.html'
+
+    course_template '/course/frames/start.html'
+    course_template '/course/frames/frame.html'
+    course_template '/course/frames/iframe.html'
+    course_pass '/course/frames/frame_contents.html'
+    course_pass '/course/frames/iframe_contents.html'
+
+    course_template '/course/javascript/start.html'
+
+    course_template '/course/loop/start.html'
+    course_template '/course/loop/next.html'
+
+    course_template '/course/remote/start.html'
+    course_pass '/course/remote/next.html'
+
+    course_template '/course/redirects/start.html'
+
+    get '/course/redirects/300.html' do
+      redirect remote_url('/course/redirects/300/pass.html')
+    end
+
+    course_pass '/course/redirects/300/pass.html'
+
+    get '/course/redirects/301.html' do
+      redirect remote_url('/course/redirects/301/pass.html')
+    end
+
+    course_pass '/course/redirects/301/pass.html'
+
+    get '/course/redirects/302.html' do
+      redirect remote_url('/course/redirects/302/pass.html')
+    end
+
+    course_pass '/course/redirects/302/pass.html'
+
+    get '/course/redirects/303.html' do
+      redirect remote_url('/course/redirects/303/pass.html')
+    end
+
+    course_pass '/course/redirects/303/pass.html'
+
+    get '/course/redirects/307.html' do
+      redirect remote_url('/course/redirects/307/pass.html')
+    end
+
+    course_pass '/course/redirects/307/pass.html'
+
+    get '/course/cookies/start.html' do
+      response.set_cookie 'auth_level', '1'
+
+      course_page :course_cookies_start
+    end
+
+    get '/course/cookies/get.html' do
+      @authed = (request.cookies['auth_level'] == '1')
+
+      course_page :course_cookies_get
+    end
+
+    get '/course/cookies/post.html' do
+      response.set_cookie 'auth_level', '2'
+
+      course_page :course_cookies_post
+    end
+
+    post '/course/cookies/post.html' do
+      @authed = (request.cookies['auth_level'] == '2')
+
+      course_page :course_cookies_post
+    end
+
+    course_pass '/course/cookies/protected/1.html'
+
+    get '/*' do
+      redirect remote_url('/course/fail')
+    end
+
+  end
+end

data/lib/wsoc/config.rb

@@ -0,0 +1,46 @@
+#
+# WSOC - The Web Spider Obstacle Course
+#
+# Copyright (c) 2009-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'wsoc/version'
+
+module WSOC
+  module Config
+    # Default host to run the WSOC server on
+    DEFAULT_HOST = 'localhost'
+
+    # Default port to run the WSOC server on
+    DEFAULT_PORT = 8080
+
+    # Paths to the specs files
+    SPECS_PATHS = {
+      :json => '/specs.json',
+      :yaml => '/specs.yaml'
+    }
+
+    # Course directory
+    COURSE_DIR = '/course'
+
+    # Path to the start of the course
+    COURSE_START_PATH = "#{COURSE_DIR}/start.html"
+
+    # Path to the course failure page
+    COURSE_FAIL_PATH = "#{COURSE_DIR}/fail"
+  end
+end

data/lib/wsoc/course.rb

@@ -0,0 +1,69 @@
+#
+# WSOC - The Web Spider Obstacle Course
+#
+# Copyright (c) 2009-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'wsoc/config'
+
+module WSOC
+  module Course
+    def self.included(base)
+      base.module_eval do
+        set :host, Config::DEFAULT_HOST
+        set :port, Config::DEFAULT_PORT
+
+        set :root, File.expand_path(File.join(File.dirname(__FILE__),'..','..'))
+        set :course, File.join(self.public,'course')
+        enable :static, :sessions
+
+        helpers WSOC::Helpers
+
+        #
+        # Adds a path to the Obstacle Course, where a course template
+        # will be rendered.
+        #
+        # @param [String] path
+        #   The path to add to the obstacle course.
+        #
+        # @since 0.1.0
+        #
+        def self.course_template(path)
+          name = path[1..-1].gsub(/\.\S*$/,'').gsub(/\/+/,'_').to_sym
+
+          get(path) do
+            erb name, :layout => false
+          end
+        end
+
+        #
+        # Adds a path to the Obstacle Course.
+        #
+        # @param [String] path
+        #   The path to add to the obstacle course.
+        #
+        # @since 0.1.0
+        #
+        def self.course_pass(path)
+          get(path) do
+            erb :course_pass, :layout => false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wsoc/course_specs.rb

@@ -0,0 +1,124 @@
+#
+# WSOC - The Web Spider Obstacle Course
+#
+# Copyright (c) 2009-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'wsoc/specs'
+
+module WSOC
+  module CourseSpecs
+    include Specs
+
+    should_ignore '/course/fail',
+                  'should not visit links not part of the obstacle course'
+
+    # Absolute Links
+    should_visit '/course/absolute/start.html',
+                 'should visit the absolute links start page'
+    should_visit '/course/absolute/next.html',
+                 'should visit absolute links to unvisited pages'
+
+    # Empty Links
+    should_visit '/course/empty/start.html',
+                 'should visit the empty links start page'
+    should_ignore '/course/empty/start.html%20',
+                  'should ignore links with blank href attributes'
+
+    # Frames
+    should_visit '/course/frames/start.html',
+                 'should visit the empty links start page'
+    should_visit '/course/frames/iframe.html',
+                 'should visit the contents of iframes'
+    should_visit '/course/frames/iframe_contents.html',
+                 'should visit links within iframes'
+    should_visit '/course/frames/frame.html',
+                 'should visit the contents of frames'
+    should_visit '/course/frames/frame_contents.html',
+                 'should visit links within frames'
+
+    # Javascript Links
+    should_visit '/course/javascript/start.html',
+                 'should visit the javascript links start page'
+    should_ignore '/course/javascript/start.html#',
+                  'should ignore target links'
+    should_ignore 'javascript:fail();',
+                  'should ignore javascript: links'
+
+    # Looping Links
+    should_visit '/course/loop/start.html',
+                 'should visit the looping links start page'
+    should_visit '/course/loop/next.html',
+                 'should visit non-circular linking pages'
+
+    # Relative Links
+    should_visit '/course/relative/start.html',
+                 'should visit the relative links start page'
+    should_ignore '/course/relative/start.html#',
+                  'should ignore in-page anchor links'
+    should_visit '/course/relative/normal.html',
+                 'should visit normal relative links'
+    should_visit '/course/relative/current_directory.html',
+                 'should visit links relative to the current directory'
+    should_visit '/course/relative/same_directory.html',
+                 'should visit relative links that traverse directories'
+
+    # Remote Links
+    should_visit '/course/remote/start.html',
+                 'should visit the remote links start page'
+    should_ignore '/course/loop/../remote/start.html',
+                  'should resolve the paths of remote links'
+    should_visit '/course/remote/next.html',
+                 'should visit normal remote links'
+    should_fail 'http://spidr.rubyforge.org:1337/course/remote/fail.html',
+                'should safely fail on closed ports'
+    should_fail 'http://not.found/course/remote/fail.html',
+                'should safely fail on bad host-names'
+
+    # Cookies
+    should_visit '/course/cookies/start.html',
+                 'should visit the cookies start page'
+    should_visit '/course/cookies/get.html',
+                 'should visit the cookies GET request test page'
+    should_visit '/course/cookies/protected/1.html',
+                 'should visit the first cookie protected page'
+
+    # HTTP Redirects
+    should_visit '/course/redirects/start.html',
+                 'should visit the HTTP redirects start page'
+    should_visit '/course/redirects/300.html',
+                 'should visit the 300 HTTP redirect test page'
+    should_visit '/course/redirects/300/pass.html',
+                 'should follow HTTP 300 redirects'
+    should_visit '/course/redirects/301.html',
+                 'should visit the 301 HTTP redirect test page'
+    should_visit '/course/redirects/301/pass.html',
+                 'should follow HTTP 301 redirects'
+    should_visit '/course/redirects/302.html',
+                 'should visit the 302 HTTP redirect test page'
+    should_visit '/course/redirects/302/pass.html',
+                 'should follow HTTP 302 redirects'
+    should_visit '/course/redirects/303.html',
+                 'should visit the 303 HTTP redirect test page'
+    should_visit '/course/redirects/303/pass.html',
+                 'should follow HTTP 303 redirects'
+    should_visit '/course/redirects/307.html',
+                 'should visit the 307 HTTP redirect test page'
+    should_visit '/course/redirects/307/pass.html',
+                 'should follow HTTP 307 redirects'
+  end
+end