feat(oauth-apple): support Sign in with Apple as a documented OmniAuth provider (#1347)

booleanbetrayal · web-flow · commit d886f476c625 · 2019-10-16T12:33:12.000-06:00
diff --git a/Gemfile b/Gemfile
@@ -21,6 +21,7 @@ group :development, :test do
   gem 'omniauth-facebook'
   gem 'omniauth-github'
   gem 'omniauth-google-oauth2'
+  gem 'omniauth-apple'
   gem 'rack-cors'
   gem 'thor'
 
diff --git a/devise_token_auth.gemspec b/devise_token_auth.gemspec
@@ -23,11 +23,12 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.2.0"
 
   s.add_dependency 'rails', '>= 4.2.0', '< 6.1'
+  s.add_dependency 'sprockets', '3.7.2' # FIXME: breaking changes in 4.0.0
   s.add_dependency 'devise', '> 3.5.2', '< 5'
   s.add_dependency 'bcrypt', '~> 3.0'
 
   s.add_development_dependency 'appraisal'
-  s.add_development_dependency 'sqlite3', '~> 1.3.6'
+  s.add_development_dependency 'sqlite3', '~> 1.4'
   s.add_development_dependency 'pg'
   s.add_development_dependency 'mysql2'
   s.add_development_dependency 'mongoid', '>= 4', '< 8'
diff --git a/docs/config/omniauth.md b/docs/config/omniauth.md
@@ -4,11 +4,12 @@
 
 If you wish to use omniauth authentication, add all of your desired authentication provider gems to your `Gemfile`.
 
-**OmniAuth example using github, facebook, and google**:
+**OmniAuth example using GitHub, Facebook, Google, and Apple**:
 ~~~ruby
 gem 'omniauth-github'
 gem 'omniauth-facebook'
 gem 'omniauth-google-oauth2'
+gem 'omniauth-apple'
 ~~~
 
 Then run `bundle install`.
@@ -21,13 +22,14 @@ In `config/initializers/omniauth.rb`, add the settings for each of your provider
 
 These settings must be obtained from the providers themselves.
 
-**Example using github, facebook, and google**:
+**Example using Github, Facebook, Google, and Apple**:
 ~~~ruby
 # config/initializers/omniauth.rb
 Rails.application.config.middleware.use OmniAuth::Builder do
   provider :github,        ENV['GITHUB_KEY'],   ENV['GITHUB_SECRET'],   scope: 'email,profile'
   provider :facebook,      ENV['FACEBOOK_KEY'], ENV['FACEBOOK_SECRET']
   provider :google_oauth2, ENV['GOOGLE_KEY'],   ENV['GOOGLE_SECRET']
+  provider :apple,         ENV['APPLE_CLIENT_ID'], '', { scope: 'email name', team_id: ENV['APPLE_TEAM_ID'], key_id: ENV['APPLE_KEY'], pem: ENV['APPLE_PEM'] }
 end
 ~~~
 
diff --git a/gemfiles/rails_4_2.gemfile b/gemfiles/rails_4_2.gemfile
@@ -13,6 +13,7 @@ group :development, :test do
   gem "omniauth-facebook", git: "https://github.com/mkdynamic/omniauth-facebook"
   gem "omniauth-github", git: "https://github.com/intridea/omniauth-github"
   gem "omniauth-google-oauth2", git: "https://github.com/zquestz/omniauth-google-oauth2"
+  gem 'omniauth-apple'
   gem "rack-cors", require: "rack/cors"
   gem "thor"
   gem "database_cleaner"
diff --git a/gemfiles/rails_4_2_mongoid_5.gemfile b/gemfiles/rails_4_2_mongoid_5.gemfile
@@ -12,6 +12,7 @@ group :development, :test do
   gem "omniauth-facebook", git: "https://github.com/mkdynamic/omniauth-facebook"
   gem "omniauth-github", git: "https://github.com/intridea/omniauth-github"
   gem "omniauth-google-oauth2", git: "https://github.com/zquestz/omniauth-google-oauth2"
+  gem 'omniauth-apple'
   gem "rack-cors", require: "rack/cors"
   gem "thor"
   gem "database_cleaner"
diff --git a/gemfiles/rails_5_0.gemfile b/gemfiles/rails_5_0.gemfile
@@ -13,6 +13,7 @@ group :development, :test do
   gem "omniauth-facebook", git: "https://github.com/mkdynamic/omniauth-facebook"
   gem "omniauth-github", git: "https://github.com/intridea/omniauth-github"
   gem "omniauth-google-oauth2", git: "https://github.com/zquestz/omniauth-google-oauth2"
+  gem 'omniauth-apple'
   gem "rack-cors", require: "rack/cors"
   gem "thor"
   gem "database_cleaner"
diff --git a/gemfiles/rails_5_1.gemfile b/gemfiles/rails_5_1.gemfile
@@ -13,6 +13,7 @@ group :development, :test do
   gem "omniauth-facebook", git: "https://github.com/mkdynamic/omniauth-facebook"
   gem "omniauth-github", git: "https://github.com/intridea/omniauth-github"
   gem "omniauth-google-oauth2", git: "https://github.com/zquestz/omniauth-google-oauth2"
+  gem 'omniauth-apple'
   gem "rack-cors", require: "rack/cors"
   gem "thor"
   gem "database_cleaner"
diff --git a/gemfiles/rails_5_1_mongoid_6.gemfile b/gemfiles/rails_5_1_mongoid_6.gemfile
@@ -12,6 +12,7 @@ group :development, :test do
   gem "omniauth-facebook", git: "https://github.com/mkdynamic/omniauth-facebook"
   gem "omniauth-github", git: "https://github.com/intridea/omniauth-github"
   gem "omniauth-google-oauth2", git: "https://github.com/zquestz/omniauth-google-oauth2"
+  gem 'omniauth-apple'
   gem "rack-cors", require: "rack/cors"
   gem "thor"
   gem "database_cleaner"
diff --git a/gemfiles/rails_5_1_mongoid_7.gemfile b/gemfiles/rails_5_1_mongoid_7.gemfile
@@ -12,6 +12,7 @@ group :development, :test do
   gem "omniauth-facebook", git: "https://github.com/mkdynamic/omniauth-facebook"
   gem "omniauth-github", git: "https://github.com/intridea/omniauth-github"
   gem "omniauth-google-oauth2", git: "https://github.com/zquestz/omniauth-google-oauth2"
+  gem 'omniauth-apple'
   gem "rack-cors", require: "rack/cors"
   gem "thor"
   gem "database_cleaner"
diff --git a/gemfiles/rails_5_2.gemfile b/gemfiles/rails_5_2.gemfile
@@ -13,6 +13,7 @@ group :development, :test do
   gem "omniauth-facebook", git: "https://github.com/mkdynamic/omniauth-facebook"
   gem "omniauth-github", git: "https://github.com/intridea/omniauth-github"
   gem "omniauth-google-oauth2", git: "https://github.com/zquestz/omniauth-google-oauth2"
+  gem 'omniauth-apple'
   gem "rack-cors", require: "rack/cors"
   gem "thor"
   gem "database_cleaner"
diff --git a/gemfiles/rails_5_2_mongoid_6.gemfile b/gemfiles/rails_5_2_mongoid_6.gemfile
@@ -12,6 +12,7 @@ group :development, :test do
   gem "omniauth-facebook", git: "https://github.com/mkdynamic/omniauth-facebook"
   gem "omniauth-github", git: "https://github.com/intridea/omniauth-github"
   gem "omniauth-google-oauth2", git: "https://github.com/zquestz/omniauth-google-oauth2"
+  gem 'omniauth-apple'
   gem "rack-cors", require: "rack/cors"
   gem "thor"
   gem "database_cleaner"
diff --git a/gemfiles/rails_5_2_mongoid_7.gemfile b/gemfiles/rails_5_2_mongoid_7.gemfile
@@ -12,6 +12,7 @@ group :development, :test do
   gem "omniauth-facebook", git: "https://github.com/mkdynamic/omniauth-facebook"
   gem "omniauth-github", git: "https://github.com/intridea/omniauth-github"
   gem "omniauth-google-oauth2", git: "https://github.com/zquestz/omniauth-google-oauth2"
+  gem 'omniauth-apple'
   gem "rack-cors", require: "rack/cors"
   gem "thor"
   gem "database_cleaner"
diff --git a/test/dummy/config/initializers/figaro.rb b/test/dummy/config/initializers/figaro.rb
@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-#Figaro.require("GITHUB_KEY", "GITHUB_SECRET", "FACEBOOK_KEY", "FACEBOOK_SECRET", "GOOGLE_KEY", "GOOGLE_SECRET")
+#Figaro.require("GITHUB_KEY", "GITHUB_SECRET", "FACEBOOK_KEY", "FACEBOOK_SECRET", "GOOGLE_KEY", "GOOGLE_SECRET", "APPLE_CLIENT_ID", "APPLE_TEAM_ID", "APPLE_KEY", "APPLE_PEM")
diff --git a/test/dummy/config/initializers/omniauth.rb b/test/dummy/config/initializers/omniauth.rb
@@ -4,6 +4,7 @@
   provider :github,        ENV['GITHUB_KEY'],   ENV['GITHUB_SECRET'],   scope: 'email,profile'
   provider :facebook,      ENV['FACEBOOK_KEY'], ENV['FACEBOOK_SECRET']
   provider :google_oauth2, ENV['GOOGLE_KEY'],   ENV['GOOGLE_SECRET']
+  provider :apple,         ENV['APPLE_CLIENT_ID'], '', { scope: 'email name', team_id: ENV['APPLE_TEAM_ID'], key_id: ENV['APPLE_KEY'], pem: ENV['APPLE_PEM'] }
   provider :developer,
            fields: [:first_name, :last_name],
            uid_field: :last_name

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# frozen_string_literal: true`
`2`	`2`
`3`		`-#Figaro.require("GITHUB_KEY", "GITHUB_SECRET", "FACEBOOK_KEY", "FACEBOOK_SECRET", "GOOGLE_KEY", "GOOGLE_SECRET")`
	`3`	`+#Figaro.require("GITHUB_KEY", "GITHUB_SECRET", "FACEBOOK_KEY", "FACEBOOK_SECRET", "GOOGLE_KEY", "GOOGLE_SECRET", "APPLE_CLIENT_ID", "APPLE_TEAM_ID", "APPLE_KEY", "APPLE_PEM")`