wsoc 0.1.0

data/lib/wsoc/helpers.rb

@@ -0,0 +1,34 @@
+#
+# 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/helpers/course'
+require 'wsoc/helpers/rendering'
+
+require 'rack'
+
+module WSOC
+  module Helpers
+    include Rack::Utils
+    alias :h :escape_html
+
+    include Rendering
+    include Course
+  end
+end

data/lib/wsoc/helpers/course.rb

@@ -0,0 +1,148 @@
+#
+# 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'
+require 'wsoc/course_specs'
+
+module WSOC
+  module Helpers
+    module Course
+      #
+      # Renders a course page.
+      #
+      # @param [Symbol] name
+      #   The name of the course page.
+      #
+      # @return [String]
+      #   The rendered page.
+      #
+      # @example
+      #   course_page :course_start
+      #
+      # @since 0.1.0
+      #
+      def course_page(name)
+        erb name, :layout => false
+      end
+
+      #
+      # Renders a title string.
+      #
+      # @param [Array] names
+      #   The names to put into the title.
+      #
+      # @return [String]
+      #   The title.
+      #
+      # @example
+      #   title_for 'HTTP Redirects'
+      #   # => "Web Spider Obstacle Course :: HTTP Redirects"
+      #
+      # @since 0.1.0
+      #
+      def title_for(*names)
+        (['Web Spider Obstacle Course'] + names).join(' :: ')
+      end
+
+      #
+      # Generates a remote URL containing a given path.
+      #
+      # @param [String] path
+      #   The path to include within the URL.
+      #
+      # @return [String]
+      #   The remote URL.
+      #
+      # @example
+      #   remote_url '/course/redirects/start.html'
+      #   # => "http://localhost:8080/course/redirects/start.html"
+      #
+      # @since 0.1.0
+      #
+      def remote_url(path)
+        s = "#{request.scheme}://#{request.host}"
+        s << ":#{request.port}" if request.port != 80
+        s << path
+
+        return s
+      end
+
+      #
+      # The course directory.
+      #
+      # @return [String]
+      #   The course directory.
+      #
+      # @example
+      #   course_dir
+      #   # => "/course/"
+      #
+      # @since 0.1.0
+      #
+      def course_dir
+        "#{Config::COURSE_DIR}/"
+      end
+
+      #
+      # The full course starting URL.
+      #
+      # @return [String]
+      #   The remote course starting URL.
+      #
+      # @example
+      #   course_start
+      #   # => "http://localhost:8080/course/start.html"
+      #
+      # @since 0.1.0
+      #
+      def course_start
+        remote_url Config::COURSE_START_PATH
+      end
+
+      #
+      # The full course failure URL.
+      #
+      # @return [String]
+      #   The remote course failure URL.
+      #
+      # @example
+      #   course_fail
+      #   # => "http://localhost:8080/course/fail"
+      #
+      # @since 0.1.0
+      #
+      def course_fail
+        remote_url Config::COURSE_FAIL_PATH
+      end
+
+      #
+      # The specs for the course.
+      #
+      # @return [Array<Hash>]
+      #   The Array of specs for each URL within the course.
+      #
+      # @since 0.1.0
+      #
+      def specs
+        CourseSpecs.specs_for(request.host,request.port)
+      end
+    end
+  end
+end

data/lib/wsoc/helpers/rendering.rb

@@ -0,0 +1,111 @@
+#
+# 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 'json'
+require 'yaml'
+
+module WSOC
+  module Helpers
+    module Rendering
+      #
+      # Renders a partial template.
+      #
+      # @param [Symbol] page
+      #   The name of the partial template.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @return [String]
+      #   The rendered partial.
+      #
+      # @example
+      #   partial :course_include
+      #
+      # @since 0.1.0
+      #
+      def partial(page,options={})
+        erb "_#{page}".to_sym, options.merge(:layout => false)
+      end
+
+      #
+      # Renders a page.
+      #
+      # @param [Symbol] page
+      #   Name of the page to render.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @return [String]
+      #   The rendered page.
+      #
+      # @example
+      #   show :course_fail
+      #
+      # @since 0.1.0
+      #
+      def show(page,options={})
+        erb(page,options)
+      end
+
+      #
+      # Renders a JSON blob and sets the content-type accordingly.
+      #
+      # @param [Object] obj
+      #   The object to encode.
+      #
+      # @return [String]
+      #   The JSON encoded object.
+      #
+      # @example
+      #   json @specs
+      #
+      # @since 0.1.0
+      #
+      def json(obj)
+        content_type :json
+
+        obj = obj.to_s unless obj.respond_to?(:to_json)
+        return obj.to_json
+      end
+
+      #
+      # Renders a YAML blob and sets the content-type accordingly.
+      #
+      # @param [Object] obj
+      #   The object to encode.
+      #
+      # @return [String]
+      #   The YAML encoded object.
+      #
+      # @example
+      #   yaml @specs
+      #
+      # @since 0.1.0
+      #
+      def yaml(obj)
+        content_type :yaml
+
+        return YAML.dump(obj)
+      end
+    end
+  end
+end

