indieweb-endpoints 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 151e40ea1ac993997ee70da6c2f997609fb1311f33ab4f10d9090d76a555c3ec
-  data.tar.gz: 73547ed72b54f2c2b954bc89df1b697bd22fbc02ea59104b6dc841b7ec9ab6ab
+  metadata.gz: d00bf075ce905d49768b047c4963ccc8fb260e3ce7c06a1305a10099bdf6e4a0
+  data.tar.gz: 2c50a4fe3f85d401ccf981e5ef4c374e35f2788a2a00422f52df08c7a7c9821f
 SHA512:
-  metadata.gz: 34e13013f71ae9d4ea89fbf1ba2a40619579023203a95a72b30c552b80ce3442e13d4eceeef4eaeceed074f3e9e39300a0b45c42e50a16c072a72f9f863b8809
-  data.tar.gz: 2f3c6b0e7267e69096f348210bf087b171c2d4acb64577bcc1a9440b0367655c85c62c23d837f054984389b4b484e39daab085db4112bd2f5777b3ce0cd33534
+  metadata.gz: ed757712cf9c99812ebdf2eb514c37b4a78cf0fd9f86c416611ce64a854706eb0e7b08599be0681438a774b76dbc9e03b2bb8434107fd17dec37403686743182
+  data.tar.gz: cadd7fad871a5d33f88e9365f7b8b1300c331cd96f2716d17f24ae8eac9eec79c463f4e45c68cb18fa35d602393fd771d3face3723c0acc1e3ab46acba02f7c7

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 7.1.0 / 2022-03-08
+
+- Refactor gem code (eba8115)
+- Refactor specs (5b92119)
+- Rescue from `OpenSSL::SSL::SSLError` (4ea38e5)
+
 ## 7.0.0 / 2022-01-06
 
 - Update runtime dependency versions (5c9430f)

data/README.md

@@ -59,7 +59,7 @@ Should the need arise, you may work with the `IndieWeb::Endpoints::Client` class
 require 'indieweb/endpoints'
 
 client = IndieWeb::Endpoints::Client.new('https://aaronparecki.com')
-#=> #<IndieWeb::Endpoints::Client url: "https://aaronparecki.com">
+#=> #<IndieWeb::Endpoints::Client uri: "https://aaronparecki.com">
 
 client.response
 #=> #<HTTP::Response/1.1 200 OK {…}>
@@ -80,6 +80,10 @@ From [httprb/http](https://github.com/httprb/http):
 
 - `IndieWeb::Endpoints::HttpError`
 
+From the Ruby Standard Library's [`OpenSSL::SSL::SSLError`](https://ruby-doc.org/stdlib-2.6.9/libdoc/openssl/rdoc/OpenSSL/SSL/SSLError.html):
+
+- `IndieWeb::Endpoints::SSLError`
+
 ## Contributing
 
 Interested in helping improve indieweb-endpoints-ruby? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/indieweb/indieweb-endpoints-ruby/blob/main/CONTRIBUTING.md) for details.

data/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

data/lib/indieweb/endpoints/client.rb

@@ -12,39 +12,45 @@ module IndieWeb
       #
       #   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
+      rescue OpenSSL::SSL::SSLError => e
+        raise SSLError, 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

data/lib/indieweb/endpoints/parser.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

data/lib/indieweb/endpoints/response_body_parser.rb

@@ -0,0 +1,43 @@
+# 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

@@ -0,0 +1,36 @@
+# 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 headers [Symbol]
+      # @return [Array<String>, nil]
+      def results_for(identifier)
+        return unless parsed_headers.key?(identifier)
+
+        # Reject endpoints that contain a fragment identifier
+        parsed_headers[identifier].reject { |header| HTTP::URI.parse(header.target_uri).fragment }.map(&:target_uri)
+      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

@@ -2,6 +2,6 @@
 
 module IndieWeb
   module Endpoints
-    VERSION = '7.0.0'
+    VERSION = '7.1.0'
   end
 end

data/lib/indieweb/endpoints.rb

@@ -1,28 +1,23 @@
 # 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
+    class SSLError < Error; end
+
     # Discover a URL's IndieAuth, Micropub, Microsub, and Webmention endpoints
     #
     #   IndieWeb::Endpoints.get('https://aaronparecki.com')

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
 description: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.
 email:
 - jason@sixtwothree.org
@@ -81,23 +67,16 @@ files:
 - indieweb-endpoints.gemspec
 - lib/indieweb/endpoints.rb
 - lib/indieweb/endpoints/client.rb
