if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know on Discord or RubyForum, as I may have missed the notification.
if ci_badges.map(&:color).all? { it == "green"} 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️
I've summarized my thoughts in this blog post.
open_id_authentication is a Rails integration layer over rack-openid2. Its
Railtie installs the Rack middleware and adds controller helpers for beginning
and completing OpenID authentication. The completion callback yields a result
object, the verified identifier, and any SReg or Attribute Exchange response.
It supports the legacy OpenID protocol, not OpenID Connect (OIDC), and is most useful when maintaining a Rails application that already accepts OpenID identifiers.
| Tokens to Remember |   |
|---|---|
| Works with JRuby |     |
| Works with Truffle Ruby |         |
| Works with MRI Ruby 4 |   |
| Works with MRI Ruby 3 |      |
| Works with MRI Ruby 2 |  |
| Support & Community |      |
| Source |     |
| Documentation |      |
| Compliance |      |
| Style |     |
| Maintainer 🎖️ |      |
... 💖 |
    🧊 🐙 🛖 🧪 |
Compatible with MRI Ruby 2.7.0+, and concordant releases of JRuby, and TruffleRuby.
CI workflows and Appraisals are generated for MRI Ruby 2.7.0+.
This test floor is configured by ruby.test_minimum in .kettle-jem.yml and
may be higher than the gem's runtime compatibility floor when legacy Rubies are
not practical for the current toolchain.
The amazing test matrix is powered by the kettle-dev stack.
How kettle-dev manages complexity in tests
| Gem | Source | Role | Total downloads |
|---|---|---|---|
| appraisal2 | GitHub | multi-dependency Appraisal matrix generation |  |
| appraisal2-rubocop | GitHub | RuboCop Appraisal generator integration |  |
| kettle-dev | GitHub | development, release, and CI workflow tooling |  |
| kettle-jem | GitHub | Appraisals & CI workflow templates |  |
| kettle-soup-cover | GitHub | SimpleCov coverage policy and reporting |  |
| kettle-test | GitHub | standard test runner and coverage harness |  |
| rubocop-lts | GitHub | Ruby-version-aware linting |  |
| turbo_tests2 | GitHub | parallel test execution |  |
Find this repo on federated forges (Coming soon!)
| Federated DVCS Repository | Status | Issues | PRs | Wiki | CI |
|---|---|---|---|---|---|
| 🧪 ruby-openid/open_id_authentication on GitLab | The Truth | 💚 | 💚 | 💚 | 🐭 Tiny Matrix |
| 🧊 ruby-openid/open_id_authentication on CodeBerg | An Ethical Mirror (Donate) | 💚 | 💚 | ➖ | ⭕️ No Matrix |
| 🐙 ruby-openid/open_id_authentication on GitHub | Another Mirror | 💚 | 💚 | 💚 | 💯 Full Matrix |
Available as part of the Tidelift Subscription.
Need enterprise-level guarantees?
The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
- 💡Subscribe for support guarantees covering all your FLOSS dependencies
- 💡Tidelift is part of Sonar
- 💡Tidelift pays maintainers to maintain the software you depend on!
📊@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers
Alternatively:
Install the gem and add to the application's Gemfile by executing:
bundle add open_id_authenticationIf bundler is not being used to manage dependencies, install the gem by executing:
gem install open_id_authenticationLoad the gem after Rails so its Railtie can install
OpenIdAuthentication::Middleware and include the controller helpers. Set the
OpenID store during application initialization:
# config/initializers/open_id_authentication.rb
OpenIdAuthentication.store = :fileSupported store values are :memory, :file, :memcache (followed by Dalli
server arguments), or an object implementing the OpenID::Store interface.
Memory storage is process-local. File storage writes below tmp/openids, so it
is suitable for one host but not a shared NFS deployment. Use Memcache or a
custom durable store when requests can reach multiple application processes.
The authentication action must accept both GET and POST callbacks, and the
application must define root_url for the relying-party realm.
OpenID authentication uses the session, so be sure that you haven't turned that off.
Alternatively, you can use the file-based store, which just relies on tmp/openids being present in RAILS_ROOT. But be aware that this store only works if you have a single application server. And it's not safe to use across NFS. It's recommended that you use the database store if at all possible. To use the file-based store, you'll also have to add this line to your config/environment.rb:
OpenIdAuthentication.store = :file
This particular plugin also relies on the fact that the authentication action allows for both POST and GET operations. If you're using REST-ful authentication, you'll need to explicitly allow for this in your routes.rb.
The plugin also expects to find a root_url method that points to the home page of your site. You can accomplish this by using a root route in config/routes.rb:
root :to => "articles#index"
This plugin works with any version of Rails you can run on Ruby 2.7 or newer.
While ruby-openid tools are free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of... "dollars" would make the project more sustainable.
We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences. Currently, Open Collective is our preferred funding platform.
If you're working in a company that's making significant use of ruby-openid tools we'd appreciate it if you suggest to your company to become a ruby-openid sponsor.
You can support the development of ruby-openid tools via GitHub Sponsors, Liberapay, PayPal, Open Collective and Tidelift.
| 📍 NOTE |
|---|
| If doing a sponsorship in the form of donation is problematic for your company from an accounting standpoint, we'd recommend the use of Tidelift, where you can get a support-like subscription instead. |
Support us with a monthly donation and help us continue our activities. [Become a backer]
NOTE: kettle-readme-backers updates this list every day, automatically.
No backers yet. Be the first!
Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]
NOTE: kettle-readme-backers updates this list every day, automatically.
No sponsors yet. Be the first!
I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈 cats).
If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.
I’m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
Floss-Funding.dev: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags
See SECURITY.md.
If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) check issues or PRs, or use the gem and think about how it could be better.
We
See CONTRIBUTING.md for more detailed instructions.
See CONTRIBUTING.md.
Coverage service badges
Everyone interacting with this project's codebases, issue trackers,
chat rooms and mailing lists agrees to follow the
Made with contributors-img.
Also see GitLab Contributors: https://gitlab.com/ruby-openid/open_id_authentication/-/graphs/main
⭐️ Star History
This library follows
For example:
spec.add_dependency("open_id_authentication", "~> 2.0")📌 Is "Platform Support" part of the public API? More details inside.
Dropping support for a platform can be a breaking change for affected users. If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:
See CHANGELOG.md for a list of releases.
The gem is available as open source under the terms of
the MIT
See LICENSE.md for the official copyright notice.
Copyright holders
- Copyright (c) 2007-2008 bitsweat
- Copyright (c) 2007 david
- Copyright (c) 2008 Geoffrey Grosenbach
- Copyright (c) 2008 Phil R
- Copyright (c) 2009 Peat Bakke
- Copyright (c) 2010 Joshua Peek
- Copyright (c) 2011 patricksrobertson
- Copyright (c) 2011 Tom Hughes
- Copyright (c) 2013 grosser
- Copyright (c) 2016 Michael Grosser
- Copyright (c) 2024-2025 Annibelle Boling
- Copyright (c) 2024-2026 Peter H. Boling
- Copyright (c) 2025 Aboling0
Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March, and encountering difficulty finding a new one, I began spending most of my time building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, I need your support. Please consider sponsoring me or the project.
To join the community or get help, use the RubyForum or Discord.
To say "thanks!" ☝️ Join the community or 👇️ send money.
Many parts of this project are actively managed by a kettle-jem smart template utilizing StructuredMerge.org merge contracts.
Thanks for RTFM.
| Field | Value |
|---|---|
| Package | open_id_authentication |
| Description | 💎 Provides a thin wrapper around the excellent rack-openid2 gem. |
| Homepage | https://github.com/ruby-openid/open_id_authentication |
| Source | https://github.com/ruby-openid/open_id_authentication |
| License | MIT |
| Funding | https://github.com/sponsors/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/ruby-openid, https://thanks.dev/gh/pboling, https://tidelift.com/funding/github/rubygems/open_id_authentication, https://www.buymeacoffee.com/pboling |