indieweb-endpoints 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c45996ba696d87124c8c764fce951197377fccfa3bf84d30ed702b3a27df610
+  data.tar.gz: 562c474fa0079dfc5d6cbd8286e1a8c5cb169d1f54ede4404bfab2cec854a0bf
+SHA512:
+  metadata.gz: 4417010c2a25d2bb07f8e59f63cd3aa31149aaa5dda33391fba11b7ef1d90d1acb2cd8e642dcf38086a6016027159914941d8dd69fb7f9beae7fe30b6b1cc2db
+  data.tar.gz: 43da9e43bb391e7e2ecf999d1bb21dd3776c005037a746230d65066c67dad68883f1397fa2e46c812daec21bd80df006e24620a4608e06774787d08705b81981

data/.editorconfig

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

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

data/.gitignore

@@ -0,0 +1,34 @@
+*.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

@@ -0,0 +1,6 @@
+detectors:
+  IrresponsibleModule:
+    enabled: false
+
+exclude_paths:
+  - vendor/

data/.rspec

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

data/.rubocop

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 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

@@ -0,0 +1 @@
+2.5.8

data/.simplecov

@@ -0,0 +1,13 @@
+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)
+end

data/.travis.yml

@@ -0,0 +1,15 @@
+dist: bionic
+language: ruby
+rvm:
+  - 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/CHANGELOG.md

