above 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06f99a9ac81e345a4b7298476432e22a3ea0fb3d74b83009e5635037355f6f8a
-  data.tar.gz: 7dac2bef090f98497ba0a99e59c6cabe456e2758ec7e979e8eb91a337523f959
+  metadata.gz: 5612c5bffd82fc8913a314d9ffdcc68b1b0a77a13e0f1f70d1dc6d61462871e1
+  data.tar.gz: 5709b06bf8110367155de64452425176147987130b81c3e3e7c63380faeac750
 SHA512:
-  metadata.gz: d60ef771694f50e5791b8aa3a62f01f46531accabbfbcbc7df9dba0df9a09951738dccd1530c145ff470a2736c7392d51a926b2b523a1dc5669bcd30270fbbfc
-  data.tar.gz: af53e6beffc417e0ce830bee4f80dbd5f1e9d517fad26416d9cf8fe231a83ca6faa927b12fe63437fa5430c56ccc4ba38da910c87526183de5353db0159818d2
+  metadata.gz: 8daeed7a7d3d08adc4106fb0d0cebdb5a35e368e52909188cbba6d41ae5ec9048e337c0f35ef7b1c158e91e6fc926e5c1d6652582a5a0e0dac37db414d7dd20c
+  data.tar.gz: abd5f52d807b0734ff31b9228977b98c30e153fa43f6414c429ef75d0b0e9487ab85709177b5ffbf081d0f0b87c166b11624059f0430bf0aa2b9a5e8f5253c06

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Above Changelog
 
+## 0.4.0 - 6 September 2024
+
+- breaking change - add ip address as a separate config value for the TCP listener
+- add a Docker example
+- refactor Config from a class to a module
+- reconfigure Standard
+- dependency updates, remove reek, add logger explicitly (leaving the standard library in 3.4)
+
 ## 0.3.0 - 27 August 2024
 
 - minor refactor, but includes the link to the repo from the Gemspec (sigh)

data/README.md

@@ -1,44 +1,5 @@
 # Above
 
-An async Gemini Protocol server with support for multi-tenancy. Above supports middleware, with default middleware for blocking, naive in-memory caching, logging, redirects, & a static file server included. Also included are utilities for certificate creation & DNS-based authentication (DANE).
+This gem is no longer maintained. Please see [mikekreuzer.com][mikekreuzer.com] for my more recent work.
 
-## Status
-
-3 - Alpha in Python terms.
-
-(Those Python statuses are 1 - Planning, 2 - Pre-alpha, 3 - Alpha, 4 - Beta, 5 - Production/Stable, 6 - Mature, 7 - Inactive.)
-
-Currently not handled:
-- user input or client certificates
-- proxy requests to other domains or protocols
-- anything not quite in the standard. Maybe...
-
-## Why
-
-I've read that the heyday of the Gemini Protocol's passed. I don't know, even if it has passed it's still an interesting take on fixing some of what ails the web. If only to delve into the depths of TCP & TLS, & to appreciate again the wonders of HTTP.
-
-None of the other Gemini servers I looked at offered quite the same mix of features as Above in quite the same way. So here we are.
-
-## Installation
-
-`gem install above`
-
-## Usage
-
-...
-
-## Development
-
-After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
-
-To install this gem locally, run `bundle exec rake local`.
-
-`bundle exec rake -T` to see the current options.
-
-## Contributing
-
-Bug reports and pull requests are welcome at https://codeberg.org/kreuzer/above. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://codeberg.org/kreuzer/above/src/branch/main/CODE_OF_CONDUCT.md).
-
-## Code of Conduct
-
-Everyone interacting in the Above project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://codeberg.org/kreuzer/above/src/branch/main/CODE_OF_CONDUCT.md).
+[mikekreuzer.com]: https://mikekreuzer.com

data/bin/above

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
 
-require 'bundler/setup'
-require 'above/cli'
+require "bundler"
+require "bundler/setup"
+require "above/cli"
 
 Above::CLI.new.start

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'above'
+require "bundler/setup"
+require "above"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'above'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start

data/lib/above/cli.rb

@@ -4,6 +4,7 @@ require "optparse"
 require_relative "certs"
 require_relative "config"
 require_relative "server"
+require_relative "version"
 
 module Above
   # CLI handled by optparse
@@ -75,8 +76,9 @@ module Above
     def start_server
       return unless @options[:server]
       dir = @options[:dir]
