indieweb-endpoints 10.1.0 → 10.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc454d00bab1d454de6ee0bbf768faa9945d3e6649ad5d142662e09de0c1bb0
-  data.tar.gz: 7d6a69d24b29aa0598c23adf619094b9322d555bb83f2f789f33751d92282ea9
+  metadata.gz: 93961d5b2254ded47773579d8b1d357621571be0256c6ccfc5768177703a28c5
+  data.tar.gz: 95904542302a29d07aefe58f49095a4db8cacb2a3fb0faca80ddd4a62b8e178d
 SHA512:
-  metadata.gz: 432c5ebe97eb622e0c0f731f12c2b0bc278dd56345e05b0bc295fffc0781278e621e73b4750d46d3214a62d9e6c5594906a145c45cb7c1bfd440f2405bf0cf7a
-  data.tar.gz: ac6d751d2b6855c19aac16b170f55e4b961b43870f26816147287bebf17cdb8d0112b49c7f2856dedcd787f310238ef146ae7741cc60b145a8da6080cc21a5a6
+  metadata.gz: 6b33c1da625391e747d6b8481cff57980d3bb8099b6ff5d286f8d6765bdec91cba5560d9a49d0cc0df51593e94ea8eb0bb42c34a8c6ccd85f6d3d898eeba5234
+  data.tar.gz: f4394054e1814421691e981d4b16d6c8568d0f9184f03b74ce88f228687b24ecc10e9de253dc9ad12aeb23342cee77ab8ef39c2844cd2f2f0ec854e20ed207e7

data/.yardopts

@@ -0,0 +1,5 @@
+-
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+LICENSE

data/CONTRIBUTING.md

@@ -8,12 +8,12 @@ There are a couple ways you can help improve indieweb-endpoints-ruby:
 
 ## Getting Started
 
