indieweb-endpoints 10.2.0 → 10.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93961d5b2254ded47773579d8b1d357621571be0256c6ccfc5768177703a28c5
-  data.tar.gz: 95904542302a29d07aefe58f49095a4db8cacb2a3fb0faca80ddd4a62b8e178d
+  metadata.gz: ea9b5e5a041478750b3af2f317436b40df1e360994107298737874aa914ad669
+  data.tar.gz: 3b2efbfeef50178c5a1583160483fa8a920d49f7a5d5bd82d81cfdcde8b995b4
 SHA512:
-  metadata.gz: 6b33c1da625391e747d6b8481cff57980d3bb8099b6ff5d286f8d6765bdec91cba5560d9a49d0cc0df51593e94ea8eb0bb42c34a8c6ccd85f6d3d898eeba5234
-  data.tar.gz: f4394054e1814421691e981d4b16d6c8568d0f9184f03b74ce88f228687b24ecc10e9de253dc9ad12aeb23342cee77ab8ef39c2844cd2f2f0ec854e20ed207e7
+  metadata.gz: b01d5fe05e209cebc5859d70b954a3d3833e6e3859b3276d8914c8bc4d8e79ce75950c7866725c8f4082a4fbd6f5d5265e8b361a87c8493ba68a116a33cfe655
+  data.tar.gz: 1efbe90ec8d70b802b474904e58042f8284c11eaac41f717ce07d083146cb2af86ea863f06fdd9329a99965ad83474f73dab703826be09faf83d693c720e42c5

data/README.md

@@ -37,11 +37,11 @@ With indieweb-endpoints-ruby added to your project's `Gemfile` and installed, yo
 ```ruby
 require "indieweb/endpoints"
 
-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" }
+IndieWeb::Endpoints.get("https://adactio.com")
+#=> { authorization_endpoint: "https://indieauth.com/auth", "indieauth-metadata": nil, micropub: "https://adactio.com/micropub", microsub: "https://aperture.p3k.io/microsub/152", redirect_uri: nil, token_endpoint: "https://tokens.indieauth.com/token", webmention: "https://adactio.com/webmention"}
 ```
 
