capistrano_quick 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc10b5d6b80f0b41c01cdb595ed0e8577cdf8911a64b5baf8391c7913f00525c
+  data.tar.gz: 742b7d320092c6720c66c938b12f1660144ff424aa6cdbe8367bf7e638dead37
+SHA512:
+  metadata.gz: ccacdd6da6b0723f9c99c5f053a8357ccf6fe32db18d0b69005ca1c051974f6a1235071471de7e390631e9769f040ce59abfed910690ebb4b4610f725e537eb3
+  data.tar.gz: 96bc6a9c67d0de0697a3e63e66f310f8801d600300e8291395b80b8b6236a6011c6f2cfd0f9fd22fb2b468a82b4344341f338071e37bc00b526047f6dab10766

data/README.md

@@ -0,0 +1,43 @@
+# CapistranoQuick
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/capistrano_quick`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano_quick. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/capistrano_quick/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CapistranoQuick project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/capistrano_quick/blob/main/CODE_OF_CONDUCT.md).

data/lib/capistrano_quick/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CapistranoQuick
+  VERSION = "0.1.0"
+end

data/lib/capistrano_quick.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "capistrano_quick/version"
+
+module CapistranoQuick
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/generators/add_capistrano_gems/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate add_capistrano_gems Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/add_capistrano_gems/add_capistrano_gems_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+
+class AddCapistranoGemsGenerator < Rails::Generators::Base
+  desc "Adds required Capistrano and Figaro gems to the Gemfile"
+
+  def add_gems
+    gemfile_path = "Gemfile"
+
+    append_to_file gemfile_path, <<~GEMS
+
+      gem 'figaro'
+
+      group :development do
+        gem 'capistrano'
+        gem 'capistrano3-puma'
+        gem 'capistrano-rails', require: false
+        gem 'capistrano-bundler', require: false
+        gem 'capistrano-rake', require: false
+        gem 'capistrano-rvm'
+        gem 'capistrano-sidekiq'
+      end
+    GEMS
+
+    say "Gems added! Run `bundle install` to install them.", :green
+  end
+end

data/lib/generators/replace_capfile/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate replace_capfile Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/replace_capfile/replace_capfile_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+
+class ReplaceCapfileGenerator < Rails::Generators::Base
+  desc "Replaces the Capfile with a predefined configuration"
+
+  def replace_capfile
+    capfile_path = "Capfile"
+
+    create_file capfile_path, <<~CAPFILE, force: true
+      require 'capistrano/setup'
+      require 'capistrano/deploy'
+      require 'capistrano/rails'
+      require 'capistrano/bundler'
+      require 'capistrano/rvm'
+      require "capistrano/rails/assets"
+      require "capistrano/rails/migrations"
+      require 'capistrano/puma'
+      require "capistrano/scm/git"
+      require 'capistrano/sidekiq'
+
+      install_plugin Capistrano::SCM::Git
+      install_plugin Capistrano::Puma  # Default puma tasks
+      install_plugin Capistrano::Puma::Systemd
+      install_plugin Capistrano::Puma, load_hooks: false
+      install_plugin Capistrano::Sidekiq::Systemd
+
+      # Load custom tasks from `lib/capistrano/tasks` if you have any defined
+      Dir.glob("lib/capistrano/tasks/*.rake").each { |r| import r }
+    CAPFILE
+
+    say "Capfile has been replaced successfully!", :green
+  end
+end

data/lib/generators/replace_deploy/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate replace_deploy Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/replace_deploy/replace_deploy_generator.rb

@@ -0,0 +1,67 @@
+require 'rails/generators'
+
+# Commands: rails generate replace_deploy YOUR_CUSTOM_REPO_URL
+
+class ReplaceDeployGenerator < Rails::Generators::Base
+  desc "Replaces the config/deploy.rb file with a predefined configuration"
+
+  argument :repo_url, type: :string, default: 'git@github.com:expertwatch/bitsatom_emailer.git'
+
+  def replace_deploy
+    deploy_rb_path = "config/deploy.rb"
+    app_name = Rails.application.class.module_parent.to_s.tableize.singularize
+    create_file deploy_rb_path, <<~DEPLOY_RB, force: true
+      # config valid for current version and patch releases of Capistrano
+      lock "~> 3.19.2"
+
+      set :application, "#{app_name}"
+      set :repo_url, "#{repo_url}"
+      set :user, 'deploy'
+      set :puma_threads, [4, 16]
+      set :puma_workers, 0
+      # Don't change these unless you know what you're doing
+      set :pty, true
+      # set :format, :pretty
+      # set :log_level, :debug
+      set :use_sudo, false
+      set :deploy_via, :remote_cache
+      set :deploy_to, "/home/\#{fetch(:user)}/\#{fetch(:application)}"
+      set :puma_bind, "unix://\#{shared_path}/tmp/sockets/puma.sock"
+      set :puma_state, "\#{shared_path}/tmp/pids/puma.state"
+      set :puma_pid, "\#{shared_path}/tmp/pids/puma.pid"
+      set :puma_access_log, "\#{release_path}/log/puma.error.log"
+      set :puma_error_log, "\#{release_path}/log/puma.access.log"
+      set :ssh_options, { forward_agent: true, user: fetch(:user), keys: %w(~/.ssh/id_rsa) }
+      set :puma_env, fetch(:rack_env, fetch(:rails_env, 'production'))
+      set :puma_preload_app, true
+      set :puma_worker_timeout, nil
+      set :puma_init_active_record, true # Change to false when not using ActiveRecord
+
+      ## Linked Files & Directories (Default None):
+      set :linked_files, %w{config/database.yml}
+      set :linked_dirs, %w{log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}
+      set :keep_releases, 5
+      set :rvm_type, :user
+      set :rvm_ruby_version, "ruby-3.2.2"
+      set :puma_service_unit_name, "puma"
+      set :puma_systemctl_user, :system
+
+      # In order to set MODE=once
+      set :mode, ENV.fetch('MODE', 'repeat')
+
+      before "deploy:starting", "deploy:setup_prerequisite"
+
+      before 'deploy:starting', 'deploy:set_rails_env'
+      namespace :deploy do
+        desc "Set Rails environment to \#{fetch(:rails_env, 'production')}"
+        task :set_rails_env do
+          on roles(:app) do
+            execute "export RAILS_ENV=\#{fetch(:rails_env, 'production')}"
+          end
+        end
+      end
+    DEPLOY_RB
+
+    say "config/deploy.rb has been replaced successfully!", :green
+  end
+end

data/lib/generators/setup_deployment/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate setup_deployment Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/setup_deployment/setup_deployment_generator.rb

@@ -0,0 +1,97 @@
+class SetupDeploymentGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def ask_for_environment
+    # Prompt the user to input either 'production' or 'staging'
+    environment = ask("Please specify the environment (production/staging):", default: "production")
+
+    # Ensure the environment is valid
+    unless ["production", "staging"].include?(environment)
+      say "Invalid environment specified. Defaulting to production.", :red
+      environment = "production"
+    end
+
+    # Set the environment variable
+    @env = environment
+  end
+
+  def ask_for_server
+    @server = ask("Please specify the server (localhost/demo.bitsatom.com/127.0.0.1):", default: "localhost")
+
+    if @server.empty?
+      say "The server cannot be empty, using the default: localhost", :red
+      @server = "localhost"
+    end
+  end
+
+  def ask_for_deploy_user
+    # Prompt the user for the custom deploy user
+    @deploy_user = ask("Please specify the deploy user (e.g., deploy):", default: "ubuntu")
+
+    # Ensure the deploy user is not empty
+    if @deploy_user.empty?
+      say "The deployment path cannot be empty, using the default: ubuntu", :red
+      @deploy_user = "deploy"
+    end
+  end
+
+  def ask_for_app_name
+    # Prompt the user for the custom app_name
+    @app_name = ask("Please specify the app name (e.g., bitsatom_emailer):", default: "bitsatom_emailer")
+
+    # Ensure the path is not empty
+    if @app_name.empty?
+      say "The app name cannot be empty, using the default: bitsatom_emailer", :red
+      @app_name = "bitsatom_emailer"
+    end
+  end
+
+  def run_all_generators
+    # Ask the user for the environment (production/staging)
+    # ask_for_environment
+    # ask_for_app_name
+    # ask_for_deploy_user
+
+    @deploy_path = "/home/#{@deploy_user}"
+    @app_path = "/home/#{@deploy_user}/#{@app_name}"
+
+    ENV["DEPLOY_USER"] = @deploy_user
+    ENV["DEPLOY_PATH"] = @deploy_path
+    ENV["APP_PATH"] = @app_path
+    ENV["ENVIRONMENT"] = @env
+    ENV["SERVER"] = @server
+
+    # Run multiple generators in sequence
+    say "Running generator: add_capistrano_gems"
+    generate "add_capistrano_gems"
+
+    # Run bundle install
+    say "Running: bundle installs"
+    run "bundle install --platform=x86_64-linux"
+    run "bundle install"
+
+    # Ask for confirmation before running cap install with the given environment
+    confirmation = ask("Do you want to run 'cap install STAGES=#{@env}'? (yes/no)", default: "yes")
+
+    if confirmation.downcase == "yes"
+      say "Running: cap install STAGES=#{@env}"
+      run "cap install STAGES=#{@env}"
+    else
+      say "Skipping 'cap install STAGES=#{@env}'", :yellow
+    end
+
+    # Run the remaining generators
+    say "Running generator: replace_capfile"
+    generate "replace_capfile"
+
+    say "Running generator: replace_deploy"
+    generate "replace_deploy"
+
+    say "Running generator: setup_prerequisite"
+    generate "setup_prerequisite"
+
+    say "All generators have been run successfully!"
+  rescue => e
+    say "An error occurred: #{e.message}", :red
+  end
+end

data/lib/generators/setup_prerequisite/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate setup_prerequisite Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/setup_prerequisite/setup_prerequisite_generator.rb

@@ -0,0 +1,21 @@
+# lib/generators/replace_deploy/setup_prerequisite_generator.rb
+class SetupPrerequisiteGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  # This generator will generate the setup_prerequisite.rake file
+  def create_setup_prerequisite_file
+
+    @deploy_user = ENV["DEPLOY_USER"] || "deploy"
+    @deploy_path = ENV["DEPLOY_PATH"] || "/home/deploy"
+    @app_path = ENV["APP_PATH"] || "/home/deploy/app"
+    @env = ENV["ENVIRONMENT"] || "development"
+    @server = ENV["SERVER"] || "localhost"
+
+
+    template "setup_prerequisite.rake.erb", "lib/capistrano/tasks/setup_prerequisite.rake"
+    template "puma.rb.erb","config/deployment/puma.rb"
+    template "puma.service.erb","config/deployment/puma.service"
+    template "production.rb.erb","config/deploy/production.rb"
+    template "nginx.conf.erb","config/deployment/nginx.conf"
+  end
+end

data/lib/generators/setup_prerequisite/templates/nginx.conf.erb

@@ -0,0 +1,34 @@
+upstream app {
+  # Path to Puma SOCK file, as defined previously
+  server unix://<%=@app_path%>/shared/tmp/sockets/puma.sock fail_timeout=0;
+}
+
+server {
+  listen 80;
+  server_name <%= @server %>;
+
+  root <%=@app_path%>/current/public;
+
+  try_files $uri/index.html $uri @app;
+
+  location / {
+    proxy_set_header X-Forwarded-Proto $scheme;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header Host $host;
+    proxy_redirect off;
+    proxy_http_version 1.1;
+    proxy_set_header Connection '';
+    proxy_pass http://app;
+  }
+
+  location ~ ^/(assets|fonts|system)/|favicon.ico|robots.txt {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  error_page 500 502 503 504 /500.html;
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+}

data/lib/generators/setup_prerequisite/templates/production.rb.erb

@@ -0,0 +1,5 @@
+server '<%= @server %>', user: 'deploy', roles: %w{web app db}
+set :rails_env, '<%= @env %>'
+set :stage, '<%= @env %>'
+set :rack_env, '<%= @env %>'
+set :branch , 'deployment'

data/lib/generators/setup_prerequisite/templates/puma.rb.erb

@@ -0,0 +1,36 @@
+#!/usr/bin/env puma
+
+directory '<%= @app_path %>/current'
+rackup "<%= @app_path %>/current/config.ru"
+environment 'production'
+
+tag ''
+
+pidfile "<%= @app_path %>/shared/tmp/pids/puma.pid"
+state_path "<%= @app_path %>/shared/tmp/pids/puma.state"
+stdout_redirect '<%= @app_path %>/current/log/puma.error.log', '<%= @app_path %>/current/log/puma.access.log', true
+
+threads 4, 16
+
+bind 'unix:<%= @app_path %>/shared/tmp/sockets/puma.sock'
+
+workers 0
+
+restart_command 'bundle exec puma'
+
+preload_app!
+
+on_restart do
+  puts 'Refreshing Gemfile'
+  ENV["BUNDLE_GEMFILE"] = ""
+end
+
+before_fork do
+  ActiveRecord::Base.connection_pool.disconnect!
+end
+
+on_worker_boot do
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::Base.establish_connection
+  end
+end

data/lib/generators/setup_prerequisite/templates/puma.service.erb

@@ -0,0 +1,13 @@
+[Unit]
+Description=Puma HTTP Server
+After=network.target
+
+[Service]
+Type=simple
+User=<%= @deploy_user %>
+WorkingDirectory=<%= @app_path %>/current
+ExecStart=/home/<%= @deploy_user %>/.rvm/bin/rvm ruby-3.2.2 do bundle exec puma -C <%= @app_path %>/shared/puma.rb
+Restart=always
+
+[Install]
+WantedBy=multi-user.target

data/lib/generators/setup_prerequisite/templates/setup_prerequisite.rake.erb

@@ -0,0 +1,65 @@
+# lib/generators/replace_deploy/templates/setup_prerequisite.rake
+namespace :deploy do
+  desc "Upload and configure Nginx"
+  task :setup_prerequisite do
+    on roles(:web) do
+
+      unless test("which git")
+        info "git not found, installing..."
+        execute :sudo, "apt-get install git"
+      else
+        info "git already exists, skipping..."
+      end
+
+      unless test("which nginx")
+        info "nginx not found, installing..."
+        execute :sudo, "apt-get install -y nginx"
+      else
+        info "nginx already exists, skipping..."
+      end
+
+      unless test("which node")
+        info "Node.js not found, installing..."
+        execute :sudo, "apt update"
+        execute :sudo, "apt install -y nodejs"
+      else
+        info "Node.js is already installed"
+      end
+
+      unless test("which yarn")
+        info "Yarn not found, installing..."
+        execute :sudo, "curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -"
+        execute :sudo, "echo \"deb https://dl.yarnpkg.com/debian/ stable main\" | sudo tee /etc/apt/sources.list.d/yarn.list"
+        execute :sudo, "apt update && sudo apt install -y yarn"
+      else
+        info "Yarn is already installed"
+      end
+
+      if fetch(:mode, 'repeat') == 'once'
+        # Upload the nginx configuration file
+        upload! "config/deployment/nginx.conf", "/tmp/nginx.conf"
+        # Move it to the correct location with sudo
+        execute :sudo, "mv /tmp/nginx.conf /etc/nginx/sites-available/default"
+        # Change Nginx user from www-data to <%= @deploy_user %> using sed
+        info "Changing Nginx user from www-data to <%= @deploy_user %>..."
+        execute :sudo, "sed -i 's/^user\\s\\+www-data;/user <%= @deploy_user %>;/' /etc/nginx/nginx.conf"
+      end
+
+      # Restart nginx to apply changes
+      execute :sudo, "systemctl daemon-reload"
+      execute :sudo, "systemctl restart nginx"
+
+      info "PUMA SETUP STARTED"
+
+      upload! "config/deployment/puma.rb", "/tmp/puma.rb"
+      execute :sudo, "mv /tmp/puma.rb <%= @app_path %>/shared/puma.rb"
+
+      # Upload the puma configuration file
+      upload! "config/deployment/puma.service", "/tmp/puma.service"
+      # Move it to the correct location with sudo
+      execute :sudo, "mv /tmp/puma.service /etc/systemd/system/puma.service"
+      execute :sudo, "systemctl daemon-reload"
+      info "PUMA SETUP END"
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: capistrano_quick
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavan Agrawal
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-30 00:00:00.000000000 Z
+dependencies: []
+description: Capistrano is a powerful deployment automation tool for Ruby on Rails
+  applications. In this guide, we’ll set up Capistrano with Puma on an AWS EC2 instance
+  to deploy a Rails application smoothly.
+email:
+- pavan.agrawala@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/capistrano_quick.rb
+- lib/capistrano_quick/version.rb
+- lib/generators/add_capistrano_gems/USAGE
+- lib/generators/add_capistrano_gems/add_capistrano_gems_generator.rb
+- lib/generators/replace_capfile/USAGE
+- lib/generators/replace_capfile/replace_capfile_generator.rb
+- lib/generators/replace_deploy/USAGE
+- lib/generators/replace_deploy/replace_deploy_generator.rb
+- lib/generators/setup_deployment/USAGE
+- lib/generators/setup_deployment/setup_deployment_generator.rb
+- lib/generators/setup_prerequisite/USAGE
+- lib/generators/setup_prerequisite/setup_prerequisite_generator.rb
+- lib/generators/setup_prerequisite/templates/nginx.conf.erb
+- lib/generators/setup_prerequisite/templates/production.rb.erb
+- lib/generators/setup_prerequisite/templates/puma.rb.erb
+- lib/generators/setup_prerequisite/templates/puma.service.erb
+- lib/generators/setup_prerequisite/templates/setup_prerequisite.rake.erb
+homepage: https://github.com/bitsatom/capistrano_quick
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bitsatom/capistrano_quick
+  source_code_uri: https://github.com/bitsatom/capistrano_quick
+  changelog_uri: https://github.com/bitsatom/capistrano_quick
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Deploying Rails with Capistrano & Puma on AWS EC2
+test_files: []