indieweb-endpoints 1.0.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0f792d375c1f3a3bd75d775b83bafba558576b43fdcd55a4f2f6609631776d1
-  data.tar.gz: 285dd5905c4305c91a922575d97f579b03b29cb20e6037051ab7e2c420d5d9f8
+  metadata.gz: f89e56b8a2f2bac61305a9d0012bdd54f4f2623b539ea19f58e0d81b6af1a966
+  data.tar.gz: 3f0e860760e5bed119e2be2cbc40dc235a179b53a880f9a2f0a4efada8e6b739
 SHA512:
-  metadata.gz: ff2be853683341b8da8c3aa35db8dc423e1d0a046fe892230e8704a4e86d6a9b0d8cdae5f355df758937ea4159de1eb992d0b3cbba46083356013f66660e47be
-  data.tar.gz: 0033ebce96813205b2c70ef9f57348e3fb6b07374e55eb519c1937680c1337d36dd4bb58ca9d200f34bc7c9e5cccd866b242f8f596a09fb515ed088c4843b4d8
+  metadata.gz: 47f6d68cb1894fee56ee0f23d3caf90c5bd143980a52085dff2a35b37467c0e6a222e2eea926b6cb904437f4b196f75bf5051cf5a47e09bfb262da4b2bc04fdb
+  data.tar.gz: '0891cbfb3831d7a2b85e9b7b3068c3679a1e9a86938e4237e1ab3f10c6760b6a5f8ff0c92456bb52314802a4c42551c936973e8956fa85a39cdc8543ef7e0420'

data/.reek.yml

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

data/.rubocop.yml

@@ -2,17 +2,16 @@ require:
   - rubocop-performance
   - rubocop-rspec
 
-Layout/AlignHash:
-  EnforcedHashRocketStyle: table
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Enabled: false
 
 Metrics/BlockLength:
   Exclude:
-    - indieweb-endpoints.gemspec
     - spec/**/*.rb
 
-Metrics/LineLength:
-  Enabled: false
-
 Naming/RescuedExceptionsVariableName:
   PreferredName: exception
 

data/.ruby-version

@@ -1 +1 @@
-2.4.7
+2.5.8

data/.simplecov

@@ -2,9 +2,11 @@ require 'simplecov-console'
 
 formatters = [SimpleCov::Formatter::HTMLFormatter]
 
+# rubocop:disable Style/IfUnlessModifier
 if RSpec.configuration.files_to_run.length > 1
   formatters << SimpleCov::Formatter::Console
 end
+# rubocop:enable Style/IfUnlessModifier
 
 SimpleCov.start do
   formatter SimpleCov::Formatter::MultiFormatter.new(formatters)

data/.travis.yml

@@ -1,13 +1,10 @@
+dist: bionic
 language: ruby
 rvm:
-  - 2.4
   - 2.5
   - 2.6
-cache:
-  - bundler
-before_install:
-  - gem update --system
-  - gem install bundler
+  - 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

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 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
 
 - Update WebMock and Addressable gems (298da63)

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.7 and is additionally tested against Ruby 2.5 and 2.6 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
+indieweb-endpoints-ruby is developed using Ruby 2.5.8 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.7. 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.7 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.8. 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.8 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install

data/Gemfile

@@ -2,3 +2,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in indieweb-endpoints.gemspec
 gemspec
+
+gem 'pry-byebug', '~> 3.9'
+gem 'rake', '~> 13.0'
+gem 'reek', '~> 6.0'
+gem 'rspec', '~> 3.10'
+gem 'rubocop', '~> 1.2'
+gem 'rubocop-performance', '~> 1.8'
+gem 'rubocop-rspec', '~> 2.0'
+gem 'simplecov', '~> 0.19.1'
+gem 'simplecov-console', '~> 0.8.0'
+gem 'webmock', '~> 3.9'

data/README.md

