boring_generators 0.6.0 → 0.11.0

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,23 @@
+===============================================================================
+
+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"
+
+  3. Your omniauth callback URL will be: `<host>/users/auth/twitter/callback`. Please update
+     callback URL in Twitter after registering your omniauth application.
+
+===============================================================================

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/paper_trail/install/install_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Boring
+  module PaperTrail
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds paper trail to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :skip_generator, type: :boolean, aliases: "-sg",
+                   desc: "Skip running paper_trail install generator"
+      class_option :skip_user_track_config, type: :boolean, aliases: "-sutc",
+                   desc: "Skip adding config for tracking devise user in paper_trail"
+
+      def add_bullet_gem
+        say "Adding paper trail gems", :green
+        Bundler.with_unbundled_env do
+          run "bundle add paper_trail"
+        end
+      end
+
+      def run_paper_trail_generator
+        return if options[:skip_generator]
+
+        say "Running rails_admin generator", :green
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails generate paper_trail:install --with-changes"
+        end
+      end
+
+      def set_configuration_to_track_whodunnit
+        return if options[:skip_user_track_config]
+
+        say "Setting configuration to track devise current_user", :green
+        insert_into_file "app/controllers/application_controller.rb", <<~RUBY, after: /class ApplicationController < ActionController::Base/
+          \tbefore_action :set_paper_trail_whodunnit
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/boring/payments/stripe/install/install_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Boring
+  module Payments
+    module Stripe
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds stripe payment method to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        def add_stripe_gem
+          say "Adding stripe gem", :green
+          Bundler.with_unbundled_env do
+            run "bundle add stripe"
+          end
+        end
+
+        def add_checkouts_resources
+          say "Adding stripe checkout resources"
+          copy_file("controllers/stripe/checkouts_controller.rb", "app/controllers/stripe/checkouts_controller.rb")
+          copy_file("views/stripe/checkouts/create.js.erb", "app/views/stripe/checkouts/create.js.erb")
+          copy_file("views/stripe/checkouts/show.html.erb", "app/views/stripe/checkouts/show.html.erb")
+        end
+
+        def add_stripe_routes
+          route <<~ROUTE
+            namespace :stripe do
+              resource :checkout, only: [:create, :show]
+            end
+          ROUTE
+        end
+
+        def add_stripe_initializer
+          say "Adding stripe initalizers"
+          copy_file("stripe.rb", "config/initializers/stripe.rb")
+        end
+
+        def show_readme
+          readme "README"
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/payments/stripe/install/templates/README

@@ -0,0 +1,21 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+    1. Register your Rails application on: https://dashboard.stripe.com/register
+    2. Update the stripe PUBLISHABLE_KEY in "config/initializers/stripe.rb"
+       For example:
+
+       Stripe.api_key = ENV['STRIPE_SECRET_KEY']
+
+    3. Update stripe PUBLISHABLE_KEY in the "views/stripe/checkouts/create.js.erb"
+       For example:
+
+       var stripe = Stripe(ENV["STRIPE_PUBLISHABLE_KEY"]);
+
+    4. Update "controllers/stripe/checkouts_controller.rb" with stripe checkout
+       line_items, success and failure callback URLs.
+
+    5. Go to: http://localhost:3000/stripe/checkout and try the checkout flow.
+
+===============================================================================

data/lib/generators/boring/payments/stripe/install/templates/controllers/stripe/checkouts_controller.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class Stripe::CheckoutsController < ApplicationController
+  def create
+    begin
+      @stripe_session = Stripe::Checkout::Session.create(checkout_payload)
+
+      respond_to :js
+    rescue Stripe::CardError => e
+      puts "Status is: #{e.http_status}"
+      puts "Type is: #{e.error.type}"
+      puts "Charge ID is: #{e.error.charge}"
+      # The following fields are optional
+      puts "Code is: #{e.error.code}" if e.error.code
+      puts "Decline code is: #{e.error.decline_code}" if e.error.decline_code
+      puts "Param is: #{e.error.param}" if e.error.param
+      puts "Message is: #{e.error.message}" if e.error.message
+    rescue Stripe::RateLimitError => e
+      # Too many requests made to the API too quickly
+    rescue Stripe::InvalidRequestError => e
+      # Invalid parameters were supplied to Stripe's API
+    rescue Stripe::AuthenticationError => e
+      # Authentication with Stripe's API failed
+      # (maybe you changed API keys recently)
+    rescue Stripe::APIConnectionError => e
+      # Network communication with Stripe failed
+    rescue Stripe::StripeError => e
+      # Display a very generic error to the user, and maybe send
+      # yourself an email
+    rescue => e
+      # Something else happened, completely unrelated to Stripe
+    end
+  end
+
+  def show
+    render
+  end
+
+  private
+    # In the payload, the line items consists of list of items the customer is purchasing.
+    # Refer the guides to learn more about parameters accepted by the <line_items>
+    # https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-line_items
+    #
+    # Sample: <line_items> looks like as follows:
+    # line_items: [{
+    #   price_data: {
+    #     currency: 'usd',                      # Three-letter ISO currency code, in lowercase
+    #     product: <product_id>                 # Product ID created on stripe.
+    #     product_data: { name: 'T-shirt' },    # Product Data (Either product_data or product is requried).
+    #     unit_amount: 2000,                    # A non-negative integer in cents representing how much to charge
+    #   },
+    #   quantity: 1,
+    # }]
+    def checkout_payload
+      {
+        payment_method_types: ['card'],  # https://stripe.com/docs/api/payment_methods/object#payment_method_object-type
+        line_items: @line_items || [],
+        mode: 'payment',
+        success_url: root_url,           # <custom_success_path>
+        cancel_url: root_url,            # <custom_cancellation_path>
+      }
+    end
+end

