goldfinger/README.md

23 lines
830 B
Markdown
Raw Normal View History

2016-02-17 16:25:35 +01:00
Goldfinger, a Webfinger client for Ruby
=======================================
2016-02-17 16:36:19 +01:00
[![Gem Version](http://img.shields.io/gem/v/goldfinger.svg)][gem]
[gem]: https://rubygems.org/gems/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, or `Goldfinger::SSLError` if something is wrong with the HTTPS connection it uses.
2016-02-17 16:25:35 +01:00
## Installation
gem install goldfinger
## Usage
data = Goldfinger.finger('acct:gargron@quitter.no')
data.link('http://schemas.google.com/g/2010#updates-from')[:href]
# => "https://quitter.no/api/statuses/user_timeline/7477.atom"
2016-02-17 16:36:19 +01:00
## RFC support
The gem only parses link data. It does not currently parse aliases, properties, or more complex structures.