-      config = Above::Config.new.read_config(dir:)
-      config.each_pair do |server_name, server_hash|
+      Above::Config.init_dir unless dir
+      domains = Above::Config.read_config(dir:)
+      domains.each_pair do |server_name, server_hash|
         puts "Starting #{server_name}"
         server = Above::Server.new(config: server_hash)
         server.start

data/lib/above/config.rb

@@ -7,21 +7,20 @@ require_relative "utils"
 
 module Above
   # Persist & use configuration
-  class Config
-    attr_reader :domains
-
-    def self.config_dir
+  module Config
+    def config_dir
       File.join(Utils.home_dir, ".config/above")
     end
 
-    def self.domains_dir
+    def domains_dir
       File.join(Config.config_dir, "domains")
     end
 
-    def self.exemplar
+    def exemplar
       {
         "server" => {
           "domain" => "localhost",
+          "ip" => "0.0.0.0",
           "max_fibers" => 20,
           "port" => 1965,
           "tls_cert" => "/home/above/localhost.crt",
@@ -56,12 +55,8 @@ module Above
       }
     end
 
-    def initialize
-      init_dir
-    end
-
     def init_dir
-      if !File.exist?(Config.domains_dir)
+      unless File.exist?(Config.domains_dir)
         FileUtils.mkdir_p(Config.domains_dir)
         File.write(File.join(Config.config_dir, "example.yml"), Config.exemplar.to_yaml)
         puts "Configuration directory created"
@@ -74,7 +69,7 @@ module Above
 
     def read_config(dir: nil)
       dir ||= Config.domains_dir
-      files = Dir[File.join(dir, "**/*.yml")]
+      files = Dir[File.join(dir, "*.yml")] # not subfolders
       domains = {}
       files.each do |file|
         hash = YAML.safe_load_file(file, permitted_classes: [Hash])
@@ -89,5 +84,7 @@ module Above
       end
       domains
     end
+
+    module_function :config_dir, :domains_dir, :exemplar, :init_dir, :read_config
   end
 end

data/lib/above/middleware/log.rb

@@ -60,7 +60,7 @@ module Above
       end
 
       def write(msg)
-        # Standard library logger doesn't support write but it supports << which actually
+        # Standard library logger (to be removed in 3.4) doesn't support write but it supports << which actually
         # calls to write on the log device without formatting
         if @logger.respond_to?(:write)
           @logger.write(msg)

data/lib/above/server.rb

@@ -45,7 +45,7 @@ module Above
       end
     end
 
-    # Instantiate each middleware class with an app vairable pointing to the
+    # Instantiate each middleware class with an app variable pointing to the
     # next piece of middleware to call
     def middleware_init(middleware:)
       @middleware = []
@@ -128,7 +128,7 @@ module Above
     end
 
     def tls_server
-      tcp_server = TCPServer.new(@server_config["domain"], @server_config["port"])
+      tcp_server = TCPServer.new(@server_config["ip"], @server_config["port"])
       ssl_ctx = OpenSSL::SSL::SSLContext.new.tap do |ctx|
         ctx.key = OpenSSL::PKey::EC.new(
           File.read(

data/lib/above/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Above
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: above
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Kreuzer
@@ -35,7 +35,7 @@ cert_chain:
   YgqTixCwts6cQYIdYNFtJbzKvRNqyviKKxPaum7UWAv6Uy80gxgJ8p+fG81FsxbZ
   0ULnXrHlhf/CHs550TxRlXalgxBCImGdHzWjhdJeC1dZP3olgNtjO23ywtw=
   -----END CERTIFICATE-----
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -51,6 +51,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: marcel
   requirement: !ruby/object:Gem::Requirement
@@ -79,10 +99,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-description: |
-  An async Gemini Protocol server with support for multi-tenancy.
+description: 'This gem is no longer maintained. Please see mikekreuzer.com for my
+  more recent work.
 
-  Above supports middleware, with default middleware for blocking, naive in-memory caching, logging, redirects, & a static file server included. Also included are utilities for certificate creation & DNS-based authentication (DANE).
+  '
 email:
 - mike@mikekreuzer.com
 executables:
@@ -136,5 +156,6 @@ requirements: []
 rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
-summary: A Gemini Protocol server
+summary: This gem is no longer maintained. Please see mikekreuzer.com for my more
+  recent work.
 test_files: []