ruby-net-text 0.0.3 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc4467da1a2124222650203e4d1f3bcbf377b2c8178d6d7a9690c1fb0003ac8a
-  data.tar.gz: a04be63fe05981caf42cd4c64f615c06dfd9ee6352b464fa80fadb7dd87b3ecb
+  metadata.gz: de26ac5c1f8127c9d08a5430adc0cff34d266847327c6864baa903b5352ac041
+  data.tar.gz: d2725dab71f60b4d12be9ff0d948ae1a3f1bc6de9858499258aeedc11c801ae0
 SHA512:
-  metadata.gz: ef9cab28b37134208fc2e24563e8f5138ca118d1df47c76e2ac8272dc688ee3f19f5ad6f343a1e08fc3f1359742f999d9216a802ce08d4b4acd213c906bcd5dc
-  data.tar.gz: d142b3651f551721b022746e32c8aee4355075dd0bbd8cdb5e897444d42d695b8576561e6068547e85b435d738f14b449c28c0991c7719d0c0890c4d18ace61f
+  metadata.gz: 79defc399e2b1e1631e153c5994ef1547d0eb9732f0153a641ba9dbf98d35ea03c176723b7bb7052ac08a61b2069eac37e158d04e213dd4c778ecb0c39af00b4
+  data.tar.gz: 050fecb1c2fda499404207e5cb3d49048ff5fcb9695497f35b257dc40c02e3e71ba648ffe575e044a57e282ac43f62590d147c65404005427ae8bfeeb66848d9

data/README.md

