gopher2000 0.5.3 → 0.7.0

data/README.markdown

@@ -25,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
@@ -59,7 +58,7 @@ menu :index do
   br(2)
 
   # link somewhere
-  link 'current time', '/time'
+  text_link 'current time', '/time'
   br
 end
 
@@ -108,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/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/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?
     #
@@ -162,12 +169,11 @@ module Gopher
     #
     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)
 
             #
@@ -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}")
@@ -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
@@ -431,20 +449,18 @@ 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
@@ -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

@@ -27,15 +27,21 @@ module Gopher
     #
     def receive_data data
       (@buf ||= '') << data
-      
+      first_line = true
+
+      ip_address = remote_ip
       while line = @buf.slice!(/(.*)\r?\n/)
-        receive_line(line)
+        is_proxy = first_line && line.match?(/^PROXY TCP[4,6] /)
+        receive_line(line, ip_address) unless is_proxy
+        ip_address = line.split(/ /)[2] if is_proxy
+
+        first_line = false
       end
     end
 
     # Invoked with lines received over the network
-    def receive_line(line)
-      call! Request.new(line, remote_ip)
+    def receive_line(line, ip_address)
+      call! Request.new(line, ip_address)
     end
     
     #

data/lib/gopher2000/rendering/base.rb

@@ -35,7 +35,7 @@ module Gopher
       # @param [String] string text to add to the output
       #
       def <<(string)
-        @result << string.to_s
+        @result << clean_line(string.to_s)
       end
 
       #
@@ -89,7 +89,9 @@ module Gopher
         # this is a hack - recombine lines, then re-split on newlines
         # doing this because word_wrap is returning an array of lines, but
         # those lines have newlines in them where we should wrap
-        lines = word_wrap(text, width).join("\n").split("\n")
+        #
+        lines = word_wrap(text, width)
+                  .join("\n").split("\n")
 
         lines.each do |line|
           text line.lstrip.rstrip
@@ -206,6 +208,19 @@ module Gopher
         end
       end
 
+      #
+      # handle lines of a single period not at the end of the
+      # transmission
+      #
+      # RFC 1436 states: Note: Lines beginning with
+      # periods must be prepended with an extra period to
+      # ensure that the transmission is not terminated
+      # early. The client should strip extra periods at
+      # the beginning of the line.
+      def clean_line(line)
+        line.match?(/^\./) ? ['.', line].join('') : line
+      end
+      
       private
       def add_spacing
         br(@spacing)

data/lib/gopher2000/request.rb

@@ -7,12 +7,21 @@ module Gopher
     attr_accessor :selector, :input, :ip_address
 
     def initialize(raw, ip_addr=nil)
-      @selector, @input = raw.chomp.split("\t")
+      @raw = raw
+      @selector, @input = @raw.chomp.split("\t")
+      
+	    @selector = Gopher::Application.sanitize_selector(@selector)
+	    @ip_address = ip_addr
+    end
 
-	  @selector = Gopher::Application.sanitize_selector(@selector)
-	  @ip_address = ip_addr
+    def url?
+      @raw =~ /^URL\:/
     end
 
+    def url
+      @raw.chomp.split("\t").first.gsub(/^URL\:/, '')
+    end
+    
     # confirm that this is actually a valid gopher request
     # @return [Boolean] true if the request is valid, false otherwise
     def valid?

data/lib/gopher2000/server.rb

@@ -13,7 +13,7 @@ module Gopher
     def initialize(a)
       @app = a
     end
-
+ 
     #
     # @return [String] name of the host specified in our config
     #
@@ -28,6 +28,13 @@ module Gopher
       @app.config[:port] ||= 70
     end
 
+    #
+    # @return [String] environment specified in config
+    #
+    def env
+      @app.config[:env] || 'development'
+    end
+    
     #
     # main app loop. called via at_exit block defined in DSL
     #
@@ -77,8 +84,8 @@ module Gopher
       require 'optparse'
       OptionParser.new { |op|
         op.on('-p port',   'set the port (default is 70)')                { |val| set :port, Integer(val) }
-        op.on('-o addr',   'set the host (default is 0.0.0.0)')             { |val| set :bind, val }
-        op.on('-e env',    'set the environment (default is development)')  { |val| set :environment, val.to_sym }
+        op.on('-o addr',   'set the host (default is 0.0.0.0)')             { |val| set :host, val }
+        op.on('-e env',    'set the environment (default is development)')  { |val| set :env, val.to_sym }
       }.parse!(ARGV.dup)
     end
   end

data/lib/gopher2000/version.rb

@@ -1,4 +1,4 @@
 module Gopher
   # current version of the app
-  VERSION = "0.5.3"
+  VERSION = "0.7.0"
 end

data/spec/dispatching_spec.rb

@@ -51,6 +51,7 @@ describe Gopher::Application do
 
       @response = @server.dispatch(@request)
       expect(@response.code).to eq(:missing)
+      expect(@response.body).to contain_any_error
     end
 
     it "should respond with error if invalid request" do
