gopher 0.5.1 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b61e25f16a3e9ce60e827a065bfdd71345856b6f0eda25852b90d4d2d9186163
+  data.tar.gz: f297cf6b2f0b6198ef0e8bc0f3b19f78c92bcd3ca477b0b61013b4d699c49cee
+SHA512:
+  metadata.gz: 2bd00e1620cd8ad3cc5ef3a6a885bad5ac6b9ca8809ee308031dbc5bfad68f99d48c688712254d4e4e191913e3791cb6cd958bb093ca3d62a7c66853e30a0369
+  data.tar.gz: a6a9ad35dd09825214acf723eb572f8e3539ff3fe94335c9497a9069a611f3d501886e3e910b6a41fc1eb56c5127acc6c56a920bcd468f41f07159298c35ae6f

data/LICENSE

@@ -0,0 +1,5 @@
+Copyright 2009 umeldt
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README

@@ -0,0 +1,34 @@
+# gopher
+
+a gopher server and a simple DSL for setting up servers
+
+## installation
+
+```bash
+gem install foobar
+```
+
+## usage
+
+set up a server using ruby
+```ruby
+gopher = Gopher.application do
+  host '0.0.0.0'
+  port 70
+
+  text '/time' do
+    line Time.now.to_s
+  end
+
+  mount '/', '/srv/gopher'
+end
+```
+
+serve the current directory over gopher
+```bash
+gopher -p 70 -a 127.0.0.1
+```
+
+## license
+[ISC](https://choosealicense.com/licenses/isc/)
+

data/bin/gopher

@@ -3,12 +3,28 @@
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'gopher'
+require 'optparse'
 
-Gopher.application do
-  host '0.0.0.0'
-  port 70
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "usage: gopher [options]"
+
+  opts.on("-a=ADDRESS", "bind to address") { |v| options[:address] = v }
+  opts.on("-p=PORT", "port") { |v| options[:port] = v }
+end.parse!
+
+gopher = Gopher.application do
+  host options[:address] || '0.0.0.0'
+  port options[:port] || 70
 
   mount '/', '.'
 end
 
-Gopher.run
+begin
+  STDERR.puts "Launching gopher server on #{gopher.host}:#{gopher.port}"
+  Gopher.run
+rescue SystemExit, Interrupt
+  STDERR.puts "Stopping server"
+  Gopher.stop
+end
+

data/lib/ext/module.rb~

@@ -0,0 +1,14 @@
+class Module
+  def dsl_accessor(*accessors)
+    accessors.each do |accessor|
+      class_eval %{
+        attr_writer :#{accessor}
+
+        def #{accessor}(value=nil)
+          send "#{accessor}=", value if value
+          @#{accessor}
+        end
+      }
+    end
+  end
+end

data/lib/gopher.rb

@@ -1,14 +1,12 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'ext/object'
-require 'ext/module'
+require 'yaml'
 
 require 'textwrap'
-require 'yaml'
 require 'eventmachine'
 
+require_relative 'ext/module'
+
 module Gopher
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 
   class Application
     dsl_accessor :host, :port
@@ -26,15 +24,18 @@ module Gopher
     end
 
     def mount(selector, path)
-      add_handler "#{selector}/?(.*)", DirectoryHandler.new(path, selector).with(self)
+      add_handler "#{selector}/?(.*)",
+        DirectoryHandler.new(path, selector).with(self)
     end
 
     def map(selector, &block)
-      add_handler selector.gsub(/:(.+)/, '(.+)'), MapHandler.new(&block).with(self)
+      add_handler selector.gsub(/:(.+)/, '(.+)'),
+        MapHandler.new(&block).with(self)
     end
 
     def text(selector, &block)
-      add_handler selector.gsub(/:(.+)/, '(.+)'), TextHandler.new(&block).with(self)
+      add_handler selector.gsub(/:(.+)/, '(.+)'),
+        TextHandler.new(&block).with(self)
     end
 
     def helpers(&block)
@@ -42,9 +43,10 @@ module Gopher
       TextContext.class_eval(&block)
     end
 
-    def application(selector, handler)
+    def app(selector, handler)
       add_handler selector, handler
     end
+    alias_method :application, :app
 
     def request(selector)
       handler, *args = lookup(selector)
@@ -71,15 +73,15 @@ module Gopher
   end
 
   class Handler
-    attr_accessor :application
+    attr_accessor :app
 
-    def with(application)
-      @application = application
+    def with(app)
+      @app = app
       self
     end
 
-    def host; application.respond_to?(:host) ? application.host : '0.0.0.0' end
-    def port; application.respond_to?(:port) ? application.port : 70 end
+    def host; app.respond_to?(:host) ? app.host : '0.0.0.0' end
+    def port; app.respond_to?(:port) ? app.port : 70 end
 
     def call(*args); end
   end
@@ -125,9 +127,9 @@ module Gopher
     def call(*args)
       path = File.join(base, *args)
       if File.directory? path
-        return DirectoryHandler.new(path, File.join(selector, args)).with(application).to_map
+        DirectoryHandler.new(path, File.join(selector, args)).with(app).to_map
       elsif File.file? path
-        return File.open(path)
+        File.open(path)
       else
         raise NotFound
       end
@@ -195,7 +197,7 @@ module Gopher
       new(host, port).instance_exec(*args, &block)
     end
 
-    def line(type, txt, selector, host = host, port = port)
+    def line(type, txt, selector, host = self.host, port = self.port)
       result << ["#{type}#{txt}", selector, host, port].join("\t")
       result << "\r\n"
     end
@@ -245,12 +247,12 @@ module Gopher
   end
 
   class Connection < EM::Connection
-    attr_accessor :application
+    attr_accessor :app
 
     def receive_data(data)
       begin
         raise InvalidRequest if data.length > 255
-        response = application.request(data)        
+        response = app.request(data)        
         case response
         when String then send_data(response)
         when StringIO then send_data(response.read)
@@ -270,29 +272,38 @@ module Gopher
     end
   end
 
-  def self.application(&block)
-    @application = Application.new(&block)
-  end
+  class <<self
+    def app(&block)
+      @app = Application.new(&block)
+    end
+    alias_method :application, :app
 
-  def self.reload(*files)
-    @last_reload = Time.now
-    @reloadables = files
-  end
+    def reload(*files)
+      @last_reload = Time.now
+      @reloadables = files
+    end
 
-  def self.reloadables
-    @reloadables ||= []
-  end
+    def reloadables
+      @reloadables ||= []
+    end
 
-  def self.run
-    return if EM.reactor_running?
-    EM.run do
-      EM.start_server(@application.host, @application.port, Gopher::Connection) do |c|
-        c.application = @application
-        reloadables.each do |f|
-          load f if File.mtime(f) > @last_reload
-        end
-        @last_reload = Time.now
-      end        
+    def run
+      return if EM.reactor_running?
+      EM.run do
+        EM.start_server(@app.host, @app.port, Gopher::Connection) do |c|
+          c.app = @app
+          reloadables.each do |f|
+            load f if File.mtime(f) > @last_reload
+          end
+          @last_reload = Time.now
+        end        
+      end
+    end
+
+    def stop
+      return unless EM.reactor_running?
+      EM.stop_server
     end
   end
 end
+

data/lib/gopher.rb~

@@ -0,0 +1,297 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'ext/module'
+
+require 'yaml'
+require 'textwrap'
+require 'eventmachine'
+
+module Gopher
+  VERSION = '0.5.2'
+
+  class Application
+    dsl_accessor :host, :port
+    attr_accessor :selectors, :root
+
+    def initialize(&block)
+      reset!
+      self.instance_eval(&block)
+    end
+
+    def reload(*f); Gopher.reload(*f) end
+
+    def use(mod)
+      extend(mod)
+    end
+
+    def mount(selector, path)
+      add_handler "#{selector}/?(.*)", DirectoryHandler.new(path, selector).with(self)
+    end
+
+    def map(selector, &block)
+      add_handler selector.gsub(/:(.+)/, '(.+)'), MapHandler.new(&block).with(self)
+    end
+
+    def text(selector, &block)
+      add_handler selector.gsub(/:(.+)/, '(.+)'), TextHandler.new(&block).with(self)
+    end
+
+    def helpers(&block)
+      MapContext.class_eval(&block)
+      TextContext.class_eval(&block)
+    end
+
+    def application(selector, handler)
+      add_handler selector, handler
+    end
+
+    def request(selector)
+      handler, *args = lookup(selector)
+      handler.call(*args)
+    end
+
+    def lookup(selector)
+      selectors.find do |k, v|
+        return v, *$~[1..-1] if k =~ Gopher.sanitize_selector(selector)
+      end
+      raise NotFound
+    end
+
+    def add_handler(selector, handler)
+      selector = Gopher.sanitize_selector(selector)
+      selector.sub!(/^\/*/, '')
+      selectors[/^\/?#{selector}$/] = handler
+    end
+
+    private
+    def reset!
+      @selectors = {}
+    end
+  end
+
+  class Handler
+    attr_accessor :application
+
+    def with(application)
+      @application = application
+      self
+    end
+
+    def host; application.respond_to?(:host) ? application.host : '0.0.0.0' end
+    def port; application.respond_to?(:port) ? application.port : 70 end
+
+    def call(*args); end
+  end
+
+  class MapHandler < Handler
+    attr_accessor :block, :result
+
+    def initialize(&block)
+      @block = block
+    end
+
+    def call(*args)
+      context = MapContext.new(host, port)
+      context.instance_exec(*args, &block)
+      context.result
+    end
+  end
+
+  class TextHandler < Handler
+    attr_accessor :block, :result
+
+    def initialize(&block)
+      @block = block
+    end
+
+    def call(*args)
+      context = TextContext.new
+      context.instance_exec(*args, &block)
+      context.result
+    end
+  end
+
+  class DirectoryHandler < Handler
+    attr_accessor :base, :selector, :index
+
+    def initialize(path, selector = '')
+      raise DirectoryNotFound unless File.directory? path
+      @selector = selector
+      @base = File.expand_path(path)
+      @index = YAML.load_file(index_file) if File.exist?(index_file)
+    end
+
+    def call(*args)
+      path = File.join(base, *args)
+      if File.directory? path
+        return DirectoryHandler.new(path, File.join(selector, args)).with(application).to_map
+      elsif File.file? path
+        return File.open(path)
+      else
+        raise NotFound
+      end
+    end
+
+    def to_map
+      MapContext.with_block(host, port, self) do |handler|
+        if handler.index
+          paragraph handler.index['description']
+          handler.index['entries'].each do |txt, path|
+            link txt, File.join(handler.selector, path)
+          end
+        else
+          Dir["#{handler.base}/*"].each do |path|
+            basename = File.basename(path)
+            if File.directory? path
+              map basename, File.join(handler.selector, basename)
+            else
+              link basename, File.join(handler.selector, basename)
+            end
+          end
+        end
+        text Time.now
+      end
+    end
+
+    private
+    def index_file
+      File.join(base, '.gopher')
+    end
+  end
+
+  class TextContext
+    attr_accessor :result
+
+    def line(text)
+      result << text
+      result << "\r\n"
+    end
+
+    def text(text)
+      line text
+    end
+
+    def paragraph(txt, width=70)
+      txt.each_line do |line|
+        Textwrap.wrap(line, width).each { |chunk| text chunk }
+      end
+    end
+
+    def initialize
+      @result = ""
+    end
+  end
+
+  class MapContext
+    attr_accessor :host, :port, :result
+
+    def initialize(host, port)
+      @host, @port = host, port
+      @result = ""
+    end
+
+    def self.with_block(host, port, *args, &block)
+      new(host, port).instance_exec(*args, &block)
+    end
+
+    def line(type, txt, selector, host = self.host, port = self.port)
+      result << ["#{type}#{txt}", selector, host, port].join("\t")
+      result << "\r\n"
+    end
+
+    def link(text, selector, *args)
+      type = Gopher.determine_type(selector)
+      line type, text, scrub(selector), *args
+    end
+
+    def map(text, selector, *args)
+      line '1', text, scrub(selector), *args
+    end
+    
+    def text(text)
+      line 'i', text, 'false', '(NULL)', 0
+    end
+
+    def paragraph(txt, width=70)
+      txt.each_line do |line|
+        Textwrap.wrap(line, width).each { |chunk| text chunk }
+      end
+    end
+
+    private
+    def scrub(s)
+      "/#{s.sub(/^\/+/,'')}"
+    end
+  end
+
+  class GopherError < StandardError; end
+  class DirectoryNotFound < GopherError; end
+  class NotFound < GopherError; end
+  class InvalidRequest < GopherError; end
+
+  def self.sanitize_selector(selector)
+    selector = selector.dup
+    selector.strip!
+    selector.gsub!(/\.+/, '.')
+    selector
+  end
+  def self.determine_type(selector)
+    case File.extname(selector).downcase
+    when '.jpg', '.png' then 'I'
+    when '.mp3' then 's'
+    else '0'
+    end
+  end
+
+  class Connection < EM::Connection
+    attr_accessor :application
+
+    def receive_data(data)
+      begin
+        raise InvalidRequest if data.length > 255
+        response = application.request(data)        
+        case response
+        when String then send_data(response)
+        when StringIO then send_data(response.read)
+        when File
+          while chunk = response.read(8192) do
+            send_data(chunk)
+          end
+        end
+        close_connection_after_writing
+      rescue Gopher::NotFound
+        send_data "not found"
+        close_connection_after_writing
+      rescue => e
+        close_connection
+        raise e
+      end
+    end
+  end
+
+  def self.application(&block)
+    @application = Application.new(&block)
+  end
+
+  def self.reload(*files)
+    @last_reload = Time.now
+    @reloadables = files
+  end
+
+  def self.reloadables
+    @reloadables ||= []
+  end
+
+  def self.run
+    return if EM.reactor_running?
+    EM.run do
+      EM.start_server(@application.host, @application.port, Gopher::Connection) do |c|
+        c.application = @application
+        reloadables.each do |f|
+          load f if File.mtime(f) > @last_reload
+        end
+        @last_reload = Time.now
+      end        
+    end
+  end
+end

metadata

@@ -1,69 +1,101 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gopher
-version: !ruby/object:Gem::Version 
-  version: 0.5.1
+version: !ruby/object:Gem::Version
+  version: 0.6.0
 platform: ruby
-authors: 
-- raspberry lemon
+authors:
+- umeldt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2008-05-22 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
-description: 
-email: lemon@raspberry-style.net
-executables: 
+date: 2019-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: textwrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+description: ''
+email: chris@svindseth.jp
+executables:
 - gopher
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- LICENSE
+- README
 - bin/gopher
-- lib/ext
 - lib/ext/module.rb
-- lib/ext/object.rb
-- lib/gopher
+- lib/ext/module.rb~
+- lib/gopher.rb
+- lib/gopher.rb~
 - lib/gopher/redirect.erb
 - lib/gopher/redirect.rb
-- lib/gopher.rb
-- spec/application_spec.rb
-- spec/ext_spec.rb
-- spec/gopher_spec.rb
-- spec/handler_spec.rb
-- spec/sandbox
-- spec/sandbox/indexed
-- spec/sandbox/indexed/cake.txt
-- spec/sandbox/recipe.txt
-- spec/spec_helper.rb
-has_rdoc: false
-homepage: http://raspberry-style.net/
+homepage: https://svindseth.jp/gopher
+licenses:
+- ISC
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+- bin
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.1.1
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 2
+specification_version: 4
 summary: gopher server and dsl
 test_files: []
-

data/lib/ext/object.rb

@@ -1,17 +0,0 @@
-# instance_exec for 1.8
-# Grabbed from Mauricio Fernandez (thanks!)
-# For more information, see http://eigenclass.org/hiki.rb?instance_exec
-class Object
-  module InstanceExecHelper; end
-  include InstanceExecHelper
-  def instance_exec(*args, &block) # !> method redefined; discarding old instance_exec
-    mname = "__instance_exec_#{Thread.current.object_id.abs}_#{object_id.abs}"
-    InstanceExecHelper.module_eval{ define_method(mname, &block) }
-    begin
-      ret = send(mname, *args)
-    ensure
-      InstanceExecHelper.module_eval{ undef_method(mname) } rescue nil
-    end
-    ret
-  end
-end

data/spec/application_spec.rb

@@ -1,42 +0,0 @@
-require File.join(File.dirname(__FILE__), '/spec_helper')
-
-describe Gopher::Application do
-  before(:all) do
-    @app = Gopher::Application.new do
-      host 'pha.hk'
-      port 7000
-
-      helpers do
-        def ruler
-          text ("=-" * 40)
-        end
-      end
-
-      mount 'documents', File.dirname(__FILE__)
-    end
-  end
-
-  it 'should set the host' do
-    @app.host.should == 'pha.hk'
-  end
-
-  it 'should set the port' do
-    @app.port.should == 7000
-  end
-
-  it 'should mount directories' do
-    @app.lookup('/documents').should be_instance_of(Array)
-  end
-
-  it 'should route properly to directories and their children' do
-    @app.lookup('/documents/tasty').should include("tasty")
-  end
-
-  it 'should sanitize lookups' do
-    @app.lookup('/documents/.././tasty...html').should include("././tasty.html")
-  end
-
-  it 'should add helpers' do
-    Gopher::MapContext.public_instance_methods.should include('ruler')
-  end
-end

data/spec/ext_spec.rb

@@ -1 +0,0 @@
-require File.join(File.dirname(__FILE__), '/spec_helper')

data/spec/gopher_spec.rb

@@ -1 +0,0 @@
-require File.join(File.dirname(__FILE__), '/spec_helper')

data/spec/handler_spec.rb

@@ -1,45 +0,0 @@
-require File.join(File.dirname(__FILE__), '/spec_helper')
-
-describe Gopher::DirectoryHandler do
-  before(:all) do
-    path = File.join(File.dirname(__FILE__), 'sandbox')
-    @handler = Gopher::DirectoryHandler.new(path)
-  end
-
-  it 'should barf on non-existent directories' do
-    proc { Gopher::DirectoryHandler.new(__FILE__) }.should raise_error(Gopher::DirectoryNotFound)
-  end
-
-  it 'should serve files under the directory' do
-    @handler.call('recipe.txt').should be_instance_of(File)
-  end
-
-  it 'should raise a NotFound when files do not exist' do
-    proc { @handler.call('recipe.tx') }.should raise_error(Gopher::NotFound)
-  end
-
-  it 'should serve generated directory maps' do
-    @handler.call('indexed').should include("An indexed directory")
-  end
-
-  it 'should serve directory indexes when applicable' do
-    @handler.call.should include("0recipe.txt\t/recipe.txt\t0.0.0.0\t70\r\n")
-  end
-end
-
-describe Gopher::MapHandler do
-  before(:all) do
-    @handler = Gopher::MapHandler.new do
-      text 'Cake recipes'
-      link 'Image', 'cake.jpg'
-    end
-  end
-
-  it 'should add text' do
-    @handler.call.should include "iCake recipes\tfalse\t(NULL)\t0\r\n"
-  end
-
-  it 'should add links and figure out the types' do
-    @handler.call.should include "IImage\t/cake.jpg\t0.0.0.0\t70\r\n"
-  end
-end

data/spec/spec_helper.rb

@@ -1,2 +0,0 @@
-require File.join(File.dirname(__FILE__), '/../lib/gopher')
-require 'spec'