Giter Site home page Giter Site logo

redfinger's Introduction

Redfinger

Redfinger is a simple Ruby library built to consume the Webfinger protocol. It’s simple!

For more information about Webfinger, see:

Installation

Redfinger is a gem:

gem install redfinger

Usage

Just call it with an e-mail address of a domain that provides the Webfinger protocol:

require 'redfinger'

Redfinger.finger('[email protected]')

From there, you have access to the links provided in the response as well as some shortcuts for common uses:

finger = Redfinger.finger('[email protected]')
finger.open_id.first.to_s # => "http://www.google.com/profiles/youraccount"

Links are simple hash based objects that store the ‘rel’ URI (such as that for hCard, OpenID, etc.), the ‘href’ (the actual destination URI), and the content type if specified. Note you can also just use #to_s on a link to get the destination URI.

So how can you use Webfinger to your advantage? Let’s take the example of hCard. If you install the ‘mofo` library you can do this:

require 'mofo'
require 'redfinger'

hcard_uri = Redfinger.finger('[email protected]').hcard.first.to_s
hcard = hCard.find(hcard_uri)
hcard.fn    # => "Example Guy"
hcard.title # => "Title guy gave himself on Google profile"

Note that the Webfinger protocol is still in its alpha/infancy and there will likely be many changes as time progresses. This library will do its best to stay up-to-date and current with these changes over time.

Note on Patches/Pull Requests

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

  • Send me a pull request. Bonus points for topic branches.

Copyright © 2010 Intridea, Inc. and Michael Bleigh. See LICENSE for details.

redfinger's People

Contributors

reidab avatar blaine avatar patcito avatar max-mapper avatar

Stargazers

Angus H. avatar Veronika Tyler avatar Timothy Johnson avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.