boring_generators 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cac88ca9c5967e3109166aab566f0ec75936e5aee8b752c0c48602eda974b9c
-  data.tar.gz: 968a3f0761e84fa8caf64c2e23acba3e82e09c2b7c85d342a9e3c872c8a11d01
+  metadata.gz: efa9742fe8c8f08258770d145e6c0e67d595020941d5f56d0be739ccda24cc94
+  data.tar.gz: 5c65a514369b0bf0c4d45ab02f32a585aadd551d65e6f9bbadef124dbaaef140
 SHA512:
-  metadata.gz: be7b2ef1596240670290b4088a7d75a82a5a525b837fa7eeaff3b713e3b974f5eb26f81d5132259bedf1eb5af3d90aba279e992d7f69571fb85406c995a62f80
-  data.tar.gz: 72b7998e2cf8f42f4c4f77c956ebccf702872e3f32b98e99266ddf1a0d94be312c9bef3e4d48f94b854d3a0ed93776576620964a9883b259f64847fb306bc751
+  metadata.gz: 01e2ed167544c93df8ef0be34c03766b51c4c9720869a6ac18bcf94785394c2afe7802837f456127e78350ad443cf4378b2e974f19e33f61f1dbfdb569cd2792
+  data.tar.gz: 5f8e9ae3aaf80bfb651392ba7436577325b16e38b54fe45bab0186daeff9f2abc44d3bd0178a602b931b76fc1ca1b6bf061e9ede4814c4fbdf3054f783103aa4

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## master (unreleased)
+* Adds Ahoy generator. ([@abhaynikam][])
+* Adds Stripe payment generator. ([@abhaynikam][])
 
 ## 0.8.0 (February 28th, 2021)
 * Adds Devise Google Omniauth generator. ([@abhaynikam][])

data/Gemfile.lock

@@ -1,62 +1,62 @@
 PATH
   remote: .
   specs:
