boring_generators 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c38ce00aea24f2d84874abeaf67e8fc1e917934b8dc24e7a722c695cd55b75f
-  data.tar.gz: 3373b320ace30d8a04e14af9780b65b819f266712cfd37e676f89872ce157cb5
+  metadata.gz: 3cac88ca9c5967e3109166aab566f0ec75936e5aee8b752c0c48602eda974b9c
+  data.tar.gz: 968a3f0761e84fa8caf64c2e23acba3e82e09c2b7c85d342a9e3c872c8a11d01
 SHA512:
-  metadata.gz: f9e074f948419ff51132578335b1b9003ba99f73779b535b0a306753a3057dd924833d31eeb12091af4ebbb0db59b0ea5faa207da0ae9e413a6c3c7d61f24f32
-  data.tar.gz: 5c06d9e92fa9b7f5599cdf77d5c391c59adffea7ccdad470e723daa1190bc94ded77b57e4417564b5ebcc53507c3b421b1093b827ea81aaa4ea2786813531df6
+  metadata.gz: be7b2ef1596240670290b4088a7d75a82a5a525b837fa7eeaff3b713e3b974f5eb26f81d5132259bedf1eb5af3d90aba279e992d7f69571fb85406c995a62f80
+  data.tar.gz: 72b7998e2cf8f42f4c4f77c956ebccf702872e3f32b98e99266ddf1a0d94be312c9bef3e4d48f94b854d3a0ed93776576620964a9883b259f64847fb306bc751

data/.github/workflows/ci.yml

@@ -11,7 +11,13 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7.0
+          bundler-cache: true
+      - name: Install Imagemagick
+        run: |
+          wget https://raw.githubusercontent.com/discourse/discourse_docker/master/image/base/install-imagemagick
+          chmod +x install-imagemagick
+          sudo ./install-imagemagick
       - name: Install gems
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
-        run: bundle exec rake test
+        run: bundle exec rake test --trace

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## master (unreleased)
 
+## 0.8.0 (February 28th, 2021)
+* Adds Devise Google Omniauth generator. ([@abhaynikam][])
+* Adds Devise Twitter Omniauth generator. ([@abhaynikam][])
+* Adds Twilio generator. ([@abhaynikam][])
+
 ## 0.7.0 (January 30th, 2021)
 * Upgrade the Tailwind CSS generator to support Tailwind V2.0. ([@abhaynikam][])
 * Adds Devise GitHub Omniauth generator. ([@abhaynikam][])

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boring_generators (0.7.0)
+    boring_generators (0.8.0)
       railties
 
 GEM
@@ -81,11 +81,13 @@ GEM
     method_source (1.0.0)
     mimemagic (0.3.5)
     mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
+    mini_portile2 (2.5.0)
     minitest (5.14.2)
     nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)

data/README.md

@@ -40,19 +40,19 @@ And then you can use it this way:
 ## Usage
 
 The boring generator introduces following generators:
-- Install Tailwind CSS: `rails generate boring:tailwind:install`
-- Install Bootstrap: `rails generate boring:bootstrap:install`
+- [Install Tailwind CSS: `rails generate boring:tailwind:install`](https://www.boringgenerators.com/blog/2020-10-18-install-tailwind/)
+- [Install Bootstrap: `rails generate boring:bootstrap:install`](https://www.boringgenerators.com/blog/2020-11-15-install-bootstrap/)
 - Install JQuery: `rails generate boring:jquery:install`
-- Install FontAwesome via Yarn: `rails generate boring:font_awesome:yarn:install`
-- Install FontAwesome via RubyGems: `rails generate boring:font_awesome:ruby_gem:install`
+- [Install FontAwesome via Yarn: `rails generate boring:font_awesome:yarn:install`](https://www.boringgenerators.com/blog/2021-02-28-install-fontawesome-yarn/)
+- [Install FontAwesome via RubyGems: `rails generate boring:font_awesome:ruby_gem:install`](https://www.boringgenerators.com/blog/2021-02-23-install-fontawesome/)
 - Install Bullet: `rails generate boring:bullet:install`
 - Install Audit gems(bundler-audit, ruby_audit): `rails generate boring:audit:install`
 - Install Pry gems for easy debugging: `rails generate boring:pry:install`
 - Install Active Storage for Google Cloud Service: `rails generate boring:active_storage:google:install`
 - Install Active Storage for AWS: `rails generate boring:active_storage:aws:install`
 - Install Active Storage for Azure: `rails generate boring:active_storage:azure:install`
-- Install CircleCI: `rails generate boring:ci:circleci:install --repository_name=<name> --ruby_version=<version>`
-- Install GitHub Actions: `rails generate boring:ci:github_action:install --repository_name=<name> --ruby_version=<version>`
+- [Install CircleCI: `rails generate boring:ci:circleci:install --repository_name=<name> --ruby_version=<version>`](https://www.boringgenerators.com/blog/2021-01-02-configure-circleci/)
+- [Install GitHub Actions: `rails generate boring:ci:github_action:install --repository_name=<name> --ruby_version=<version>`](https://www.boringgenerators.com/blog/2020-12-17-configure-github-actions/)
 - Install Travis CI: `rails generate boring:ci:travisci:install --ruby_version=<version>`
 - Install Rubocop: `rails generate boring:rubocop:install --ruby_version=<version>`
 - Build Favicon: `rails generate boring:favicon:build --application_name=<application_name> --favico_letter=<favico_letter> --primary_color=<color>`
@@ -60,8 +60,11 @@ The boring generator introduces following generators:
 - Install GraphQL: `rails generate boring:graphql:install`
 - 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 Facebook Omniauth: `rails generate boring:oauth:facebook:install`](https://www.boringgenerators.com/blog/2021-02-07-install-oauth-facbook/)
 - Install Devise GitHub Omniauth: `rails generate boring:oauth:github:install`
+- Install Devise Google Omniauth: `rails generate boring:oauth:google:install`
+- Install Devise Twitter Omniauth: `rails generate boring:oauth:twitter:install`
+- Install Twilio: `rails generate boring:twilio:install`
 
 ## Development
 

data/Rakefile

@@ -5,6 +5,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
 end
 
 task :default => :test

data/lib/boring_generators/version.rb

@@ -1,3 +1,3 @@
 module BoringGenerators
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/generators/boring/oauth/google/install/install_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'generators/boring/oauth/base_generator'
+
+module Boring
+  module Oauth
+    module Google
+      class InstallGenerator < Rails::Generators::Base
+        include Boring::Oauth::BaseGenerator
+
+        class MissingDeviseConfigurationError < StandardError; end
+
+        desc "Adds Google OmniAuth to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        def add_github_omniauth_gem
+          say "Adding GitHub OmniAuth gem", :green
+          Bundler.with_unbundled_env do
+            run "bundle add omniauth-google-oauth2"
+          end
+        end
+
+        def invoke_common_generator_methods
+          @oauth_name = :google_oauth2
+          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

data/lib/generators/boring/oauth/google/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 google omniauth APP_ID and APP_SECRET in "config/initializers/devise.rb"
+     after registering the Rails application on: https://code.google.com/apis/console/
+     For example:
+
+     config.omniauth :google_auth, "APP_ID", "APP_SECRET"
+
+===============================================================================

data/lib/generators/boring/oauth/google/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: :google_auth
+
+  def google_auth
+    # 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: "Google") if is_navigational_format?
+    else
+      session["devise.google_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

data/lib/generators/boring/oauth/twitter/install/install_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'generators/boring/oauth/base_generator'
+
+module Boring
+  module Oauth
+    module Twitter
+      class InstallGenerator < Rails::Generators::Base
+        include Boring::Oauth::BaseGenerator
+
+        class MissingDeviseConfigurationError < StandardError; end
+
+        desc "Adds Twitter OmniAuth to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        def add_twitter_omniauth_gem
+          say "Adding Twitter OmniAuth gem", :green
+          Bundler.with_unbundled_env do
+            run "bundle add omniauth-twitter"
+          end
+        end
+
+        def invoke_common_generator_methods
+          @oauth_name = :twitter
+          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

data/lib/generators/boring/oauth/twitter/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 twitter omniauth APP_ID and APP_SECRET in "config/initializers/devise.rb"
+     after registering the Rails application on: https://developer.twitter.com/en/apps
+     For example:
+
+     config.omniauth :twitter, "APP_ID", "APP_SECRET"
+
+===============================================================================

data/lib/generators/boring/oauth/twitter/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: :twitter
+
+  def twitter
+    # 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: "Twitter") if is_navigational_format?
+    else
+      session["devise.twitter_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

data/lib/generators/boring/twilio/install/install_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Boring
+  module Twilio
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Twilio to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_twilio_ruby_gem
+        say "Adding Twilio gem", :green
+        twilio_gem_content = <<~RUBY
+          \n
+          # for twilio REST APIs
+          gem 'twilio-ruby', '~> 5.47'
+        RUBY
+        append_to_file "Gemfile", twilio_gem_content
+        run "bundle install"
+      end
+
+      def add_twilio_configurations
+        say "Copying Twilio configuration", :green
+        template("twilio.rb", "config/initializers/twilio.rb")
+      end
+
+      def show_readme
+        readme "README"
+      end
+    end
+  end
+end

data/lib/generators/boring/twilio/install/templates/README

@@ -0,0 +1,11 @@
+===============================================================================
+
+Some step require your attention:
+
+  1. Update the twilio TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN in "config/initializers/twilio.rb"
+     For example:
+
+     config.account_sid = Rails.application.credentials.dig(:twilio, :account_sid)
+     config.auth_token = Rails.application.credentials.dig(:twilio, :auth_token)
+
+===============================================================================

data/lib/generators/boring/twilio/install/templates/twilio.rb

@@ -0,0 +1,4 @@
+Twilio.configure do |config|
+  config.account_sid = "TWILIO_ACCOUNT_SID"
+  config.auth_token = "TWILIO_AUTH_TOKEN"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boring_generators
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Abhay Nikam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-31 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -87,6 +87,12 @@ files:
 - lib/generators/boring/oauth/github/install/install_generator.rb
 - lib/generators/boring/oauth/github/install/templates/README
 - lib/generators/boring/oauth/github/install/templates/omniauth_callbacks_controller.rb
+- lib/generators/boring/oauth/google/install/install_generator.rb
+- lib/generators/boring/oauth/google/install/templates/README
+- lib/generators/boring/oauth/google/install/templates/omniauth_callbacks_controller.rb
+- lib/generators/boring/oauth/twitter/install/install_generator.rb
+- lib/generators/boring/oauth/twitter/install/templates/README
+- lib/generators/boring/oauth/twitter/install/templates/omniauth_callbacks_controller.rb
 - lib/generators/boring/pry/install/install_generator.rb
 - lib/generators/boring/pry/install/templates/pryrc
 - lib/generators/boring/pundit/install/install_generator.rb
@@ -96,6 +102,9 @@ files:
 - lib/generators/boring/tailwind/install/install_generator.rb
 - lib/generators/boring/tailwind/install/templates/README
 - lib/generators/boring/tailwind/install/templates/application.scss
+- lib/generators/boring/twilio/install/install_generator.rb
+- lib/generators/boring/twilio/install/templates/README
+- lib/generators/boring/twilio/install/templates/twilio.rb
 - tmp/templates/app_template/.ruby-version
 - tmp/templates/app_template/Gemfile
 - tmp/templates/app_template/README.md