@@ -4,7 +4,7 @@
 
 [![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)
+[![Build](https://img.shields.io/travis/com/indieweb/indieweb-endpoints-ruby/main.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)
 
@@ -12,13 +12,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 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.7 and is additionally tested against Ruby 2.5 and 2.6 using [Travis CI](https://travis-ci.com/indieweb/indieweb-endpoints-ruby).
+indieweb-endpoints-ruby is developed using Ruby 2.5.8 and is additionally tested against Ruby 2.6 and 2.7 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,17 +59,13 @@ 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
@@ -102,7 +84,7 @@ From [httprb/http](https://github.com/httprb/http):
 
 ## 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.7']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 2.8')
 
   spec.name          = 'indieweb-endpoints'
   spec.version       = IndieWeb::Endpoints::VERSION
@@ -16,28 +13,18 @@ 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.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  end
 
   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', '~> 12.3'
-  spec.add_development_dependency 'reek', '~> 5.4'
-  spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.74.0'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.4'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.35'
-  spec.add_development_dependency 'simplecov', '~> 0.17.0'
-  spec.add_development_dependency 'simplecov-console', '~> 0.5.0'
-  spec.add_development_dependency 'webmock', '~> 3.7'
+  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.0'
+  spec.add_runtime_dependency 'absolutely', '~> 5.0'
   spec.add_runtime_dependency 'addressable', '~> 2.7'
-  spec.add_runtime_dependency 'http', '~> 5.0.0.pre'
-  spec.add_runtime_dependency 'link-header-parser', '~> 0.2.0'
+  spec.add_runtime_dependency 'http', '~> 4.4'
+  spec.add_runtime_dependency 'link-header-parser', '~> 2.1'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
 end

data/lib/indieweb/endpoints.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 require 'absolutely'
 require 'addressable/uri'
 require 'http'
@@ -9,15 +7,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 +22,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,54 @@
 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)
+        raise ArgumentError, "url must be a String (given #{url.class})" unless url.is_a?(String)
 
-        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})"
+        @url = url
+
+        raise ArgumentError, "url (#{url}) must be an absolute URL (e.g. https://example.com)" unless uri.absolute? && uri.scheme.match?(/^https?$/)
+      end
+
+      # @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::ConnectionError,
+             HTTP::TimeoutError,
+             HTTP::Redirector::TooManyRedirectsError => exception
+        raise IndieWeb::Endpoints.const_get(exception.class.name.split('::').last), 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/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,45 @@
+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| 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::ResponseParserService.parse_body(response, self.class.identifier)
+        end
+
+        def results_from_headers
+          @results_from_headers ||= Services::ResponseParserService.parse_headers(response, 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,12 +2,11 @@ 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?
 

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(response, 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,29 @@
+module IndieWeb
+  module Endpoints
+    module Services
+      class ResponseParserService
+        # @param response [HTTP::Response]
+        # @param identifier [Symbol]
+        # @return [Array<String>]
+        def self.parse_body(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
+
+        # @param response [HTTP::Response]
+        # @param identifier [Symbol]
+        # @return [Array<String>, nil]
+        def self.parse_headers(response, identifier)
+          headers = LinkHeaderParser.parse(response.headers.get('link'), base: response.uri.to_s).group_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

data/lib/indieweb/endpoints/version.rb

@@ -1,5 +1,5 @@
 module IndieWeb
   module Endpoints
-    VERSION = '1.0.2'.freeze
+    VERSION = '5.0.0'.freeze
   end
 end

metadata

@@ -1,155 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 5.0.0
 platform: ruby
 authors:
 - Jason Garber
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-31 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.4'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.74.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.74.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.35'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.35'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.0
-- !ruby/object:Gem::Dependency
-  name: simplecov-console
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: absolutely
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -170,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.pre
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: link-header-parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -233,26 +107,24 @@ files:
 - 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.0.2/CHANGELOG.md
-post_install_message: 
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v5.0.0/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,18 +132,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '2.8'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.
 test_files: []

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