mina-puma-systemd 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bba706a63a92692726ff2c26bc07b9efa79dfdedcdd7c8420be8e20989f9ddb6
+  data.tar.gz: ee45eb3521f66d81a63858f529ff1fd60435cdb05d852bf20d0b9da25cde1865
+SHA512:
+  metadata.gz: 91415fd1f025faf1fd81695c98fa2334adb254abb3266e405870d1d3d4b1129cb09a0e5438495a7b0408f2a0a6271d764d8cd0e57a76077c99919e030961408a
+  data.tar.gz: 26568e17afaeced834e2e5f71c22c502c53475d2ad441692ee0172315effd2438e380c23854e3ca760c75765f2a96c7fb605fe3364174051b61e18e6dc5bad67

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mina-puma.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tobias Sandelius
+
+MIT License
+
+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,93 @@
+# Mina Puma
+
+[Mina](https://github.com/mina-deploy/mina) tasks for handle with
+[Puma](https://github.com/puma/puma) using [systemd](https://systemd.io).
+
+This gem provides several mina tasks:
+
+    mina puma:reload          # Restart puma (using phased restart)
+    mina puma:restart         # Restart puma (using stop, then start)
+    mina puma:start           # Start puma
+    mina puma:stop            # Stop puma
+    mina puma:status          # Get status
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mina-puma-systemd', require: false
+
+And then execute:
+
+    $ bundle
+
+Note: by just including this gem, does not mean your development server will be Puma, for that, you need explicitly add `gem 'puma'` to your Gemfile and configure it.
+This gem does not (yet) create puma and systemd service config files, you have to do it manually.
+
+## Usage
+
+Add this to your `config/deploy.rb` file:
+
+    require 'mina/puma-systemd'
+
+Make sure the following settings are set in your `config/deploy.rb`:
+
+* `deploy_to`   - deployment path
+* `rails_env`   - rails environement (will default to `production`)
+
+Make sure the following directories exists on your server (they are added automatically to `shared_dirs`:
+
+* `shared/tmp/sockets` - directory for socket files.
+* `shared/tmp/pids` - directory for pid files.
+
+You can tweak some settings:
+
+* `puma_systemctl` - systemctl command, default is ` sudo systemctl`. Other option would be `systemctl --user` if you have setup pumas as user service. 
+* `puma_service_name` - puma service name , default is `puma_#{fetch(:application_name)}_#{fetch(:puma_env)}`
+
+
+Then:
+
+```
+$ mina puma:start
+```
+
+## Example
+```ruby
+require 'mina/puma-systemd'
+
+task :deploy do
+  deploy do
+    invoke :'git:clone'
+    invoke :'deploy:link_shared_paths'
+    ...
+
+    on :launch do
+      ...
+      invoke :'puma:reload'
+    end
+  end
+end
+```
+
+## sudo configuration
+By default plugin relies on sudo to run systemctl command. You should give proper permissions to the user which runs your app.
+```bash
+Cmnd_Alias SERVICES = /usr/bin/systemctl start *, /usr/bin/systemctl stop *, /usr/bin/systemctl reload *, /usr/bin/systemctl restart *, /usr/bin/systemctl status *, /usr/bin/systemctl enable *, /usr/bin/systemctl disable *
+deploy          ALL=(ALL)       NOPASSWD: SERVICES
+
+```
+
+If you are paranoid, substitute `*` with exact service name. Better option would be to run as user service, but it did not work for me out of box on AWS AMI2.
+
+## TODO
+* Generate and upload puma.rb file
+* Generate and upload puma systemd service
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mina/puma_systemd/tasks.rake

@@ -0,0 +1,63 @@
+require 'mina/bundler'
+require 'mina/rails'
+
+namespace :puma do
+  set :shared_dirs, fetch(:shared_dirs, []).push("tmp/sockets", "tmp/pids")
+
+  set :puma_role,      -> { fetch(:user) }
+  set :puma_env,       -> { fetch(:rails_env, 'production') }
+  set :puma_root_path, -> { fetch(:current_path) }
+
+  set :puma_systemctl, -> { fetch(:systemctl, "sudo systemctl")}
+  set :puma_service_name, -> { "puma_#{fetch(:application_name)}_#{fetch(:puma_env)}" }
+
+  desc 'Enable puma'
+  task enable: :remote_environment do
+    comment "Enabling Puma..."
+    command "#{fetch(:puma_systemctl)} enable #{fetch(:puma_service_name)}"
+  end
+
+  desc 'Disable puma'
+  task start: :remote_environment do
+    comment "Enabling Puma..."
+    command "#{fetch(:puma_systemctl)} disable #{fetch(:puma_service_name)}"
+  end
+
+  desc 'Start puma'
+  task start: :remote_environment do
+    comment "Starting Puma..."
+    command "#{fetch(:puma_systemctl)} start #{fetch(:puma_service_name)}"
+  end
+
+  desc 'Stop puma'
+  task stop: :remote_environment do
+    comment "Stopping Puma..."
+    command "#{fetch(:puma_systemctl)} stop #{fetch(:puma_service_name)}"
+  end
+
+  desc 'Restart puma'
+  task restart: :remote_environment do
+    comment "Restart Puma...."
+    command "#{fetch(:puma_systemctl)} restart #{fetch(:puma_service_name)}"
+  end
+
+  desc 'Reload puma (phased restart)'
+  task reload: :remote_environment do
+    command %[
+      if #{fetch(:puma_systemctl)} is-active --quiet #{fetch(:puma_service_name)} ; then
+        echo "Reload Puma -- phased..."
+        #{fetch(:puma_systemctl)} reload #{fetch(:puma_service_name)}
+      else
+        echo "Starting Puma..."
+        #{fetch(:puma_systemctl)} start #{fetch(:puma_service_name)}
+      fi
+    ]
+  end
+
+  desc 'Get status of puma'
+  task status: :remote_environment do
+    comment "Puma status..."
+    command "#{fetch(:puma_systemctl)} status -l #{fetch(:puma_service_name)}"
+  end
+
+end

data/lib/mina/puma_systemd/version.rb

@@ -0,0 +1,5 @@
+module Mina
+  module PumaSystemd
+    VERSION = "1.0.0"
+  end
+end

data/lib/mina/puma_systemd.rb

@@ -0,0 +1 @@
+load File.expand_path("../puma/tasks.rake", __FILE__)

data/mina-puma-systemd.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mina/puma_systemd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mina-puma-systemd'
+  spec.version       = Mina::PumaSystemd::VERSION
+  spec.authors       = ['Vladimir Elchinov']
+  spec.email         = ['elik@elik.ru']
+  spec.description   = %q{Puma tasks for Mina and systemd}
+  spec.summary       = %q{Puma tasks for Mina and systemd}
+  spec.homepage      = 'https://github.com/railsblueprint/mina-puma-systemd'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mina', '~> 1.2.0'
+  spec.add_dependency 'puma', '>= 2.13'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: mina-puma-systemd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vladimir Elchinov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Puma tasks for Mina and systemd
+email:
+- elik@elik.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mina/puma_systemd.rb
+- lib/mina/puma_systemd/tasks.rake
+- lib/mina/puma_systemd/version.rb
+- mina-puma-systemd.gemspec
+homepage: https://github.com/railsblueprint/mina-puma-systemd
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Puma tasks for Mina and systemd
+test_files: []