capistrano-simple_systemd 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cda40e1475446c76a2540b874302e2d10390000568f0a1f74674dfbe27115d6d
-  data.tar.gz: 2eeaee0344715bc9bbfbe385ce7f09208d071675afb9692d4ead02bd1b4e7a97
+  metadata.gz: f52f1550b5740291f3a698e04bc3be99c2bfdd900809ab1f8f10ec493da7f42c
+  data.tar.gz: 2f7a9d9ccbeb2e5c6156da99c9dd52ca7810064c3443368aee27e5413a0392d3
 SHA512:
-  metadata.gz: e12110fc85a12e817f1a84acc501f11ad0cbac0a36563baae8cfafc8a175120237ddb15979e65c0c47903795a9db8cbb6ddcab30d5b2b30ea6f990b6f7a293e7
-  data.tar.gz: 97272c579d7f5055a80de64cbc55cb6b12d37e5b6a3b90306c7b389f9235b0445367ed5f43a3d2cf97bf9af5990ba3635c2b06b125b191700268a62f3fd6cbc1
+  metadata.gz: 8f19749c8e99eb8742c9df11c196edde497d569436c6bd4b95536b1c637487cb14c550fb23b3e37eee661f1a23eb5429b5ff11aab8e3eb30ac9ba92886856080
+  data.tar.gz: d3e59b089c5bb23dd8e8491315c6d470f9bef6501150c17655f3f0b5120d765984dd63712ff0935404c794d80ab57272acc923e6e2ba781bc89fc43f78e8d86e

data/CHANGELOG.md

@@ -1,4 +1,15 @@
 # Changelog
