indieweb-endpoints 1.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08489907fd615d0e6eec6e6c80aee184713c5a65014c150255517413688693dd'
-  data.tar.gz: 0d426b9e30cc91dacec91f26fea509d0b761ac30b96c02336d28b99d0aad68d9
+  metadata.gz: d751a18dc854951b0c3b71429959f2fdd0690ee9ba51a1b5cf6b6cc5dcec5143
+  data.tar.gz: 5b3dd9ab89de1bf668471c58d4bf8097633125e37b9ccf80d0c94554ae3dbe38
 SHA512:
-  metadata.gz: 468db55b447dddc64b56c60a013111d74f7d25c9f71ae3ca728484bc60a283652f87cefe92ec187125f57bce1a7512bcb02047c0e85bac671297bcfce95d5e0a
-  data.tar.gz: bd0d10b05873cefe89c64ae2144896c59c06556e58d8980da19dd1a85f5959a9c1601f2c15c2689faba6b86a115edfb4419d8ec2d9ce5ff4b1fac83e40f6a209
+  metadata.gz: 8b2dc2195a547c955545ff89d540e40dde34de784490271c6726afd49249f4ebd66bafcdd43bcc3dff30ca9444f306aa4264da7849b19f9401575dbe3dcd49f4
+  data.tar.gz: 356ab5dbb4ea2b233ab490323bd80da4e61568654a0c1c209fd6e7932fe7af5ba15792ee209f79ab650f54478e18a9d67357b8204c7dc40a4d2cddf2d04dba8f

data/CHANGELOG.md

@@ -1,8 +1,40 @@
 # Changelog
 
