Add GitHub oauth install generator (#25)

* Adds the google oauth install generator

* Refactored and extracted the common code for oauth generator + completed the github oauth generator

Author: abhaynikam

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## master (unreleased)
 * Upgrade the Tailwind CSS generator to support Tailwind V2.0. ([@abhaynikam][])
+* Adds Devise GitHub Omniauth generator. ([@abhaynikam][])
 
 ## 0.6.0 (January 10th, 2021)
 * Updates default ruby version of GitHub Actions install generator. ([@jamesglover][])

README.md

@@ -61,6 +61,7 @@ The boring generator introduces following generators:
 - Install SimpleForm: `rails generate boring:simple_form:install --css_framework=<css_framework>`
 - Install Devise: `rails generate boring:devise:install`
 - Install Devise Facebook Omniauth: `rails generate boring:oauth:facebook:install`
+- Install Devise GitHub Omniauth: `rails generate boring:oauth:github:install`
 
 ## Development
 

lib/generators/boring/oauth/base_generator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module Boring
+  module Oauth
+    module BaseGenerator
+      def add_provider_and_uuid_user_details
+        say "Adding migration to add provider and uuid columns to users", :green
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate migration AddOmniauthToUsers provider:string uid:string"
+        end
+      end
+
+      def configure_devise_omniauth
+        say "Adding omniauth devise configuration", :green
+        if File.exist?("config/initializers/devise.rb")
+          insert_into_file "config/initializers/devise.rb", <<~RUBY, after: /Devise.setup do \|config\|/
+            \n
+            \tconfig.omniauth :#{@oauth_name}, "APP_ID", "APP_SECRET"
+          RUBY
+        else
+          raise MissingDeviseConfigurationError, <<~ERROR
+            Looks like the devise installation is incomplete. Could not find devise.rb in config/initializers.
+          ERROR
+        end
+      end
+
+      def add_omniauth_callback_routes
+        devise_route = '# devise_for :users, controllers: { omniauth_callbacks: "users/omniauth_callbacks" }'.dup
+        route devise_route
+      end
+
+      def add_omniauth_callback_controller
+        say "Copying omniauth_callbacks_controller.rb", :green
+        template("omniauth_callbacks_controller.rb", "app/controllers/users/omniauth_callbacks_controller.rb")
+      end
+
+      def configure_and_add_devise_setting_in_user_model
+        say "Configuring #{@oauth_name.to_s} omniauth for user model", :green
+        insert_into_file "app/models/user.rb", <<~RUBY, after: /class User < ApplicationRecord/
+          \n\tdevise :omniauthable, omniauth_providers: %i[#{@oauth_name}]
+
+          \tdef self.from_omniauth(auth)
+            \twhere(provider: auth.provider, uid: auth.uid).first_or_create do |user|
+              \tuser.email = auth.info.email
+              \tuser.password = Devise.friendly_token[0, 20]
+              \tuser.name = auth.info.name   # assuming the user model has a name
+              \t# user.image = auth.info.image # assuming the user model has an image
+              \t# If you are using confirmable and the provider(s) you use validate emails,
+              \t# uncomment the line below to skip the confirmation emails.
+              \t# user.skip_confirmation!
+            \tend
+          \tend
+        RUBY
+      end
+
+      def show_readme
+        readme "README"
+      end
+    end
+  end
+end

lib/generators/boring/oauth/facebook/install/install_generator.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require 'bundler'
+require 'generators/boring/oauth/base_generator'
 
 module Boring
   module Oauth
     module Facebook
       class InstallGenerator < Rails::Generators::Base
+        include Boring::Oauth::BaseGenerator
+
         class MissingDeviseConfigurationError < StandardError; end
 
         desc "Adds facebook OmniAuth to the application"
@@ -24,66 +27,14 @@ def add_facebook_omniauth_gem
           end
         end
 
-        def add_provider_and_uuid_user_details
-          say "Adding migration to add provider and uuid columns to users", :green
-          Bundler.with_unbundled_env do
-            run "DISABLE_SPRING=1 bundle exec rails generate migration AddOmniauthToUsers provider:string uid:string"
-          end
-        end
-
-        def configure_devise_omniauth_facebook
-          say "Adding omniauth devise configuration", :green
-          if File.exist?("config/initializers/devise.rb")
-            insert_into_file "config/initializers/devise.rb", <<~RUBY, after: /Devise.setup do \|config\|/
-              \n
-              \tconfig.omniauth :facebook, "APP_ID", "APP_SECRET"
-            RUBY
-          else
-            raise MissingDeviseConfigurationError, <<~ERROR
-              Looks like the devise installation is incomplete. Could not find devise.rb in config/initializers.
-            ERROR
-          end
-        end
-
-        def add_omniauth_callback_routes
-          devise_route = '# devise_for :users, controllers: { omniauth_callbacks: "users/omniauth_callbacks" }'.dup
-          route devise_route
-        end
-
-        def add_omniauth_callback_controller
-          say "Copying omniauth_callbacks_controller.rb", :green
-          template("omniauth_callbacks_controller.rb", "app/controllers/users/omniauth_callbacks_controller.rb")
-        end
-
-        def configure_and_add_devise_setting_in_user_model
-          say "Configuring facebook omniauth for user model", :green
-          insert_into_file "app/models/user.rb", <<~RUBY, after: /class User < ApplicationRecord/
-
-              \tdevise :omniauthable, omniauth_providers: %i[facebook]
-
-              \tdef self.from_omniauth(auth)
-                \twhere(provider: auth.provider, uid: auth.uid).first_or_create do |user|
-                  \tuser.email = auth.info.email
-                  \tuser.password = Devise.friendly_token[0, 20]
-                  \tuser.name = auth.info.name   # assuming the user model has a name
-                  \t# user.image = auth.info.image # assuming the user model has an image
-                  \t# If you are using confirmable and the provider(s) you use validate emails,
-                  \t# uncomment the line below to skip the confirmation emails.
-                  \t# user.skip_confirmation!
-                \tend
-              \tend
-          RUBY
-        end
-
-        def add_the_facebook_devise_omniauth_view
-          insert_into_file "app/views/users/sessions/new.html.erb", <<~RUBY, after: /<%= render "users\/shared\/links" %>/
-
-            <%= link_to "Sign in with Facebook", user_facebook_omniauth_authorize_path %>
-          RUBY
-        end
-
-        def show_readme
-          readme "README"
+        def invoke_common_generator_methods
+          @oauth_name = :facebook
+          add_provider_and_uuid_user_details
+          configure_devise_omniauth
+          add_omniauth_callback_routes
+          add_omniauth_callback_controller
+          configure_and_add_devise_setting_in_user_model
+          show_readme
         end
       end
     end

lib/generators/boring/oauth/facebook/install/templates/README

@@ -16,9 +16,5 @@ Some setup you must do manually if you haven't yet:
      For example:
 
      config.omniauth :facebook, "APP_ID", "APP_SECRET"
-  3. Ensure you have added the facebook omniauth route in the devise session view:
-     For example:
-
-     <%= link_to "Sign in with Facebook", user_facebook_omniauth_authorize_path %>
 
 ===============================================================================

lib/generators/boring/oauth/github/install/install_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'generators/boring/oauth/base_generator'
+
+module Boring
+  module Oauth
+    module Github
+      class InstallGenerator < Rails::Generators::Base
+        include Boring::Oauth::BaseGenerator
+
+        class MissingDeviseConfigurationError < StandardError; end
+
+        desc "Adds GitHub OmniAuth to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        def add_github_omniauth_gem
+          say "Adding GitHub OmniAuth gem", :green
+          github_omniauth_gem = <<~RUBY
+            \n
+            # for omniauth github
+            gem 'omniauth-github', '~> 1.4.0'
+          RUBY
+          append_to_file "Gemfile", github_omniauth_gem
+          Bundler.with_unbundled_env do
+            run "bundle install"
+          end
+        end
+
+        def invoke_common_generator_methods
+          @oauth_name = :github
+          add_provider_and_uuid_user_details
+          configure_devise_omniauth
+          add_omniauth_callback_routes
+          add_omniauth_callback_controller
+          configure_and_add_devise_setting_in_user_model
+          show_readme
+        end
+      end
+    end
+  end
+end

lib/generators/boring/oauth/github/install/templates/README

@@ -0,0 +1,20 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Ensure you have overridden or uncommented the routes for generated omniauth callback controllers in your routes.rb.
+     For example:
+
+     Rails.application.routes.draw do
+       devise_for :users, controllers: {
+         omniauth_callbacks: "users/omniauth_callbacks"
+       }
+     end
+
+  2. Update the devise github omniauth APP_ID and APP_SECRET in "config/initializers/devise.rb"
+     after registering the Rails application on: https://github.com/settings/applications/new
+     For example:
+
+     config.omniauth :github, "APP_ID", "APP_SECRET"
+
+===============================================================================

lib/generators/boring/oauth/github/install/templates/omniauth_callbacks_controller.rb

@@ -0,0 +1,21 @@
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  # See https://github.com/omniauth/omniauth/wiki/FAQ#rails-session-is-clobbered-after-callback-on-developer-strategy
+  skip_before_action :verify_authenticity_token, only: :github
+
+  def github
+    # You need to implement the method below in your model (e.g. app/models/user.rb)
+    @user = User.from_omniauth(request.env["omniauth.auth"])
+
+    if @user.persisted?
+      sign_in_and_redirect @user, event: :authentication #this will throw if @user is not activated
+      set_flash_message(:notice, :success, kind: "GitHub") if is_navigational_format?
+    else
+      session["devise.github_data"] = request.env["omniauth.auth"].except(:extra) # Removing extra as it can overflow some session stores
+      redirect_to new_user_registration_url
+    end
+  end
+
+  def failure
+    redirect_to root_path
+  end
+end

test/generators/oauth/facebook_install_generator_test.rb

@@ -33,10 +33,6 @@ def test_should_install_facebook_oauth
         assert_match('devise :omniauthable, omniauth_providers: %i[facebook]', content)
         assert_match('def self.from_omniauth(auth)', content)
       end
-
-      assert_file "app/views/users/sessions/new.html.erb" do |content|
-        assert_match('Sign in with Facebook', content)
-      end
     end
   end
 

test/generators/oauth/github_install_generator_test.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "generators/boring/devise/install/install_generator"
+require "generators/boring/oauth/github/install/install_generator"
+
+class OauthGithubInstallGeneratorTest < Rails::Generators::TestCase
+  tests Boring::Oauth::Github::InstallGenerator
+  setup :build_app
+  teardown :teardown_app
+
+  include GeneratorHelper
+  include ActiveSupport::Testing::Isolation
+
+  def destination_root
+    app_path
+  end
+
+  def test_should_install_github_oauth
+    Dir.chdir(app_path) do
+      quietly { Rails::Generators.invoke("boring:devise:install") }
+      quietly { run_generator }
+
+      assert_gem "omniauth-github"
+      assert_migration "db/migrate/add_omniauth_to_users.rb"
+      assert_file "config/initializers/devise.rb" do |content|
+        assert_match('config.omniauth :github', content)
+      end
+
+      assert_file "app/controllers/users/omniauth_callbacks_controller.rb"
+
+      assert_file "app/models/user.rb" do |content|
+        assert_match('devise :omniauthable, omniauth_providers: %i[github]', content)
+        assert_match('def self.from_omniauth(auth)', content)
+      end
+    end
+  end
+
+  def test_should_raise_devise_configuration_missing_error
+    Dir.chdir(app_path) do
+      assert_raises do
+        run_generator
+      end
+    end
+  end
+end