README.md in rodauth-oauth-1.0.0.pre.beta2 vs README.md in rodauth-oauth-1.0.0

- old
+ new

@@ -1,13 +1,27 @@ # Rodauth::Oauth [![Gem Version](https://badge.fury.io/rb/rodauth-oauth.svg)](http://rubygems.org/gems/rodauth-oauth) -[![pipeline status](https://gitlab.com/honeyryderchuck/rodauth-oauth/badges/master/pipeline.svg)](https://gitlab.com/honeyryderchuck/rodauth-oauth/pipelines?page=1&scope=all&ref=master) -[![coverage report](https://gitlab.com/honeyryderchuck/rodauth-oauth/badges/master/coverage.svg?job=coverage)](https://honeyryderchuck.gitlab.io/rodauth-oauth/coverage/#_AllFiles) +[![pipeline status](https://gitlab.com/os85/rodauth-oauth/badges/master/pipeline.svg)](https://gitlab.com/os85/rodauth-oauth/pipelines?page=1&scope=all&ref=master) +[![coverage report](https://gitlab.com/os85/rodauth-oauth/badges/master/coverage.svg?job=coverage)](https://os85.gitlab.io/rodauth-oauth/coverage/#_AllFiles) This is an extension to the `rodauth` gem which implements the [OAuth 2.0 framework](https://tools.ietf.org/html/rfc6749) for an authorization server. +## Certification +[<img width="184" height="96" align="right" src="/openid-certified.jpg" alt="OpenID Certification">](https://openid.net/certification/) + +`rodauth-oauth` is [certified](https://openid.net/certification/) for the following profiles of the OpenID Connectâ„¢ protocol: + +* Basic OP +* Implicit OP +* Hybrid OP +* Config OP +* Dynamic OP +* Form Post OP + +(it also passes the conformance tests for the RP-Initiated Logout OP). + ## Features This gem implements the following RFCs and features of OAuth: * `oauth` - [The OAuth 2.0 protocol framework](https://tools.ietf.org/html/rfc6749): @@ -63,14 +77,14 @@ ## Resources | | | | ------------- | ----------------------------------------------------------- | -| Website | https://honeyryderchuck.gitlab.io/rodauth-oauth/ | -| Documentation | https://honeyryderchuck.gitlab.io/rodauth-oauth/rdoc/ | -| Wiki | https://gitlab.com/honeyryderchuck/rodauth-oauth/wikis/home | -| CI | https://gitlab.com/honeyryderchuck/rodauth-oauth/pipelines | +| Website | https://os85.gitlab.io/rodauth-oauth/ | +| Documentation | https://os85.gitlab.io/rodauth-oauth/rdoc/ | +| Wiki | https://gitlab.com/os85/rodauth-oauth/wikis/home | +| CI | https://gitlab.com/os85/rodauth-oauth/pipelines | ## Articles * [How to use rodauth-oauth with rails and rodauth](https://honeyryderchuck.gitlab.io/httpx/2021/03/15/oidc-provider-on-rails-using-rodauth-oauth.html) * [How to use rodauth-oauth with rails and without rodauth](https://honeyryderchuck.gitlab.io/httpx/2021/09/08/using-rodauth-oauth-in-rails-without-rodauth-based-auth.html) @@ -130,16 +144,16 @@ ``` ### Example (TL;DR) -Just [check our example applications](https://gitlab.com/honeyryderchuck/rodauth-oauth/-/tree/master/examples/). +Just [check our example applications](https://gitlab.com/os85/rodauth-oauth/-/tree/master/examples/). ### Database migrations -You have to generate database tables for accounts, oauth applications, grants and tokens. In order for you to hit the ground running, [here's a set of migrations (using `sequel`) to generate the needed tables](https://gitlab.com/honeyryderchuck/rodauth-oauth/-/tree/master/test/migrate) (omit the first 2 if you already have account tables, and [follow recommendations from rodauth accordingly](https://github.com/jeremyevans/rodauth)). +You have to generate database tables for accounts, oauth applications, grants and tokens. In order for you to hit the ground running, [here's a set of migrations (using `sequel`) to generate the needed tables](https://gitlab.com/os85/rodauth-oauth/-/tree/master/test/migrate) (omit the first 2 if you already have account tables, and [follow recommendations from rodauth accordingly](https://github.com/jeremyevans/rodauth)). You can change column names or even use existing tables, however, be aware that you'll have to define new column accessors at the `rodauth` plugin declaration level. Let's say, for instance, you'd like to change the `oauth_grants` table name to `access_grants`, and it's `code` column to `authorization_code`; then, you'd have to do the following: ```ruby plugin :rodauth do @@ -268,11 +282,11 @@ #### Internationalization (i18n) `rodauth-oauth` supports translating all user-facing text found in all pages and forms, by integrating with [rodauth-i18n](https://github.com/janko/rodauth-i18n). Just set it up in your application and `rodauth` configuration. -Default translations shipping with `rodauth-oauth` can be found [in this directory](https://gitlab.com/honeyryderchuck/rodauth-oauth/-/tree/master/locales). If they're not available for the languages you'd like to support, consider getting them translated from the english text, and contributing them to this repository via a Merge Request. +Default translations shipping with `rodauth-oauth` can be found [in this directory](https://gitlab.com/os85/rodauth-oauth/-/tree/master/locales). If they're not available for the languages you'd like to support, consider getting them translated from the english text, and contributing them to this repository via a Merge Request. (This feature is available since `v0.7`.) ## Ruby support policy @@ -287,6 +301,6 @@ After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests, and `rake rubocop` to run the linter. ## Contributing -Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/honeyryderchuck/rodauth-oauth. +Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/os85/rodauth-oauth.