autopilot-rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f1263c2b13ad874e16683c2592423a3f8c16fe2faaff652df9d58874228d1ad
+  data.tar.gz: c5521addd46867b05042f1d34f396ab9e5d493ec799444b63630585c532657d1
+SHA512:
+  metadata.gz: 5fe3a57ef797c27e2f65b6e48dbabe94c9c6ffddf212a60518ffa8f984fcb594a382e0d0af3d51d651055e32aefc9dcd317cc4447517ce9db7f20f7d1d3e6c74
+  data.tar.gz: 969a72f022ec58114b76762124b6aa35575228ba73c99ac71496eb060c9153eee75ff3791c5f6b0c2dc9ade80cb36b90d60ac18c274d79cd730d3a2091fa75e6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Dylan Feltus
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# Autopilot Rails
+
+_⚠️ This project is still a WIP. It currently works with a limited set of features._
+
+Ship your next SaaS product in hours, not days or weeks.
+
+This gem will help you to scaffold your next project. Currently it will add:
+- Users with authentication via Devise
+- Accounts with devise_invitable
+- Super admin area with ActiveAdmin
+- Default routes and pages
+
+More features coming soon:
+- User roles & permissions
+- Stripe billing with optional annual plans
+- Feature flipper for super admins
+- UI themes
+
+## Install
+
+To install Autopilot, simply add the gem to your Gemfile:
+`gem 'autopilot', git: 'https://github.com/stratuslabs/autopilot.git'`
+
+## Usage
+
+To generate a project run `rails generate autopilot:go` to get started. The generator will ask a few questions to customize the output.
+
+| Option | Description |
+| --- | --- |
+| Do you want to have multiple users per account? | This will add an Account model, some account related helpers, and [Devise Invitable](https://github.com/scambra/devise_invitable). You will also get a `account/users` page with a list of users and the invite form. |
+| Do you want to include ActiveAdmin? | This will install ActiveAdmin with a few extra features like "Log in as user" and an account growth chart. |
+| Do you want to include a home page? | This will add a blank html page and set it as your unauthenticated root path. When set to false your log in page will be the root. |
+
+## Starting from scratch
+
+Here are some instructions to help you start a Rails app from scratch:
+
+- rails new example --database=postgresql
+- ~~Add config~~
+- gem 'autopilot', git: 'https://github.com/stratuslabs/autopilot.git'
+- `bundle install`
+- Set up database

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Autopilot'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/autopilot.rb

@@ -0,0 +1,4 @@
+require "autopilot/railtie"
+
+module Autopilot
+end

data/lib/generators/autopilot/accounts_generator.rb

@@ -0,0 +1,44 @@
+module Autopilot
+  module Generators
+    class AccountsGenerator < Rails::Generators::Base
+      desc "Generate Account model with devise_invitable"
+      source_root File.expand_path("../../../templates", __FILE__)
+
+      def do_magic
+        puts "Setting up multiple users per accounts"
+
+        gem 'devise_invitable', '~> 2.0.0'
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
+        generate "devise_invitable:install"
+        generate "devise_invitable User"
+
+        generate "model Account"
+        template "account.rb", "app/models/account.rb", force: true
+        template "user.rb", "app/models/user.rb", force: true
+
+        copy_file "controllers/accounts_controller.rb", "app/controllers/accounts_controller.rb", force: true
+        copy_file "controllers/application_controller.rb", "app/controllers/application_controller.rb", force: true
+
+        route "get 'account/users', to: 'accounts#users', as: :account_users"
+        route "post 'account/send_user_invite' => 'accounts#send_user_invite', as: :send_user_invite"
+        copy_file "views/accounts/users.html.erb", "app/views/accounts/users.html.erb"
+
+        inject_into_file 'app/views/layouts/_nav.html.erb', after: "dash_path %>\n" do <<-'RUBY'
+        <%= link_to "Users", account_users_path %>
+        RUBY
+        end
+
+        inject_into_file 'config/environments/development.rb', after: "Rails.application.configure do\n" do <<-'RUBY'
+  config.action_mailer.default_url_options = { :host => 'localhost' }
+        RUBY
+        end
+
+        generate "migration AddAccountToUsers account:references"
+        generate "migration AddOwnerIdToAccounts owner_id:integer"
+        generate "migration AddDeletedAtToAccounts deleted_at:datetime:index"
+      end
+    end
+  end
+end

data/lib/generators/autopilot/admin_generator.rb

@@ -0,0 +1,24 @@
+module Autopilot
+  module Generators
+    class AdminGenerator < Rails::Generators::Base
+      desc "Add ActiveAdmin to your project"
+
+      def do_magic
+        puts "Set up active admin"
+
+        gem "activeadmin"
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
+        generate "active_admin:install"
+        run "db:migrate"
+        run "db:seed"
+
+        puts "Admin account generated:"
+        puts "Email: admin@example.com"
+        puts "Password: password"
+        puts "Access your admin account at /admin"
+      end
+    end
+  end
+end

data/lib/generators/autopilot/example_generator.rb

@@ -0,0 +1,12 @@
+module Autopilot
+  module Generators
+    class ExampleGenerator < Rails::Generators::Base
+      desc "WIP: Generate example Post and Comment model"
+
+      def do_magic
+        puts "Adding an example model..."
+        # TODO
+      end
+    end
+  end
+end

data/lib/generators/autopilot/go_generator.rb

@@ -0,0 +1,44 @@
+module Autopilot
+  module Generators
+    class GoGenerator < Rails::Generators::Base
+      desc "This generator will create your app based on the answers you provide."
+
+      def do_magic
+
+        if yes?("Do you want to have multiple users per account? [y|n]")
+          include_accounts = true
+        else
+          include_accounts = false
+        end
+
+        if yes?("Do you want to include ActiveAdmin? [y|n]")
+          include_admin = true
+        else
+          include_admin = false
+        end
+
+        if yes?("Do you want to include a home page? [y|n]")
+          include_home = true
+        else
+          include_home = false
+        end
+
+        gem "paranoia", "~> 2.2"
+
+        generate "autopilot:users"
+        generate "autopilot:routes #{include_home ? '--home' : nil}"
+
+        if include_accounts
+          generate "autopilot:accounts"
+        end
+
+        if include_admin
+          generate "autopilot:admin"
+        end
+
+        rake "db:migrate"
+        run "rails s"
+      end
+    end
+  end
+end

data/lib/generators/autopilot/routes_generator.rb

@@ -0,0 +1,37 @@
+module Autopilot
+  module Generators
+    class RoutesGenerator < Rails::Generators::Base
+      desc "Generate basic routes and pages"
+      class_option :home, type: :boolean
+      source_root File.expand_path("../../../templates", __FILE__)
+
+      def do_magic
+        puts "Setting up routes..."
+        @home = options['home']
+
+        template "controllers/pages_controller.rb", "app/controllers/pages_controller.rb"
+        template "views/pages/dash.html.erb", "app/views/pages/dash.html.erb"
+        copy_file "views/layouts/_nav.html.erb", "app/views/layouts/_nav.html.erb"
+
+        inject_into_file 'app/views/layouts/application.html.erb', after: "<body>\n" do <<-'RUBY'
+        <%= render 'layouts/nav' %>
+        RUBY
+        end
+
+        if @home
+          puts "Set up marketing home page..."
+
+          template "views/pages/home.html.erb", "app/views/pages/home.html.erb"
+          template "routes-with-home.rb", "config/routes.rb", force: true
+
+          inject_into_file 'app/views/layouts/_nav.html.erb', after: "<% else %>\n" do <<-'RUBY'
+          <%= link_to "Home", root_path %>
+          RUBY
+          end
+        else
+          template "routes-without-home.rb", "config/routes.rb", force: true
+        end
+      end
+    end
+  end
+end

data/lib/generators/autopilot/users_generator.rb

@@ -0,0 +1,19 @@
+module Autopilot
+  module Generators
+    class UsersGenerator < Rails::Generators::Base
+      desc "Generate User model with Devise"
+
+      def do_magic
+        puts "Setting up users & authentication..."
+        gem "devise"
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
+        generate "devise:install"
+        generate "devise User"
+        generate "devise:views"
+        generate "migration AddDeletedAtToUsers deleted_at:datetime:index"
+      end
+    end
+  end
+end

data/lib/templates/account.rb

@@ -0,0 +1,5 @@
+class Account < ApplicationRecord
+  acts_as_paranoid
+  has_many :users, dependent: :destroy
+  accepts_nested_attributes_for :users
+end

data/lib/templates/controllers/accounts_controller.rb

@@ -0,0 +1,26 @@
+class AccountsController < ApplicationController
+  before_action :authenticate_user!
+
+  def users
+    @users = current_account.users.all
+  end
+
+  def send_user_invite
+    email = params[:user][:email]
+
+    if User.only_deleted.where(email: email).any?
+      user = User.only_deleted.where(email: email).first
+      if user.deleted_at
+        user.restore
+        user.update(account: current_account)
+        user.invite!(user)
+      end
+    else
+      User.invite!(email: email, account: current_account)
+    end
+
+    respond_to do |format|
+      format.html { redirect_to account_users_path, notice: 'Invite sent successfully' }
+    end
+  end
+end

data/lib/templates/controllers/application_controller.rb

@@ -0,0 +1,8 @@
+class ApplicationController < ActionController::Base
+
+  def current_account
+    current_user.account
+  end
+  helper_method :current_account
+
+end

data/lib/templates/controllers/pages_controller.rb

@@ -0,0 +1,10 @@
+class PagesController < ApplicationController
+  before_action :authenticate_user!, only: :dash
+
+  def show
+    render template: "pages/#{params[:page]}"
+  end
+
+  def dash
+  end
+end

data/lib/templates/routes-with-home.rb

@@ -0,0 +1,16 @@
+Rails.application.routes.draw do
+  devise_for :users
+
+  authenticated :user do
+    root "pages#dash", as: :authenticated_root
+  end
+
+  devise_scope :user do
+    get "join", to: "devise/registrations#new"
+    get "login", to: "devise/sessions#new"
+    get "logout", to: "devise/sessions#destroy"
+    root to: 'pages#home'
+  end
+
+  get "/dash", to: "pages#dash", as: :dash
+end

data/lib/templates/routes-without-home.rb

@@ -0,0 +1,16 @@
+Rails.application.routes.draw do
+  devise_for :users
+
+  authenticated :user do
+    root "pages#dash", as: :authenticated_root
+  end
+  
+  devise_scope :user do
+    get "join", to: "devise/registrations#new"
+    get "login", to: "devise/sessions#new"
+    get "logout", to: "devise/sessions#destroy"
+    root to: 'devise/sessions#new'
+  end
+
+  get "/dash", to: "pages#dash", as: :dash
+end

data/lib/templates/user.rb

@@ -0,0 +1,25 @@
+class User < ApplicationRecord
+  acts_as_paranoid
+  devise :database_authenticatable, :registerable, :recoverable,
+         :rememberable, :validatable, :invitable
+
+  belongs_to :account, optional: true
+
+  validates_uniqueness_of :email
+
+  after_create :create_account, unless: :invited_to_sign_up?
+
+  def is_pending
+    owner = Account.find(self.account_id).users.first
+    true unless self.invitation_accepted_at || self == owner
+  end
+
+private
+
+  def create_account
+    if self.account_id.nil?
+      account = Account.create(owner_id: self.id)
+      self.update(account: account)
+    end
+  end
+end

data/lib/templates/views/accounts/users.html.erb

@@ -0,0 +1,24 @@
+<h1>Users</h1>
+
+<% @users.each do |u| %>
+  <div class="user" style="display: flex; border: 1px solid lightgrey; padding: 10px; margin-bottom: 15px;">
+    <p><%= u.email %></p>
+    <% if u.is_pending %>
+      <p class="pending">
+        Invite is pending.
+        <%= link_to "Resend", {
+                      controller: 'accounts',
+                      action: 'send_user_invite',
+                      user: { email: u.email },
+                    }, method: :post %>
+      </p>
+    <% end %>
+  </div>
+<% end %>
+
+<h3>Invite your team</h3>
+<%= form_for [current_account, User.new], url: { action: "send_user_invite" } do |f| %>
+  <%= f.label :email, "Email address" %>
+  <%= f.text_field :email, placeholder: "example@gmail.com", required: true %>
+  <%= f.submit "Send invite" %>
+<% end %>

data/lib/templates/views/layouts/_nav.html.erb

@@ -0,0 +1,9 @@
+<nav>
+  <% if current_user %>
+    <%= link_to "Dash", dash_path %>
+    <%= link_to "Log out", destroy_user_session_path, method: :delete %>
+  <% else %>
+    <%= link_to "Log in", new_user_session_path %>
+    <%= link_to "Create an account", new_user_registration_path %>
+  <% end %>
+</nav>

data/lib/templates/views/pages/dash.html.erb

@@ -0,0 +1,2 @@
+<h1>Dashboard</h1>
+<p>Welcome to your new application!</p>

data/lib/templates/views/pages/home.html.erb

@@ -0,0 +1,2 @@
+<h3>Hello world!</h3>
+<p>Welcome to your generated project! This is your home page for logged out users.</p>

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: autopilot-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dylan Feltus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+description: With Autopilot for Rails you can generate a starting point for your next
+  SaaS project. Add accounts with multiple users, Stripe billing, permissions, onboarding
+  flows, and more.
+email:
+- contact@dylanfeltus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/autopilot.rb
+- lib/generators/autopilot/accounts_generator.rb
+- lib/generators/autopilot/admin_generator.rb
+- lib/generators/autopilot/example_generator.rb
+- lib/generators/autopilot/go_generator.rb
+- lib/generators/autopilot/routes_generator.rb
+- lib/generators/autopilot/users_generator.rb
+- lib/templates/account.rb
+- lib/templates/controllers/accounts_controller.rb
+- lib/templates/controllers/application_controller.rb
+- lib/templates/controllers/pages_controller.rb
+- lib/templates/routes-with-home.rb
+- lib/templates/routes-without-home.rb
+- lib/templates/user.rb
+- lib/templates/views/accounts/users.html.erb
+- lib/templates/views/layouts/_nav.html.erb
+- lib/templates/views/pages/dash.html.erb
+- lib/templates/views/pages/home.html.erb
+homepage: https://github.com/stratuslabs/autopilot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Generate your next SaaS app using Rails
+test_files: []