ruby-net-text 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c547f919d21a6cb162b2e56553a4c7d7a935d8823036bbb97ae249417be0e1ae
-  data.tar.gz: 754907558f7a4db368b7f7cd7001bd5550dde2bb798804ee133dfee433945594
+  metadata.gz: de26ac5c1f8127c9d08a5430adc0cff34d266847327c6864baa903b5352ac041
+  data.tar.gz: d2725dab71f60b4d12be9ff0d948ae1a3f1bc6de9858499258aeedc11c801ae0
 SHA512:
-  metadata.gz: '079107d052b63ac01d47b648966b875b7150d20db1787411f671ad5cf0fd911ded1924e9300885a0a17dea342d884482b2b4132c1b7ffdc9adb1417ecfead74a'
-  data.tar.gz: f2894b7e387968c2d0c3f1f7a00bceb18b78351f0aa392dc53b350badccb6e5a5c17ebfb150679537cb4be344b19ca98f1c9c9ce3ecaf6b4fea2146d761eb307
+  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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-net-text
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Étienne Deparis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-20 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies: []
 description:
 email: etienne@depar.is
@@ -17,12 +17,16 @@ 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
@@ -31,7 +35,8 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-  source_code_uri: https://git.umaneti.net/ruby-net-text
+  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: []
@@ -48,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Gemini, Gopher, and Finger support for Net::* and URI::*