data/lib/generators/boring/payments/stripe/install/templates/stripe.rb

@@ -0,0 +1 @@
+Stripe.api_key = ENV['STRIPE_SECRET_KEY']

data/lib/generators/boring/payments/stripe/install/templates/views/stripe/checkouts/create.js.erb

@@ -0,0 +1,13 @@
+// TODO: Please update the stripe publishable key here.
+var stripe = Stripe(ENV["STRIPE_PUBLISHABLE_KEY"]);
+
+stripe.redirectToCheckout({
+  sessionId: "<%= @stripe_session.id %>"
+}).then(function(result) {
+  // If `redirectToCheckout` fails due to a browser or network
+  // error, you should display the localized error message to your
+  // customer using `error.message`.
+  if (result.error) {
+    alert(result.error.message);
+  }
+});

data/lib/generators/boring/payments/stripe/install/templates/views/stripe/checkouts/show.html.erb

@@ -0,0 +1,8 @@
+<div style="text-align:center;">
+  <h1>Checkout View</h1>
+  <h5>(from <a href="https://github.com/abhaynikam/boring_generators">Boring Generator Gem</a>)</h5>
+
+  <%= button_to "Try Checkout", stripe_checkout_path, remote: true, class: "btn btn-primary" %>
+  <script src="https://js.stripe.com/v3/"></script>
+</div>
+

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

@@ -7,15 +7,10 @@ module Boring
       source_root File.expand_path("templates", __dir__)
 
       def add_bullet_gem
-        say "Adding Bullet gem", :green
-        pry_gem_content = <<~RUBY
-          \n
-          # for using pry as Rails console
-          gem "pry"
-          gem "pry-rails"
-        RUBY
-        append_to_file "Gemfile", pry_gem_content
-        run "bundle install"
+        say "Adding pry gems", :green
+        Bundler.with_unbundled_env do
+          run "bundle add pry pry-rails"
+        end
       end
 
       def add_pryrc_configuration

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

@@ -14,14 +14,8 @@ module Boring
 
       def add_pundit_gem
         say "Adding Pundit gem", :green
-        pundit_gem = <<~RUBY
-          \n
-          # for authorization
-          gem 'pundit', '~> 2.1'
-        RUBY
-        append_to_file "Gemfile", pundit_gem
         Bundler.with_unbundled_env do
-          run "bundle install"
+          run "bundle add pundit"
         end
       end
 

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Boring
+  module RailsAdmin
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds rails_admin to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :skip_generator, type: :boolean, aliases: "-sg",
+                   desc: "Skip running rails_admin install generator"
+      class_option :route_name, type: :string, aliases: "-r",
+                   desc: "Mount the rails_admin engine on route"
+
+      def add_rails_admin_ruby_gem
+        say "Adding rails_admin gem", :green
+        Bundler.with_unbundled_env do
+          run "bundle add rails_admin"
+        end
+      end
+
+      def run_rails_admin_generator
+        return if options[:skip_generator]
+        if options[:route_name].present?
+          say "Running rails_admin generator", :green
+          Bundler.with_unbundled_env do
+            run "DISABLE_SPRING=1 bundle exec rails generate rails_admin:install #{options[:route_name]}"
+          end
+        else
+          say <<~WARNING, :red
+            ERROR: Please specify the --route_name=<name> where you want to mount the rails_admin engine
+          WARNING
+        end
+      end
+    end
+  end
+end

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

@@ -23,7 +23,9 @@ module Boring
           \tgem "rubocop-performance", require: false
         RUBY
         insert_into_file "Gemfile", bullet_gem_content, after: /group :development do/
-        run "bundle install"
+        Bundler.with_unbundled_env do
+          run "bundle install"
+        end
       end
 
       def add_rails_prefered_rubocop_rules

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

@@ -15,13 +15,9 @@ module Boring
 
       def add_bullet_gem
         say "Adding SimpleForm gem", :green
-        simple_form_content = <<~RUBY
-          \n
-          # for simple forms
-          gem 'simple_form', '~> 5.0'
-        RUBY
-        append_to_file "Gemfile", simple_form_content
-        run "bundle install"
+        Bundler.with_unbundled_env do
+          run "bundle add simple_form"
+        end
       end
 
       def run_simple_form_generator
@@ -29,7 +25,7 @@ module Boring
 
         say "Running SimpleForm Generator", :green
         if options[:css_framework].present? && ALLOWED_CSS_FRAMEWORK.include?(options[:css_framework])
-          run "rails generate simple_form:install --#{options[:css_framework]}"
+          run "DISABLE_SPRING=1 bundle exec rails generate simple_form:install --#{options[:css_framework]}"
         elsif options[:css_framework].present?
           say <<~WARNING, :red
             ERROR: Invalid option css_framework: #{options[:css_framework]}. Generator allows css_framework: #{ALLOWED_CSS_FRAMEWORK.join(", ")}

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Boring
+  module Stimulus
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Stimulus to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_stimulus_ruby_gem
+        say "Adding Stimulus gem", :green
+        Bundler.with_unbundled_env do
+          run "bundle add stimulus-rails"
+        end
+      end
+
+      def generating_devise_defaults
+        say "Generating stimulus defaults", :green
+        Bundler.with_unbundled_env do
+          run "DISABLE_SPRING=1 bundle exec rails stimulus:install"
+        end
+      end
+    end
+  end
+end