Stripe Connect OAuth2 Strategy for OmniAuth 1.0.
Supports the OAuth 2.0 server-side and client-side flows. Read the Stripe Connect docs for more details: https://stripe.com/connect
Add this line to your application's Gemfile:
gem 'omniauth-stripe-connect'
And then execute:
$ bundle
Or install it yourself as:
$ gem install omniauth-stripe-connect
OmniAuth::Strategies::StripeConnect is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/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 :stripe_connect, ENV['STRIPE_CONNECT_CLIENT_ID'], ENV['STRIPE_SECRET']
endYou need to declare the provider in your config/initializers/devise.rb:
config.omniauth :stripe_connect, "STRIPE_CONNECT_CLIENT_ID", "STRIPE_SECRET"You'll also need to add some configuration to your devise model (e.g. User in app/models/user.rb) along with any other OmniAuth providers you might have:
:omniauthable, :omniauth_providers => [:stripe_connect]Your STRIPE_CONNECT_CLIENT_ID is application-specific and your STRIPE_SECRET is account-specific and may also be known as your Stripe API key or Stripe Private key.
Edit your routes.rb file to have:
devise_for :users, :controllers => { :omniauth_callbacks => "omniauth_callbacks" }
And create a file called omniauth_callbacks_controller.rb which should have this inside:
class OmniauthCallbacksController < Devise::OmniauthCallbacksController
def stripe_connect
# Delete the code inside of this method and write your own.
# The code below is to show you where to access the data.
raise request.env["omniauth.auth"].to_yaml
end
endMake sure to go to Stripe's Account Settings > Applications and set your Redirect URL to:
http://localhost:3003/users/auth/stripe_connect/callback
The Webhook URL will be something similar:
http://www.yourdomain.com/users/auth/stripe_connect/callback
Then you can hit /auth/stripe_connect
If you hit /auth/stripe_connect with any query params, they will be passed along to Stripe. You can access these params from request.env['omniauth.params']. Read Stripe's OAuth Reference for more information.
Here is an example of the Auth Hash you get back from calling request.env['omniauth.auth']:
{
"provider"=>"stripe_connect",
"uid"=>"<STRIPE_USER_ID>",
"info"=> {
"email"=>"[email protected]",
"name"=>"Name",
"nickname"=>"Nickname",
"scope"=>"read_write", # or "read_only"
"livemode"=>false,
"stripe_publishable_key"=>"<STRIPE_PUBLISHABLE_KEY>",
},
"credentials"=> {
"token"=>"<STRIPE_ACCESS_TOKEN>",
"refresh_token"=>"<STRIPE_REFRESH_TOKEN>",
"expires"=>false
},
"extra"=> {
"raw_info"=> {
"token_type"=>"bearer",
"stripe_user_id"=>"<STRIPE_USER_ID>",
"scope"=>"read_only",
"stripe_publishable_key"=>"<STRIPE_PUBLISHABLE_KEY>",
"livemode"=>false
},
"extra_info"=> {
"business_logo"=>"https://stripe.com/business_logo.png",
"business_name"=>"Business Name",
"business_url"=>"example.com",
"charges_enabled"=>true,
"country"=>"US",
"default_currency"=>"eur",
"details_submitted"=>true,
"display_name"=>"Business Name",
"email"=>"[email protected]",
"id"=>"<STRIPE_USER_ID>",
"managed"=>false,
"object"=>"account",
"statement_descriptor"=>"EXAMPLE.COM",
"support_email"=>"[email protected]",
"support_phone"=>"123456789",
"timezone"=>"Europe/Berlin",
"transfers_enabled"=>true
}
}
}Stripe Connect in Rails Tutorial
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent