ruby-net-text 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5e45e34116b3865c72a1691baa06372be3266aebdae1fc7d823ba4136d4438a
-  data.tar.gz: 3e8045ac8d2b7c82b4dfffccaeeda707d92aded2f36b7eff794008d0ec8e5b06
+  metadata.gz: d42363c44449f94239e0f6ab431c925bf663ed11ee823d1fb797711011401795
+  data.tar.gz: ac7bcf1f19392f5a57efab70f71b340680cb51b21d946af00a66dbf20b49ca7e
 SHA512:
-  metadata.gz: cbd55419137361ce17b1df2459a734fbd305fad146701fd37b20df22e7fe861daead41494c7e20ce76baf2d37c825667acc87cebe49ef1310001f38b703f1152
-  data.tar.gz: 6cc15cc19dc559ed63b092f9c1c0c6622685f6a07d90a5634b9f074ca02e762bc4c60be95e8f6d45192718c2797b039e5ea3b13030d52d16b7c585e72b628065
+  metadata.gz: 934907f91ea8c4d00415f7a58d238dfadda9dd5bfd017b74fdbaab530eebbc20eb1e0791ead39db5b4637eaa89bdec13fb90e6cf64dd08332ed13b7deddf61df
+  data.tar.gz: b0aa7b75364c0ba4d56be615b1d1db77b32f515d5d2a73096c1900d82509a8f7f658f264c81294e833a24cbb421e025ef9ad69c41f8d3becc28b58bd25ac1b5c

data/README.md

@@ -1,9 +1,6 @@
 # Finger, Gemini, Gopher and Nex 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/)
 
@@ -65,3 +62,33 @@ This repository also includes 2 little helpers:
   and it will output the remote file.
 - `bin/test_thread.rb`: a toy performance test script to run against a Gemini
   server
+
+## Contributing
+
+### Code of conduct
+
+![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)
+
+`ruby-net-text` is proudly following the
+[Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/).
+
+[You can read it here](./CODE_OF_CONDUCT.md).
+
+### Code
+
+The canonical repository is located at https://git.umaneti.net/ruby-net-text.
+A mirror also exists on [Github](https://github.com/milouse/ruby-net-text).
+
+Merge requests and issues are accepted on github, or by mail to the main author.
+
+Contributions must not include content generated by large language models. This
+policy covers code, documentation, pull requests, issues, comments, and any
+other contributions to ruby-net-text. The main reason for this, sufficient by
+itself, is ethical issues. AI tools require an unreasonable amount of energy and
+water to build and operate; their models are built with heavily exploited
+workers in unacceptable working conditions. These are harms that we do not want
+to perpetuate, even if only indirectly.¹
+
+¹ This paragraph only is adapted from
+[the Servo project note on AI contribution](https://book.servo.org/contributing/getting-started.html#ai-contributions),
+available under the [Mozilla Public License 2.0](https://github.com/servo/servo/blob/main/LICENSE).

data/lib/net/gemini/client/ssl.rb

@@ -7,7 +7,7 @@ module Net
     class Client
       private
 
-      def ssl_check_existing(new_cert, cert_file)
+      def ssl_known_cert_valid?(new_cert, cert_file)
         raw = File.read cert_file
         saved_one = OpenSSL::X509::Certificate.new raw
         return true if saved_one == new_cert
@@ -17,12 +17,12 @@ module Net
         false
       end
 
-      def ssl_verify_cb(cert)
+      def ssl_cert_valid?(cert)
         identity_check = OpenSSL::SSL.verify_certificate_identity(cert, @host)
         return false unless identity_check
 
         cert_file = File.expand_path("#{@certs_path}/#{@host}.pem")
-        return ssl_check_existing(cert, cert_file) if File.exist?(cert_file)
+        return ssl_known_cert_valid?(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 }
@@ -34,13 +34,12 @@ module Net
         ssl_context.set_params(
           verify_mode: OpenSSL::SSL::VERIFY_PEER,
           min_version: OpenSSL::SSL::TLS1_2_VERSION,
-          ca_file: '/etc/ssl/certs/ca-certificates.crt',
           verify_hostname: true
         )
         ssl_context.verify_callback = lambda do |preverify_ok, store_context|
           return true if preverify_ok
 
-          ssl_verify_cb store_context.current_cert
+          ssl_cert_valid? store_context.current_cert
         end
         ssl_context
       end

data/lib/net/gemini/client.rb

@@ -6,7 +6,7 @@ require_relative 'response'
 require_relative '../text/generic'
 
 module Net
-  module Gemini # rubocop:disable Style/Documentation
+  module Gemini
     # An example client to fetch resources hosted on Gemini network.
     class Client
       attr_writer :certs_path
@@ -27,8 +27,12 @@ module Net
         res.reading_body(@ssl_socket)
       end
 
-      def request(uri)
-        request! uri
+      def request(uri, &block)
+        response = request! uri
+        yield response if block
+        # In any case, read it once
+        response.read_body
+        response
       rescue OpenSSL::SSL::SSLError => e
         msg = format(
           'SSLError: %<cause>s',
@@ -41,19 +45,19 @@ module Net
         finish
       end
 
-      def fetch(uri, limit = 5)
+      def fetch(uri, limit = 5, &)
         raise Error, 'Too many Gemini redirects' if limit.zero?
 
-        r = request(uri)
-        return r unless r.status[0] == '3'
+        response = request(uri, &)
+        return response unless response.status[0] == '3'
 
         begin
-          uri = handle_redirect(r)
+          uri = handle_redirect response
         rescue ArgumentError, URI::InvalidURIError
-          return r
+          return response
         end
         warn "Redirect to #{uri}" if $VERBOSE
-        fetch(uri, limit - 1)
+        fetch(uri, limit - 1, &)
       end
 
       private
@@ -71,6 +75,11 @@ module Net
       end
     end
 
+    # @param host_or_uri [String, ::URI]
+    # @param port [Integer, nil]
+    # @yield [self]
+    # @return [self] Returns self with no block given
+    # @return [Object] Returns the result of the block, if given
     def self.start(host_or_uri, port = nil, &block)
       if host_or_uri.is_a? URI::Gemini
         host = host_or_uri.host
@@ -78,16 +87,21 @@ module Net
       else
         host = host_or_uri
       end
-      gem = Client.new(host, port)
-      return gem unless block
+      client = Client.new(host, port)
+      return client unless block
 
-      yield gem
+      yield client
     end
 
-    def self.get_response(uri)
-      start(uri.host, uri.port) { |gem| gem.fetch(uri) }
+    # @param uri [::URI]
+    # @yield [Response]
+    # @return [Response]
+    def self.get_response(uri, &)
+      start(uri.host, uri.port) { |client| client.fetch(uri, &) }
     end
 
+    # @param string_or_uri [String, ::URI]
+    # @return [String]
     def self.get(string_or_uri)
       uri = Net::Text::Generic.build_uri string_or_uri, URI::Gemini
       get_response(uri).body

data/lib/net/gemini/response/parser.rb

@@ -32,17 +32,6 @@ module Net
         header.merge received_mime(raw_meta)
       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?
@@ -58,12 +47,16 @@ module Net
 
       def parse_body
         buf = StringIO.new(@body)
+        mono_block_open = false
         while (line = buf.gets)
-          if line.start_with?('```')
-            parse_preformatted_block(line, buf)
-          elsif line.start_with?('=>')
-            parse_link(line)
-          end
+          mono_block_open = !mono_block_open if line.start_with?('```')
+
+          # Do not parse links inside preformatted block
+          next if mono_block_open
+
+          next unless line.start_with?('=>')
+
+          parse_link(line)
         end
       end
     end

data/lib/net/gemini/response.rb

@@ -19,24 +19,36 @@ module Net
     #
     class Response
       # @return [String] The Gemini response <STATUS> string.
-      # @example '20'
+      # @example
+      #   "20"
       attr_reader :status
 
       # @return [String] The Gemini response <META> message sent by the server.
-      # @example 'text/gemini'
+      # @example
+      #   "text/gemini"
       attr_reader :meta
 
-      # @return [Hash] The Gemini response <META>.
+      # @return [Hash{Symbol => String, nil}] The Gemini response <META>.
+      # @example
+      #   { status: '20', meta: 'text/gemini; charset=UTF-8',
+      #     mimetype: 'text/gemini', lang: 'en',
+      #     charset: 'utf-8', format: nil }
       attr_reader :header
 
       # The Gemini response main content as a string.
       attr_writer :body
 
       # The URI related to this response as an URI object.
+      # @return [::URI]
       attr_accessor :uri
 
-      # @return [Array<String>] All links found on a Gemini response of MIME
-      #   text/gemini
+      # All links found on a Gemini response of MIME text/gemini
+      #
+      # Each link is a Hash with the keys `:uri` containing the link {::URI},
+      # and `:label` containing the link label as a {::String}, or nil if none
+      # was provided.
+      #
+      # @return [Array<Hash{:uri => ::URI; :label => String, nil}>]
       attr_reader :links
 
       def initialize(status = nil, meta = nil)
@@ -46,23 +58,40 @@ module Net
         @uri = nil
         @body = nil
         @links = []
-        @preformatted_blocks = []
+        @socket = nil
       end
 
+      # Whether the current {Response} has a body of interest
+      #   (i.e. is not an error or a redirection).
+      # @return [Boolean]
       def body_permitted?
         @status && @status[0] == '2'
       end
 
+      # Set the socket to read data through {#read_body}.
+      # @param sock [OpenSSL::SSL::SSLSocket]
+      # @return [self]
       def reading_body(sock)
         return self unless body_permitted?
 
-        raw_body = []
-        sock.each_line { raw_body << _1 }
-        @body = encode_body(raw_body.join)
-        return self unless @header[:mimetype] == 'text/gemini'
+        @socket = sock
+        self
+      end
+
+      # Read data from the SSL socket.
+      # @yield [self]
+      # @return [String, nil] The data read from the socket
+      #   (aka. the Response body)
+      def read_body(&)
+        return @body unless @socket
+
+        @body = read_chunked(&)
+        return @body unless @header[:mimetype] == 'text/gemini'
 
         parse_body
-        self
+        @body
+      ensure
+        @socket = nil
       end
 
       # Return the response body (i.e. the requested document content).
@@ -100,18 +129,27 @@ module Net
 
       private
 
-      def encode_body(body)
-        return body unless @header[:mimetype].start_with?('text/')
+      def read_chunked(&block)
+        raw_body = ''
+        is_text = @header[:mimetype].start_with?('text/')
+        while (chunk = @socket.read(4096))
+          chunk = fix_encoding chunk if is_text
+          yield chunk if block
+          raw_body += chunk
+        end
+        raw_body
+      end
 
+      def fix_encoding(data)
         if @header[:charset] && @header[:charset] != 'utf-8'
-          # If body use another charset than utf-8, we need first to
+          # If data use another charset than utf-8, we need first to
           # declare the raw byte string as using this chasret
-          body.force_encoding(@header[:charset])
+          data.force_encoding(@header[:charset])
           # Then we can safely try to convert it to utf-8
-          return body.encode('utf-8')
+          return data.encode('utf-8')
         end
-        # Just declare that the body uses utf-8
-        body.force_encoding('utf-8')
+        # Just declare that the data uses utf-8
+        data.force_encoding('utf-8')
       end
     end
   end

data/lib/net/gemini.rb

@@ -21,8 +21,7 @@ module Net
   #
   #   require 'net/gemini'
   #
-  # This will also require 'uri' so you don't need to require it
-  # separately.
+  # This will also require 'uri' so you don't need to require it separately.
   #
   # The Net::Gemini methods in the following section do not persist
   # connections.
@@ -53,18 +52,47 @@ module Net
   #           mimetype: 'text/gemini', lang: 'en',
   #           charset: 'utf-8', format: nil }
   #
-  # The lang, charset and format headers will only be provided in case
-  # of `text/*` mimetype, and only if body for 2* status codes.
+  # The `:lang`, `:charset` and `:format` headers will only be provided in case
+  # of `text/*` mimetype, and {Response#body body} only for 2* status codes.
   #
   #   # Body
   #   puts res.body if res.body_permitted?
   #   puts res.body(reflow_at: 85)
   #
+  # When the response is `text/gemini` mimetype, the body is parsed
+  # automatically to extract all its links.
+  #
+  #   res.links # => [{ :uri => #<URI::Gemini gemini://…>, :label => "…" }, …]
+  #
+  # ==== Large Response
+  #
+  # You may not want to load the whole body of a large response such as images,
+  # videos, etc. into memory. To avoid that, you can read response body as
+  # chunks.
+  #
+  #   f = File.new 'image.png', 'wb'
+  #   Net::Gemini.get_response(URI('gemini://example.org/image.png')) do |res|
+  #     res.read_body { |chunk| f.write chunk }
+  #   end
+  #   f.close
+  #
+  # It has to be noted that the block given to the {::get_response} method is
+  # executed while the socket is being read. This means the {Response} instance
+  # you get as block argument does not have parsed its body in case of
+  # a `text/gemini` mimetype, and thus its {Response#links} array will be
+  # empty. In any case, {::get_response} returns the {Response} instance, thus
+  # if you need access to these links, you must do this:
+  #
+  #   uri = URI('gemini://example.org/very_long_text.gmi')
+  #   res = Net::Gemini.get_response(uri) do |res|
+  #     # … do something
+  #   end
+  #   res.links # => [{ :uri => #<URI::Gemini gemini://…>, :label => "…" }, …]
+  #
   # === Following Redirection
   #
-  # The {Client#fetch} method, contrary to the {Client#request} one will try
-  # to automatically resolves redirection, leading you to the final
-  # destination.
+  # The {Client#fetch} method, contrary to the {Client#request} one will try to
+  # automatically resolves redirection, leading you to the final destination.
   #
   #   u = URI('gemini://exemple.com/redirect')
   #   res = Net::Gemini.start(u.host, u.port) do |g|
@@ -80,6 +108,12 @@ module Net
   #   puts "#{res.status} - #{res.meta}" # => '20 - text/gemini;'
   #   puts res.uri.to_s                  # => 'gemini://exemple.com/final/dest'
   #
+  # This fetch method is automatically called by the class methods {::get} and
+  # {::get_response}.
+  #
+  #   res = Net::Gemini.get_response(URI('gemini://exemple.com/redirect'))
+  #   puts "#{res.status} - #{res.meta}" # => '20 - text/gemini;'
+  #   puts res.uri.to_s                  # => 'gemini://exemple.com/final/dest'
   module Gemini; end
 end
 

data/lib/net/text/reflow.rb

@@ -16,36 +16,43 @@ module Net
         ' ' * m[1].length
       end
 
-      def self.reflow_text_line(line, mono_block_open, length)
-        line.strip!
-        if mono_block_open || line.start_with?('=>') || line.length < length
-          return [line]
-        end
-
+      def self.reflow_line(line, length)
         output = []
         prefix = reflow_line_prefix(line)
         limit_chars = ['-', '­', ' '].freeze
         while line.length > length
-          cut_line = line[0...length]
-          cut_index = limit_chars.map { cut_line.rindex(_1) || -1 }.max
+          # Detect first possible cut
+          cut_index = limit_chars.map { line[0...length].rindex(_1) || -1 }.max
           break if cut_index.zero? # Better do nothing for now
 
           output << line[0...cut_index]
-          line = prefix + line[cut_index + 1..]
+          line = prefix + line[(cut_index + 1)..]
         end
         output << line
       end
 
+      def self.parse_line(line, mono_block_open, length)
+        if line.start_with?('```')
+          mono_block_open = !mono_block_open
+          return [mono_block_open, [line.chomp]]
+        end
+
+        return [mono_block_open, [line.chomp]] if mono_block_open
+
+        line.strip!
+        if line.start_with?('=>') || line.length < length
+          return [mono_block_open, [line]]
+        end
+
+        [mono_block_open, reflow_line(line, length)]
+      end
+
       def self.format_body(body, length)
         new_body = []
         mono_block_open = false
         body.each_line do |line|
-          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)
+          mono_block_open, content = parse_line line, mono_block_open, length
+          new_body += content
         end
         new_body.join("\n")
       end

data/lib/uri/finger.rb

@@ -9,7 +9,7 @@ module URI # :nodoc:
   #
   # @see https://tools.ietf.org/html/rfc1288#section-2.3
   #
-  class Finger < HTTP
+  class Finger < Generic
     # A Default port of 79 for URI::Finger.
     DEFAULT_PORT = 79
 

data/lib/uri/gemini.rb

@@ -9,7 +9,7 @@ module URI # :nodoc:
   #
   # @see https://geminiprotocol.net/docs/protocol-specification.html
   #
-  class Gemini < HTTP
+  class Gemini < Generic
     # A Default port of 1965 for URI::Gemini.
     DEFAULT_PORT = 1965
 

data/lib/uri/gopher.rb

@@ -9,7 +9,7 @@ module URI # :nodoc:
   #
   # @see https://www.rfc-editor.org/rfc/rfc4266.html
   #
-  class Gopher < HTTP
+  class Gopher < Generic
     # A Default port of 70 for URI::Gopher.
     DEFAULT_PORT = 70
 

data/lib/uri/nex.rb

@@ -9,7 +9,7 @@ module URI # :nodoc:
   #
   # @see nex://nightfall.city/nex/info/specification.txt
   #
-  class Nex < HTTP
+  class Nex < Generic
     # A Default port of 1900 for URI::Nex.
     DEFAULT_PORT = 1900
 

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-net-text
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Étienne Pflieger
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description:
 email: etienne@pflieger.bzh
 executables: []
 extensions: []
@@ -56,15 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.19
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Finger, Gemini, Gopher and Nex support for Net::* and URI::*
 test_files: []