data/lib/wsoc/runner.rb

@@ -0,0 +1,123 @@
+#
+# 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'
+require 'wsoc/app'
+
+require 'optparse'
+
+module WSOC
+  class Runner
+
+    # Host to run the WSOC server on
+    attr_reader :host
+
+    # Port to run the WSOC server on
+    attr_reader :port
+
+    #
+    # Creates a new runner.
+    #
+    # @since 0.1.0
+    #
+    def initialize
+      @host = Config::DEFAULT_HOST
+      @port = Config::DEFAULT_PORT
+      @handler = nil
+    end
+
+    #
+    # Starts the runner.
+    #
+    # @param [Array<String>] argvs (ARGV)
+    #   The arguments to run the runner with.
+    #
+    # @since 0.1.0
+    #
+    def Runner.start(args=ARGV)
+      runner = self.new()
+      runner.run(*args)
+    end
+
+    #
+    # Runs the runner.
+    #
+    # @param [Array<String>] args
+    #   The arguments to run the runner with.
+    #
+    # @since 0.1.0
+    #
+    def run(*args)
+      optparse(*args)
+
+      options = {
+        :env => :production,
+        :host => @host,
+        :port => @port
+      }
+
+      options.merge!(:server => @handler) if @handler
+
+      App.run!(options)
+    end
+
+    protected
+
+    #
+    # Parses the given arguments.
+    #
+    # @param [Array<String>] args
+    #   The arguments to parse.
+    #
+    # @since 0.1.0
+    #
+    def optparse(*args)
+      opts = OptionParser.new
+
+      opts.banner = "usage: #{$0} [options]"
+
+      opts.on('-H','--host HOST',"The host to run the server on","Default: #{@host}") do |host|
+        @host = host
+      end
+
+      opts.on('-p','--port PORT',"The port to run the server on","Default: #{@port}") do |port|
+        @port = port.to_i
+      end
+
+      opts.on('--s','--server NAME','Rack handler to run the server under') do |handler|
+        @handler = handler
+      end
+
+      opts.on('-h','--help','Display the help output') do
+        puts opts
+        exit
+      end
+
+      begin
+        opts.parse!(args)
+      rescue OptionParser::InvalidOption => e
+        STDERR.puts e.message
+        STDERR.puts opts
+        exit -1
+      end
+    end
+
+  end
+end

data/lib/wsoc/specs.rb

@@ -0,0 +1,62 @@
+#
+# 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
+#
+
+module WSOC
+  module Specs
+    def self.included(base)
+      base.module_eval do
+        def self.specs
+          @@specs ||= []
+        end
+
+        def self.should(behavior,options)
+          self.specs << {:behavior => behavior}.merge(options)
+        end
+
+        def self.specs_for(host,port=nil)
+          prefix = "http://#{host}"
+          prefix << ":#{port}" if (port && port != 80)
+
+          self.specs.map do |spec|
+            unless spec[:url] =~ /^[a-zA-Z0-9]+:/
+              spec.merge(:url => prefix + spec[:url])
+            else
+              spec
+            end
+          end
+        end
+
+        protected
+
+        def self.should_visit(url,message=nil)
+          self.should(:visit,:url => url, :message => message)
+        end
+
+        def self.should_ignore(url,message=nil)
+          self.should(:ignore,:url => url, :message => message)
+        end
+
+        def self.should_fail(url,message=nil)
+          self.should(:fail,:url => url, :message => message)
+        end
+      end
+    end
+  end
+end