@@ -59,6 +60,7 @@ describe Gopher::Application do
 
       @response = @server.dispatch(@request)
       expect(@response.code).to eq(:error)
+      expect(@response.body).to contain_any_error
     end
 
     it "should respond with error if there's an exception" do
@@ -67,6 +69,7 @@ describe Gopher::Application do
 
       @response = @server.dispatch(@request)
       expect(@response.code).to eq(:error)
+      expect(@response.body).to contain_any_error
     end
   end
 
@@ -127,7 +130,17 @@ describe Gopher::Application do
     end
   end
 
+  describe 'dispatch for URL requests' do
+    let(:target) { 'URL:http://github.com/muffinista/gopher2000' }
+    let(:request) { Gopher::Request.new(target) }
+    let(:response) { @server.dispatch(request) }
 
+    it "should return web page" do
+      expect(response.body).to include('<meta http-equiv="refresh" content="5;URL=http://github.com/muffinista/gopher2000">')
+    end
+  end
+
+  
   describe "globs" do
     before(:each) do
       @server.route '/about/*' do
@@ -142,3 +155,11 @@ describe Gopher::Application do
     end
   end
 end
+
+RSpec::Matchers.define :contain_any_error do
+  match do |actual|
+    actual.split(/\r?\n/).any? do |line| 
+      line.match(/^3.*?\tnull\t\(FALSE\)\t0$/)
+    end
+  end
+end

data/spec/dsl_spec.rb

@@ -14,103 +14,112 @@ describe Gopher::DSL do
 
     @server = FakeServer.new(@app)
     @server.send :require, 'gopher2000/dsl'
-    allow(@server).to receive(:application).and_return(@app)
-    @app.reset!
   end
 
-
-  describe "set" do
-    it "should set a config var" do
-      @server.set :foo, 'bar'
-      expect(@app.config[:foo]).to eq('bar')
+  describe "application" do
+    it "should return a Gopher::Application" do
+      expect(@server.application).to be_a(Gopher::Application)
     end
   end
 
-  describe "route" do
-    it "should pass a lookup and block to the app" do
-      expect(@app).to receive(:route).with('/foo')
-      @server.route '/foo' do
-        "hi"
+  context "with application" do
+    before do
+      allow(@server).to receive(:application).and_return(@app)
+      @app.reset!
+    end
+
+    describe "set" do
+      it "should set a config var" do
+        @server.set :foo, 'bar'
+        expect(@app.config[:foo]).to eq('bar')
       end
     end
-  end
 
-  describe "default_route" do
-    it "should pass a default block to the app" do
-      expect(@app).to receive(:default_route)
-      @server.default_route do
-        "hi"
+    describe "route" do
+      it "should pass a lookup and block to the app" do
+        expect(@app).to receive(:route).with('/foo')
+        @server.route '/foo' do
+          "hi"
+        end
       end
     end
-  end
 
-  describe "mount" do
-    it "should pass a route, path, and some opts to the app" do
-      expect(@app).to receive(:mount).with('/foo', {:path => "/bar"})
-      @server.mount "/foo" => "/bar"
+    describe "default_route" do
+      it "should pass a default block to the app" do
+        expect(@app).to receive(:default_route)
+        @server.default_route do
+          "hi"
+        end
+      end
     end
 
-    it "should pass a route, path, filter, and some opts to the app" do
-      expect(@app).to receive(:mount).with('/foo', {:path => "/bar", :filter => "*.jpg"})
-      @server.mount "/foo" => "/bar", :filter => "*.jpg"
+    describe "mount" do
+      it "should pass a route, path, and some opts to the app" do
+        expect(@app).to receive(:mount).with('/foo', {:path => "/bar"})
+        @server.mount "/foo" => "/bar"
+      end
+
+      it "should pass a route, path, filter, and some opts to the app" do
+        expect(@app).to receive(:mount).with('/foo', {:path => "/bar", :filter => "*.jpg"})
+        @server.mount "/foo" => "/bar", :filter => "*.jpg"
+      end
     end
-  end
 
-  describe "menu" do
-    it "should pass a menu key and block to the app" do
-      expect(@app).to receive(:menu).with('/foo')
-      @server.menu '/foo' do
-        "hi"
+    describe "menu" do
+      it "should pass a menu key and block to the app" do
+        expect(@app).to receive(:menu).with('/foo')
+        @server.menu '/foo' do
+          "hi"
+        end
       end
     end
-  end
 
-  describe "text" do
-    it "should pass a text_template key and block to the app" do
-      expect(@app).to receive(:text).with('/foo')
-      @server.text '/foo' do
-        "hi"
+    describe "text" do
+      it "should pass a text_template key and block to the app" do
+        expect(@app).to receive(:text).with('/foo')
+        @server.text '/foo' do
+          "hi"
+        end
       end
     end
-  end
 
-  describe "helpers" do
-    it "should pass a block to the app" do
-      expect(@app).to receive(:helpers)
-      @server.helpers do
-        "hi"
+    describe "helpers" do
+      it "should pass a block to the app" do
+        expect(@app).to receive(:helpers)
+        @server.helpers do
+          "hi"
+        end
       end
     end
