indieweb-endpoints 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e5738ea28dd0ec5b0d473991732d7dccfc9f0375a91d25aab02d435b769fc01
-  data.tar.gz: 730bc87082fa7601804103a92bbfadde1b9a59ce697edff95adbf433df359169
+  metadata.gz: 0c45996ba696d87124c8c764fce951197377fccfa3bf84d30ed702b3a27df610
+  data.tar.gz: 562c474fa0079dfc5d6cbd8286e1a8c5cb169d1f54ede4404bfab2cec854a0bf
 SHA512:
-  metadata.gz: 18f837e57571ac559a9eff564e3330266168b1ff19a61df12989f1a951f48817c84eb830d64a251afcf0a2c7200ad0b8db9c54ab6076bf914d4b43028593e0e0
-  data.tar.gz: 3eff42bf94a9f8477a5cf86f20a0f9755b7adb228072fd2189808f6957fba849d17bcc59cef7e4195e29f2ab04deed219e48d08ede9a0d81f7e0035842638886
+  metadata.gz: 4417010c2a25d2bb07f8e59f63cd3aa31149aaa5dda33391fba11b7ef1d90d1acb2cd8e642dcf38086a6016027159914941d8dd69fb7f9beae7fe30b6b1cc2db
+  data.tar.gz: 43da9e43bb391e7e2ecf999d1bb21dd3776c005037a746230d65066c67dad68883f1397fa2e46c812daec21bd80df006e24620a4608e06774787d08705b81981

data/.ruby-version

@@ -1 +1 @@
-2.4.10
+2.5.8

data/.travis.yml

@@ -1,7 +1,6 @@
 dist: bionic
 language: ruby
 rvm:
-  - 2.4
   - 2.5
   - 2.6
   - 2.7

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 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)

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.10 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.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.10. 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.10 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

@@ -3,12 +3,13 @@ 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.9'
-gem 'rubocop', '~> 0.83.0'
-gem 'rubocop-performance', '~> 1.5'
-gem 'rubocop-rspec', '~> 1.39'
+gem 'rubocop', '~> 0.88.0'
+gem 'rubocop-performance', '~> 1.7'
+gem 'rubocop-rspec', '~> 1.42'
 gem 'simplecov', '~> 0.18.5'
 gem 'simplecov-console', '~> 0.7.2'
 gem 'webmock', '~> 3.8'

data/README.md

@@ -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.10 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.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

data/indieweb-endpoints.gemspec

@@ -1,7 +1,7 @@
 require_relative 'lib/indieweb/endpoints/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.4', '< 2.8')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 2.8')
 
   spec.name          = 'indieweb-endpoints'
   spec.version       = IndieWeb::Endpoints::VERSION
@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'absolutely', '~> 4.0'
   spec.add_runtime_dependency 'addressable', '~> 2.7'
   spec.add_runtime_dependency 'http', '~> 4.4'
-  spec.add_runtime_dependency 'link-header-parser', '~> 1.0.0'
+  spec.add_runtime_dependency 'link-header-parser', '~> 2.0'
   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,9 +7,7 @@ require 'nokogiri'
 require 'indieweb/endpoints/version'
 require 'indieweb/endpoints/exceptions'
 
-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'
@@ -26,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.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/base_parser.rb

@@ -6,12 +6,14 @@ module IndieWeb
           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
@@ -27,11 +29,11 @@ module IndieWeb
         end
 
         def results_from_body
-          @results_from_body ||= Services::ResponseBodyParserService.parse(response, self.class.identifier)
+          @results_from_body ||= Services::ResponseParserService.parse_body(response, self.class.identifier)
         end
 
         def results_from_headers
-          @results_from_headers ||= Services::ResponseHeadersParserService.parse(response, self.class.identifier)
+          @results_from_headers ||= Services::ResponseParserService.parse_headers(response, self.class.identifier)
         end
 
         def results_from_http_request

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

@@ -6,6 +6,7 @@ module IndieWeb
 
         Parsers.register(self)
 
+        # @return [Array<String>, nil]
         def results
           return unless mapped_results.any?
 

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

@@ -9,7 +9,7 @@ module IndieWeb
         private
 
         def results_for_node(node)
-          Services::ResponseBodyParserService.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 = '3.0.0'.freeze
+    VERSION = '4.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indieweb-endpoints
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: absolutely
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -116,16 +116,14 @@ files:
 - 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/v3.0.0/CHANGELOG.md
+  changelog_uri: https://github.com/indieweb/indieweb-endpoints-ruby/blob/v4.0.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -134,7 +132,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'
@@ -144,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.

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

@@ -1,22 +0,0 @@
-module IndieWeb
-  module Endpoints
-    module Services
-      class HttpRequestService
-        HTTP_HEADERS_OPTS = {
-          accept: '*/*',
-          user_agent: 'IndieWeb Endpoint Discovery (https://rubygems.org/gems/indieweb-endpoints)'
-        }.freeze
-
-        # HTTP options derived from Webmention specification examples
-        # https://www.w3.org/TR/webmention/#limits-on-get-requests
-        def self.get(uri)
-          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
-      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 self.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 self.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