https://github.com/mastodon/goldfinger

A Webfinger utility for Ruby
https://github.com/mastodon/goldfinger

mastodon ostatus webfinger

Last synced: 3 months ago
JSON representation

A Webfinger utility for Ruby

• Host: GitHub
• URL: https://github.com/mastodon/goldfinger
• Owner: mastodon
• License: mit
• Archived: true
• Created: 2016-02-17T15:37:00.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-07-12T21:24:19.000Z (over 3 years ago)
• Last Synced: 2024-04-15T06:51:15.749Z (8 months ago)
• Topics: mastodon, ostatus, webfinger
• Language: Ruby
• Size: 37.1 KB
• Stars: 31
• Watchers: 5
• Forks: 9
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Goldfinger, a WebFinger client for Ruby

=======================================

[![Gem Version](http://img.shields.io/gem/v/goldfinger.svg)][gem]

[![Build Status](http://img.shields.io/travis/tootsuite/goldfinger.svg)][travis]

[gem]: https://rubygems.org/gems/goldfinger

[travis]: https://travis-ci.org/tootsuite/goldfinger

A WebFinger client for Ruby. Supports `application/xrd+xml` and `application/jrd+json` responses. Raises `Goldfinger::NotFoundError` on failure to fetch the Webfinger or XRD data, can also raise `HTTP:Error` or `OpenSSL::SSL::SSLError` if something is wrong with the HTTPS connection it uses.

- **Does not** fall back to HTTP if HTTPS is not available

- **Does** check host-meta XRD, but *only* if the standard WebFinger path yielded no result

## Installation

    gem install goldfinger

## Usage

    data = Goldfinger.finger('acct:[email protected]')

    data.link('http://schemas.google.com/g/2010#updates-from').href

    # => "https://quitter.no/api/statuses/user_timeline/7477.atom"

    data.aliases

    # => ["https://quitter.no/user/7477", "https://quitter.no/gargron"]

    data.subject

    # => "acct:[email protected]"

## RFC support

The official WebFinger RFC is [7033](https://tools.ietf.org/html/rfc7033).