Omniauth::Typeform
Typeform's OAuth Strategy for OmniAuth.
Installation
Add this line to your application's Gemfile:
gem 'omniauth-typeform'
And then execute:
$ bundle
Or install it yourself as:
$ gem install omniauth-typeform
Usage
OmniAuth::Strategies::Typeform
is simply a Rack middleware. Read the OmniAuth
docs for detailed instructions: https://github.com/intridea/omniauth.
First, create a new application at
https://admin.typeform.com/account#/section/apps
. Your callback URL must be
something like https://example.com/auth/typeform/callback
. For development you
can use http://127.0.0.1:3000/auth/typeform/callback
.
Here's a quick example, adding the middleware to a Rails app in
config/initializers/omniauth.rb
. This example assumes you're exporting your
credentials as environment variables.
Notice that omniauth-typeform will always inject account
and emails
scopes,
so we can retrieve the required information.
Rails.application.config.middleware.use OmniAuth::Builder do
provider :typeform,
ENV['TYPEFORM_CLIENT_ID'],
ENV['TYPEFORM_CLIENT_SECRET']
end
Now visit /auth/typeform
to start authentication against Typeform.
Contributing
- Fork omniauth-typeform
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request