server.rb 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d86d66d6dd85fd989a0c7cea5e0a89003da4f93c5bbb90e8e59cb24aa92a4273
-  data.tar.gz: 22d12221ead684c5897cd9138502370852d4869f47a965d0b4678648924baa64
+  metadata.gz: d6f5a23f88fe1b283e2b5004394f493a588060e653a28f72840ff5a194108d41
+  data.tar.gz: 479b0da5bf427fd73ef5ade931b713f342dc5be8d0e5409d12041b323e3c3c43
 SHA512:
-  metadata.gz: ba7756e35e925bb88b6dbd82d75ad098a349b0f27fb823a766650d5683df8bc4893cc6017da46458140d059ab6e0e683b34486ff4880da2546c9e41f4f77e8c6
-  data.tar.gz: 5fee378893a5c0f1c8984f396e2cda243f4fa24d866f2a6b0fe58dfb1db34b160320140cdc08a73196e52b6319317fae0e201290940c1294e9913e1547b50fd9
+  metadata.gz: 213694f2d265096664eaee7e7eab3f75f95fa361155e7c2671118dd02768f41bd9d1dab1d77eb320deb9c584c904207ee57025b7446bf8657bbde68f596c1620
+  data.tar.gz: c2182a37c1af04a2cac3e9826e3d70a145810dd9f2fb8d76a6a52a5b1ecdfcae2c9f4d87ee72bf39aa3284a3fb9c9d09ed47cf9f8b60b377b2daf7fa39b426de

data/lib/server/index_resolver.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+##
+# {Server::IndexResolver Server::IndexResolver} is a
+# middleware that serves the contents of index.html
+# from a given directory
+class Server::IndexResolver
+  def initialize(app, options = {})
+    @app = app
+    @root = options.fetch(:root)
+  end
+
+  def call(env)
+    index = File.join(root, File.expand_path(env["PATH_INFO"]), "index.html")
+    if File.exist?(index)
+      Rack::Response[
+        200,
+        {"content-type" => "text/html"},
+        File.read(index).each_line
+      ].finish
+    else
+      @app.call(env)
+    end
+  end
+
+  private
+  attr_reader :root
+end

data/lib/server/version.rb

@@ -1,3 +1,3 @@
 class Server
-  VERSION = "0.2.2"
+  VERSION = "0.4.0"
 end

data/lib/server.rb

@@ -3,34 +3,39 @@
 class Server
   require "rack"
   require_relative "server/puma"
-  require_relative "server/gzip"
-  require_relative "server/etag"
-  require_relative "server/dir"
+  require_relative "server/index_resolver"
 
   ##
-  # @param [String] path
-  #  The path to a directory.
-  #
+  # @param [String] root
+  #  The path to a directory
   # @return [Rack::Builder]
-  #  Returns a Rack app.
-  def self.app(path)
+  #  Returns a Rack app
+  def self.app(root)
     Rack::Builder.app do
-      use Server::ETag
-      run Server::Dir.new(path)
+      use IndexResolver, {root:}
+      use Rack::Deflater
+      run Rack::Files.new(root)
     end
   end
-  private_class_method :app
 
   ##
   # @param [String] path
   #  The path to a directory
-  #
   # @param [Hash] options
   #  Hash of options
-  #
   # @return [Server]
   #  Returns an instance of {Server Server}
   def self.for(path, options = {})
+    new app(path), prepare(options)
+  end
+
+  ##
+  # Prepares options for {Server#initialize Server#initialize}
+  # @param [#to_h] options
+  # @return [Hash]
+  #  Returns a Hash object
+  def self.prepare(options)
+    options = options.to_h.dup
     host = options.delete(:host)  ||
            options.delete("host") ||
            options.delete(:bind)  ||
@@ -42,10 +47,12 @@ class Server
     unix = options.delete(:unix)  ||
            options.delete("unix") ||
            nil
-    new app(path), options.merge!(
+    options.merge!(
       binds: [unix ? "unix://#{unix}" : "tcp://#{host}:#{port}"]
     )
+    options
   end
+
   class << self
     alias_method :dir, :for
   end
@@ -53,10 +60,8 @@ class Server
   ##
   # @param [Rack::Builder] app
   #  Rack application
-  #
   # @param [Hash] options
   #  Hash of options
-  #
   # @return [Server]
   #  Returns an instance of {Server Server}
   def initialize(app, options = {})
@@ -68,10 +73,8 @@ class Server
 
   ##
   # Starts the web server
-  #
   # @param [Boolean] block
   #  When given as true, this method will block
-  #
   # @return [Thread]
   #  Returns a thread
   def start(block: false)
@@ -82,7 +85,6 @@ class Server
 
   ##
   # Stops the web server
-  #
   # @return [void]
   def stop
     @server.stop

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: server.rb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-04 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -88,9 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/server.rb
-- lib/server/dir.rb
-- lib/server/etag.rb
-- lib/server/gzip.rb
+- lib/server/index_resolver.rb
 - lib/server/puma.rb
 - lib/server/version.rb
 homepage: https://github.com/0x1eef/server.rb#readme
@@ -112,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.13
 signing_key:
 specification_version: 4
 summary: A static file web server

data/lib/server/dir.rb

@@ -1,52 +0,0 @@
-# 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

@@ -1,31 +0,0 @@
-# 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

@@ -1,33 +0,0 @@
-# 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