-indieweb-endpoints-ruby is developed using Ruby 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
+indieweb-endpoints-ruby is developed using Ruby 4.0 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
 
 > [!TIP]
 > This project is configured with a [Dev Container](https://containers.dev) which includes everything you'd need to contribute to indieweb-endpoints-ruby. If you use a supported code editor or IDE, you're encouraged to use the existing Dev Container setup.
 
-Before making changes to indieweb-endpoints-ruby, you'll want to install Ruby 3.4. Using a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm) is recommended. Once you've installed Ruby 3.4 using your method of choice, install the project's gems by running:
+Before making changes to indieweb-endpoints-ruby, you'll want to install Ruby 4.0. Using a Ruby version managment tool like [rv](https://github.com/spinel-coop/rv) or [rbenv](https://github.com/rbenv/rbenv) is recommended. Once you've installed Ruby 4.0 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install

data/README.md

@@ -14,9 +14,9 @@ A Ruby gem for discovering a URL's [IndieAuth](https://indieweb.org/IndieAuth),
 
 ## Getting Started
 
-Before installing and using indieweb-endpoints-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.7 (or newer) installed. Using a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm) is recommended.
+Before installing and using indieweb-endpoints-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.7 (or newer) installed. Using a Ruby version managment tool like [rv](https://github.com/spinel-coop/rv) or [rbenv](https://github.com/rbenv/rbenv) is recommended.
 
-indieweb-endpoints-ruby is developed using Ruby 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
+indieweb-endpoints-ruby is developed using Ruby 4.0 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
 
 ## Installation
 
@@ -70,7 +70,7 @@ indieweb-endpoints-ruby may raise the following exceptions which are subclasses
 
 ## Contributing
 
-See [CONTRIBUTING.md](https://github.com/indieweb/indieweb-endpoints-ruby/blob/main/CONTRIBUTING.md) for more on how to contribute to indieweb-endpoints-ruby. Your help is greatly appreciated!
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute to indieweb-endpoints-ruby. Your help is greatly appreciated!
 
 By contributing to and participating in the development of indieweb-endpoints-ruby, you acknowledge that you have read and agree to the [IndieWeb Code of Conduct](https://indieweb.org/code-of-conduct).
 

data/indieweb-endpoints.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7"
 
   spec.name = "indieweb-endpoints"
-  spec.version = "10.1.0"
+  spec.version = "10.2.0"
   spec.authors = ["Jason Garber"]
   spec.email = ["jason@sixtwothree.org"]
 
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
 
   spec.files = Dir["lib/**/*"].reject { |f| File.directory?(f) }
-  spec.files += ["LICENSE", "CHANGELOG.md", "CODE_OF_CONDUCT.md", "CONTRIBUTING.md", "README.md"]
+  spec.files += [".yardopts", "LICENSE", "CHANGELOG.md", "CODE_OF_CONDUCT.md", "CONTRIBUTING.md", "README.md"]
   spec.files += ["indieweb-endpoints.gemspec"]
 
   spec.require_paths = ["lib"]

data/lib/indieweb/endpoints/client.rb

@@ -2,13 +2,34 @@
 
 module IndieWeb
   module Endpoints
+    # A client interface to parse IndieWeb endpoints from a URL.
     class Client
-      # Create a new client with a URL to parse for IndieWeb endpoints.
+      # Set defaults derived from Webmention specification examples.
+      #
+      # @see https://www.w3.org/TR/webmention/#limits-on-get-requests
+      #   W3C Webmention Recommendation § 4.2 Limits on GET requests
+      HTTP_CLIENT_OPTS = {
+        follow: {
+          max_hops: 20,
+        },
+        headers: {
+          accept: "*/*",
+          user_agent: "Mozilla/5.0 (compatible; IndieWebEndpointsDiscovery/1.0; +https://rubygems.org/gems/indieweb-endpoints)",
+        },
+        timeout_options: {
+          connect_timeout: 5,
+          read_timeout: 5,
+        },
+      }.freeze
+
+      private_constant :HTTP_CLIENT_OPTS
+
+      # Create a new {Client} to parse a URL for IndieWeb endpoints.
       #
       # @example
-      #   client = IndieWeb::Endpoints::Client.new("https://aaronparecki.com")
+      #   IndieWeb::Endpoints::Client.new("https://aaronparecki.com")
       #
-      # @param url [String, HTTP::URI, #to_s] an absolute URL
+      # @param url [String, HTTP::URI, #to_s] An absolute URL.
       #
       # @raise [InvalidURIError]
       def initialize(url)
@@ -17,35 +38,30 @@ module IndieWeb
         raise InvalidURIError, e
       end
 
-      # :nocov:
-      # @return [String]
+      # @!visibility private
+      # simplecov:disable
       def inspect
-        format "#<%<class>s:%<id>#0x @uri=%<uri>s>",
-               class: self.class,
-               id: object_id << 1,
-               uri: uri.inspect
+        "#<#{self.class}:#{format("%#0x", object_id)} @uri: #{@uri.inspect}>"
       end
-      # :nocov:
+      # simplecov:enable
 
-      # A Hash of the discovered IndieWeb endpoints from the provided URL.
+      # The IndieWeb endpoints advertised by the provided URL.i
+      #
+      # @example
+      #   IndieWeb::Endpoints::Client.new("https://aaronparecki.com").endpoints
       #
       # @return [Hash{Symbol => String, Array, nil}]
       def endpoints
         @endpoints ||= Parser.new(response).to_h
       end
 
-      # The +HTTP::Response+ object.
-      #
-      # @return [HTTP::Response]
+      # The `HTTP::Response` object for the provided URL.
       #
       # @raise [HttpError, SSLError]
+      #
+      # @return [HTTP::Response]
       def response
-        @response ||=
-          HTTP
-            .follow(max_hops: 20)
-            .headers(accept: "*/*", user_agent: user_agent)
-            .timeout(connect: 5, read: 5)
-            .get(uri)
+        @response ||= client.request(:get, @uri)
       rescue HTTP::Error => e
         raise HttpError, e
       rescue OpenSSL::SSL::SSLError => e
@@ -54,12 +70,9 @@ module IndieWeb
 
       private
 
-      # @return [HTTP::URI]
-      attr_reader :uri
-
-      # @return [String]
-      def user_agent
-        "Mozilla/5.0 (compatible; IndieWebEndpointsDiscovery/1.0; +https://rubygems.org/gems/indieweb-endpoints)"
+      # @return [HTTP::Client]
+      def client
+        @client ||= HTTP::Client.new(HTTP_CLIENT_OPTS)
       end
     end
   end

data/lib/indieweb/endpoints/exceptions.rb

@@ -3,11 +3,8 @@
 module IndieWeb
   module Endpoints
     class Error < StandardError; end
-
     class HttpError < Error; end
-
     class InvalidURIError < Error; end
-
     class SSLError < Error; end
   end
 end

data/lib/indieweb/endpoints/parser.rb

@@ -2,19 +2,24 @@
 
 module IndieWeb
   module Endpoints
+    # A parser for extracting IndieWeb endpoints from an `HTTP::Response`
+    # instance's headers and body.
+    #
     # @api private
     class Parser
       # @param response [HTTP::Response]
       def initialize(response)
-        @response = response
+        @body = Nokogiri::HTML5(response.body, response.uri.to_s).resolve_urls!
+        @headers = LinkHeaderParser.parse(response.headers.get("link"), base_uri: response.uri).group_by_relation_type
+        @mime_type = response.mime_type
       end
 
       # @param identifier [String]
       # @param node_names [Array<String>]
       #
-      # @return [Array<String>]
-      #
       # @raise [InvalidURIError]
+      #
+      # @return [Array<String>]
       def matches(identifier, node_names: ["link"])
         results = (matches_from_headers(identifier) + matches_from_body(identifier, node_names)).compact
 
@@ -46,19 +51,6 @@ module IndieWeb
 
       private
 
-      # @return [HTTP::Response]
-      attr_reader :response
-
-      # @return [Nokogiri::HTML5::Document]
-      def body
-        @body ||= Nokogiri::HTML5(response.body, response.uri.to_s).resolve_urls!
-      end
-
-      # @return [Hash{Symbol => Array<LinkHeaderParser::LinkHeader>}]
-      def headers
-        @headers ||= LinkHeaderParser.parse(response.headers.get("link"), base_uri: response.uri).group_by_relation_type
-      end
-
       # Reject URLs with fragment identifiers per the IndieAuth specification.
       #
       # @param identifier [String, #to_s]
@@ -66,9 +58,9 @@ module IndieWeb
       #
       # @return [Array<String>]
       def matches_from_body(identifier, node_names)
-        return [] unless response.mime_type == "text/html"
+        return [] unless @mime_type == "text/html"
 
-        body
+        @body
           .css(*node_names.map { |node| %(#{node}[rel~="#{identifier}"][href]:not([href*="#"]) / @href) })
           .map(&:value)
       end
@@ -79,7 +71,7 @@ module IndieWeb
       #
       # @return [Array<String>]
       def matches_from_headers(identifier)
-        Array(headers[identifier]).filter_map do |header|
+        Array(@headers[identifier]).filter_map do |header|
           header.target_uri unless HTTP::URI.parse(header.target_uri).fragment
         end
       end

data/lib/indieweb/endpoints.rb

@@ -5,11 +5,14 @@ require "link-header-parser"
 require "nokogiri/html-ext"
 
 require_relative "endpoints/exceptions"
-
 require_relative "endpoints/client"
 require_relative "endpoints/parser"
 
+# Welcome to the IndieWeb, a people-focused alternative to the "corporate web."
+#
+# @see https://indieweb.org
 module IndieWeb
+  # @see https://indieweb.org/endpoint
   module Endpoints
     # Discover a URL's IndieAuth, Micropub, Microsub, and Webmention endpoints.
     #
@@ -20,6 +23,8 @@ module IndieWeb
     #
     # @param (see Client#initialize)
     #
+    # @raise (see Client#initialize)
+    #
     # @return (see Client#endpoints)
     def self.get(url)
       Client.new(url).endpoints

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 10.1.0
+  version: 10.2.0
 platform: ruby
 authors:
 - Jason Garber
@@ -64,6 +64,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -79,11 +80,11 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/indieweb/indieweb-endpoints-ruby/issues
-  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/releases/tag/v10.1.0
-  documentation_uri: https://rubydoc.info/gems/indieweb-endpoints/10.1.0
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/releases/tag/v10.2.0
+  documentation_uri: https://rubydoc.info/gems/indieweb-endpoints/10.2.0
   homepage_uri: https://github.com/indieweb/indieweb-endpoints-ruby
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/indieweb/indieweb-endpoints-ruby/tree/v10.1.0
+  source_code_uri: https://github.com/indieweb/indieweb-endpoints-ruby/tree/v10.2.0
 rdoc_options: []
 require_paths:
 - lib
@@ -98,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.
 test_files: []