dokkustrano 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6aa8fa86d37528f383f054151ede08d2ed7ee843ef4b2d4dedbf9df569ce70f
+  data.tar.gz: 6e6778de1eada6782248bd23865d48c2ce4261a267f7107eb68b929551bfb3b5
+SHA512:
+  metadata.gz: 8331bbefa273f54ae550013b8ac135f4676ac847e14d838f3f9f044e766d0d1968962b9c41edb1592235d4e29966b264106f0ef42b8c0a28502f82d9bfda1e8f
+  data.tar.gz: 301f2781c3e8b281fbe93225fafc933ed6904183d971356e46a1ab0009b51620f4f783f3813a4026ff847468b4aa9c311978c95989d72d2fe0cc6f1b7306e625

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.swp
+.bundle
+.ruby-version
+Gemfile.lock
+tmp/
+vendor/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+# Latest versions of rake don't support Ruby < 2.2
+if Gem::Requirement.new("< 2.2").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+  gem 'rake', '< 13.0.0'
+end

data/README.md

@@ -0,0 +1,124 @@
+# Dokkustrano: A deployment tool built on Ruby, Rake, and SSH to connect with Dokku servers
+
+Dokkustrano is a library for connecting with Dokku servers which run Ruby on Rails applications.
+
+Once installed on a Rails project, Capistrano gives you rake tasks to perform several operations from your command line.
+
+```
+$ cd my-dokkustrano-enabled-rails-project
+$ rails dokku:console[APP_NAME]
+```
+
+When you run [Rake](https://github.com/ruby/rake) tasks tasks from the `dokku` namespace, Dokkustrano dutifully connects to your server via SSH and executes the necessary actions.
+
+## Installation
+
+### Requirements
+
+* Ruby version 2.0 or higher on your local machine.
+* [Bundler](http://bundler.io), along with a Gemfile for your project.
+
+### Setup
+
+Add the gem to your project's Gemfile:
+
+```ruby
+gem 'dokkustrano'
+```
+
+Then run Bundler to ensure Capistrano is downloaded and installed:
+
+``` sh
+bundle install
+```
+
+Dokkustrano requires you to have configured a SHH host with the server in which Dokku will be running. By default, the host `dokku` will be used, but it can be changed using an initializer (`config/initializers/dokkustrano.rb`):
+
+```ruby
+require 'dokkustrano'
+
+Dokkustrano.configure do |configuration|
+  configuration.host_name = 'dokku-server'
+end
+```
+
+## Available commands
+
+These are all the Rake tasks which are provided by this gem:
+```ruby
+rails dokku:console[app]                                # Connect with Dokku app and open a Rails console
+rails dokku:data:export[app]                            # Download dump from Dokku given app
+rails dokku:data:import[app,path]                       # Import dump to given Dokku app
+rails dokku:postgres:change_version[service,version]    # Change PostgreSQL version for given Dokku database service
+rails dokku:postgres:console[service]                   # Connect with PostgreSQL console for given Dokku database service
+rails dokku:ssl:cleanup[app]                            # Cleanup SSL for given Dokku app
+rails dokku:ssl:enable[app]                             # Enable SSL for given Dokku app
+rails dokku:ssl:renew[app]                              # Auto-renew SSL for given Dokku app
+```
+
+## Custom commands
+
+You can define new actions yourself by writing Rake tasks, which are really simple to make. Here're some examples:
+
+```ruby
+namespace :dokku do
+  desc 'Enter into container for given Dokku app'
+  task :enter, [:app] => :environment do |t, args|
+    include Dokkustrano::Validations
+
+    validate_argument!(args, :app)
+
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku config:show #{args[:app]}'"
+  end
+end
+```
+
+```ruby
+namespace :dokku do
+  namespace :postgres do
+    desc 'Restart PostgreSQL for given Dokku service'
+    task :restart, [:service] => :environment do |t, args|
+      include Dokkustrano::Validations
+
+      validate_argument!(args, :service)
+
+      sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku postgres:restart #{args[:service]}'"
+    end
+  end
+end
+```
+
+As it can be seen in the previous examples, if you include the `Dokkustrano::Validations` module, you can use the `validate_argument!` method to validate arguments presence.
+
+```ruby
+validate_argument!(args, :app)
+validate_argument!(args, :version, :second) # => indicates that the second argument is missing if that's the case
+```
+
+## Bugs report
+
+Please, fill an issue with a reproduction of the error in order to report a bug.
+
+If you think you may have discovered a security vulnerability in Dokkustrano, do not open a GitHub issue. Instead, please send a report to <info@unagi.com.ar>.
+
+## License
+
+MIT License (MIT)
+
+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/dokkustrano.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'dokkustrano/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'dokkustrano'
+  gem.version       = Dokkustrano::VERSION
+  gem.authors       = ['Lucas Hourquebie']
+  gem.email         = ['lucas.hourquebie@unagi.com.ar']
+  gem.description   = 'Dokkustrano is a utility and framework for executing commands via SSH on remote Dokku applications.'
+  gem.summary       = 'Dokkustrano - Easy Dokku deployment with Ruby over SSH'
+  gem.homepage      = 'https://github.com/unagisoftware/dokkustrano'
+  gem.metadata      = {
+    'bug_tracker_uri' => 'https://github.com/unagisoftware/dokkustrano/issues',
+    'changelog_uri' => 'https://github.com/unagisoftware/dokkustrano/releases',
+    'source_code_uri' => 'https://github.com/unagisoftware/dokkustrano',
+    'homepage_uri' => 'https://github.com/unagisoftware/dokkustrano',
+    'homepage' => 'https://github.com/unagisoftware/dokkustrano',
+  }
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f =~ /^docs/ }
+  gem.require_paths = ['lib']
+  gem.licenses      = ['MIT']
+  gem.required_ruby_version = '>= 2.0'
+  gem.add_dependency 'rake', '>= 10.0.0'
+end

data/lib/dokkustrano/configuration.rb

@@ -0,0 +1,11 @@
+module Dokkustrano
+  class Configuration
+    DEFAULT_HOST_NAME = 'dokku'.freeze
+
+    attr_writer :host_name
+
+    def host_name
+      @host_name || DEFAULT_HOST_NAME
+    end
+  end
+end

data/lib/dokkustrano/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+require 'dokkustrano/validations'
+
+module Dokkustrano
+  class Railtie < Rails::Railtie
+    railtie_name :dokku
+
+    rake_tasks do
+      namespace :dokku do
+        path = File.expand_path(__dir__)
+        Dir.glob("#{path}/tasks/**/*.rake").each { |file| load file }
+      end
+    end
+  end
+end

data/lib/dokkustrano/tasks/console.rake

@@ -0,0 +1,8 @@
+desc 'Connect with Dokku app and open a Rails console'
+task :console, [:app] => :environment do |t, args|
+  include Dokkustrano::Validations
+
+  validate_app_argument!(args)
+
+  sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku run #{args[:app]} rails console -e production'"
+end

data/lib/dokkustrano/tasks/data.rake

@@ -0,0 +1,22 @@
+namespace :data do
+  desc 'Download dump from Dokku given app'
+  task :export, [:app] => :environment do |t, args|
+    include Dokkustrano::Validations
+
+    validate_app_argument!(args)
+
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku postgres:export #{args[:app]}' > dump.sql"
+    puts "Dump exported to 'dump.sql'"
+  end
+
+  desc 'Import dump to given Dokku app'
+  task :import, [:app, :path] => :environment do |t, args|
+    include Dokkustrano::Validations
+
+    validate_app_argument!(args)
+    validate_path_argument!(args)
+
+    sh "scp #{args[:path]} #{Dokkustrano.configuration.host_name}:/tmp/dump.sql"
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku postgres:import #{args[:app]} < /tmp/dump.sql'"
+  end
+end

data/lib/dokkustrano/tasks/postgres.rake

@@ -0,0 +1,22 @@
+namespace :postgres do
+  desc 'Connect with PostgreSQL console for given Dokku database service'
+  task :console, [:service] => :environment do |t, args|
+    include Dokkustrano::Validations
+
+    validate_database_service_argument!(args)
+
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku postgres:connect #{args[:service]}'"
+  end
+
+  desc 'Change PostgreSQL version for given Dokku database service'
+  task :change_version, [:service, :version] => :environment do |t, args|
+    include Dokkustrano::Validations
+
+    validate_database_service_argument!(args)
+    validate_version_argument!(args)
+
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku postgres:stop #{args[:service]}'"
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku postgres:upgrade #{args[:service]} -I #{args[:version]}'"
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku postgres:start #{args[:service]}'"
+  end
+end

data/lib/dokkustrano/tasks/ssl.rake

@@ -0,0 +1,28 @@
+namespace :ssl do
+  desc 'Enable SSL for given Dokku app'
+  task :enable, [:app] => :environment do |t, args|
+    include Dokkustrano::Validations
+
+    validate_app_argument!(args)
+
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku letsencrypt:enable #{args[:app]}'"
+  end
+
+  desc 'Auto-renew SSL for given Dokku app'
+  task :renew, [:app] => :environment do |t, args|
+    include Dokkustrano::Validations
+
+    validate_app_argument!(args)
+
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku letsencrypt:auto-renew #{args[:app]}'"
+  end
+
+  desc 'Cleanup SSL for given Dokku app'
+  task :cleanup, [:app] => :environment do |t, args|
+    include Dokkustrano::Validations
+
+    validate_app_argument!(args)
+
+    sh "ssh -t #{Dokkustrano.configuration.host_name} 'dokku letsencrypt:cleanup #{args[:app]}'"
+  end
+end

data/lib/dokkustrano/validations.rb

@@ -0,0 +1,25 @@
+module Dokkustrano
+  module Validations
+    def validate_argument!(args, argument, position = :first)
+      return if args[argument].present?
+
+      abort ":#{argument} argument missing (#{position} argument)"
+    end
+
+    def validate_app_argument!(args)
+      validate_argument!(args, :app)
+    end
+
+    def validate_database_service_argument!(args)
+      validate_argument!(args, :service)
+    end
+
+    def validate_version_argument!(args)
+      validate_argument!(args, :version, :second)
+    end
+
+    def validate_path_argument!(args)
+      validate_argument!(args, :path, :second)
+    end
+  end
+end

data/lib/dokkustrano/version.rb

@@ -0,0 +1,3 @@
+module Dokkustrano
+  VERSION = '0.0.1'.freeze
+end

data/lib/dokkustrano.rb

@@ -0,0 +1,16 @@
+require 'dokkustrano/configuration'
+require 'dokkustrano/railtie'
+
+module Dokkustrano
+  def self.configure
+    @configuration ||= Configuration.new
+
+    yield @configuration if block_given?
+  end
+
+  def self.configuration
+    @configuration
+  end
+
+  configure
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: dokkustrano
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lucas Hourquebie
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+description: Dokkustrano is a utility and framework for executing commands via SSH
+  on remote Dokku applications.
+email:
+- lucas.hourquebie@unagi.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- dokkustrano.gemspec
+- lib/dokkustrano.rb
+- lib/dokkustrano/configuration.rb
+- lib/dokkustrano/railtie.rb
+- lib/dokkustrano/tasks/console.rake
+- lib/dokkustrano/tasks/data.rake
+- lib/dokkustrano/tasks/postgres.rake
+- lib/dokkustrano/tasks/ssl.rake
+- lib/dokkustrano/validations.rb
+- lib/dokkustrano/version.rb
+homepage: https://github.com/unagisoftware/dokkustrano
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/unagisoftware/dokkustrano/issues
+  changelog_uri: https://github.com/unagisoftware/dokkustrano/releases
+  source_code_uri: https://github.com/unagisoftware/dokkustrano
+  homepage_uri: https://github.com/unagisoftware/dokkustrano
+  homepage: https://github.com/unagisoftware/dokkustrano
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Dokkustrano - Easy Dokku deployment with Ruby over SSH
+test_files: []