server.rb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1e9f252405fa8dfefb506be2f364ab0397e219b73de71de64d0b44d3afac915
+  data.tar.gz: 8ea9be708ac06fa1c6828376948f2cd54e2743229dd4bdcf1643765e8fe82ba0
+SHA512:
+  metadata.gz: c591537a32ca5e8f8fb3808df201b68a1f554005f09a2668701a2aab57cb7077a7f3c134916ded8f52c6eeae149142ab8979cd55db014cb79ece01235e48aa20
+  data.tar.gz: 1adc90d672fba8a1e6b57e9dc49aa3b7b90723b17d57304fadf82cee3cc42757ddb01bd1259dbe309cbb54ebf11f15e85625903d89ae1710471d8af778c26e16

data/lib/server/dir.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+##
+# A rack application that serves the contents
+# of a directory over HTTP.
+class Server::Dir
+  prepend Server::Gzip
+
+  def initialize(root)
+    @root = File.realpath(root)
+    @mime_types = {".ttf" => "font/ttf"}.freeze
+  end
+
+  def call(env)
+    catch(:redirect) { finish Rack::Request.new(env) }
+  rescue Errno::EPERM, Errno::EACCES
+    body = "Permission denied"
+    [403, {"content-length" => body.bytesize, "content-type" => "text/plain"}, [body]]
+  rescue Errno::ENOENT
+    body = "The requested URL was not found"
+    [404, {"content-length" => body.bytesize, "content-type" => "text/plain"}, [body]]
+  rescue => ex
+    body = "Internal server error (#{ex.class})"
+    [500, {"content-length" => body.bytesize, "content-type" => "text/plain"}, [body]]
+  end
+
+  def finish(req)
+    path = resolve_path(req)
+    body = File.binread(path)
+    extn = File.extname(path)
+    [
+      200,
+      {"content-type" => mime_types[extn] || Rack::Mime.mime_type(extn),
+       "content-length" => body.bytesize},
+      body.each_line.to_a
+    ]
+  end
+
+  private
+
+  attr_reader :root, :mime_types
+
+  def resolve_path(req)
+    path = File.join root, File.expand_path(req.path)
+    return path unless File.directory?(path)
+    if req.path.end_with?("/")
+      File.join(path, "index.html")
+    else
+      throw(:redirect, [301, {"Location" => "#{req.path}/"}, [""]])
+    end
+  end
+end

data/lib/server/etag.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+##
+# A middleware that adds ETag support.
+class Server::ETag < Rack::ETag
+  ETAGS = {}
+
+  ##
+  # @param [#call] app
+  #  A rack app.
+  #
+  # @return [Server::ETag]
+  #  Reurns an instance of {Server::ETag Server::ETag}.
+  def initialize(app)
+    @app = app
+  end
+
+  ##
+  # @param [Hash] env
+  #  An environment hash.
+  #
+  # @return [Array<Number, Hash, #each>]
+  def call(env)
+    status, headers, body = super(env)
+    if headers["etag"] && headers["etag"] == env["HTTP_IF_NONE_MATCH"]
+      [304, headers, [""]]
+    else
+      [status, headers, body]
+    end
+  end
+end

data/lib/server/gzip.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+##
+# A mixin that serves a compressed copy of a file.
+# Similar to the nginx module
+# [gzip_static](http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html).
+module Server::Gzip
+  def finish(request)
+    path = gzip_path(request)
+    if path
+      body = File.binread(path)
+      extn = File.extname(path[0..-4])
+      [
+        200,
+        {"content-type" => mime_types[extn] || Rack::Mime.mime_type(extn),
+         "content-encoding" => "gzip",
+         "content-length" => body.bytesize},
+        body.each_line
+      ]
+    else
+      super
+    end
+  end
+
+  private
+
+  def gzip_path(request)
+    return unless request.get_header("accept-encoding")
+                        &.include?("gzip")
+    path = "#{find_path(request)}.gz"
+    File.exist?(path) ? path : nil
+  end
+end

data/lib/server/puma.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "puma"
+require "puma/events"
+
+class Puma::Server
+  public :binder
+end

data/lib/server/version.rb

@@ -0,0 +1,3 @@
+class Server
+  VERSION = "0.1.1"
+end

data/lib/server.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+class Server
+  require "rack"
+  require_relative "server/puma"
+  require_relative "server/gzip"
+  require_relative "server/etag"
+  require_relative "server/dir"
+
+  ##
+  # @param [String] path
+  #  The path to a directory.
+  #
+  # @return [Rack::Builder]
+  #  Returns a Rack app.
+  def self.app(path)
+    Rack::Builder.app do
+      use Server::ETag
+      run Server::Dir.new(path)
+    end
+  end
+  private_class_method :app
+
+  ##
+  # @param [String] path
+  #  The path to a directory.
+  #
+  # @param [Hash] options
+  #  A hash of options.
+  #
+  # @return [Server]
+  #  Returns an instance of {Server Server}.
+  def self.dir(path, options = {})
+    host = options.delete(:host) || options.delete("host") || "127.0.0.1"
+    port = options.delete(:port) || options.delete("port") || 3000
+    unix = options.delete(:unix) || options.delete("unix") || nil
+    new app(path), options.merge!(
+      binds: [unix ? "unix://#{unix}" : "tcp://#{host}:#{port}"]
+    )
+  end
+
+  ##
+  # @param [Rack::Builder] app
+  #  A rack app.
+  #
+  # @param [Hash] options
+  #  A hash of options.
+  #
+  # @return [Server]
+  #  Returns an instance of {Server Server}.
+  def initialize(app, options = {})
+    @app = app
+    @options = default_options.merge!(options)
+    @events = Puma::Events.new
+    @server = Puma::Server.new(@app, @events, @options)
+  end
+
+  ##
+  # Starts the web server.
+  #
+  # @param [Boolean] block
+  #  When given as true, this method will block.
+  #
+  # @return [Thread]
+  #  Returns a thread.
+  def start(block: false)
+    @server.binder.parse(@options[:binds])
+    thr = @server.run
+    block ? thr.join : thr
+  end
+
+  ##
+  # Stops the web server.
+  #
+  # @return [void]
+  def stop
+    @server.stop
+  end
+
+  private
+
+  def default_options
+    {
+      min_threads: 1,
+      max_threads: 5,
+      workers: 1
+    }
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: server.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- '0x1eef'
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: A static file web server
+email:
+- 0x1eef@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/server.rb
+- lib/server/dir.rb
+- lib/server/etag.rb
+- lib/server/gzip.rb
+- lib/server/puma.rb
+- lib/server/version.rb
+homepage: https://github.com/0x1eef/server.rb#readme
+licenses:
+- 0BSD
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_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'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A static file web server
+test_files: []