-    boring_generators (0.8.0)
+    boring_generators (0.9.0)
       railties
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.4)
-      actionpack (= 6.0.3.4)
+    actioncable (6.0.3.6)
+      actionpack (= 6.0.3.6)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionmailbox (6.0.3.6)
+      actionpack (= 6.0.3.6)
+      activejob (= 6.0.3.6)
+      activerecord (= 6.0.3.6)
+      activestorage (= 6.0.3.6)
+      activesupport (= 6.0.3.6)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
+    actionmailer (6.0.3.6)
+      actionpack (= 6.0.3.6)
+      actionview (= 6.0.3.6)
+      activejob (= 6.0.3.6)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.4)
-      actionview (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionpack (6.0.3.6)
+      actionview (= 6.0.3.6)
+      activesupport (= 6.0.3.6)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actiontext (6.0.3.6)
+      actionpack (= 6.0.3.6)
+      activerecord (= 6.0.3.6)
+      activestorage (= 6.0.3.6)
+      activesupport (= 6.0.3.6)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionview (6.0.3.6)
+      activesupport (= 6.0.3.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    activejob (6.0.3.6)
+      activesupport (= 6.0.3.6)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activerecord (6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activestorage (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      marcel (~> 0.3.1)
-    activesupport (6.0.3.4)
+    activemodel (6.0.3.6)
+      activesupport (= 6.0.3.6)
+    activerecord (6.0.3.6)
+      activemodel (= 6.0.3.6)
+      activesupport (= 6.0.3.6)
+    activestorage (6.0.3.6)
+      actionpack (= 6.0.3.6)
+      activejob (= 6.0.3.6)
+      activerecord (= 6.0.3.6)
+      marcel (~> 1.0.0)
+    activesupport (6.0.3.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -64,56 +64,54 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     builder (3.2.4)
     byebug (11.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
     erubi (1.10.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.8.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.1)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
+    mini_mime (1.1.0)
     mini_portile2 (2.5.0)
-    minitest (5.14.2)
-    nio4r (2.5.4)
-    nokogiri (1.11.1)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.3)
       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)
-    rails (6.0.3.4)
-      actioncable (= 6.0.3.4)
-      actionmailbox (= 6.0.3.4)
-      actionmailer (= 6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actiontext (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    rails (6.0.3.6)
+      actioncable (= 6.0.3.6)
+      actionmailbox (= 6.0.3.6)
+      actionmailer (= 6.0.3.6)
+      actionpack (= 6.0.3.6)
+      actiontext (= 6.0.3.6)
+      actionview (= 6.0.3.6)
+      activejob (= 6.0.3.6)
+      activemodel (= 6.0.3.6)
+      activerecord (= 6.0.3.6)
+      activestorage (= 6.0.3.6)
+      activesupport (= 6.0.3.6)
       bundler (>= 1.3.0)
-      railties (= 6.0.3.4)
+      railties (= 6.0.3.6)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    railties (6.0.3.6)
+      actionpack (= 6.0.3.6)
+      activesupport (= 6.0.3.6)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
@@ -126,7 +124,7 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
-    thor (1.0.1)
+    thor (1.1.0)
     thread_safe (0.3.6)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)

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`](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 Tailwind CSS](https://www.boringgenerators.com/blog/2020-10-18-install-tailwind/): `rails generate boring:tailwind:install`
+- [Install Bootstrap](https://www.boringgenerators.com/blog/2020-11-15-install-bootstrap/): `rails generate boring:bootstrap:install`
 - Install JQuery: `rails generate boring:jquery: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 FontAwesome via Yarn](https://www.boringgenerators.com/blog/2021-02-28-install-fontawesome-yarn/): `rails generate boring:font_awesome:yarn:install`
+- [Install FontAwesome via RubyGems](https://www.boringgenerators.com/blog/2021-02-23-install-fontawesome/): `rails generate boring:font_awesome:ruby_gem:install`
 - 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>`](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 CircleCI](https://www.boringgenerators.com/blog/2021-01-02-configure-circleci/): `rails generate boring:ci:circleci:install --repository_name=<name> --ruby_version=<version>`
+- [Install GitHub Actions](https://www.boringgenerators.com/blog/2020-12-17-configure-github-actions/): `rails generate boring:ci:github_action:install --repository_name=<name> --ruby_version=<version>`
 - 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,11 +60,17 @@ 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`](https://www.boringgenerators.com/blog/2021-02-07-install-oauth-facbook/)
+- [Install Devise Facebook Omniauth](https://www.boringgenerators.com/blog/2021-02-07-install-oauth-facbook/): `rails generate boring:oauth:facebook:install`
 - 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`
+- Install Ahoy: `rails generate boring:ahoy:install`
+- Install Stripe: `rails generate boring:payments:stripe:install`
+
+## Screencasts
+
+- [How to use Boring Generators](https://www.youtube.com/watch?v=9vaK9nDMbU8) by [Yaroslav Shmarov](https://twitter.com/yarotheslav)
 
 ## Development
 

data/lib/boring_generators/version.rb

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

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module Boring
+  module Ahoy
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Ahoy to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_twitter_omniauth_gem
+        say "Adding Ahoy gem", :green
+        Bundler.with_unbundled_env do
+          run "bundle add ahoy_matey"
+        end
+      end
+
+      def run_ahoy_generator
+        say "Running Ahoy generator", :green
+        Bundler.with_unbundled_env do
+          run "bundle exec rails generate ahoy:install"
+          run "bundle exec rails db:migrate"
+        end
+      end
+
+      def show_readme
+        readme "README"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+===============================================================================
+
+Some setup you must do manually based on your project requirement:
+
+  1. To prevent Rails actions from tracking visits: `skip_before_action :track_ahoy_visit`
+  2. To associate and add association in the model with ahoy. Add `visitable :ahoy_visit` in the model.
+
+You could find more configuration options on Ahoy documentation: https://github.com/ankane/ahoy
+
+===============================================================================

data/lib/generators/boring/oauth/base_generator.rb

@@ -45,7 +45,7 @@ module Boring
             \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.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.

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

@@ -17,4 +17,7 @@ Some setup you must do manually if you haven't yet:
 
      config.omniauth :facebook, "APP_ID", "APP_SECRET"
 
+  3. Your omniauth callback URL will be: `<host>/users/auth/facebook/callback`. Please update
+     callback URL in Facebook after registering your omniauth application.
+
 ===============================================================================

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

@@ -17,4 +17,7 @@ Some setup you must do manually if you haven't yet:
 
      config.omniauth :github, "APP_ID", "APP_SECRET"
 
+  3. Your omniauth callback URL will be: `<host>/users/auth/github/callback`. Please update
+     callback URL in Github after registering your omniauth application.
+
 ===============================================================================

data/lib/generators/boring/oauth/google/install/templates/README

@@ -17,4 +17,7 @@ Some setup you must do manually if you haven't yet:
 
      config.omniauth :google_auth, "APP_ID", "APP_SECRET"
 
+  3. Your omniauth callback URL will be: `<host>/users/auth/google_oauth2/callback`. Please update
+     callback URL in Google after registering your omniauth application.
+
 ===============================================================================

data/lib/generators/boring/oauth/twitter/install/templates/README

@@ -17,4 +17,7 @@ Some setup you must do manually if you haven't yet:
 
      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/payments/stripe/install/install_generator.rb

@@ -0,0 +1,44 @@
+# 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_charges_controller
+          say "Adding stripe charge resources"
+          copy_file("controllers/charges_controller.rb", "app/controllers/charges_controller.rb")
+        end
+
+        def add_stripe_routes
+          route "resources :charges"
+        end
+
+        def add_stripe_initializer
+          say "Adding stripe initalizers"
+          copy_file("stripe.rb", "config/initializers/stripe.rb")
+        end
+
+        def add_stripe_views
+          say "Adding stripe views and layout"
+          copy_file("views/charges.html.erb", "app/views/layouts/charges.html.erb")
+          copy_file("views/new.html.erb", "app/views/charges/new.html.erb")
+          copy_file("views/create.html.erb", "app/views/charges/create.html.erb")
+        end
+
+        def show_readme
+          readme "README"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+    Update the stripe PUBLISHABLE_KEY and SECRET_KEY in "config/initializers/stripe.rb"
+    after registering the Rails application on: https://dashboard.stripe.com/register
+    For example:
+
+    Rails.configuration.stripe = {
+      :publishable_key => ENV['PUBLISHABLE_KEY'],
+      :secret_key      => ENV['SECRET_KEY']
+    }
+
+===============================================================================

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class ChargesController < ApplicationController
+  def new
+    render
+  end
+
+  def create
+    if create_stripe_customer && create_stripe_charge
+      redirect_to root_path, flash: { success: "Boring stripe setup is successful" }
+    else
+      redirect_to new_charge_path, flash: { error: "Ugh. Something went wrong in setup." }
+    end
+  rescue Stripe::CardError => e
+    flash[:error] = e.message
+    redirect_to new_charge_path
+  end
+
+  private
+    def create_stripe_customer
+      @customer = Stripe::Customer.create({
+        email: params[:stripeEmail],
+        source: params[:stripeToken],
+      })
+    end
+
+    def create_stripe_charge
+      # Amount in cents
+      @amount = 500
+
+      Stripe::Charge.create({
+        customer: customer.id,
+        amount: @amount,
+        description: 'Rails Stripe customer',
+        currency: 'usd',
+      })
+    end
+end

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

@@ -0,0 +1,6 @@
+Rails.configuration.stripe = {
+  :publishable_key => ENV['PUBLISHABLE_KEY'],
+  :secret_key      => ENV['SECRET_KEY']
+}
+
+Stripe.api_key = Rails.configuration.stripe[:secret_key]

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

@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html>
+  <head></head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

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

@@ -0,0 +1 @@
+<h2>Thanks, you paid <strong>$5.00</strong>!</h2>

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

@@ -0,0 +1,19 @@
+<%= form_tag charges_path do %>
+  <article>
+    <% if flash[:error].present? %>
+      <div id="error_explanation">
+        <p><%= flash[:error] %></p>
+      </div>
+    <% end %>
+
+    <label class="amount">
+      <span>Amount: $5.00</span>
+    </label>
+  </article>
+
+  <script src="https://checkout.stripe.com/checkout.js" class="stripe-button"
+          data-key="<%= Rails.configuration.stripe[:publishable_key] %>"
+          data-description="A month's subscription"
+          data-amount="500"
+          data-locale="auto"></script>
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boring_generators
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Abhay Nikam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-28 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -56,6 +56,8 @@ files:
 - lib/generators/boring/active_storage/aws/install/install_generator.rb
 - lib/generators/boring/active_storage/azure/install/install_generator.rb
 - lib/generators/boring/active_storage/google/install/install_generator.rb
+- lib/generators/boring/ahoy/install/install_generator.rb
+- lib/generators/boring/ahoy/install/templates/README
 - lib/generators/boring/audit/install/install_generator.rb
 - lib/generators/boring/bootstrap/install/install_generator.rb
 - lib/generators/boring/bootstrap/install/templates/application.scss
@@ -93,6 +95,13 @@ files:
 - 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/payments/stripe/install/install_generator.rb
+- lib/generators/boring/payments/stripe/install/templates/README
+- lib/generators/boring/payments/stripe/install/templates/controllers/charges_controller.rb
+- lib/generators/boring/payments/stripe/install/templates/stripe.rb
+- lib/generators/boring/payments/stripe/install/templates/views/charges.html.erb
+- lib/generators/boring/payments/stripe/install/templates/views/create.html.erb
+- lib/generators/boring/payments/stripe/install/templates/views/new.html.erb
 - lib/generators/boring/pry/install/install_generator.rb
 - lib/generators/boring/pry/install/templates/pryrc
 - lib/generators/boring/pundit/install/install_generator.rb