-- lib/indieweb/endpoints/exceptions.rb
-- lib/indieweb/endpoints/parsers.rb
-- lib/indieweb/endpoints/parsers/authorization_endpoint_parser.rb
-- lib/indieweb/endpoints/parsers/base_parser.rb
-- lib/indieweb/endpoints/parsers/micropub_parser.rb
-- lib/indieweb/endpoints/parsers/microsub_parser.rb
-- lib/indieweb/endpoints/parsers/redirect_uri_parser.rb
-- lib/indieweb/endpoints/parsers/token_endpoint_parser.rb
-- lib/indieweb/endpoints/parsers/webmention_parser.rb
-- lib/indieweb/endpoints/services/response_parser_service.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/blob/v7.0.0/CHANGELOG.md
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v7.1.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []

data/lib/indieweb/endpoints/exceptions.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    class Error < StandardError; end
-
-    class ArgumentError < Error; end
-
-    class HttpError < Error; end
-
-    class InvalidURIError < Error; end
-  end
-end

data/lib/indieweb/endpoints/parsers/authorization_endpoint_parser.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    module Parsers
-      class AuthorizationEndpointParser < BaseParser
-        @identifier = :authorization_endpoint
-
-        Parsers.register(self)
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/parsers/base_parser.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    module Parsers
-      class BaseParser
-        class << self
-          attr_reader :identifier
-        end
-
-        # @param response [HTTP::Response]
-        def initialize(response)
-          raise ArgumentError, "response must be an HTTP::Response (given #{response.class.name})" unless response.is_a?(HTTP::Response)
-
-          @response = response
-        end
-
-        # @return [String]
-        def results
-          mapped_results.shift
-        end
-
-        private
-
-        attr_reader :response
-
-        def mapped_results
-          @mapped_results ||= results_from_http_request.map { |endpoint| Addressable::URI.join(response.uri, endpoint).to_s }.uniq.sort
-        rescue Addressable::URI::InvalidURIError => e
-          raise InvalidURIError, e
-        end
-
-        def parsed_response_body
-          @parsed_response_body ||= Nokogiri::HTML(response.body.to_s)
-        end
-
-        def parsed_response_headers
-          @parsed_response_headers ||= LinkHeaderParser.parse(response.headers.get('link'), base: response.uri)
-        end
-
-        def results_from_body
-          return if response.mime_type != 'text/html'
-
-          Services::ResponseParserService.parse_body(parsed_response_body, self.class.identifier)
-        end
-
-        def results_from_headers
-          return if parsed_response_headers.none?
-
-          Services::ResponseParserService.parse_headers(parsed_response_headers.group_by_relation_type, self.class.identifier)
-        end
-
-        def results_from_http_request
-          @results_from_http_request ||= [results_from_headers, results_from_body].flatten.compact
-        end
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/parsers/micropub_parser.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    module Parsers
-      class MicropubParser < BaseParser
-        @identifier = :micropub
-
-        Parsers.register(self)
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/parsers/microsub_parser.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    module Parsers
-      class MicrosubParser < BaseParser
-        @identifier = :microsub
-
-        Parsers.register(self)
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/parsers/redirect_uri_parser.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    module Parsers
-      class RedirectUriParser < BaseParser
-        @identifier = :redirect_uri
-
-        Parsers.register(self)
-
-        # @return [Array<String>, nil]
-        def results
-          return if mapped_results.none?
-
-          mapped_results
-        end
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/parsers/token_endpoint_parser.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    module Parsers
-      class TokenEndpointParser < BaseParser
-        @identifier = :token_endpoint
-
-        Parsers.register(self)
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/parsers/webmention_parser.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    module Parsers
-      class WebmentionParser < BaseParser
-        @identifier = :webmention
-
-        Parsers.register(self)
-
-        private
-
-        def results_for_node(node)
-          Services::ResponseParserService.parse_body(parsed_response_body, self.class.identifier, node)
-        end
-
-        # https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint
-        def results_from_body
-          @results_from_body ||= [results_for_node('link'), results_for_node('a')].flatten.compact
-        end
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/parsers.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    module Parsers
-      def self.register(klass)
-        registered[klass.identifier] = klass
-      end
-
-      def self.registered
-        @registered ||= {}
-      end
-    end
-  end
-end

data/lib/indieweb/endpoints/services/response_parser_service.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module IndieWeb
-  module Endpoints
-    module Services
-      class ResponseParserService
-        # @param body [Nokogiri::HTML::Document]
-        # @param identifier [Symbol]
-        # @return [Array<String>]
-        def self.parse_body(body, identifier, node = 'link')
-          # Reject endpoints that contain a fragment identifier
-          body.css(%(#{node}[rel~="#{identifier}"][href]:not([href*="#"]))).map { |element| element['href'] }
-        end
-
-        # @param headers [Hash{Symbol => Array<LinkHeaderParser::LinkHeader}]
-        # @param identifier [Symbol]
-        # @return [Array<String>, nil]
-        def self.parse_headers(headers, identifier)
-          return unless headers.key?(identifier)
-
-          # Reject endpoints that contain a fragment identifier
-          headers[identifier].reject { |header| Addressable::URI.parse(header.target_uri).fragment }.map(&:target_uri)
-        end
-      end
-    end
-  end
-end