+## 6.0.0 / 2021-05-25
+
+- Refactor parsers (e22e0af)
+- Simplify exception handling (65361ee)
+- Update http dependency to 5.0 (44f2d23)
+- **Breaking change:** Favor Addressable::URI.join over Absolutely (0bc5049)
+- Update development Ruby version to 2.5.9 (3439cce)
+
+## 5.0.0 / 2020-11-11
+
+- Update absolutely and link-header-parser dependencies (064696e)
+
+## 4.0.0 / 2020-07-21
+
+- **Breaking change:** Return a Hash of endpoints instead of an OpenStruct (15dc387)
+- Update [link-header-parser](https://rubygems.org/gems/link-header-parser) dependency to v2.0.0 (2255e6b)
+- **Breaking change:** Update development Ruby version to 2.5.8 and minimum Ruby version to 2.5 (dd5a142)
+- Refactor response headers/body parsers into a single class (ee02da3)
+- Refactor `IndieWeb::Endpoints::Client` and remove `HttpRequestService` (2732616)
+- Add offending url to exception message (#5) (4bf7a54)
+
+## 3.0.0 / 2020-05-14
+
+- Update Absolutely and LinkHeaderParser dependencies (9e0a64a)
+- Move development dependencies to `Gemfile` (67067f3)
+- Update development Ruby version to 2.4.10 (f5430f9)
+
+## 2.0.0 / 2020-01-25
+
+- Downgrade HTTP gem version constraint to ~> 4.3 (cb63230)
+
 ## 1.1.0 / 2020-01-20
 
 - Expand supported Ruby versions to include 2.7 (ae63ed0)
+- Update project Ruby version to 2.4.9 (e576ad6)
 
 ## 1.0.2 / 2019-08-31
 

data/CONTRIBUTING.md

@@ -8,9 +8,9 @@ There are a couple ways you can help improve indieweb-endpoints-ruby:
 
 ## Getting Started
 
-indieweb-endpoints-ruby is developed using Ruby 2.4.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
+indieweb-endpoints-ruby is developed using Ruby 2.5.9 and is additionally tested against Ruby 2.6 and 2.7 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
 
-Before making changes to indieweb-endpoints-ruby, you'll want to install Ruby 2.4.9. It's recommended that you use 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). Once you've installed Ruby 2.4.9 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 2.5.9. It's recommended that you use 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). Once you've installed Ruby 2.5.9 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install
@@ -22,7 +22,7 @@ bundle install
 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. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bin/ci`.
 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.

data/README.md

@@ -2,23 +2,23 @@
 
 **A Ruby gem for discovering a URL's [IndieAuth](https://indieweb.org/IndieAuth), [Micropub](https://indieweb.org/Micropub), [Microsub](https://indieweb.org/Microsub), and [Webmention](https://indieweb.org/Webmention) endpoints.**
 
-[![Gem](https://img.shields.io/gem/v/indieweb-endpoints.svg?style=for-the-badge)](https://rubygems.org/gems/indieweb-endpoints)
-[![Downloads](https://img.shields.io/gem/dt/indieweb-endpoints.svg?style=for-the-badge)](https://rubygems.org/gems/indieweb-endpoints)
-[![Build](https://img.shields.io/travis/com/indieweb/indieweb-endpoints-ruby/master.svg?style=for-the-badge)](https://travis-ci.com/indieweb/indieweb-endpoints-ruby)
-[![Maintainability](https://img.shields.io/codeclimate/maintainability/indieweb/indieweb-endpoints-ruby.svg?style=for-the-badge)](https://codeclimate.com/github/indieweb/indieweb-endpoints-ruby)
-[![Coverage](https://img.shields.io/codeclimate/c/indieweb/indieweb-endpoints-ruby.svg?style=for-the-badge)](https://codeclimate.com/github/indieweb/indieweb-endpoints-ruby/code)
+[![Gem](https://img.shields.io/gem/v/indieweb-endpoints.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/indieweb-endpoints)
+[![Downloads](https://img.shields.io/gem/dt/indieweb-endpoints.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/indieweb-endpoints)
+[![Build](https://img.shields.io/travis/com/indieweb/indieweb-endpoints-ruby/main.svg?logo=travis&style=for-the-badge)](https://travis-ci.com/indieweb/indieweb-endpoints-ruby)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/indieweb/indieweb-endpoints-ruby.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/indieweb/indieweb-endpoints-ruby)
+[![Coverage](https://img.shields.io/codeclimate/c/indieweb/indieweb-endpoints-ruby.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/indieweb/indieweb-endpoints-ruby/code)
 
 ## Key Features
 
 - 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 2.4 and newer.
+- Supports Ruby 2.5 and newer.
 
 ## Getting Started
 
-Before installing and using indieweb-endpoints-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.4 (or newer) installed. It's recommended that you use 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).
+Before installing and using indieweb-endpoints-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.5 (or newer) installed. It's recommended that you use 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).
 
-indieweb-endpoints-ruby is developed using Ruby 2.4.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
+indieweb-endpoints-ruby is developed using Ruby 2.5.9 and is additionally tested against Ruby 2.6, 2.7, and 3.0 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
 
 ## Installation
 
@@ -45,25 +45,11 @@ With indieweb-endpoints-ruby added to your project's `Gemfile` and installed, yo
 ```ruby
 require 'indieweb/endpoints'
 
-endpoints = IndieWeb::Endpoints.get('https://aaronparecki.com')
-
-puts endpoints # => #<OpenStruct 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">
-```
-
-This example will search `https://aaronparecki.com` for valid IndieAuth, Micropub, and Webmention endpoints. In this case, the program returns an `OpenStruct` with the following attributes (represented below as a `Hash`):
-
-```ruby
-{
-  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'
-}
+IndieWeb::Endpoints.get('https://aaronparecki.com')
+#=> { 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" }
 ```
 
-Each attribute will return either a `String` representing a URL or `nil`. The `redirect_uri` attribute will return either an `Array` or `nil` since a given URL may register multiple callback URLs.
+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.
 
 ### Advanced Usage
 
@@ -73,36 +59,30 @@ 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">
 
-puts client.response # => #<HTTP::Response/1.1 200 OK {…}>
-
-endpoints = client.endpoints
+client.response
+#=> #<HTTP::Response/1.1 200 OK {…}>
 
