indieweb-endpoints 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 370058542f4dab2038574dc7fc35970351000f89c0cb9e26eb9f516d1e65fb1e
-  data.tar.gz: 397f0722f44609cfb10dfb6aa8c927007b37f182714eb1aa4fe0143044da5caf
+  metadata.gz: da8f18ac80e24b04e834e41ef4ec959cc26c3496b888de60c92d518fb89bbc78
+  data.tar.gz: 64a2117a77c161ab5d4c5b616c4fe1685406ea58218ade5af72eb2998048f402
 SHA512:
-  metadata.gz: 4fe7c09096ecd71e46acf6dd793bb9c808332c657e3c85a077169fe5031493a3d103b060141ab30bae8ec4c3ff5eeb18c17e4223f68d6f5bc3f10bb03929818e
-  data.tar.gz: 4f6f3a2c4d5ad81280d2e4071b4aa817cd52dffeafb7b046624028d1235fff48e255c9f4d86846e2a8188733e218b304bead056b3b05e9647ac410b9247db560
+  metadata.gz: 54fdc8310a995d36c8f46e8926790bafd8352a5db02e32144a4d4ce074258bc5c7ca80cc9778d910a522749f4b9807eb5cd202465ee8d811ca5ee4d4aa6311f7
+  data.tar.gz: 1d36d41eccca9f32ccecd622bc739915af4af9f61596fabf48d994e4d6f741ae4c8013a064c9b908917bf6896ac4ad291df8a90e882f074a3b1a12dbcc23b76b

data/CONTRIBUTING.md

@@ -8,9 +8,12 @@ There are a couple ways you can help improve indieweb-endpoints-ruby:
 
 ## Getting Started
 
-indieweb-endpoints-ruby is developed using Ruby 3.3.0 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 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
 
