redirect-uri-ruby

⚠️ Deprecation Notice (2019-04-24) ⚠️ This gem is deprecated in favor of indieweb/indieweb-endpoints-ruby and will no longer receive updates.

A Ruby gem for discovering a URL’s registered callback URLs for use with Micropub and IndieAuth clients.

Gem Downloads Build Dependencies Maintainability Coverage

Key Features

Getting Started

Before installing and using redirect-uri-ruby, you'll want to have Ruby 2.4 (or newer) installed. It's recommended that you use a Ruby version managment tool like rbenv, chruby, or rvm.

redirect-uri-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.2 using Travis CI.

Installation

If you're using Bundler, add redirect-uri-ruby to your project's Gemfile:

source 'https://rubygems.org'

gem 'redirect-uri'

…and hop over to your command prompt and run…

$ bundle install

Usage

Basic Usage

With redirect-uri-ruby added to your project's Gemfile and installed, you may discover a URL's registered callback URLs by doing:

require 'redirect-uri'

endpoints = RedirectUri.discover('https://sixtwothree.org')

puts endpoints # returns Array: ['https://sixtwothree.org/auth']

This example will search https://sixtwothree.org for valid callback URLs using the same rules described in the W3C's IndieAuth Working Group Note. In this case, the program returns an array: ['https://sixtwothree.org/auth'].

If no endpoints are discovered at the provided URL, the program will return an empty array:

require 'redirect-uri'

endpoints = RedirectUri.discover('https://example.com')

puts endpoints # returns Array: []

Advanced Usage

Should the need arise, you may work directly with the RedirectUri::Client class:

require 'redirect-uri'

client = RedirectUri::Client.new('https://sixtwothree.org')

puts client.response # returns HTTP::Response
puts client.endpoints # returns Array: ['https://sixtwothree.org/auth']

Exception Handling

There are several exceptions that may be raised by redirect-uri-ruby's underlying dependencies. These errors are raised as subclasses of RedirectUri::Error (which itself is a subclass of StandardError).

From jgarber623/absolutely and sporkmonger/addressable:

  • RedirectUri::InvalidURIError

From httprb/http:

  • RedirectUri::ConnectionError
  • RedirectUri::TimeoutError
  • RedirectUri::TooManyRedirectsError

Contributing

Interested in helping improve redirect-uri-ruby? Awesome! Your help is greatly appreciated. See CONTRIBUTING.md for details.

Acknowledgments

redirect-uri-ruby wouldn't exist without Micropub, IndieAuth, and the hard work put in by everyone involved in the IndieWeb movement.

redirect-uri-ruby is written and maintained by Jason Garber.

License

redirect-uri-ruby is freely available under the MIT License. Use it, learn from it, fork it, improve it, change it, tailor it to your needs.