-puts endpoints.authorization_endpoint # => 'https://aaronparecki.com/auth'
-puts endpoints.micropub               # => 'https://aaronparecki.com/micropub'
-puts endpoints.microsub               # => 'https://aperture.p3k.io/microsub/1'
-puts endpoints.redirect_uri           # => nil
-puts endpoints.token_endpoint         # => 'https://aaronparecki.com/auth/token'
-puts endpoints.webmention             # => 'https://webmention.io/aaronpk/webmention'
+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" }
 ```
 
 ### Exception Handling
 
-There are several exceptions that may be raised by indieweb-endpoints-ruby's underlying dependencies. These errors are raised as subclasses of `IndieWebEndpointsError` (which itself is a subclass of `StandardError`).
+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 [jgarber623/absolutely](https://github.com/jgarber623/absolutely) and  [sporkmonger/addressable](https://github.com/sporkmonger/addressable):
+From [sporkmonger/addressable](https://github.com/sporkmonger/addressable):
 
 - `IndieWeb::Endpoints::InvalidURIError`
 
 From [httprb/http](https://github.com/httprb/http):
 
-- `IndieWeb::Endpoints::ConnectionError`
-- `IndieWeb::Endpoints::TimeoutError`
-- `IndieWeb::Endpoints::TooManyRedirectsError`
+- `IndieWeb::Endpoints::HttpError`
 
 ## 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/master/CONTRIBUTING.md) for details.
+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.
 
 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

@@ -1,10 +1,7 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'indieweb/endpoints/version'
+require_relative 'lib/indieweb/endpoints/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ['>= 2.4', '< 2.8']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 2.8')
 
   spec.name          = 'indieweb-endpoints'
   spec.version       = IndieWeb::Endpoints::VERSION
@@ -16,28 +13,17 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/indieweb/indieweb-endpoints-ruby'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  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.require_paths = ['lib']
 
-  spec.metadata = {
-    'bug_tracker_uri' => "#{spec.homepage}/issues",
-    'changelog_uri'   => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
-  }
-
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'reek', '~> 5.6'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'rubocop', '~> 0.79.0'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
-  spec.add_development_dependency 'simplecov', '~> 0.17.1'
-  spec.add_development_dependency 'simplecov-console', '~> 0.6.0'
-  spec.add_development_dependency 'webmock', '~> 3.8'
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['changelog_uri']   = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
 
-  spec.add_runtime_dependency 'absolutely', '~> 3.1'
   spec.add_runtime_dependency 'addressable', '~> 2.7'
-  spec.add_runtime_dependency 'http', '~> 5.0.0.pre'
-  spec.add_runtime_dependency 'link-header-parser', '~> 0.3.0'
-  spec.add_runtime_dependency 'nokogiri', '~> 1.10'
+  spec.add_runtime_dependency 'http', '~> 5.0'
+  spec.add_runtime_dependency 'link-header-parser', '~> 3.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.11'
 end

data/lib/indieweb/endpoints.rb

@@ -1,6 +1,3 @@
-require 'ostruct'
-
-require 'absolutely'
 require 'addressable/uri'
 require 'http'
 require 'link-header-parser'
@@ -9,15 +6,12 @@ require 'nokogiri'
 require 'indieweb/endpoints/version'
 require 'indieweb/endpoints/exceptions'
 
-require 'indieweb/endpoints/concerns/registerable'
-
-require 'indieweb/endpoints/services/http_request_service'
-require 'indieweb/endpoints/services/response_body_parser_service'
-require 'indieweb/endpoints/services/response_headers_parser_service'
+require 'indieweb/endpoints/services/response_parser_service'
 
 require 'indieweb/endpoints/client'
 require 'indieweb/endpoints/parsers'
 
+require 'indieweb/endpoints/parsers/base_parser'
 require 'indieweb/endpoints/parsers/authorization_endpoint_parser'
 require 'indieweb/endpoints/parsers/micropub_parser'
 require 'indieweb/endpoints/parsers/microsub_parser'
@@ -27,6 +21,12 @@ require 'indieweb/endpoints/parsers/webmention_parser'
 
 module IndieWeb
   module Endpoints
+    # Discover a URL's IndieAuth, Micropub, Microsub, and Webmention endpoints
+    #
+    #   IndieWeb::Endpoints.get('https://aaronparecki.com')
+    #
+    # @param url [String] an absolute URL
+    # @return [Hash{Symbol => String, Array, nil}]
     def self.get(url)
       Client.new(url).endpoints
     end

data/lib/indieweb/endpoints/client.rb

@@ -1,27 +1,48 @@
 module IndieWeb
   module Endpoints
     class Client
+      HTTP_HEADERS_OPTS = {
+        accept: '*/*',
+        user_agent: 'IndieWeb Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)'
+      }.freeze
+
+      # Create a new client with a URL to parse for IndieWeb endpoints
+      #
+      #   client = IndieWeb::Endpoints::Client.new('https://aaronparecki.com')
+      #
+      # @param url [String] an absolute URL
       def initialize(url)
-        @uri = Addressable::URI.parse(url)
+        @url = url.to_str
+      end
 
-        raise ArgumentError, 'url must be an absolute URL (e.g. https://example.com)' unless @uri.absolute? && @uri.scheme.match?(/^https?$/)
-      rescue Addressable::URI::InvalidURIError => exception
-        raise InvalidURIError, exception
-      rescue NoMethodError, TypeError
-        raise ArgumentError, "url must be a String (given #{url.class})"
+      # @return [String]
+      def inspect
+        format(%(#<#{self.class.name}:%#0x url: #{url.inspect}>), object_id)
       end
 
+      # @return [Hash{Symbol => String, Array, nil}]
       def endpoints
-        @endpoints ||= OpenStruct.new(Parsers.registered.transform_values { |parser| parser.new(response).results })
+        @endpoints ||= Parsers.registered.transform_values { |parser| parser.new(response).results }
       end
 
+      # @see https://www.w3.org/TR/webmention/#limits-on-get-requests
+      #
+      # @return [HTTP::Response]
       def response
-        @response ||= Services::HttpRequestService.new.get(uri)
+        @response ||= HTTP.follow(max_hops: 20).headers(HTTP_HEADERS_OPTS).timeout(connect: 5, read: 5).get(uri)
+      rescue HTTP::Error => exception
+        raise HttpError, exception
       end
 
       private
 
-      attr_accessor :uri
+      attr_accessor :url
+
+      def uri
+        @uri ||= Addressable::URI.parse(url)
+      rescue Addressable::URI::InvalidURIError => exception
+        raise InvalidURIError, exception
+      end
     end
   end
 end

data/lib/indieweb/endpoints/exceptions.rb

@@ -1,15 +1,11 @@
 module IndieWeb
   module Endpoints
-    class IndieWebEndpointsError < StandardError; end
+    class Error < StandardError; end
 
-    class ArgumentError < IndieWebEndpointsError; end
+    class ArgumentError < Error; end
 
-    class ConnectionError < IndieWebEndpointsError; end
+    class HttpError < Error; end
 
-    class InvalidURIError < IndieWebEndpointsError; end
-
-    class TimeoutError < IndieWebEndpointsError; end
-
-    class TooManyRedirectsError < IndieWebEndpointsError; end
+    class InvalidURIError < Error; end
   end
 end

data/lib/indieweb/endpoints/parsers.rb

@@ -1,40 +1,12 @@
 module IndieWeb
   module Endpoints
     module Parsers
-      extend Concerns::Registerable
-
-      class BaseParser
-        def initialize(response)
-          raise ArgumentError, "response must be an HTTP::Response (given #{response.class.name})" unless response.is_a?(HTTP::Response)
-
-          @response = response
-        end
-
-        def results
-          mapped_results.shift
-        end
-
-        private
-
-        attr_reader :response
-
-        def mapped_results
-          @mapped_results ||= results_from_http_request.map { |endpoint| Absolutely.to_abs(base: response.uri.to_s, relative: endpoint) }.uniq.sort
-        rescue Absolutely::InvalidURIError => exception
-          raise InvalidURIError, exception
-        end
-
-        def results_from_body
-          @results_from_body ||= Services::ResponseBodyParserService.new.parse(response, self.class.identifier)
-        end
-
-        def results_from_headers
-          @results_from_headers ||= Services::ResponseHeadersParserService.new.parse(response, self.class.identifier)
-        end
+      def self.register(klass)
+        registered[klass.identifier] = klass
+      end
 
-        def results_from_http_request
-          @results_from_http_request ||= [results_from_headers, results_from_body].flatten.compact
-        end
+      def self.registered
+        @registered ||= {}
       end
     end
   end

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

@@ -2,9 +2,7 @@ module IndieWeb
   module Endpoints
     module Parsers
       class AuthorizationEndpointParser < BaseParser
-        def self.identifier
-          :authorization_endpoint
-        end
+        @identifier = :authorization_endpoint
 
         Parsers.register(self)
       end

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

@@ -0,0 +1,57 @@
+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 => exception
+          raise InvalidURIError, exception
+        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

@@ -2,9 +2,7 @@ module IndieWeb
   module Endpoints
     module Parsers
       class MicropubParser < BaseParser
-        def self.identifier
-          :micropub
-        end
+        @identifier = :micropub
 
         Parsers.register(self)
       end

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

@@ -2,9 +2,7 @@ module IndieWeb
   module Endpoints
     module Parsers
       class MicrosubParser < BaseParser
-        def self.identifier
-          :microsub
-        end
+        @identifier = :microsub
 
         Parsers.register(self)
       end

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

@@ -2,14 +2,13 @@ module IndieWeb
   module Endpoints
     module Parsers
       class RedirectUriParser < BaseParser
-        def self.identifier
-          :redirect_uri
-        end
+        @identifier = :redirect_uri
 
         Parsers.register(self)
 
+        # @return [Array<String>, nil]
         def results
-          return unless mapped_results.any?
+          return if mapped_results.none?
 
           mapped_results
         end

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

@@ -2,9 +2,7 @@ module IndieWeb
   module Endpoints
     module Parsers
       class TokenEndpointParser < BaseParser
-        def self.identifier
-          :token_endpoint
-        end
+        @identifier = :token_endpoint
 
         Parsers.register(self)
       end

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

@@ -2,16 +2,14 @@ module IndieWeb
   module Endpoints
     module Parsers
       class WebmentionParser < BaseParser
-        def self.identifier
-          :webmention
-        end
+        @identifier = :webmention
 
         Parsers.register(self)
 
         private
 
         def results_for_node(node)
-          Services::ResponseBodyParserService.new.parse(response, self.class.identifier, node)
+          Services::ResponseParserService.parse_body(parsed_response_body, self.class.identifier, node)
         end
 
         # https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint

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

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

data/lib/indieweb/endpoints/version.rb

@@ -1,5 +1,5 @@
 module IndieWeb
   module Endpoints
-    VERSION = '1.1.0'.freeze
+    VERSION = '6.0.0'.freeze
   end
 end

metadata

@@ -1,155 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Jason Garber
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-- !ruby/object:Gem::Dependency
-  name: simplecov-console
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: absolutely
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -170,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: link-header-parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
 description: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.
 email:
 - jason@sixtwothree.org
@@ -213,46 +73,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/CODEOWNERS"
-- ".gitignore"
-- ".reek.yml"
-- ".rspec"
-- ".rubocop"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".simplecov"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - indieweb-endpoints.gemspec
 - lib/indieweb/endpoints.rb
 - lib/indieweb/endpoints/client.rb
-- lib/indieweb/endpoints/concerns/registerable.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/http_request_service.rb
-- lib/indieweb/endpoints/services/response_body_parser_service.rb
-- lib/indieweb/endpoints/services/response_headers_parser_service.rb
+- lib/indieweb/endpoints/services/response_parser_service.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/v1.1.0/CHANGELOG.md
-post_install_message: 
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v6.0.0/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
   - - "<"
     - !ruby/object:Gem::Version
       version: '2.8'
@@ -270,8 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.16
+signing_key:
 specification_version: 4
 summary: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.
 test_files: []

data/.editorconfig

@@ -1,14 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-indent_size = 2
-indent_style = space
-trim_trailing_whitespace = true
-
-[*.md]
-indent_size = 4
-indent_style = tab

data/.github/CODEOWNERS

@@ -1 +0,0 @@
-*  jgarber623

data/.gitignore

@@ -1,34 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-# Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/.reek.yml

@@ -1,11 +0,0 @@
-detectors:
-  IrresponsibleModule:
-    enabled: false
-  UtilityFunction:
-    exclude:
-      - FixtureHelpers#read_fixture
-      - IndieWeb::Endpoints::Services::ResponseBodyParserService#parse
-      - IndieWeb::Endpoints::Services::ResponseHeadersParserService#parse
-
-exclude_paths:
-  - vendor/

data/.rspec

@@ -1,2 +0,0 @@
---order random
---require spec_helper

data/.rubocop

@@ -1,3 +0,0 @@
---display-style-guide
---extra-details
---parallel

data/.rubocop.yml

@@ -1,30 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-Layout/HashAlignment:
-  EnforcedHashRocketStyle: table
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Exclude:
-    - indieweb-endpoints.gemspec
-    - spec/**/*.rb
-
-Naming/RescuedExceptionsVariableName:
-  PreferredName: exception
-
-RSpec/FilePath:
-  Exclude:
-    - spec/lib/indieweb/**/*_spec.rb
-
-Style/Documentation:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-2.4.9

data/.simplecov

@@ -1,11 +0,0 @@
-require 'simplecov-console'
-
-formatters = [SimpleCov::Formatter::HTMLFormatter]
-
-if RSpec.configuration.files_to_run.length > 1
-  formatters << SimpleCov::Formatter::Console
-end
-
-SimpleCov.start do
-  formatter SimpleCov::Formatter::MultiFormatter.new(formatters)
-end

data/.travis.yml

@@ -1,16 +0,0 @@
-dist: bionic
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-cache: bundler
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-notifications:
-  email: false

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in indieweb-endpoints.gemspec
-gemspec

data/Rakefile

@@ -1,17 +0,0 @@
-require 'bundler/gem_tasks'
-
-require 'reek/rake/task'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-Reek::Rake::Task.new do |task|
-  task.fail_on_error = false
-end
-
-RSpec::Core::RakeTask.new
-
-RuboCop::RakeTask.new do |task|
-  task.fail_on_error = false
-end
-
-task default: [:rubocop, :reek, :spec]

data/lib/indieweb/endpoints/concerns/registerable.rb

@@ -1,15 +0,0 @@
-module IndieWeb
-  module Endpoints
-    module Concerns
-      module Registerable
-        def register(klass)
-          registered[klass.identifier] = klass
-        end
-
-        def registered
-          @registered ||= {}
-        end
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-module IndieWeb
-  module Endpoints
-    module Services
-      class HttpRequestService
-        # Defaults derived from Webmention specification examples
-        # https://www.w3.org/TR/webmention/#limits-on-get-requests
-        HTTP_CLIENT_OPTS = {
-          follow: {
-            max_hops: 20
-          },
-          headers: {
-            accept: '*/*',
-            user_agent: 'IndieWeb Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)'
-          },
-          timeout_options: {
-            connect_timeout: 5,
-            read_timeout: 5
-          }
-        }.freeze
-
-        def initialize
-          @client = HTTP::Client.new(HTTP_CLIENT_OPTS)
-        end
-
-        def get(uri)
-          client.request(:get, uri)
-        rescue HTTP::ConnectionError,
-               HTTP::TimeoutError,
-               HTTP::Redirector::TooManyRedirectsError => exception
-          raise IndieWeb::Endpoints.const_get(exception.class.name.split('::').last), exception
-        end
-
-        private
-
-        attr_accessor :client
-      end
-    end
-  end
-end

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

@@ -1,14 +0,0 @@
-module IndieWeb
-  module Endpoints
-    module Services
-      class ResponseBodyParserService
-        def parse(response, identifier, node = 'link')
-          return unless response.mime_type == 'text/html'
-
-          # Reject endpoints that contain a fragment identifier
-          Nokogiri::HTML(response.body.to_s).css(%(#{node}[rel~="#{identifier}"][href]:not([href*="#"]))).map { |element| element['href'] }
-        end
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-module IndieWeb
-  module Endpoints
-    module Services
-      class ResponseHeadersParserService
-        def parse(response, identifier)
-          headers = LinkHeaderParser.parse(response.headers.get('link'), base: response.uri.to_s).by_relation_type[identifier]
-
-          return unless headers
-
-          # Reject endpoints that contain a fragment identifier
-          headers.reject { |header| Addressable::URI.parse(header.target_uri).fragment }.map(&:target_uri)
-        end
-      end
-    end
-  end
-end