OmniAuth Frameio

This is a Ruby gem providing an OmniAuth strategy for Frame.io (via Adobe IMS OAuth2).

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add omniauth-frameio --github=lininglink/omniauth-frameio

This gem is not on rubygems.org. Do not run gem install omniauth-frameio or bundle add omniauth-frameio.

Usage

Register the strategy with OmniAuth in your Rails app (e.g. config/initializers/omniauth.rb):

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :frameio, ENV["FRAMEIO_CLIENT_ID"], ENV["FRAMEIO_CLIENT_SECRET"]
end

Then point users at /auth/frameio to begin the OAuth2 flow. After a successful callback, request.env["omniauth.auth"] will include the authenticated user's uid, info (email, name, image), and extra (raw IMS userinfo plus the Frame.io /v4/me profile).

Development

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

Contributing

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

License

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

Code of Conduct

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