@@ -0,0 +1,39 @@
+# Gemini, Gopher, and Finger support for Net::* and URI::*
+
+[![Support using Liberapay](https://img.shields.io/badge/Liberapay-Support_me-yellow?logo=liberapay)](https://liberapay.com/milouse/donate)
+[![Support using Flattr](https://img.shields.io/badge/Flattr-Support_me-brightgreen?logo=flattr)](https://flattr.com/@milouse)
+[![Support using Paypal](https://img.shields.io/badge/Paypal-Support_me-00457C?logo=paypal&labelColor=lightgray)](https://paypal.me/milouse)
+
+[![Gem](https://img.shields.io/gem/v/ruby-net-text)](https://rubygems.org/gems/ruby-net-text)
+[![Documentation](https://img.shields.io/badge/Documentation-ruby--net--text-CC342D?logo=rubygems)](https://www.rubydoc.info/gems/ruby-net-text/Net/Gemini)
+
+This project aims to add connectors to well known internet text protocols
+through the standard `Net::*` and `URI::*` ruby module namespaces.
+
+## Documentation
+
+The code is self-documented and you can browse it on rubydoc.info:
+
+### Gemini
+
+- [URI::Gemini](https://www.rubydoc.info/gems/ruby-net-text/URI/Gemini)
+- [Net::Gemini](https://www.rubydoc.info/gems/ruby-net-text/Net/Gemini)
+
+### Gopher
+
+- [URI::Gopher](https://www.rubydoc.info/gems/ruby-net-text/URI/Gopher)
+- [Net::Gopher](https://www.rubydoc.info/gems/ruby-net-text/Net/Gopher)
+
+### Finger
+
+- [URI::Finger](https://www.rubydoc.info/gems/ruby-net-text/URI/Finger)
+- [Net::Finger](https://www.rubydoc.info/gems/ruby-net-text/Net/Finger)
+
+## Helpers
+
+This repository also includes 2 little helpers:
+
+- `bin/heraut`: a toy client for Gemini, Gopher and Finger. Give it a URI and
+  it will output the remote file.
+- `bin/test_thread.rb`: a toy performance test script to run against a Gemini
+  server

data/lib/net/finger.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../uri/finger'
+require_relative 'generic'
+
+module Net
+  # == A Finger client API for Ruby.
+  #
+  # Net::Finger provides a library which can be used to build Finger
+  # user-agents.
+  #
+  # Net::Finger is designed to work closely with URI.
+  #
+  # == Simple Examples
+  #
+  # All examples assume you have loaded Net::Finger with:
+  #
+  #   require 'net/finger'
+  #
+  # This will also require 'uri' so you don't need to require it
+  # separately.
+  #
+  # The Net::Finger methods in the following section do not persist
+  # connections.
+  #
+  # === GET by URI
+  #
+  #   uri = URI('finger://skyjake.fi/jaakko')
+  #   Net::Finger.get(uri) # => String
+  #
+  class Finger
+    extend TextGeneric
+
+    def self.get(string_or_uri)
+      uri = build_uri string_or_uri, URI::Finger
+      request uri, uri.name.to_s
+    end
+  end
+end

data/lib/net/gemini/gmi_parser.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Gemini
+  # Contains specific method to parse text/gemini documents.
+  module GmiParser
+    private
+
+    def parse_meta
+      header = { status: @status, meta: @meta, mimetype: nil }
+      return header unless body_permitted?
+      mime = { lang: nil, charset: 'utf-8', format: nil }
+      raw_meta = meta.split(';').map(&:strip)
+      header[:mimetype] = raw_meta.shift
+      return header unless raw_meta.any?
+      raw_meta.map { |m| m.split('=') }.each do |opt|
+        key = opt[0].downcase.to_sym
+        next unless mime.has_key? key
+        mime[key] = opt[1].downcase
+      end
+      header.merge(mime)
+    end
+
+    def parse_preformatted_block(line, buf)
+      cur_block = { meta: line[3..].chomp, content: '' }
+      while (line = buf.gets)
+        if line.start_with?('```')
+          @preformatted_blocks << cur_block
+          break
+        end
+        cur_block[:content] += line
+      end
+    end
+
+    def parse_link(line)
+      m = line.strip.match(/\A=>\s*([^\s]+)(?:\s*(.+))?\z/)
+      return if m.nil?
+      begin
+        uri = URI(m[1])
+      rescue URI::InvalidURIError
+        return
+      end
+      uri = @uri.merge(uri) if @uri && uri.is_a?(URI::Generic)
+      @links << { uri: uri, label: m[2]&.chomp }
+    end
+
+    def parse_body
+      buf = StringIO.new(@body)
+      while (line = buf.gets)
+        if line.start_with?('```')
+          parse_preformatted_block(line, buf)
+        elsif line.start_with?('=>')
+          parse_link(line)
+        end
+      end
+    end
+  end
+end

data/lib/net/gemini/reflow_text.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Gemini
+  # Contains specific method to correctly display Gemini texts
+  module ReflowText
+    private
+
+    def reflow_line_cut_index(line)
+      possible_cut = [
+        line.rindex(' ') || 0,
+        line.rindex('­') || 0,
+        line.rindex('-') || 0
+      ].sort
+      possible_cut.reverse!
+      possible_cut[0]
+    end
+
+    def reflow_line_prefix(line)
+      m = line.match(/\A([*#>]+ )/)
+      return '' unless m
+      # Each quote line should begin with the quote mark
+      return m[1] if m[1].start_with?('>')
+      ' ' * m[1].length
+    end
+
+    def reflow_text_line(line, mono_block_open, length)
+      line.strip!
+      if mono_block_open || line.start_with?('=>') || line.length < length
+        return [line]
+      end
+      output = []
+      prefix = reflow_line_prefix(line)
+      while line.length > length
+        cut_line = line[0...length]
+        cut_index = reflow_line_cut_index(cut_line)
+        break if cut_index.zero? # Better do nothing for now
+        output << line[0...cut_index]
+        line = prefix + line[cut_index + 1..]
+      end
+      output << line
+    end
+
+    def reformat_body(length)
+      unless length.is_a? Integer
+        raise ArgumentError, "Length must be Integer, #{length} given"
+      end
+      return @body if length.zero?
+      new_body = []
+      mono_block_open = false
+      buf = StringIO.new(@body)
+      while (line = buf.gets)
+        if line.start_with?('```')
+          mono_block_open = !mono_block_open
+          # Don't include code block toggle lines
+          next
+        end
+        new_body += reflow_text_line(line, mono_block_open, length)
+      end
+      new_body.join("\n")
+    end
+  end
+end

data/lib/net/gemini/request.rb

@@ -42,7 +42,7 @@ module Net
         # - 2 bytes for <CR><LF>
         str = sock.gets($INPUT_RECORD_SEPARATOR, 1026)
         m = /\A(.*)\r\n\z/.match(str)
-        raise GeminiBadRequest, "Malformed request: #{str.dump}" if m.nil?
+        raise GeminiBadRequest, "Malformed request: #{str&.dump}" if m.nil?
         new(m[1])
       end
     end

data/lib/net/gemini/ssl.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Gemini
+  # Contains specific method to handle SSL connection
+  module SSL
+    private
+
+    def ssl_check_existing(new_cert, cert_file)
+      raw = File.read cert_file
+      saved_one = OpenSSL::X509::Certificate.new raw
+      return true if saved_one == new_cert
+      # TODO: offer some kind of recuperation
+      warn "#{cert_file} does not match the current host cert!"
+      false
+    end
+
+    def ssl_verify_cb(cert)
+      return false unless OpenSSL::SSL.verify_certificate_identity(cert, @host)
+      cert_file = File.expand_path("#{@certs_path}/#{@host}.pem")
+      return ssl_check_existing(cert, cert_file) if File.exist?(cert_file)
+      FileUtils.mkdir_p(File.expand_path(@certs_path))
+      File.open(cert_file, 'wb') { |f| f.print cert.to_pem }
+      true
+    end
+
+    def ssl_context
+      ssl_context = OpenSSL::SSL::SSLContext.new
+      ssl_context.set_params(verify_mode: OpenSSL::SSL::VERIFY_PEER)
+      ssl_context.min_version = OpenSSL::SSL::TLS1_2_VERSION
+      ssl_context.verify_hostname = true
+      ssl_context.ca_file = '/etc/ssl/certs/ca-certificates.crt'
+      ssl_context.verify_callback = lambda do |preverify_ok, store_context|
+        return true if preverify_ok
+        ssl_verify_cb store_context.current_cert
+      end
+      ssl_context
+    end
+
+    def init_sockets
+      socket = TCPSocket.new(@host, @port)
+      @ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
+      # Close underlying TCP socket with SSL socket
+      @ssl_socket.sync_close = true
+      @ssl_socket.hostname = @host # SNI
+      @ssl_socket.connect
+    end
+
+    # Closes the SSL and TCP connections.
+    def finish
+      @ssl_socket.close
+    end
+  end
+end

data/lib/net/gemini.rb

@@ -16,8 +16,8 @@ module Net
 
   # == A Gemini client API for Ruby.
   #
-  # Net::Gemini provides a rich library which can be used to build
-  # Gemini user-agents.
+  # Net::Gemini provides a library which can be used to build Gemini
+  # user-agents.
   # @see https://gemini.circumlunar.space/docs/specification.html
   #
   # Net::Gemini is designed to work closely with URI.

data/lib/net/generic.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'socket'
+
+# Generic interface to be used by specific network protocol implementation.
+module TextGeneric
+  private
+
+  def build_uri(string_or_uri, uri_class)
+    string_or_uri = URI(string_or_uri) if string_or_uri.is_a?(String)
+    return string_or_uri if string_or_uri.is_a?(uri_class)
+    raise ArgumentError, "uri is not a String, nor an #{uri_class.name}"
+  end
+
+  def request(uri, query)
+    sock = TCPSocket.new(uri.host, uri.port)
+    sock.puts query
+    sock.read
+  ensure
+    # Stop remaining connection, even if they should be already cut
+    # by the server
+    sock&.close
+  end
+end

data/lib/net/gopher.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../uri/gopher'
+require_relative 'generic'
+
+module Net
+  # == A Gopher client API for Ruby.
+  #
+  # Net::Gopher provides a library which can be used to build Gopher
+  # user-agents.
+  #
+  # Net::Gopher is designed to work closely with URI.
+  #
+  # == Simple Examples
+  #
+  # All examples assume you have loaded Net::Gopher with:
+  #
+  #   require 'net/gopher'
+  #
+  # This will also require 'uri' so you don't need to require it
+  # separately.
+  #
+  # The Net::Gopher methods in the following section do not persist
+  # connections.
+  #
+  # === GET by URI
+  #
+  #   uri = URI('gopher://thelambdalab.xyz/1/projects/elpher/')
+  #   Net::Gopher.get(uri) # => String
+  #
+  class Gopher
+    extend TextGeneric
+
+    def self.get(string_or_uri)
+      uri = build_uri string_or_uri, URI::Gopher
+      request uri, "#{uri.selector}\r\n"
+    end
+  end
+end

data/lib/uri/finger.rb

@@ -14,8 +14,22 @@ module URI # :nodoc:
     DEFAULT_PORT = 79
 
     # An Array of the available components for URI::Finger.
-    COMPONENT = [:scheme, :userinfo, :host, :port].freeze
+    COMPONENT = [:scheme, :userinfo, :host, :port, :path].freeze
+
+    def name
+      # Utilitary method to extract a name to query, either from the userinfo
+      # part or from the path.
+      return @user if @user
+      return '' unless @path
+      # Remove leading /
+      @path[1..] || ''
+    end
   end
 
-  @@schemes['FINGER'] = Finger
+  if respond_to? :register_scheme
+    # Introduced somewhere in ruby 3.0.x
+    register_scheme 'FINGER', Finger
+  else
+    @@schemes['FINGER'] = Finger
+  end
 end

data/lib/uri/gemini.rb

@@ -18,5 +18,10 @@ module URI # :nodoc:
                  :path, :query, :fragment].freeze
   end
 
-  @@schemes['GEMINI'] = Gemini
+  if respond_to? :register_scheme
+    # Introduced somewhere in ruby 3.0.x
+    register_scheme 'GEMINI', Gemini
+  else
+    @@schemes['GEMINI'] = Gemini
+  end
 end

data/lib/uri/gopher.rb

@@ -15,7 +15,29 @@ module URI # :nodoc:
 
     # An Array of the available components for URI::Gopher.
     COMPONENT = [:scheme, :host, :port, :path].freeze
+
+    def selector
+      return @selector if defined? @selector
+      @selector = extract_gopher_path_elements[1]
+    end
+
+    def item_type
+      return @item_type if defined? @item_type
+      @item_type = extract_gopher_path_elements[0]
+    end
+
+    private
+
+    def extract_gopher_path_elements
+      m = /\A\/([0-9+dfghisA-LT])(\/.*)?\Z/.match(@path)
+      m.captures
+    end
   end
 
-  @@schemes['GOPHER'] = Gopher
+  if respond_to? :register_scheme
+    # Introduced somewhere in ruby 3.0.x
+    register_scheme 'GOPHER', Gopher
+  else
+    @@schemes['GOPHER'] = Gopher
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-net-text
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
 platform: ruby
 authors:
 - Étienne Deparis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-12 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies: []
 description:
 email: etienne@depar.is
@@ -17,16 +17,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
+- lib/net/finger.rb
 - lib/net/gemini.rb
+- lib/net/gemini/gmi_parser.rb
+- lib/net/gemini/reflow_text.rb
 - lib/net/gemini/request.rb
 - lib/net/gemini/response.rb
+- lib/net/gemini/ssl.rb
+- lib/net/generic.rb
+- lib/net/gopher.rb
 - lib/uri/finger.rb
 - lib/uri/gemini.rb
 - lib/uri/gopher.rb
 homepage: https://git.umaneti.net/ruby-net-text/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://git.umaneti.net/ruby-net-text/
+  documentation_uri: https://www.rubydoc.info/gems/ruby-net-text
+  funding_uri: https://liberapay.com/milouse
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -42,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Gemini, Gopher, and Finger support for Net::* and URI::*