@@ -0,0 +1,75 @@
+# 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)
+- 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)
+- Update development dependencies (5663e3a)
+
+## 1.0.1 / 2019-07-17
+
+- Safely combine, flatten, and compact result set (5f2d9c5)
+
+## 1.0.0 / 2019-07-08
+
+-  Refactor gem code using service objects approach (78511d7 and 9d2fee0)
+
+## 0.7.0 / 2019-07-03
+
+- Update runtime and development dependencies (d99214b and 7692ab3)
+
+## 0.6.0 / 2019-06-15
+
+- Update Parser-related classes to resolve #2
+
+## 0.5.0 / 2019-05-09
+
+- Add support for Microsub endpoint discovery (5e81d9f)
+- Refactor parsers to ignore URLs with fragments (797b376)
+- Rescue `NoMethodError` (for `nil`) and `TypeError` (for non-`String`) (e33522e)
+- Raise `ArgumentError` if url scheme is not `http` or `https` (8eb1b1a)
+- Shorten up User Agent string (f9717b4)
+- Refactor `HTTPRequest` class using specification defaults (feef2ba)
+
+## 0.4.0 / 2019-05-01
+
+- Add `IndieWeb::Endpoints.client` method (c4d42d0)
+- Rename base `Error` class to `IndieWebEndpointsError` (d6d6f98)
+- Add `HttpRequest` class (7864cbd)
+
+## 0.3.0 / 2019-04-30
+
+- `IndieWeb::Endpoints::Client#endpoints` returns an `OpenStruct` instead of a `Hash` (c209b0b).
+
+## 0.2.0 / 2019-04-25
+
+- Subclass exceptions under `IndieWeb::Endpoints::Error` (667eec7)
+- Refactor parsers and `Registerable` module (3b96858)
+- Refactor `Client#response` method (c36fda3)
+
+## 0.1.0 / 2019-04-24
+
+- Initial release!

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+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/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to indieweb-endpoints-ruby
+
+There are a couple ways you can help improve indieweb-endpoints-ruby:
+
+1. Fix an existing [issue][issues] and submit a [pull request][pulls].
+1. Review open [pull requests][pulls].
+1. Report a new [issue][issues]. _Only do this after you've made sure the behavior or problem you're observing isn't already documented in an open issue._
+
+## Getting Started
+
+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.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
+```
+
+## Making Changes
+
+1. Fork and clone the project's repo.
+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. 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.
+
+## Code Style
+
+Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended you install the EditorConfig plugin for your editor of choice.
+
+Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.
+
+[issues]: https://github.com/indieweb/indieweb-endpoints-ruby/issues
+[pulls]: https://github.com/indieweb/indieweb-endpoints-ruby/pulls

data/Gemfile

@@ -0,0 +1,15 @@
+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.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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Jason Garber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# indieweb-endpoints-ruby
+
+**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)
+
+## 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.5 and newer.
+
+## Getting Started
+
+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.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
+
+If you're using [Bundler](https://bundler.io), add indieweb-endpoints-ruby to your project's `Gemfile`:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'indieweb-endpoints'
+```
+
+…and hop over to your command prompt and run…
+
+```sh
+$ bundle install
+```
+
+## Usage
+
+### Basic Usage
+
+With indieweb-endpoints-ruby added to your project's `Gemfile` and installed, you may discover a URL's IndieWeb-relevant endpoints by doing:
+
+```ruby
+require 'indieweb/endpoints'
+
+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" }
+```
+
+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
+
+Should the need arise, you may work with the `IndieWeb::Endpoints::Client` class:
+
+```ruby
+require 'indieweb/endpoints'
+
+client = IndieWeb::Endpoints::Client.new('https://aaronparecki.com')
+#=> #<IndieWeb::Endpoints::Client url: "https://aaronparecki.com">
+
+client.response
+#=> #<HTTP::Response/1.1 200 OK {…}>
+
+client.endpoints
+#=> { authorization_endpoint: "https://aaronparecki.com/auth", micropub: "https://aaronparecki.com/micropub", microsub: "https://aperture.p3k.io/microsub/1", redirect_uri: nil, token_endpoint: "https://aaronparecki.com/auth/token", webmention: "https://webmention.io/aaronpk/webmention" }
+```
+
+### 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`).
+
+From [jgarber623/absolutely](https://github.com/jgarber623/absolutely) and  [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`
+
+## 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.
+
+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).
+
+## Acknowledgments
+
+indieweb-endpoints-ruby wouldn't exist without IndieAuth, Micropub, and Webmention and the hard work put in by everyone involved in the [IndieWeb](https://indieweb.org) movement. Additionally, the comprehensive Webmention Endpoint Discovery test suite at [webmention.rocks](https://webmention.rocks) was invaluable in the development of this Ruby gem.
+
+indieweb-endpoints-ruby is written and maintained by [Jason Garber](https://sixtwothree.org).
+
+## License
+
+indieweb-endpoints-ruby is freely available under the [MIT License](https://opensource.org/licenses/MIT). Use it, learn from it, fork it, improve it, change it, tailor it to your needs.

data/Rakefile

@@ -0,0 +1,17 @@
+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/indieweb-endpoints.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/indieweb/endpoints/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5', '< 2.8')
+
+  spec.name          = 'indieweb-endpoints'
+  spec.version       = IndieWeb::Endpoints::VERSION
+  spec.authors       = ['Jason Garber']
+  spec.email         = ['jason@sixtwothree.org']
+
+  spec.summary       = 'Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/indieweb/indieweb-endpoints-ruby'
+  spec.license       = 'MIT'
+
+  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"
+  spec.metadata['changelog_uri']   = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
+
+  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', '~> 2.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.10'
+end

data/lib/indieweb/endpoints.rb

@@ -0,0 +1,35 @@
+require 'absolutely'
+require 'addressable/uri'
+require 'http'
+require 'link-header-parser'
+require 'nokogiri'
+
+require 'indieweb/endpoints/version'
+require 'indieweb/endpoints/exceptions'
+
+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'
+require 'indieweb/endpoints/parsers/redirect_uri_parser'
+require 'indieweb/endpoints/parsers/token_endpoint_parser'
+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
+  end
+end

data/lib/indieweb/endpoints/client.rb

@@ -0,0 +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)
+        raise ArgumentError, "url must be a String (given #{url.class})" unless url.is_a?(String)
+
+        @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 ||= 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 ||= 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 :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

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

data/lib/indieweb/endpoints/parsers.rb

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,5 @@
+module IndieWeb
+  module Endpoints
+    VERSION = '4.0.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: indieweb-endpoints
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Jason Garber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: absolutely
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: link-header-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.
+email:
+- jason@sixtwothree.org
+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/exceptions.rb
+- lib/indieweb/endpoints/parsers.rb
+- lib/indieweb/endpoints/parsers/authorization_endpoint_parser.rb
+- lib/indieweb/endpoints/parsers/base_parser.rb
+- lib/indieweb/endpoints/parsers/micropub_parser.rb
+- lib/indieweb/endpoints/parsers/microsub_parser.rb
+- lib/indieweb/endpoints/parsers/redirect_uri_parser.rb
+- lib/indieweb/endpoints/parsers/token_endpoint_parser.rb
+- lib/indieweb/endpoints/parsers/webmention_parser.rb
+- lib/indieweb/endpoints/services/response_parser_service.rb
+- lib/indieweb/endpoints/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/v4.0.0/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '2.8'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Discover a URL’s IndieAuth, Micropub, Microsub, and Webmention endpoints.
+test_files: []