https://github.com/nov/webfinger

WebFinger Client in Ruby
https://github.com/nov/webfinger

Keywords from Contributors

jose json-web-encryption json-web-key json-web-signature json-web-token jwe jwk jws oauth oauth-client

Last synced: about 3 hours ago
JSON representation

Repository metadata

WebFinger Client in Ruby

• Host: GitHub
• URL: https://github.com/nov/webfinger
• Owner: nov
• License: mit
• Created: 2012-12-18T01:34:53.000Z (almost 13 years ago)
• Default Branch: main
• Last Pushed: 2025-08-09T01:56:45.000Z (4 months ago)
• Last Synced: 2025-11-19T06:24:56.063Z (28 days ago)
• Language: Ruby
• Size: 54.7 KB
• Stars: 15
• Watchers: 2
• Forks: 11
• Open Issues: 0
• Releases: 4
• Metadata Files:
  • Readme: README.rdoc
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

README.rdoc

          = WebFinger

An Ruby WebFinger client library.

Following the latest WebFinger spec discussed at IETF WebFinger WG.
http://tools.ietf.org/html/draft-ietf-appsawg-webfinger

If you found something different from the latest spec, open an issue please.

== Installation

Add this line to your application's Gemfile:

  gem 'webfinger'

And then execute:

  $ bundle

Or install it yourself as:

  $ gem install webfinger

== Usage

=== Basic

You can discover resource metadata.

  WebFinger.discover! 'acct:nov@connect-op.heroku.com'
  WebFinger.discover! 'connect-op.heroku.com'
  WebFinger.discover! 'http://connect-op.heroku.com'

You can also specify link relations via "rel" option.

  WebFinger.discover! 'acct:nov@connect-op.heroku.com', rel: 'http://openid.net/specs/connect/1.0/issuer'
  WebFinger.discover! 'acct:nov@connect-op.heroku.com', rel: ['http://openid.net/specs/connect/1.0/issuer', 'vcard']

=== Caching

Caching is important in HTTP-based discovery.

If you set your own cache object to WebFinger.cache, this gem caches the discovery result until it expires.
(the expiry is calculated based on the "expires" value in JRD response)

  # Set Cache
  WebFinger.cache = Rails.cache

  WebFinger.discover! 'acct:nov@connect-op.heroku.com' # do HTTP request
  WebFinger.discover! 'acct:nov@connect-op.heroku.com' # use cache, no HTTP request

=== Debugging

Once you turn-on debugging, you can see all HTTP request/response in your log.

  # Turn on debugging
  WebFinger.debug!

  # Set logger (OPTIONAL, ::Logger.new(STDOUT) is used as default)
  WebFinger.logger = Rails.logger

You can also specify URL builder to force non-HTTPS access. (NOTE: allow non-HTTPS access only for debugging, not on your production.)

  WebFinger.url_builder = URI::HTTP # default URI::HTTPS

== Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

== Copyright

Copyright (c) 2012 nov matake. See LICENSE for details.

        

---

Owner metadata

• Name: Nov Matake
• Login: nov
• Email: nov@matake.jp
• Kind: user
• Description: Working around Ruby, OAuth, OpenID etc.
• Website: https://matake.jp
• Location: Tokyo, Japan
• Twitter: nov
• Company: YAuth.jp LLC
• Icon url: https://avatars.githubusercontent.com/u/27299?u=d02b1d3e03dc134d2d0a42e670eac1be099064e0&v=4
• Repositories: 166
• Last ynced at: 2025-10-29T22:36:11.404Z
• Profile URL: https://github.com/nov

---

GitHub Events

Total

• Push event: 1
• Pull request event: 1

Last Year

• Push event: 1

---

Committers metadata

Last synced: 3 days ago

Name	Email	Commits
nov	n****v@m****p	68
nov	n****e@g****t	11
Toon Willems	m@t****e	1

Committer domains:

• toonwillems.be: 1
• gree.net: 1
• matake.jp: 1

---

Issue and Pull Request metadata

Last synced: 13 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/nov/webfinger

---

---

---

Package metadata

• Total packages: 2
• Total downloads:
  • rubygems: 131,582,384 total
• Total docker downloads: 1,027,728,420
• Total dependent packages: 1 (may contain duplicates)
• Total dependent repositories: 1,323 (may contain duplicates)
• Total versions: 32
• Total maintainers: 1

---

Dependencies

Score: 24.677755539789203