+### v0.2.0, 2019-11-16 (Feature release)
+- Added the following specific tasks
+  - cap {stage} systemd:{service}:upload to upload a single service file
+  - cap {stage} systemd:{service}:remove to upload a single service file
+- Added the following global tasks
+  - cap {stage} systemd:enable to enable all services
+  - cap {stage} systemd:disable to disable all services
+  - cap {stage} systemd:remove to remove all services
+- Moved both global and specific tasks into one file
+- Pruned dependencies
+
 ### v0.1.1, 2019-10-26 (Maintenance release)
 - Moved gem to new repository (https://github.com/gkosae/capistrano-simple_systemd.git)
 - Added sample service file template to README

data/Gemfile.lock

@@ -1,23 +1,22 @@
 PATH
   remote: .
   specs:
-    capistrano-simple_systemd (0.1.1)
+    capistrano-simple_systemd (0.2.0)
       capistrano (~> 3.7)
-      sshkit (~> 1.2)
-      sshkit-sudo (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    airbrussh (1.3.4)
+    airbrussh (1.4.0)
       sshkit (>= 1.6.1, != 1.7.0)
-    capistrano (3.11.1)
+    byebug (11.0.1)
+    capistrano (3.11.2)
       airbrussh (>= 1.0.0)
       i18n
       rake (>= 10.0.0)
       sshkit (>= 1.9.0)
     concurrent-ruby (1.1.5)
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     net-scp (2.0.0)
       net-ssh (>= 2.6.5, < 6.0.0)
@@ -26,14 +25,13 @@ GEM
     sshkit (1.20.0)
       net-scp (>= 1.1.2)
       net-ssh (>= 2.8.0)
-    sshkit-sudo (0.1.0)
-      sshkit (~> 1.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
+  byebug
   capistrano-simple_systemd!
   rake (~> 10.0)
 

data/README.md

@@ -1,4 +1,4 @@
-# capistrano-simple_systemd
+# capistrano-simple_systemd [![Gem Version](https://badge.fury.io/rb/capistrano-simple_systemd.svg)](https://badge.fury.io/rb/capistrano-simple_systemd)
 
 Capistrano tasks to control mutiple services with systemd
 
@@ -52,8 +52,11 @@ PLEASE NOTE: Currently only files with the  `.service.erb` extension are conside
 
 The following tasks are provided out of the box
 ```ruby
-cap systemd:reload-daemons
-cap systemd:upload
+cap systemd:reload-daemons # run sudo systemctl daemon-reload
+cap systemd:upload         # upload all provided service files
+cap systemd:remove         # remove all provided service files
+cap systemd:enable         # enable all provided service files
+cap systemd:disable        # disable all provided service files
 ```
 
 The following tasks will be created for each service template detected in the `config/systemd` directory
@@ -66,6 +69,8 @@ cap systemd:{service}:reload-or-restart
 cap systemd:{service}:restart
 cap systemd:{service}:start
 cap systemd:{service}:stop
+cap systemd:{service}:upload
+cap systemd:{service}:remove
 ```
 Where `service` is the base name of the service template. <br>
 For example, placing `puma.service.erb` in the template directory will yield the following tasks
@@ -77,6 +82,8 @@ cap systemd:puma:reload-or-restart
 cap systemd:puma:restart
 cap systemd:puma:start
 cap systemd:puma:stop
+cap systemd:puma:upload
+cap systemd:puma:remove
 ```
 
 Run 
@@ -99,15 +106,13 @@ Services are enabled after upload by invoking `systemd:{service}:enable`. This b
 set :enable_services_after_upload, false
 ```
 
-## Development
-
-After checking out the repo, run `bundle`
-
-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 tags, 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/gkosae/capistrano-simple_systemd.git.
+All contributions are welcome. Improvements are especially welcome. To contribute
+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
 
 ## License
 

data/capistrano-simple_systemd.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/gkosae/capistrano-simple_systemd/blob/master/CHANGELOG.md"
   spec.metadata["source_code_uri"] = "https://github.com/gkosae/capistrano-simple_systemd.git"
 
   # Specify which files should be added to the gem when it is released.
@@ -28,9 +29,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "capistrano", "~> 3.7"
-  spec.add_runtime_dependency "sshkit", "~> 1.2"
-  spec.add_runtime_dependency "sshkit-sudo", "~> 0.1"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug"
 end

data/lib/capistrano/simple_systemd.rb

@@ -1,4 +1,3 @@
 require 'capistrano/simple_systemd/paths'
 require 'capistrano/simple_systemd/helpers'
-load File.expand_path('../tasks/simple_systemd/global_tasks.rake', __FILE__)
-load File.expand_path('../tasks/simple_systemd/specific_tasks.rake', __FILE__)
+load File.expand_path('../tasks/simple_systemd.rake', __FILE__)

data/lib/capistrano/simple_systemd/helpers.rb

@@ -2,23 +2,31 @@ module Capistrano
   module SimpleSystemd
     module Helpers
       def each_service_template(&block)
-        service_file_local_dir = Capistrano::SimpleSystemd::Paths.service_file_local_dir
+        service_file_local_dir = Capistrano::SimpleSystemd::Paths::SERVICE_FILE_LOCAL_DIR
 
         Dir
           .glob(File.join(service_file_local_dir, '*.service.erb'))
-          .each do |template_file|
-            block.call(template_file)
-          end
+          .each { |template_file| block.call(template_file) }
       end
-      
-      def compile(template_file_path)
-        ERB.new(File.new(template_file_path).read).result(binding)
+
+      def invoke_on_all(task)
+        each_service_template do |template|
+          basename = File.basename(template, '.service.erb')
+          invoke! "systemd:#{basename}:#{task}"
+        end
       end
-      
-      def upload_service_file(file_content, file_name, destination_dir)
-        tmp_path = "#{fetch(:tmp_dir)}/#{file_name}"
+
+
+      def upload_template(template, service_file_name)
+        file_content = compile(File.absolute_path(template))
+        tmp_path     = "#{fetch(:tmp_dir)}/#{service_file_name}"
+
         upload! StringIO.new(file_content), tmp_path
-        sudo :mv, tmp_path, "#{destination_dir}/#{file_name}"
+        sudo :mv, tmp_path, "#{fetch(:service_file_remote_dir)}/#{service_file_name}"
+      end
+      
+      def compile(template_path)
+        ERB.new(File.new(template_path).read).result(binding)
       end
     end
   end

data/lib/capistrano/simple_systemd/paths.rb

@@ -1,13 +1,7 @@
 module Capistrano
   module SimpleSystemd
     module Paths
-      def self.service_file_local_dir
-        'config/systemd'
-      end
-
-      def self.service_file_remote_dir
-        '/etc/systemd/system'
-      end
+      SERVICE_FILE_LOCAL_DIR = 'config/systemd'
     end
   end
 end

data/lib/capistrano/simple_systemd/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module SimpleSystemd
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/capistrano/tasks/simple_systemd.rake

@@ -0,0 +1,97 @@
+include Capistrano::SimpleSystemd::Helpers
+
+namespace :load do
+  task :defaults do
+    set :service_file_remote_dir,      '/etc/systemd/system'
+    set :service_file_prefix,          -> { fetch(:application) }
+    set :enable_services_after_upload, true
+  end
+end
+
+task :setup do
+  invoke 'systemd:upload'
+  invoke 'systemd:reload-daemons'
+end
+
+namespace :systemd do
+  task :upload do
+    on release_roles :all do
+      each_service_template do |template|
+        template_basename = File.basename(template, '.service.erb')
+        service_basename = [ fetch(:service_file_prefix), template_basename ].join('-')
+        service_filename = "#{service_basename}.service"
+        upload_template(template, service_filename)
+      end
+
+      invoke_on_all(:enable) if fetch(:enable_services_after_upload)
+    end
+  end
+
+  task :enable do
+    on release_roles :all do
+      invoke_on_all(:enable)
+    end
+  end
+
+  task :disable do
+    on release_roles :all do
+      invoke_on_all(:disable)
+    end
+  end
+
+  task :remove do
+    on release_roles :all do
+      invoke_on_all(:remove)
+    end
+  end
+
+  task :'reload-daemons' do
+    on release_roles :all do
+      sudo :systemctl, :'daemon-reload'
+    end
+  end
+
+  each_service_template do |template|
+    template_basename = File.basename(template, '.service.erb')
+
+    namespace template_basename do
+      {
+        start:                "Run systemctl %{task_name} for %{service} service",
+        stop:                 "Run systemctl %{task_name} for %{service} service",
+        reload:               "Run systemctl %{task_name} for %{service} service",
+        restart:              "Run systemctl %{task_name} for %{service} service",
+        "reload-or-restart":  "Run systemctl %{task_name} for %{service} service",
+        enable:               "Run systemctl %{task_name} for %{service} service",
+        disable:              "Run systemctl %{task_name} for %{service} service",
+        upload:               "Upload service file for %{service} service",
+        remove:               "Remove service file for %{service} service"
+      }.each do |task_name, desc_template|
+        desc(desc_template % { service: template_basename, task_name: task_name})
+        task task_name do
+          service_basename = [ fetch(:service_file_prefix), template_basename ].join('-')
+          service_filename = "#{service_basename}.service"
+
+          on release_roles :all do
+            case task_name
+            when :upload  
+              on release_roles :all do
+                upload_template(template, service_filename)
+
+                if fetch(:enable_services_after_upload)
+                  invoke! "systemd:#{template_basename}:enable"
+                end
+              end
+            when :remove
+              invoke "systemd:#{template_basename}:disable"
+              service_file_path = "#{fetch(:service_file_remote_dir)}/#{service_filename}"
+              sudo :rm, service_file_path
+              invoke! "systemd:reload-daemons"
+            else
+              sudo :systemctl, task_name, "#{service_basename}.service"
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-simple_systemd
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - George Osae
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-26 00:00:00.000000000 Z
+date: 2019-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -25,61 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: sshkit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: sshkit-sudo
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: Simple systemd integration for Capistrano. Uploads service files and
   provides rake tasks for managing these services
 email:
@@ -101,15 +87,14 @@ files:
 - lib/capistrano/simple_systemd/helpers.rb
 - lib/capistrano/simple_systemd/paths.rb
 - lib/capistrano/simple_systemd/version.rb
-- lib/capistrano/tasks/simple_systemd/global_tasks.rake
-- lib/capistrano/tasks/simple_systemd/specific_tasks.rake
-- lib/capistrano/tasks/simple_systemd/task_defaults.rake
+- lib/capistrano/tasks/simple_systemd.rake
 homepage: https://github.com/gkosae/capistrano-simple_systemd.git
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/gkosae/capistrano-simple_systemd.git
+  changelog_uri: https://github.com/gkosae/capistrano-simple_systemd/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/gkosae/capistrano-simple_systemd.git
 post_install_message: 
 rdoc_options: []

data/lib/capistrano/tasks/simple_systemd/global_tasks.rake

@@ -1,45 +0,0 @@
-include Capistrano::SimpleSystemd::Helpers
-load "#{File.dirname(__FILE__)}/task_defaults.rake"
-
-namespace :systemd do
-  task :upload do
-    original_pty_value = fetch(:pty)
-    set :pty, true
-
-    each_service_template do |template|
-      template_basename = File.basename(template, '.service.erb')
-      
-      service_basename = [
-        fetch(:service_file_prefix),
-        template_basename
-      ].join('-')
-
-      service_filename = "#{service_basename}.service"
-      enable_services_after_upload = fetch(:enable_services_after_upload)
-
-      on release_roles :all do
-        upload_service_file(
-          compile(File.absolute_path(template)),
-          service_filename,
-          fetch(:service_file_remote_dir)
-        )
-
-        invoke "systemd:#{template_basename}:enable" if enable_services_after_upload
-      end
-    end
-
-    set :pty, original_pty_value
-  end
-
-  task :'reload-daemons' do
-    on release_roles :all do
-      sudo :systemctl, :'daemon-reload'
-      # puts fetch(:service_file_local_dir)
-    end
-  end
-end
-
-task :setup do
-  invoke 'systemd:upload'
-  invoke 'systemd:reload-daemons'
-end

data/lib/capistrano/tasks/simple_systemd/specific_tasks.rake

@@ -1,32 +0,0 @@
-include Capistrano::SimpleSystemd::Helpers
-load "#{File.dirname(__FILE__)}/task_defaults.rake"
-
-namespace :systemd do
-  each_service_template do |template|
-    template_basename = File.basename(template, '.service.erb')
-
-    namespace template_basename do
-      {
-        start:                "Run systemctl %{task_name} for %{service} service",
-        stop:                 "Run systemctl %{task_name} for %{service} service",
-        reload:               "Run systemctl %{task_name} for %{service} service",
-        restart:              "Run systemctl %{task_name} for %{service} service",
-        "reload-or-restart":  "Run systemctl %{task_name} for %{service} service",
-        enable:               "Run systemctl %{task_name} for %{service} service",
-        disable:              "Run systemctl %{task_name} for %{service} service",
-      }.each do |task_name, desc_template|
-        desc(desc_template % { service: template_basename, task_name: task_name})
-        task task_name do
-          on release_roles :all do
-            service_basename = [
-              fetch(:service_file_prefix),
-              template_basename
-            ].join('-')
-
-            sudo :systemctl, task_name, "#{service_basename}.service"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/capistrano/tasks/simple_systemd/task_defaults.rake

@@ -1,8 +0,0 @@
-namespace :load do
-  task :defaults do
-    set :service_file_local_dir,       Capistrano::SimpleSystemd::Paths.service_file_local_dir
-    set :service_file_remote_dir,      Capistrano::SimpleSystemd::Paths.service_file_remote_dir
-    set :service_file_prefix,          -> { fetch(:application) }
-    set :enable_services_after_upload, true
-  end
-end