🚜 Refactor Tractor 🚜

This commit represents a nearly complete rewrite of the gem's code with
(hopefully) zero change to the user-facing API. There are _many_ fewer
files and the end results should be the same.

Author: jgarber623

indieweb-endpoints.gemspec

@@ -27,8 +27,7 @@ Gem::Specification.new do |spec|
     'rubygems_mfa_required' => 'true'
   }
 
-  spec.add_runtime_dependency 'addressable', '~> 2.8'
   spec.add_runtime_dependency 'http', '~> 5.0'
   spec.add_runtime_dependency 'link-header-parser', '~> 4.0'
-  spec.add_runtime_dependency 'nokogiri', '~> 1.12'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.13'
 end

lib/indieweb/endpoints.rb

@@ -1,28 +1,22 @@
 # frozen_string_literal: true
 
-require 'addressable/uri'
 require 'http'
 require 'link-header-parser'
 require 'nokogiri'
 
 require_relative 'endpoints/version'
-require_relative 'endpoints/exceptions'
-
-require_relative 'endpoints/services/response_parser_service'
 
 require_relative 'endpoints/client'
-require_relative 'endpoints/parsers'
-
-require_relative 'endpoints/parsers/base_parser'
-require_relative 'endpoints/parsers/authorization_endpoint_parser'
-require_relative 'endpoints/parsers/micropub_parser'
-require_relative 'endpoints/parsers/microsub_parser'
-require_relative 'endpoints/parsers/redirect_uri_parser'
-require_relative 'endpoints/parsers/token_endpoint_parser'
-require_relative 'endpoints/parsers/webmention_parser'
+require_relative 'endpoints/parser'
+require_relative 'endpoints/response_body_parser'
+require_relative 'endpoints/response_headers_parser'
 
 module IndieWeb
   module Endpoints
+    class Error < StandardError; end
+    class HttpError < Error; end
+    class InvalidURIError < Error; end
+
     # Discover a URL's IndieAuth, Micropub, Microsub, and Webmention endpoints
     #
     #   IndieWeb::Endpoints.get('https://aaronparecki.com')

lib/indieweb/endpoints/client.rb

@@ -12,39 +12,43 @@ class Client
       #
       #   client = IndieWeb::Endpoints::Client.new('https://aaronparecki.com')
       #
-      # @param url [String] an absolute URL
+      # @param url [String, HTTP::URI, #to_s] an absolute URL
+      # @raise [IndieWeb::Endpoints::InvalidURIError]
       def initialize(url)
-        @url = url.to_str
+        @uri = HTTP::URI.parse(url.to_s)
+      rescue Addressable::URI::InvalidURIError => e
+        raise InvalidURIError, e
       end
 
       # @return [String]
       def inspect
-        "#<#{self.class.name}:#{format('%#0x', object_id)} url: #{url.inspect}>"
+        %(#<#{self.class.name}:#{format('%#0x', object_id)} uri: "#{uri}">)
       end
 
+      # A Hash of the discovered IndieWeb endpoints from the provided URL
+      #
       # @return [Hash{Symbol => String, Array, nil}]
       def endpoints
-        @endpoints ||= Parsers.registered.transform_values { |parser| parser.new(response).results }
+        @endpoints ||= Parser.new(response).results
       end
 
-      # @see https://www.w3.org/TR/webmention/#limits-on-get-requests
+      # The HTTP::Response object returned by the provided URL
       #
       # @return [HTTP::Response]
+      # @raise [IndieWeb::Endpoints::HttpError]
       def response
-        @response ||= HTTP.follow(max_hops: 20).headers(HTTP_HEADERS_OPTS).timeout(connect: 5, read: 5).get(uri)
+        @response ||= HTTP.follow(max_hops: 20)
+                          .headers(HTTP_HEADERS_OPTS)
+                          .timeout(connect: 5, read: 5)
+                          .get(uri)
       rescue HTTP::Error => e
         raise HttpError, e
       end
 
       private
 
-      attr_accessor :url
-
-      def uri
-        @uri ||= Addressable::URI.parse(url)
-      rescue Addressable::URI::InvalidURIError => e
-        raise InvalidURIError, e
-      end
+      # @return [HTTP::URI]
+      attr_reader :uri
     end
   end
 end

lib/indieweb/endpoints/exceptions.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module IndieWeb
+  module Endpoints
+    # @api private
+    class Parser
+      # @param response [HTTP::Response]
+      def initialize(response)
+        @response = response
+      end
+
+      # @return [Hash{Symbol => String, Array<String>, nil}]
+      def results
+        {
+          authorization_endpoint: result_for(:authorization_endpoint),
+          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])
+        }
+      end
+
+      private
+
+      # @return [HTTP::Response]
+      attr_reader :response
+
+      # @return [IndieWeb::Endpoints::ResponseBodyParser]
+      def response_body_parser
+        @response_body_parser ||= ResponseBodyParser.new(response)
+      end
+
+      # @return [IndieWeb::Endpoints::ResponseHeadersParser]
+      def response_headers_parser
+        @response_headers_parser ||= ResponseHeadersParser.new(response)
+      end
+
+      # @param identifier [Symbol]
+      # @param nodes [Array<String>]
+      # @return [String, nil]
+      def result_for(identifier, nodes = ['link'])
+        results_for(identifier, nodes)&.first
+      end
+
+      # @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
+
+        return if results_from_request.none?
+
+        results_from_request.map { |endpoint| response.uri.join(endpoint).to_s }.uniq.sort
+      rescue Addressable::URI::InvalidURIError => e
+        raise InvalidURIError, e
+      end
+    end
+  end
+end