Rails OpenId¶ ↑

Rails OpenId is a very small library that intends to abstract away a little bit of ruby-openid to make it easier to use in Rails applications. It is a very infant library, use at your own peril.

The canonical places for this gem are:

• github.com/pupeno/rails_openid

• rubygems.org/gems/rails_openid

• rdoc.info/projects/pupeno/rails_openid

This gem is provided through RubyGems.org so you need to have gem configured to pull gems from RubyGems.org.

You can skip this if you have RubyGems.org enabled (which is going to be the default in the future anyway). A properly configured environment should list rubygems.org or gemcutter.org in the gem sources, like:

$ gem sources
*** CURRENT SOURCES ***

http://rubygems.org/

If you don’t have it, you can probably add it this way:

$ gem source -a http://rubygems.org/

It’s simple a matter of running:

$ gem install rails_openid

and that’s it. Let me know if something breaks.

In the Gemfile file of your Ruby on Rails project you’ll need to add:

gem "rails_openid"

after that run

bundle install

and watch the magic happen, all required gems will be installed. Configuring your Rails project like that is something you’ll need anyway, so this is my recommended way.

In the environment.rb file of your Ruby on Rails project you’ll have some commented out lines like this:

# config.gem "bj"
# config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
# config.gem "sqlite3-ruby", :lib => "sqlite3"
# config.gem "aws-s3", :lib => "aws/s3"

After those you can just add

config.gem "rails_openid"

and then run

$ rake gems:install

and you’ll get this and all the gems your Rails project need installed. Configuring your Rails project like that is something you’ll need anyway, so this is my recommended way.

A good way to get started is to run the open_id_scaffold generator:

./script/generate open_id_scaffold

Be sure to have the following line in your environment.rb (or the equivalent in Rails 3)

config.gem "rails_openid"
config.gem "ruby-openid", :lib => "openid"

To be able to run the provided tests, you’ll need mocha, so add:

config.gem "mocha"

to your config/environments/test.rb

If you don’t have a user model, you’ll want to create one. You can do it like this:

./script/generate model User name:string email:string nickname:string

To link your user model to their open ids add the following line to your user model:

has_many :open_ids

rails_openid come with tests you already have in your project. Their failures will show things you need to complete on your own. Also, if you go through the generated code, search for TODOs and you’ll find the places where there’s code you are likely to want to change.

Up to date api documentation should be automatically generated on rdoc.info/projects/pupeno/rails_openid

• 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 © 2009 J. Pablo Fernández. See LICENSE for details.