-  end
 
-  describe "watch" do
-    it "should pass a script app for watching" do
-      expect(@app.scripts).to receive(:<<).with("foo")
-      @server.watch("foo")
+    describe "watch" do
+      it "should pass a script app for watching" do
+        expect(@app.scripts).to receive(:<<).with("foo")
+        @server.watch("foo")
+      end
     end
-  end
 
-  describe "run" do
-    it "should set any incoming opts" do
-      expect(@server).to receive(:set).with(:x, 1)
-      expect(@server).to receive(:set).with(:y, 2)
-      allow(@server).to receive(:load)
+    describe "run" do
+      it "should set any incoming opts" do
+        expect(@server).to receive(:set).with(:x, 1)
+        expect(@server).to receive(:set).with(:y, 2)
+        allow(@server).to receive(:load)
 
-      @server.run("foo", {:x => 1, :y => 2})
-    end
+        @server.run("foo", {:x => 1, :y => 2})
+      end
 
-    it "should turn on script watching if in debug mode" do
-      @app.config[:debug] = true
-      expect(@server).to receive(:watch).with("foo.rb")
-      expect(@server).to receive(:load).with("foo.rb")
+      it "should turn on script watching if in debug mode" do
+        @app.config[:debug] = true
+        expect(@server).to receive(:watch).with("foo.rb")
+        expect(@server).to receive(:load).with("foo.rb")
 
-      @server.run("foo.rb")
-    end
+        @server.run("foo.rb")
+      end
 
-    it "should load the script" do
-      expect(@server).to receive(:load).with("foo.rb")
-      @server.run("foo.rb")
+      it "should load the script" do
+        expect(@server).to receive(:load).with("foo.rb")
+        @server.run("foo.rb")
+      end
     end
   end
-
 end

data/spec/rendering/base_spec.rb

@@ -10,7 +10,7 @@ describe Gopher::Rendering::Base do
     @ctx.text("line 2")
     expect(@ctx.result).to eq("line 1\r\nline 2\r\n")
   end
-
+  
   it "should add breaks correctly" do
     @ctx.spacing 2
     @ctx.text("line 1")
@@ -18,6 +18,13 @@ describe Gopher::Rendering::Base do
     expect(@ctx.result).to eq("line 1\r\n\r\nline 2\r\n\r\n")
   end
 
+  it "should add extra period to lines beginning with period" do
+    @ctx.text("line 1")
+    @ctx.text(".")
+    @ctx.text("line 2")
+    expect(@ctx.result).to eq("line 1\r\n..\r\nline 2\r\n")
+  end
+  
   it "br outputs a bunch of newlines" do
     expect(@ctx.br(2)).to eq("\r\n\r\n")
   end
@@ -60,7 +67,12 @@ describe Gopher::Rendering::Base do
   describe "block" do
     it "wraps text" do
       expect(@ctx).to receive(:text).twice.with "a"
-      @ctx.block("a a",1)
+      @ctx.block("a a", 1)
+    end
+
+    it "handles stray period" do
+      @ctx.block("a a .", 1)
+      expect(@ctx.result).to eq("a\r\na\r\n..\r\n")
     end
   end
 end

data/spec/rendering/menu_spec.rb

@@ -54,9 +54,25 @@ describe Gopher::Rendering::Menu do
   end
 
   describe "link" do
-    it "should get type with determine_type" do
-      expect(@ctx).to receive(:determine_type).with("foo.txt").and_return("A")
-      expect(@ctx.link("FILE", "foo.txt")).to eq("AFILE\tfoo.txt\thost\t1234\r\n")
+    context "with filepath" do
+      it "should get type with determine_type" do
+        expect(@ctx).to receive(:determine_type).with("foo.txt").and_return("A")
+        expect(@ctx.link("FILE", "thing", "external-server.com", 70, "foo.txt")).to eq("AFILE\tthing\texternal-server.com\t70\r\n")
+      end
+    end
+
+    context "without filepath" do
+      it "should get type with determine_type" do
+        expect(@ctx).to receive(:determine_type).with("foo.txt").and_return("A")
+        expect(@ctx.link("FILE", "foo.txt")).to eq("AFILE\tfoo.txt\thost\t1234\r\n")
+      end
+    end
+    
+  end
+
+  describe "text_link" do
+    it "should work" do
+      expect(@ctx.text_link("text link", "/files/foo.txt")).to eq("0text link\t/files/foo.txt\thost\t1234\r\n")
     end
   end
 

data/spec/request_spec.rb

@@ -32,4 +32,10 @@ describe Gopher::Request do
     request = Gopher::Request.new("x" * 255, "bar")
     expect(request.valid?).to eq(false)
   end
+
+  it 'detects urls' do
+    request = Gopher::Request.new("URL:http://github.com/muffinista/gopher2000")
+    expect(request).to be_url
+    expect(request.url).to eql('http://github.com/muffinista/gopher2000')
+  end
 end