-Before making changes to indieweb-endpoints-ruby, you'll want to install Ruby 3.3.0. 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.3.0 using your method of choice, install the project's gems by running:
+> [!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:
 
 ```sh
 bundle install
@@ -19,17 +22,17 @@ bundle install
 ## Making Changes
 
 1. Fork and clone the project's repo.
-1. Install development dependencies as outlined above.
-1. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
-1. _Write some code!_
-1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
-1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://chris.beams.io/posts/git-commit/) for tips on writing useful Git commit messages.)_
-1. Push the branch to your fork: `git push -u origin my-new-feature`.
-1. Create a new [Pull Request][pulls] and we'll review your changes.
+2. Install development dependencies as outlined above.
+3. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
+4. _Write some code!_
+5. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
+6. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://cbea.ms/git-commit/) for tips on writing useful Git commit messages.)_
+7. Push the branch to your fork: `git push -u origin my-new-feature`.
+8. Create a new [Pull Request][pulls] and we'll review your changes.
 
 ## Code Style
 
-Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended installing the EditorConfig plugin for your editor of choice.
+Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](https://editorconfig.org) syntax. There are [plugins for a variety of editors](https://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended installing the EditorConfig plugin for your editor of choice.
 
 Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.
 

data/README.md

@@ -10,13 +10,13 @@
 
 - Compliant with [Section 4.1](https://www.w3.org/TR/indieauth/#discovery-by-clients) and [Section 4.2.2](https://www.w3.org/TR/indieauth/#redirect-url) of [the W3C's IndieAuth Working Group Note](https://www.w3.org/TR/indieauth/), [Section 5.3](https://www.w3.org/TR/micropub/#endpoint-discovery) of [the W3C's Micropub Recommendation](https://www.w3.org/TR/micropub/), and [Section 3.1.2](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint) of [the W3C's Webmention Recommendation](https://www.w3.org/TR/webmention/).
 - Passes all Endpoint Discovery tests on [webmention.rocks](https://webmention.rocks).
-- Supports Ruby 3.0 and newer.
+- Supports Ruby 2.6 and newer.
 
 ## Getting Started
 
-Before installing and using indieweb-endpoints-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 3.0 (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.6 (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.
 
-indieweb-endpoints-ruby is developed using Ruby 3.3.0 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 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).
 
 ## Installation
 
@@ -41,7 +41,7 @@ IndieWeb::Endpoints.get("https://aaronparecki.com")
 #=> { authorization_endpoint: "https://aaronparecki.com/auth", "indieauth-metadata": "https://aaronparecki.com/.well-known/oauth-authorization-server", micropub: "https://aaronparecki.com/micropub", microsub: "https://aperture.p3k.io/microsub/1", redirect_uri: nil, token_endpoint: "https://aaronparecki.com/auth/token", webmention: "https://webmention.io/aaronpk/webmention" }
 ```
 
-This example will search `https://aaronparecki.com` for valid IndieAuth, Micropub, and Webmention endpoints and return a `Hash` of results. Each key in the returned `Hash` will have a value of either a `String` representing a URL or `nil`. The `redirect_uri` key's value will be either an `Array` or `nil` since a given URL may register multiple callback URLs.
+This example will search [Aaron's website](https://aaronparecki.com) for valid IndieAuth, Micropub, and Webmention endpoints and return a `Hash` of results. Each key in the returned `Hash` will have a value of either a `String` representing a URL or `nil`. The `redirect_uri` key's value will be either an `Array` or `nil` since a given URL may register multiple callback URLs.
 
 ### Advanced Usage
 
@@ -62,18 +62,10 @@ client.endpoints
 
 ### Exception Handling
 
-There are several exceptions that may be raised by indieweb-endpoints-ruby's underlying dependencies. These errors are raised as subclasses of `IndieWeb::Endpoints::Error` (which itself is a subclass of `StandardError`).
-
-From [sporkmonger/addressable](https://github.com/sporkmonger/addressable):
+indieweb-endpoints-ruby may raise the following exceptions which are subclasses of `IndieWeb::Endpoints::Error` (which itself is a subclass of `StandardError`).
 
 - `IndieWeb::Endpoints::InvalidURIError`
-
-From [httprb/http](https://github.com/httprb/http):
-
 - `IndieWeb::Endpoints::HttpError`
-
-From the Ruby Standard Library's [`OpenSSL::SSL::SSLError`](https://ruby-doc.org/3.3.0/exts/openssl/OpenSSL/SSL/SSLError.html):
-
 - `IndieWeb::Endpoints::SSLError`
 
 ## Contributing

data/indieweb-endpoints.gemspec

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "lib/indieweb/endpoints/version"
-
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 2.6"
 
   spec.name = "indieweb-endpoints"
-  spec.version = IndieWeb::Endpoints::VERSION
+  spec.version = "9.1.0"
   spec.authors = ["Jason Garber"]
   spec.email = ["jason@sixtwothree.org"]
 
@@ -16,19 +14,21 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
 
   spec.files = Dir["lib/**/*"].reject { |f| File.directory?(f) }
-  spec.files += %w[LICENSE CHANGELOG.md CODE_OF_CONDUCT.md CONTRIBUTING.md README.md]
-  spec.files += %w[indieweb-endpoints.gemspec]
+  spec.files += ["LICENSE", "CHANGELOG.md", "CODE_OF_CONDUCT.md", "CONTRIBUTING.md", "README.md"]
+  spec.files += ["indieweb-endpoints.gemspec"]
 
   spec.require_paths = ["lib"]
 
   spec.metadata = {
     "bug_tracker_uri" => "#{spec.homepage}/issues",
     "changelog_uri" => "#{spec.homepage}/releases/tag/v#{spec.version}",
+    "documentation_uri" => "https://rubydoc.info/gems/#{spec.name}/#{spec.version}",
+    "homepage_uri" => spec.homepage,
     "rubygems_mfa_required" => "true",
-    "source_code_uri" => "#{spec.homepage}/tree/v#{spec.version}"
+    "source_code_uri" => "#{spec.homepage}/tree/v#{spec.version}",
   }
 
-  spec.add_runtime_dependency "http", "~> 5.2"
-  spec.add_runtime_dependency "link-header-parser", "~> 5.1"
-  spec.add_runtime_dependency "nokogiri", ">= 1.16"
+  spec.add_dependency "http", "~> 5.2"
+  spec.add_dependency "link-header-parser", "~> 6.1"
+  spec.add_dependency "nokogiri", ">= 1.13"
 end

data/lib/indieweb/endpoints/client.rb

@@ -5,7 +5,7 @@ module IndieWeb
     class Client
       HTTP_HEADERS_OPTS = {
         accept: "*/*",
-        user_agent: "IndieWeb Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)"
+        user_agent: "IndieWeb Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)",
       }.freeze
 
       private_constant :HTTP_HEADERS_OPTS
@@ -16,7 +16,8 @@ module IndieWeb
       #   client = IndieWeb::Endpoints::Client.new("https://aaronparecki.com")
       #
       # @param url [String, HTTP::URI, #to_s] an absolute URL
-      # @raise [IndieWeb::Endpoints::InvalidURIError]
+      #
+      # @raise [InvalidURIError]
       def initialize(url)
         @uri = HTTP::URI.parse(url.to_s)
       rescue Addressable::URI::InvalidURIError => e
@@ -32,19 +33,20 @@ module IndieWeb
       #
       # @return [Hash{Symbol => String, Array, nil}]
       def endpoints
-        @endpoints ||= Parser.new(response).results
+        @endpoints ||= Parser.new(response).to_h
       end
 
-      # The +HTTP::Response+ object returned by the provided URL.
+      # The {HTTP::Response} object returned by the provided URL.
       #
       # @return [HTTP::Response]
-      # @raise [IndieWeb::Endpoints::HttpError, IndieWeb::Endpoints::SSLError]
+      #
+      # @raise [HttpError, SSLError]
       def response
         @response ||= HTTP
-          .follow(max_hops: 20)
-          .headers(HTTP_HEADERS_OPTS)
-          .timeout(connect: 5, read: 5)
-          .get(uri)
+                        .follow(max_hops: 20)
+                        .headers(HTTP_HEADERS_OPTS)
+                        .timeout(connect: 5, read: 5)
+                        .get(uri)
       rescue HTTP::Error => e
         raise HttpError, e
       rescue OpenSSL::SSL::SSLError => e

data/lib/indieweb/endpoints/parser.rb

@@ -9,16 +9,43 @@ module IndieWeb
         @response = response
       end
 
-      # @return [Hash{Symbol => String, Array<String>, nil}]
-      def results
+      # @param identifier [String]
+      # @param node_names [Array<String>]
+      #
+      # @return [Array<String>]
+      #
+      # @raise [InvalidURIError]
+      def matches(identifier, node_names: ["link"])
+        results =
+          (matches_from_headers(identifier) + matches_from_body(identifier, node_names))
+            .compact
+            .map! { |endpoint| response.uri.join(endpoint).to_s }
+
+        results.uniq!
+        results.sort!
+
+        results
+      rescue Addressable::URI::InvalidURIError => e
+        raise InvalidURIError, e
+      end
+
+      # @param (see #matches)
+      #
+      # @return [String]
+      def match(identifier, **kwargs)
+        matches(identifier, **kwargs).first
+      end
+
+      # @return [Hash{Symbol => String, Array, nil}]
+      def to_h
         {
-          authorization_endpoint: result_for(:authorization_endpoint),
-          "indieauth-metadata": result_for(:"indieauth-metadata"),
-          micropub: result_for(:micropub),
-          microsub: result_for(:microsub),
-          redirect_uri: results_for(:redirect_uri),
-          token_endpoint: result_for(:token_endpoint),
-          webmention: result_for(:webmention, %w[link a])
+          authorization_endpoint: match("authorization_endpoint"),
+          "indieauth-metadata": match("indieauth-metadata"),
+          micropub: match("micropub"),
+          microsub: match("microsub"),
+          redirect_uri: (redirect_uri = matches("redirect_uri")).any? ? redirect_uri : nil,
+          token_endpoint: match("token_endpoint"),
+          webmention: match("webmention", node_names: ["link", "a"]),
         }
       end
 
@@ -27,38 +54,32 @@ module IndieWeb
       # @return [HTTP::Response]
       attr_reader :response
 
-      # @return [IndieWeb::Endpoints::ResponseBodyParser]
-      def response_body_parser
-        @response_body_parser ||= ResponseBodyParser.new(response)
+      # @return [Nokogiri::HTML5::Document]
+      def body
+        @body ||= Nokogiri::HTML5(response.body)
       end
 
-      # @return [IndieWeb::Endpoints::ResponseHeadersParser]
-      def response_headers_parser
-        @response_headers_parser ||= ResponseHeadersParser.new(response)
+      # @return [Hash{Symbol => Array<LinkHeaderParser::LinkHeader>}]
+      def headers
+        @headers ||= LinkHeaderParser.parse(response.headers.get("link"), base: response.uri).group_by_relation_type
       end
 
-      # @param identifier [Symbol]
-      # @param nodes [Array<String>]
-      # @return [String, nil]
-      def result_for(identifier, nodes = ["link"])
-        results_for(identifier, nodes)&.first
-      end
+      # @return [Array<String>]
+      def matches_from_body(identifier, node_names)
+        return [] unless response.mime_type == "text/html"
 
-      # @param identifier [Symbol]
-      # @param nodes [Array<String>]
-      # @return [Array<String>, nil]
-      # @raise [IndieWeb::Endpoints::InvalidURIError]
-      def results_for(identifier, nodes = ["link"])
-        results_from_request = [
-          response_headers_parser.results_for(identifier),
-          response_body_parser.results_for(identifier, nodes)
-        ].flatten.compact
+        # Reject endpoints that contain a fragment identifier.
+        selectors = node_names.map { |node| %(#{node}[rel~="#{identifier}"][href]:not([href*="#"])) }.join(",")
 
-        return if results_from_request.none?
+        body.css(selectors).map { |element| element["href"] }
+      end
 
-        results_from_request.map { |endpoint| response.uri.join(endpoint).to_s }.uniq.sort
-      rescue Addressable::URI::InvalidURIError => e
-        raise InvalidURIError, e
+      # @return [Array<String>]
+      def matches_from_headers(identifier)
+        # Reject endpoints that contain a fragment identifier.
+        Array(headers[identifier.to_sym])
+          .filter { |header| !HTTP::URI.parse(header.target_uri).fragment }
+          .map(&:target_uri)
       end
     end
   end

data/lib/indieweb/endpoints.rb

@@ -4,12 +4,8 @@ require "http"
 require "link-header-parser"
 require "nokogiri"
 
-require_relative "endpoints/version"
-
 require_relative "endpoints/client"
 require_relative "endpoints/parser"
-require_relative "endpoints/response_body_parser"
-require_relative "endpoints/response_headers_parser"
 
 module IndieWeb
   module Endpoints
@@ -23,13 +19,14 @@ module IndieWeb
 
     # Discover a URL's IndieAuth, Micropub, Microsub, and Webmention endpoints.
     #
-    # Convenience method for {IndieWeb::Endpoints::Client#endpoints}.
+    # Convenience method for {Client#endpoints}.
     #
     # @example
     #   IndieWeb::Endpoints.get("https://aaronparecki.com")
     #
-    # @param (see IndieWeb::Endpoints::Client#endpoints)
-    # @return (see IndieWeb::Endpoints::Client#endpoints)
+    # @param (see Client#initialize)
+    #
+    # @return (see Client#endpoints)
     def self.get(url)
       Client.new(url).endpoints
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - Jason Garber
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -30,28 +29,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.13'
 description: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.
 email:
 - jason@sixtwothree.org
@@ -68,18 +67,16 @@ files:
 - lib/indieweb/endpoints.rb
 - lib/indieweb/endpoints/client.rb
 - lib/indieweb/endpoints/parser.rb
-- lib/indieweb/endpoints/response_body_parser.rb
-- lib/indieweb/endpoints/response_headers_parser.rb
-- lib/indieweb/endpoints/version.rb
 homepage: https://github.com/indieweb/indieweb-endpoints-ruby
 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/v9.0.0
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/releases/tag/v9.1.0
+  documentation_uri: https://rubydoc.info/gems/indieweb-endpoints/9.1.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/v9.0.0
-post_install_message: 
+  source_code_uri: https://github.com/indieweb/indieweb-endpoints-ruby/tree/v9.1.0
 rdoc_options: []
 require_paths:
 - lib
@@ -87,15 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.
 test_files: []

data/lib/indieweb/endpoints/response_body_parser.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    # @api private
-    class ResponseBodyParser
-      # @param response [HTTP::Response]
-      def initialize(response)
-        @body = response.body.to_s
-        @mime_type = response.mime_type
-        @uri = response.uri
-      end
-
-      # @param identifier [Symbol]
-      # @param nodes [Array<String>]
-      # @return [Array<string>, nil]
-      def results_for(identifier, nodes = ["link"])
-        return unless mime_type == "text/html"
-
-        # Reject endpoints that contain a fragment identifier
-        selectors = nodes.map { |node| %(#{node}[rel~="#{identifier}"][href]:not([href*="#"])) }.join(",")
-
-        parsed_body.css(selectors).map { |element| element["href"] }
-      end
-
-      private
-
-      # @return [String]
-      attr_reader :body
-
-      # @return [String]
-      attr_reader :mime_type
-
-      # @return [HTTP::URI]
-      attr_reader :uri
-
-      # @return [Nokogiri::HTML5::Document]
-      def parsed_body
-        @parsed_body ||= Nokogiri::HTML5(body)
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/response_headers_parser.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    # @api private
-    class ResponseHeadersParser
-      # @param response [HTTP::Response]
-      def initialize(response)
-        @headers = response.headers.get("link")
-        @uri = response.uri
-      end
-
-      # @param identifier [Symbol]
-      # @return [Array<String>, nil]
-      def results_for(identifier)
-        # Reject endpoints that contain a fragment identifier
-        parsed_headers[identifier]&.filter_map do |header|
-          header.target_uri unless HTTP::URI.parse(header.target_uri).fragment
-        end
-      end
-
-      private
-
-      # @return [Array<String>]
-      attr_reader :headers
-
-      # @return [HTTP::URI]
-      attr_reader :uri
-
-      # @return [Hash{Symbol => Array<LinkHeaderParser::LinkHeader>}]
-      def parsed_headers
-        @parsed_headers ||= LinkHeaderParser.parse(headers, base: uri).group_by_relation_type
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    VERSION = "9.0.0"
-  end
-end