OmniAuth OpenStreetMap strategy via OAuth2

This gem contains the OpenStreetMap OAuth2 strategy for OmniAuth.

OpenStreetMap recommends the OAuth2 flow. see: https://wiki.openstreetmap.org/wiki/OAuth

Originally developed by omniauth-osm (https://github.com/sozialhelden/omniauth-osm)

Add this line to your application's Gemfile:

gem 'omniauth-osm-oauth2'

And then execute:

$ bundle install

If you don't have an OpenStreetMap logo handy you may wish to drop openstreetmap.svg into your asset pipeline.

OmniAuth::Strategies::OsmOauth2 is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/omniauth/omniauth.

Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :osm_oauth2, ENV['OSM_APP_ID'], ENV['OSM_APP_SECRET']
end

Since July 2024, OSM dropped OAuth 1 support. So the omniauth-osm gem is no longer usable and apps using it need to migrate to this gem.

OAuth2 requires redirect_uri to start with https. This impacts local development - there is puma-dev gem with SSL support out-of-the-box, alternatively puma can be setup with self-signed certificate.

List of required changes (may be app-specific):

• Gemfile: gem 'omniauth-osm' -> gem 'omniauth-osm-oauth2'
• config/initializers/devise.rb: config.omniauth :osm -> config.omniauth :osm_oauth2
• app/controllers/omniauth_callbacks_controller.rb: def osm -> def osm_oauth2
• app/models/user.rb: :omniauth_providers => [:osm] -> :omniauth_providers => [:osm_oauth2]

Then the following needs to be run (otherwise a new user would be created when signing in):

User.where(provider: :osm).update_all(provider: :osm_oauth2)

TODO: Write usage instructions here

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-osm-oauth2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Omniauth::Osm::Oauth2 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.