indieauth_discovery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64aec7aba0f75ed8c80dbfc68dba30a3a321d0275b8d8a991772357eba013caa
+  data.tar.gz: 18fee04fbe53329ffa4410a3a4b7712fa0204688423b54ecabe23780668177e8
+SHA512:
+  metadata.gz: 289ed40bac4fba8ffec7e968fb0c244f9325978078cff9f2720e4e0f991e3a083bc78c5dc8d98853f50dcbc4e10dcc0b17b3988172c63820d4eeb67f45b92c21
+  data.tar.gz: cb523fa2da8aa2263ffc1fd2059acf3a83cf059d49185b593a993c17ad0e687d2c4b3c15ea7963458c993614595667c383c0258bb4c80e6c69fd0e4a1b7d39cd

data/.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+
+[{Dangerfile,Gemfile,Rakefile}]
+indent_style = space
+indent_size = 2
+
+[*.{json,md,rb,yaml,yml}]
+indent_style = space
+indent_size = 2

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+**Pull Request template**
+
+Please, go through these steps before you submit a PR.
+
+1. Make sure that your PR is not a duplicate.
+2. If not, then make sure that:
+
+    a. You have done your changes in a separate branch. Branches MUST have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/some-issue` or `feature/issue-templates`.
+
+    b. You have a descriptive commit message with a short title (first line).
+
+    c. You have only one commit (if not, squash them into one commit).
+
+    d. `bundle exec rspec` doesn't throw any errors. If it does, fix them first and amend your commit (`git commit --amend`).
+
+    e. `bundle exec rubocop` doesn't throw any errors. If it does, fix them first and amend your commit (`git commit --amend`).
+
+3. **After** these steps, you're ready to open a pull request.
+
+    a. Give a descriptive title to your PR.
+
+    b. Provide a description of your changes.
+
+    c. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
+
+IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
+
+**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

data/.github/workflows/verify.yml

@@ -0,0 +1,74 @@
+name: Verify
+on: [push, pull_request]
+
+jobs:
+  lint:
+    name: Lint (Ruby ${{ matrix.ruby }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Ruby gem cache
+        uses: actions/cache@v2.1.0
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run linters
+        run: |
+          bundle exec rubocop --parallel
+
+      - name: Run security checks
+        run: |
+          bundle exec bundler-audit --update
+
+  test:
+    name: Test (Ruby ${{ matrix.ruby }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Ruby gem cache
+        uses: actions/cache@v2.1.0
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+          RAILS_ENV: test
+        run: |
+          bundle exec rspec

data/.gitignore

@@ -0,0 +1,16 @@
+.byebug_history
+.env
+.rspec_status
+.ruby-version
+.rvmrc
+*.gem
+/_yardoc/
+/.bundle/
+/.config
+/.yardoc/
+/coverage/
+/doc/
+/pkg/
+/rdoc/
+/tmp/
+/vendor/bundle

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+#inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+  TargetRubyVersion: 2.5
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/FilePath:
+  CustomTransform:
+    IndieAuthDiscovery: indieauth_discovery

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+Initial release! :tada:
+
+### Added
+
+* User profile URL and client identifier validation and canonicalization
+* Authorization, token, and MicroPub endpoint discovery from user profiles
+
+[Unreleased]: https://github.com/craftyphotons/indieauth_discovery/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/craftyphotons/indieauth_discovery/releases/tag/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tony@tonyburns.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing to `indieauth_discovery`
+
+Bug reports and pull requests are welcome on GitHub at [craftyphotons/indieauth_discovery](https://github.com/craftyphotons/indieauth_discovery). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/craftyphotons/indieauth_discovery/blob/main/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'bundler-audit', '~> 0.7'
+gem 'coveralls', '~> 0.8'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.9'
+gem 'rubocop', '~> 0.89'
+gem 'rubocop-performance', '~> 1.7'
+gem 'rubocop-rspec', '~> 1.42'
+gem 'webmock', '~> 3.8'
+gem 'yard', '~> 0.9'

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    indieauth_discovery (0.1.0)
+      faraday (~> 1.0)
+      faraday_middleware (~> 1.0)
+      link-header-parser (~> 2.0)
+      nokogiri (~> 1.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    absolutely (4.0.0)
+      addressable (~> 2.7)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    bundler-audit (0.7.0.1)
+      bundler (>= 1.2.0, < 3)
+      thor (>= 0.18, < 2)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    json (2.3.1)
+    link-header-parser (2.0.0)
+      absolutely (~> 4.0)
+    mini_portile2 (2.4.0)
+    multipart-post (2.1.1)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.89.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.25.0)
+      sync
+    unicode-display_width (1.7.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler-audit (~> 0.7)
+  coveralls (~> 0.8)
+  indieauth_discovery!
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rubocop (~> 0.89)
+  rubocop-performance (~> 1.7)
+  rubocop-rspec (~> 1.42)
+  webmock (~> 3.8)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tony Burns
+
+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,104 @@
+# `indieauth_discovery`
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/craftyphotons/indieauth_discovery/Verify/main?style=for-the-badge)](https://github.com/craftyphotons/indieauth_discovery/actions?query=workflow%3AVerify)
+ 
+[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/craftyphotons/indieauth_discovery?style=for-the-badge)](https://codeclimate.com/github/craftyphotons/indieauth_discovery)
+ 
+[![Coveralls github branch](https://img.shields.io/coveralls/github/craftyphotons/indieauth_discovery/main?style=for-the-badge)](https://coveralls.io/github/craftyphotons/indieauth_discovery)
+
+Profile and client discovery for [Ruby](https://www.ruby-lang.org/en)-based [IndieAuth](https://indieauth.spec.indieweb.org) clients and providers.
+
+## Features
+
+- [x] [User profile URL](https://indieauth.spec.indieweb.org/#user-profile-url) and [client identifier](https://indieauth.spec.indieweb.org/#client-identifier) validation and [canonicalization](https://indieauth.spec.indieweb.org/#url-canonicalization) with 
+- [x] Handling of [permanant and temporary redirects](https://indieauth.spec.indieweb.org/#redirect-examples)
+- [x] [Authorization, token, and MicroPub endpoint discovery](https://indieauth.spec.indieweb.org/#discovery-by-clients) from user profiles
+
+## Roadmap
+
+- [ ] [Client information discovery](https://indieauth.spec.indieweb.org/#client-information-discovery) from [`h-app` and `h-xapp`](https://indieweb.org/h-x-app)
+- [ ] [Redirect URI verification](https://indieauth.spec.indieweb.org/#redirect-url)
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'indieauth_discovery'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install indieauth_discovery
+
+## Usage
+
+### URL verification and canonicalization
+
+`indieauth_discovery` can canonicalize and verify URLs indepedently of information discovery via the `IndieAuthDiscovery::URL` class:
+
+``` ruby
+require 'indieauth_discovery/url'
+
+url = IndieAuthDiscovery::URL.new('example.com')
+url.canonicalize
+
+# or
+
+url = IndieAuthDiscovery::URL.canonicalize('example.com')
+
+url.original_url # example.com
+url.canonical_url # http://example.com/
+```
+
+The `#canonicalize` method performs the following steps:
+
+1. Normalizes the URL (downcases the hostname)
+2. Verifies the URL if already `http` or `https` by performing an HTTP `HEAD` request
+3. If the URL is generic without a scheme (i.e. `example.com`), attempts to verify the URL with an HTTP `HEAD` request to both `https://<url>` and `http://<url>`, prioritizing HTTPS
+4. Ensures the URL has a path by appending `/` to it if the path component is empty
+5. Follows up to three redirects, and uses the last permanent (301) redirect as the canonical URL
+
+If none of the steps above result in a verified URL, an `IndieAuthDiscovery::InvalidURLError` will be raised.
+
+### User profile discovery
+
+User profile information can be discovered with `indieauth_discovery` via the `IndieAuthDiscovery::Profile` class:
+
+``` ruby
+require 'indieauth_discovery/profile'
+
+profile = IndieAuthDiscovery::Profile.new('example.com')
+profile.discover
+
+# or
+
+profile = IndieAuthDiscovery::Profile.discover('example.com')
+
+profile.url # http://example.com/
+profile.authorization_endpoint # http://example.com/auth
+profile.token_endpoint # http://example.com/token
+profile.micropub_endpoint # http://example.com/micropub
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [craftyphotons/indieauth_discovery](https://github.com/craftyphotons/indieauth_discovery). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/craftyphotons/indieauth_discovery/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IndieauthDiscovery project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/indieauth_discovery/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'indieauth_discovery'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/indieauth_discovery.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/indieauth_discovery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'indieauth_discovery'
+  spec.version       = IndieAuthDiscovery::VERSION
+  spec.authors       = ['Tony Burns']
+  spec.email         = ['tony@tonyburns.net']
+
+  spec.summary       = 'IndieAuth profile and client discovery'
+  spec.description   = 'Profile and client discovery for IndieAuth clients and providers'
+  spec.homepage      = 'https://github.com/craftyphotons/indieauth_discovery'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/craftyphotons/indieauth_discovery'
+  spec.metadata['changelog_uri'] = 'https://github.com/craftyphotons/indieauth_discovery/blob/main/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 1.0'
+  spec.add_runtime_dependency 'link-header-parser', '~> 2.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.10'
+end

data/lib/indieauth_discovery.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'indieauth_discovery/version'
+
+# Provides utilities to discover and verify user profiles and clients for IndieAuth clients and servers.
+module IndieAuthDiscovery
+end

data/lib/indieauth_discovery/client.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware/response/follow_redirects'
+require 'link-header-parser'
+require 'nokogiri'
+
+require_relative './errors'
+require_relative './url'
+
+module IndieAuthDiscovery
+  # Client information discovery according to the IndieAuth spec.
+  #
+  # @see https://indieauth.spec.indieweb.org/#client-information-discovery
+  class Profile
+    attr_reader :profile_url, :authorization_endpoint, :token_endpoint, :response
+
+    def initialize(default_scheme: :https)
+      @default_scheme = default_scheme
+    end
+
+    def call(url)
+      @profile_url = URL.canonicalize(url)
+      retrieve
+      discover
+    end
+
+    private
+
+    def retrieve
+      @response ||= get_follow_redirects(profile_url)
+      @link_headers = parse_link_headers(response)
+      @profile_document = parse_html_document(response)
+    end
+
+    def discover
+      @authorization_endpoint = first_link('authorization_endpoint')
+      @token_endpoint = first_link('token_endpoint')
+    end
+
+    def parse_link_headers(response)
+      return {} unless response.headers['link']
+
+      LinkHeaderParser.parse(response.headers['link'], base: profile_url).group_by_relation_type
+    end
+
+    def parse_html_document(response)
+      return Nokogiri::HTML('') unless response.headers['content-type'].start_with?('text/html')
+
+      Nokogiri::HTML(response.body)
+    end
+
+    def first_link(rel)
+      @link_headers[rel.to_sym]&.first&.target_uri ||
+        @profile_document.at_xpath("//link[@rel='#{rel}']")&.attribute('href')&.to_s
+    end
+
+    def get_follow_redirects(url)
+      Faraday.new(url: url) do |faraday|
+        faraday.use(FaradayMiddleware::FollowRedirects)
+        faraday.adapter(Faraday.default_adapter)
+      end.get
+    end
+  end
+end

data/lib/indieauth_discovery/errors.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module IndieAuthDiscovery
+  # Base class for IndieAuthDiscovery errors.
+  class Error < StandardError
+    attr_accessor :error, :error_reason, :error_uri
+
+    def initialize(error, error_reason = nil, error_uri = nil)
+      @error = error
+      @error_reason = error_reason
+      @error_uri = error_uri
+
+      super(message)
+    end
+
+    def message
+      [error, error_reason, error_uri].compact.join(' | ')
+    end
+  end
+
+  # Error raised when endpoint discovery fails.
+  class DiscoveryError < Error
+  end
+
+  # Error raised when a URL is invalid.
+  class InvalidURLError < Error
+  end
+end

data/lib/indieauth_discovery/profile.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware/response/follow_redirects'
+require 'link-header-parser'
+require 'nokogiri'
+
+require_relative './errors'
+require_relative './url'
+
+module IndieAuthDiscovery
+  # User profile information discovery according to the IndieAuth spec.
+  #
+  # @see https://indieauth.spec.indieweb.org/#discovery-by-clients
+  class Profile
+    attr_reader :url, :authorization_endpoint, :micropub_endpoint, :token_endpoint, :response
+
+    def initialize(url)
+      @url = URL.new(url)
+    end
+
+    # Returns a new Profile after canonicalizing and verifying the URL and discovering endpoints.
+    def self.discover(url)
+      new(url).discover
+    end
+
+    # Returns the Profile after canonicalizing and verifying the URL and discovering endpoints.
+    def discover
+      canonicalize_url
+      fetch_profile
+      find_endpoints
+      self
+    end
+
+    private
+
+    def canonicalize_url
+      url.canonicalize
+    end
+
+    def fetch_profile
+      @response ||= get_follow_redirects(url.to_s)
+      @link_headers = parse_link_headers(response)
+      @profile_document = parse_html_document(response)
+    end
+
+    def find_endpoints
+      @authorization_endpoint = first_link('authorization_endpoint')
+      @token_endpoint = first_link('token_endpoint')
+      @micropub_endpoint = first_link('micropub')
+    end
+
+    def parse_link_headers(response)
+      return {} unless response.headers['link']
+
+      LinkHeaderParser.parse(response.headers['link'], base: url.to_s).group_by_relation_type
+    end
+
+    def parse_html_document(response)
+      return Nokogiri::HTML('') unless response.headers['content-type'].start_with?('text/html')
+
+      Nokogiri::HTML(response.body)
+    end
+
+    def first_link(rel)
+      @link_headers[rel.to_sym]&.first&.target_uri ||
+        @profile_document.at_xpath("//link[@rel='#{rel}']")&.attribute('href')&.to_s
+    end
+
+    def get_follow_redirects(url)
+      Faraday.new(url: url) do |faraday|
+        faraday.use(FaradayMiddleware::FollowRedirects)
+        faraday.adapter(Faraday.default_adapter)
+      end.get
+    end
+  end
+end

data/lib/indieauth_discovery/url.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware/response/follow_redirects'
+require 'nokogiri'
+
+require_relative './errors'
+
+module IndieAuthDiscovery
+  # Canonicalization for IndieAuth client and user profile URLs.
+  class URL
+    attr_reader :original_url, :canonical_url
+
+    def initialize(original_url)
+      @original_url = original_url.to_s
+      @canonical_url = original_url.to_s
+    end
+
+    def self.canonicalize(original_url)
+      url = new(original_url)
+      url.canonicalize
+      url
+    end
+
+    # Canonicalizes and verifies the URL.
+    #
+    # @see https://indieauth.spec.indieweb.org/#user-profile-url
+    # @see https://indieauth.spec.indieweb.org/#client-identifier
+    def canonicalize
+      canonical = normalize_url(original_url)
+      canonical, verify_response = verify_url(canonical)
+      canonical = ensure_path(canonical)
+      canonical = follow_redirects(canonical, verify_response)
+
+      @canonical_url = canonical
+    rescue URI::InvalidURIError, *FARADAY_ERRORS
+      raise_invalid_url_error(original_url)
+    end
+
+    # Returns the canonical URL as a string.
+    def to_s
+      @canonical_url
+    end
+
+    # Returns the canonical URL as a URI.
+    def to_uri
+      URI.parse(@canonical_url)
+    end
+
+    private
+
+    FARADAY_ERRORS = [Faraday::ConnectionFailed, Faraday::TimeoutError].freeze
+
+    def normalize_url(url)
+      URI.parse(url).normalize
+    end
+
+    # @see https://indieauth.spec.indieweb.org/#url-canonicalization
+    def verify_url(uri)
+      if http_uri?(uri) && (last_response = check_url?(uri))
+        # Use the URL as-is if its already HTTP(S) and is available
+        [uri.to_s, last_response]
+      elsif (last_response = check_url?(URI.parse("https://#{uri}")))
+        # If no scheme was given (e.g. example.com), try HTTPS
+        ["https://#{uri}", last_response]
+      elsif (last_response = check_url?(URI.parse("http://#{uri}")))
+        # Try HTTP if HTTPS is not available
+        ["http://#{uri}", last_response]
+      else
+        # The URL is considered invalid if none of the above work
+        raise_invalid_url_error(uri)
+      end
+    end
+
+    def http_uri?(uri)
+      uri.is_a?(URI::HTTPS) || uri.is_a?(URI::HTTP)
+    end
+
+    def check_url?(uri)
+      response = Faraday.head(uri)
+      return false unless response.status < 400
+
+      response
+    rescue *FARADAY_ERRORS
+      nil
+    end
+
+    def ensure_path(uri)
+      return uri unless URI.parse(uri).path == ''
+
+      "#{uri}/"
+    end
+
+    # @see https://indieauth.spec.indieweb.org/#redirect-examples
+    def follow_redirects(uri, response)
+      return uri unless [301, 302].include?(response.status)
+
+      redirects = []
+      redirector(uri, redirects).head
+
+      uri = redirects.last if redirects.any? && redirects.last != uri
+      uri
+    end
+
+    def redirector(uri, redirects)
+      @redirector ||=
+        begin
+          callback = ->(old_env, new_env) { redirects << new_env.url.to_s if old_env.status == 301 }
+          Faraday.new(url: uri) do |faraday|
+            faraday.use(FaradayMiddleware::FollowRedirects, callback: callback)
+            faraday.adapter(Faraday.default_adapter)
+          end
+        end
+    end
+
+    def raise_invalid_url_error(url)
+      raise InvalidURLError.new(:invalid_url, 'URL must begin with http:// or https://', url)
+    end
+  end
+end

data/lib/indieauth_discovery/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IndieAuthDiscovery
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: indieauth_discovery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tony Burns
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: Profile and client discovery for IndieAuth clients and providers
+email:
+- tony@tonyburns.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/verify.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- indieauth_discovery.gemspec
+- lib/indieauth_discovery.rb
+- lib/indieauth_discovery/client.rb
+- lib/indieauth_discovery/errors.rb
+- lib/indieauth_discovery/profile.rb
+- lib/indieauth_discovery/url.rb
+- lib/indieauth_discovery/version.rb
+homepage: https://github.com/craftyphotons/indieauth_discovery
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/craftyphotons/indieauth_discovery
+  source_code_uri: https://github.com/craftyphotons/indieauth_discovery
+  changelog_uri: https://github.com/craftyphotons/indieauth_discovery/blob/main/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.0
+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: IndieAuth profile and client discovery
+test_files: []