gopher2000 0.3.0 → 0.6.0

data/README.markdown

@@ -16,6 +16,8 @@ Gopher2000 - A Gopher server for the next millenium
 Gopher2000 is a ruby-based Gopher server. It is built for speedy, enjoyable development of
 all sorts of gopher sites.
 
+[![Build Status](https://travis-ci.org/muffinista/gopher2000.svg?branch=master)](https://travis-ci.org/muffinista/gopher2000)
+
 Features
 --------
 * Simple, Sintra-inspired routing DSL.
@@ -23,11 +25,10 @@ Features
 * built on Event Machine.
 * Easy to mount directories and serve up files.
 * built in logging and stats.
-* Runs on Ruby 1.9.2 with all the modern conveniences.
 
 Requirements
 ------------
-* Ruby 1.9.2 or greater
+* Ruby 2 or greater
 * Nerves of steel
 
 Examples
@@ -57,7 +58,7 @@ menu :index do
   br(2)
 
   # link somewhere
-  link 'current time', '/time'
+  text_link 'current time', '/time'
   br
 end
 
@@ -106,6 +107,34 @@ Command line options will override defaults specified in your script
 -- so you can try out things on a different port/address if needed.
 
 
+Docker
+------
+
+There's a pretty simple docker script which you can use to run an
+app. To run one of the included examples, you could do something like:
+
+
+```
+docker build -t gopher2000 .
+docker run -p 7070:7070 --rm -it gopher2000 examples/simple.rb
+```
+
+This will run the `simple` example on port 7070. You can view it
+locally by running something like:
+
+```
+lynx gopher://0.0.0.0:7070
+```
+
+The Dockerfile is also published to Docker Hub, so you could run
+something like this:
+
+```
+docker run -p 7070:7070 --rm -v $PWD:/opt muffinista/gopher2000 /opt/gopher-script.rb
+```
+
+
+
 Developing Gopher Sites
 -----------------------
 

data/bin/gopher2000

@@ -31,7 +31,7 @@ params = {
 
 opts.on('-d', '--debug', "run in debug mode")    { params[:debug] = true }
 opts.on('-p port',   'set the port (default is 70)')                { |val| params[:port] = Integer(val) }
-opts.on('-o addr',   'set the host (default is 0.0.0.0)')             { |val| params[host] = val }
+opts.on('-o addr',   'set the host (default is 0.0.0.0)')             { |val| params[:host] = val }
 opts.on('-e env',    'set the environment (default is development)')  { |val| params[:env] = val.to_sym }
 
 opts.on_tail("-h", "--help", "Show this message") do

data/examples/figlet.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#
+# Simple gopher example
+#
+
+require 'gopher2000'
+
+set :host, '0.0.0.0'
+set :port, 7070
+
+route '/figlet' do
+  render :figlet
+end
+
+#
+# special text output rendering
+#
+text :figlet do
+  @text = "Hello!"
+
+  # nicely wrapped text
+  figlet @text
+
+  # spacing
+  br(2)
+end

data/examples/simple.rb

@@ -5,6 +5,8 @@
 # Simple gopher example
 #
 
+require "rubygems"
+require "bundler/setup"
 require 'gopher2000'
 
 set :host, '0.0.0.0'
@@ -57,11 +59,11 @@ menu :index do
   br(2)
 
   # link somewhere
-  link 'current time', '/time'
+  text_link 'current time', '/time'
   br
 
   # another link
-  link 'about', '/about'
+  text_link 'about', '/about'
   br
 
   # ask for some input

data/gopher2000.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   s.summary     = %q{Gopher2000 - A Gopher server for the next millenium}
   s.description = %q{Gopher2000 is a ruby-based Gopher server. It is built for speedy, enjoyable development of all sorts of gopher sites.}
 
-  s.rubyforge_project = "gopher2000"
   s.licenses = ["WTFPL"]
 
   s.files         = `git ls-files`.split("\n")
@@ -26,10 +25,11 @@ Gem::Specification.new do |s|
   s.add_development_dependency "yard"
   s.add_development_dependency "shoulda"
   s.add_development_dependency "rdoc"
-  s.add_development_dependency "simplecov"
+  s.add_development_dependency "simplecov", "~> 0.16.1"
   s.add_development_dependency "watchr"
-  s.add_development_dependency "eventmachine"
 
-  s.add_runtime_dependency "eventmachine"
+  s.add_runtime_dependency "artii", ">= 2.0.1"
+  s.add_runtime_dependency "eventmachine", "~> 1.2.5"
   s.add_runtime_dependency "logging"
+  s.add_runtime_dependency "mimemagic"
 end

data/lib/gopher2000/base.rb

@@ -54,6 +54,13 @@ module Gopher
       config[:port] ||= 70
     end
 
+    #
+    # return the application environment
+    #
+    def env
+      config[:env] ||= 'development'
+    end
+
     #
     # are we in debugging mode?
     #
@@ -91,9 +98,9 @@ module Gopher
     #
     # mount a directory for browsing via gopher
     #
-    # @param [Hash] A hash specifying the path your route will answer to, and the filesystem path to use '/route' => '/home/path/etc'
-    #
-    # @param [Hash] a hash of options for the mount. Primarily this is a filter, which will restrict the list files outputted. example: :filter => '*.jpg'
+    # @param [Hash] path A hash specifying the path your route will answer to, and the filesystem path to use '/route' => '/home/path/etc'
+    # @param [Hash] opts a hash of options for the mount. Primarily this is a filter, which will restrict the list files outputted. example: :filter => '*.jpg'
+	# @param [Class] klass The class that should be used to handle this mount. You could write and use a custom handler if desired
     #
     # @example mount the directory '/home/user/foo' at the gopher path '/files', and only show JPG files:
     #   mount '/files' => '/home/user/foo', :filter => '*.jpg'
@@ -118,8 +125,7 @@ module Gopher
 
     #
     # define a route.
-    # @param [String] the path your route will answer to. This is
-    # basically a URI path
+    # @param [String] path the path your route will answer to. This is basically a URI path
     # @yield a block that handles your route
     #
     # @example respond with a simple string
@@ -145,6 +151,7 @@ module Gopher
 
     #
     # specify a default route to handle requests if no other route exists
+    # @yield a block to handle the default route
     #
     # @example render a template
     #   default_route do
@@ -158,16 +165,15 @@ module Gopher
     #
     # lookup an incoming path
     #
-    # @param [String] the selector path of the incoming request
+    # @param [String] selector the selector path of the incoming request
     #
     def lookup(selector)
       unless routes.nil?
-		routes.each do |pattern, keys, block|
-
+		    routes.each do |pattern, keys, block|
           if match = pattern.match(selector)
             match = match.to_a
             url = match.shift
-
+            
             params = to_params_hash(keys, match)
 
             #
@@ -190,7 +196,7 @@ module Gopher
 
     #
     # find and run the first route which matches the incoming request
-    # @param [Request] Gopher::Request object
+    # @param [Request] req Gopher::Request object
     #
     def dispatch(req)
       debug_log(req)
@@ -201,6 +207,9 @@ module Gopher
       if ! @request.valid?
         response.body = handle_invalid_request
         response.code = :error
+      elsif @request.url?
+        response.body = handle_url(@request)
+        response.code = :success
       else
         begin
           debug_log("do lookup for #{@request.selector}")
@@ -233,11 +242,11 @@ module Gopher
     # define a template which will be used to render a gopher-style
     # menu.
     #
-    # @param [String/Symbol] -- the name of the template. This is what
-    # identifies the template when making a call to render
+    # @param [String/Symbol] name the name of the template. This is what
+    #   identifies the template when making a call to render
     # @yield a block which will output the menu. This block is
-    # executed within an instance of Gopher::Rendering::Menu and will
-    # have access to all of its methods.
+    #   executed within an instance of Gopher::Rendering::Menu and will
+    #   have access to all of its methods.
     #
     # @example a simple menu:
     #  menu :index do
@@ -273,7 +282,7 @@ module Gopher
     # access to the methods defined in Gopher::Rendering::Text for
     # wrapping strings, adding simple headers, etc.
     #
-    # @param [String/Symbol] -- the name of the template. This is what identifies the template when making a call to render
+    # @param [String/Symbol] name the name of the template. This is what identifies the template when making a call to render
     #
     # @yield a block which will output the menu. This block is executed within an instance of Gopher::Rendering::Text and will have access to all of its methods.
     # @example simple example
@@ -295,7 +304,7 @@ module Gopher
 
     #
     # find a template
-    # @param [String/Symbol] name of the template
+    # @param [String/Symbol] t name of the template
     # @return template block and the class context it should use
     #
     def find_template(t)
@@ -311,8 +320,8 @@ module Gopher
 
     #
     # Find the desired template and call it within the proper context
-    # @param [String/Symbol] name of the template to render
-    # @param [Array] optional arguments to be passed to template
+    # @param [String/Symbol] template name of the template to render
+    # @param [Array] arguments optional arguments to be passed to template
     # @return result of rendering
     #
     def render(template, *arguments)
@@ -347,6 +356,15 @@ module Gopher
       menus.include?(:error) ? :error : :'internal/error'
     end
 
+
+    #
+    # get the id of the template that will be used when rendering an html page
+    # @return name of error template
+    #
+    def url_template
+      menus.include?(:html) ? :html : :'internal/url'
+    end
+    
     #
     # get the id of the template that will be used when rendering an
     # invalid request
@@ -385,7 +403,7 @@ module Gopher
     # Gopher servers in production)
     #
     def non_blocking?
-      config[:non_blocking] ||= ! debug_mode?
+      config.key?(:non_blocking) ? config[:non_blocking] : ! debug_mode?
     end
 
 
@@ -411,7 +429,7 @@ module Gopher
     # turn a path string with optional keys (/foo/:bar/:boo) into a
     # regexp which will be used when searching for a route
     #
-    # @param [String] the path to compile
+    # @param [String] path the path to compile
     #
     def compile(path)
       keys = []
@@ -431,24 +449,22 @@ module Gopher
 
     class << self
 
-	  #
-	  # Sanitizes a gopher selector
-	  #
-	  def sanitize_selector(raw)
-		"/#{raw}".dup.
-		  strip. # Strip whitespace
-		  sub(/\/$/, ''). # Strip last rslash
-		  sub(/^\/*/, '/'). # Strip extra lslashes
-		  gsub(/\.+/, '.') # Don't want consecutive dots!
-
-		#raw = "/#{raw}" if ! raw.match(/^\//)
-	  end
-
-	  #
+	    #
+	    # Sanitizes a gopher selector
+	    #
+	    def sanitize_selector(raw)
+		    "/#{raw}".dup.
+		      strip. # Strip whitespace
+		      sub(/\/$/, ''). # Strip last rslash
+		      sub(/^\/*/, '/'). # Strip extra lslashes
+		      gsub(/\.+/, '.') # Don't want consecutive dots!
+	    end
+      
+	    #
       # generate a method which we will use to run routes. this is
       # based on #generate_method as used by sinatra.
       # @see https://github.com/sinatra/sinatra/blob/master/lib/sinatra/base.rb
-      # @param [String] name to use for the method
+      # @param [String] method_name name to use for the method
       # @yield block to use for the method
       def generate_method(method_name, &block)
         define_method(method_name, &block)
@@ -457,7 +473,7 @@ module Gopher
         method
       end
     end
-
+    
     #
     # output a debugging message
     #
@@ -474,15 +490,37 @@ module Gopher
     #
     def register_defaults
       menu :'internal/not_found' do
-        text "Sorry, #{@request.selector} was not found"
+        error "Sorry, #{@request.selector} was not found"
       end
 
       menu :'internal/error' do |details|
-        text "Sorry, there was an error #{details}"
+        error "Sorry, there was an error #{details}"
       end
 
       menu :'internal/invalid_request' do
-        text "invalid request"
+        error "invalid request"
+      end
+
+      menu :'internal/url' do
+        output = <<-EOHTML
+<html>
+  <head>
+    <meta http-equiv="refresh" content="5;URL=#{@request.url}">
+  </head>
+  <body>
+    <p>
+      You are following a link from gopher to a website. If your browser supports it, you will be
+      automatically taken to the web site shortly.  If you do not get
+      sent there, please click <a href="#{@request.url}">here</a>.
+   </p>
+   <p>
+     The URL linked is: <a href="#{@request.url}">#{@request.url}</a>.
+   </p>
+   <p>Have a nice day!</p>
+  </body>
+</html>
+EOHTML
+        output
       end
     end
 
@@ -490,6 +528,10 @@ module Gopher
       render not_found_template
     end
 
+    def handle_url(request)
+      render url_template, request
+    end
+
     def handle_error(e)
       render error_template, e
     end

data/lib/gopher2000/dispatcher.rb

@@ -22,16 +22,25 @@ module Gopher
     #
     # called by EventMachine when there's an incoming request
     #
-    # @param [String] incoming selector
+    # @param [String] selector incoming selector
     # @return Response object
     #
-    def receive_data(selector)
-      call! Request.new(selector, remote_ip)
+    def receive_data data
+      (@buf ||= '') << data
+      
+      while line = @buf.slice!(/(.*)\r?\n/)
+        receive_line(line)
+      end
     end
 
+    # Invoked with lines received over the network
+    def receive_line(line)
+      call! Request.new(line, remote_ip)
+    end
+    
     #
     # generate a request object from an incoming selector, and dispatch it to the app
-    # @param [String] incoming selector
+    # @param [Request] request Request object to handle
     # @return Response object
     #
     def call!(request)

data/lib/gopher2000/dsl.rb

@@ -81,7 +81,7 @@ module Gopher
     end
 
     # watch the specified script for changes
-    # @param [String] script to watch
+    # @param [String] f script to watch
     def watch(f)
       application.scripts << f
     end