-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.
+This example will search [Jeremy's website](https://adactio.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
 
@@ -50,22 +50,22 @@ Should the need arise, you may work with the `IndieWeb::Endpoints::Client` class
 ```ruby
 require "indieweb/endpoints"
 
-client = IndieWeb::Endpoints::Client.new("https://aaronparecki.com")
-#=> #<IndieWeb::Endpoints::Client uri: "https://aaronparecki.com">
+client = IndieWeb::Endpoints::Client.new("https://adactio.com")
+#=> #<IndieWeb::Endpoints::Client @uri: Addressable::URI URI:https://adactio.com>>
 
 client.response
 #=> #<HTTP::Response/1.1 200 OK {…}>
 
 client.endpoints
-#=> { authorization_endpoint: "https://aaronparecki.com/auth", 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" }
+#=> { authorization_endpoint: "https://indieauth.com/auth", "indieauth-metadata": nil, micropub: "https://adactio.com/micropub", microsub: "https://aperture.p3k.io/microsub/152", redirect_uri: nil, token_endpoint: "https://tokens.indieauth.com/token", webmention: "https://adactio.com/webmention"}
 ```
 
 ### Exception Handling
 
 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`
 - `IndieWeb::Endpoints::HttpError`
+- `IndieWeb::Endpoints::InvalidURIError`
 - `IndieWeb::Endpoints::SSLError`
 
 ## Contributing

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.2.0"
+  spec.version = "10.3.0"
   spec.authors = ["Jason Garber"]
   spec.email = ["jason@sixtwothree.org"]
 
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
     "source_code_uri" => "#{spec.homepage}/tree/v#{spec.version}",
   }
 
-  spec.add_dependency "http", ">= 5.3"
+  spec.add_dependency "addressable", "~> 2.9"
   spec.add_dependency "link-header-parser", "~> 7.0", ">= 7.0.1"
   spec.add_dependency "nokogiri-html-ext", "~> 1.7"
 end

data/lib/indieweb/endpoints/client.rb

@@ -4,75 +4,48 @@ module IndieWeb
   module Endpoints
     # A client interface to parse IndieWeb endpoints from a URL.
     class Client
-      # 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
-      #   IndieWeb::Endpoints::Client.new("https://aaronparecki.com")
-      #
-      # @param url [String, HTTP::URI, #to_s] An absolute URL.
+      #   IndieWeb::Endpoints::Client.new("https://adactio.com")
       #
-      # @raise [InvalidURIError]
+      # @param url [String, #to_s] An absolute URL.
       def initialize(url)
-        @uri = HTTP::URI.parse(url)
-      rescue Addressable::URI::InvalidURIError, HTTP::URI::InvalidError => e
-        raise InvalidURIError, e
+        @url = url
       end
 
       # @!visibility private
       # simplecov:disable
       def inspect
-        "#<#{self.class}:#{format("%#0x", object_id)} @uri: #{@uri.inspect}>"
+        "#<#{self.class}:#{format("%#0x", object_id)} @url: #{@url}>"
       end
       # simplecov:enable
 
-      # The IndieWeb endpoints advertised by the provided URL.i
+      # The IndieWeb endpoints advertised by the provided URL.
       #
       # @example
-      #   IndieWeb::Endpoints::Client.new("https://aaronparecki.com").endpoints
+      #   IndieWeb::Endpoints::Client.new("https://adactio.com").endpoints
+      #
+      # @raise (see #response)
       #
       # @return [Hash{Symbol => String, Array, nil}]
       def endpoints
-        @endpoints ||= Parser.new(response).to_h
+        @endpoints ||=
+          Parser.new(
+            body: response.body,
+            headers: response.fetch("link", []),
+            mime_type: response.content_type,
+            uri: response.uri
+          ).to_h
       end
 
-      # The `HTTP::Response` object for the provided URL.
+      # The `Net::HTTPResponse` for the provided URL.
       #
-      # @raise [HttpError, SSLError]
+      # @raise (see HTTP#get)
       #
-      # @return [HTTP::Response]
+      # @return (see HTTP#get)
       def response
-        @response ||= client.request(:get, @uri)
-      rescue HTTP::Error => e
-        raise HttpError, e
-      rescue OpenSSL::SSL::SSLError => e
-        raise SSLError, e
-      end
-
-      private
-
-      # @return [HTTP::Client]
-      def client
-        @client ||= HTTP::Client.new(HTTP_CLIENT_OPTS)
+        @response ||= HTTP.new(@url).fetch
       end
     end
   end

data/lib/indieweb/endpoints/exceptions.rb

@@ -2,9 +2,16 @@
 
 module IndieWeb
   module Endpoints
+    # Base error class.
     class Error < StandardError; end
+
+    # Re-raises rescued exceptions originating from `Net::HTTP` responses.
     class HttpError < Error; end
+
+    # Re-raises rescued `Addressable::URI::InvalidURIError`.
     class InvalidURIError < Error; end
+
+    # Re-raises rescued `OpenSSL::OpenSSLError`.
     class SSLError < Error; end
   end
 end

data/lib/indieweb/endpoints/http.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module IndieWeb
+  module Endpoints
+    # A simple HTTP client to fetch a URL.
+    #
+    # @api private
+    #
+    # HTTP client defaults are derived from Webmention specification.
+    #
+    # @see https://www.w3.org/TR/webmention/#limits-on-get-requests
+    #   W3C Webmention Recommendation § 4.2 Limits on GET requests
+    class HTTP
+      HTTP_CLIENT_OPTS = {
+        open_timeout: 5,
+        read_timeout: 5,
+        ssl_timeout: 5,
+      }.freeze
+
+      HTTP_MAX_REDIRECTS = 20
+
+      HTTP_REQUEST_HEADERS = {
+        "accept" => "*/*",
+        "user-agent" => "Mozilla/5.0 (compatible; IndieWebEndpointsDiscovery/1.0; +https://rubygems.org/gems/indieweb-endpoints)",
+      }.freeze
+
+      private_constant :HTTP_CLIENT_OPTS
+      private_constant :HTTP_MAX_REDIRECTS
+      private_constant :HTTP_REQUEST_HEADERS
+
+      # @param uri [Addressable::URI]
+      def initialize(uri)
+        @redirects = 0
+        @uri = uri
+      end
+
+      # @param uri [Addressable::URI, URI, String] An absolute URL.
+      #
+      # @raise [HttpError, InvalidURIError, SSLError]
+      #
+      # @return [Net::HTTPResponse]
+      def fetch(uri = @uri)
+        raise if @redirects > HTTP_MAX_REDIRECTS
+
+        make_request(Addressable::URI.parse(uri).normalize!)
+      rescue Addressable::URI::InvalidURIError => e
+        raise InvalidURIError, e
+      rescue OpenSSL::OpenSSLError => e
+        raise SSLError, e
+      rescue StandardError => e
+        raise HttpError, e
+      end
+
+      private
+
+      def handle_response(response)
+        case response
+        when Net::HTTPRedirection
+          @redirects += 1
+          fetch(response.uri.merge(response.fetch("location")))
+        when Net::HTTPSuccess
+          response
+        else
+          response.value
+        end
+      end
+
+      def make_request(uri)
+        Net::HTTP.start(uri.host, use_ssl: uri.scheme == "https", **HTTP_CLIENT_OPTS) do |http|
+          handle_response(http.get(URI.parse(uri), HTTP_REQUEST_HEADERS))
+        end
+      end
+    end
+  end
+end

data/lib/indieweb/endpoints/parser.rb

@@ -2,16 +2,17 @@
 
 module IndieWeb
   module Endpoints
-    # A parser for extracting IndieWeb endpoints from an `HTTP::Response`
-    # instance's headers and body.
-    #
-    # @api private
+    # A parser for extracting IndieWeb endpoints from an HTTP response's headers
+    # and body.
     class Parser
-      # @param response [HTTP::Response]
-      def initialize(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
+      # @param body [String, #to_s]
+      # @param headers [Array<String>]
+      # @param mime_type [String, #to_s]
+      # @param uri [Addressable::URI, URI, #to_s]
+      def initialize(body: "", headers: [], mime_type: "text/html", uri: "")
+        @body = Nokogiri::HTML5(body.to_s, uri.to_s).resolve_urls!
+        @headers = LinkHeaderParser.parse(Array(headers), base_uri: uri).group_by_relation_type
+        @mime_type = mime_type.to_s
       end
 
       # @param identifier [String]
@@ -69,11 +70,15 @@ module IndieWeb
       #
       # @param identifier [String, #to_sym]
       #
+      # @raise [InvalidURIError]
+      #
       # @return [Array<String>]
       def matches_from_headers(identifier)
         Array(@headers[identifier]).filter_map do |header|
-          header.target_uri unless HTTP::URI.parse(header.target_uri).fragment
+          header.target_uri unless Addressable::URI.parse(header.target_uri).fragment
         end
+      rescue Addressable::URI::InvalidURIError => e
+        raise InvalidURIError, e
       end
     end
   end

data/lib/indieweb/endpoints.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
-require "http"
+require "net/http"
+
+require "addressable"
 require "link-header-parser"
 require "nokogiri/html-ext"
 
-require_relative "endpoints/exceptions"
 require_relative "endpoints/client"
+require_relative "endpoints/exceptions"
+require_relative "endpoints/http"
 require_relative "endpoints/parser"
 
 # Welcome to the IndieWeb, a people-focused alternative to the "corporate web."
@@ -19,11 +22,11 @@ module IndieWeb
     # Convenience method for {Client#endpoints}.
     #
     # @example
-    #   IndieWeb::Endpoints.get("https://aaronparecki.com")
+    #   IndieWeb::Endpoints.get("https://adactio.com")
     #
     # @param (see Client#initialize)
     #
-    # @raise (see Client#initialize)
+    # @raise (see Client#endpoints)
     #
     # @return (see Client#endpoints)
     def self.get(url)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 10.2.0
+  version: 10.3.0
 platform: ruby
 authors:
 - Jason Garber
@@ -10,19 +10,19 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: http
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: link-header-parser
   requirement: !ruby/object:Gem::Requirement
@@ -74,17 +74,18 @@ files:
 - lib/indieweb/endpoints.rb
 - lib/indieweb/endpoints/client.rb
 - lib/indieweb/endpoints/exceptions.rb
+- lib/indieweb/endpoints/http.rb
 - lib/indieweb/endpoints/parser.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/v10.2.0
-  documentation_uri: https://rubydoc.info/gems/indieweb-endpoints/10.2.0
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/releases/tag/v10.3.0
+  documentation_uri: https://rubydoc.info/gems/indieweb-endpoints/10.3.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.2.0
+  source_code_uri: https://github.com/indieweb/indieweb-endpoints-ruby/tree/v10.3.0
 rdoc_options: []
 require_paths:
 - lib