dokku-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2c1c3ba24f4e2e7cb273efb5f0da3be07790e636aa0f0c7494f0947d1797688
+  data.tar.gz: df3ea07a87442ed43a0eb3aa91f3dd679a4d757431055f7392a8e9087e525f54
+SHA512:
+  metadata.gz: 26f4956de70aba19cc7527535065d8eb3012f20f3640ed9fdfc148f1a625d3be291c7b646ae4f497abbc5c1dab3cd3f89c976772a98fb3b7e94584993ec73c69
+  data.tar.gz: d5829309b50407a0590b0d704e9227c1009e66a145b207fa543f1039e10fc61358da95a73750716578dc4607509c0aed6544d6a036aa06f12f63dfb6061e1153

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dokku-ruby.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.9'
+
+# net-ssh
+gem 'bcrypt_pbkdf', '~> 1.0.1'
+gem 'ed25519', '~> 1.2.4'
+gem 'net-ssh', '~> 5.2.0'

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    dokku-ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bcrypt_pbkdf (1.0.1)
+    diff-lcs (1.4.4)
+    ed25519 (1.2.4)
+    net-ssh (5.2.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bcrypt_pbkdf (~> 1.0.1)
+  dokku-ruby!
+  ed25519 (~> 1.2.4)
+  net-ssh (~> 5.2.0)
+  rake (~> 12.0)
+  rspec (~> 3.9)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 robertsimoes
+
+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,54 @@
+# Dokku::Ruby
+
+Small [Dokku](https://github.com/dokku/dokku) API for Ruby over SSH
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dokku-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dokku-ruby
+
+## Usage
+
+Start a Dokku Session:
+```
+ssh = Dokku::SSH.new(
+ host: 'http://example.com',
+ user: 'deploy-user',
+ key_file: '~/.ssh/id_dokku'
+ )
+```
+
+Use that session to create apps on server:
+
+```
+ssh.start do |session|
+	env = { env_var_one: '123', env_var_two: '456' }
+	
+	# Create a new Dokku application on the server
+  session.create(app_name: 'my-dokku-app')
+
+	# Set the environment config for that application
+	session.set_env_vars(app_name: app_name, env_vars: env)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dokku"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dokku-ruby.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dokku/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dokku-ruby'
+  spec.version       = Dokku::VERSION
+  spec.authors       = ['robertsimoes']
+  spec.email         = ['robertsimoes@users.noreply.github.com']
+
+  spec.summary       = 'Simple Dokku SSH wrapper in ruby'
+  spec.description   = 'Simple Dokku SSH wrapper in ruby'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = 'https://github.com/robertsimoes/dokku-ruby'
+  spec.metadata['source_code_uri'] = 'https://github.com/robertsimoes/dokku-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/robertsimoes/dokku-ruby/releases'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Dev
+  spec.add_development_dependency 'rspec', '~> 3.9'
+end

data/lib/dokku.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'dokku/version'
+require 'dokku/session'
+require 'dokku/ssh'
+
+module Dokku
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/dokku/session.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Dokku
+  class Session
+    def initialize(session, logger = Logger.new(STDOUT))
+      @session = session
+      @logger = logger
+    end
+
+    def create(app_name:)
+      command = "dokku apps:create #{app_name}"
+      @logger.info command
+      @logger.info @session.exec!(command)
+    end
+
+    def set_env_vars(app_name:, env_vars:)
+      env = hash_to_env_vars(env_vars)
+
+      command = "dokku config:set #{app_name} #{env}"
+
+      stdout = ''
+      @logger.info "dokku config:set #{app_name}"
+      @session.exec!(command) do |_channel, stream, data|
+        stdout << redact_sensitive(data) if stream == :stdout
+      end
+
+      @logger.info stdout
+    end
+
+    def destroy(app_name:)
+      command = "dokku --force apps:destroy #{app_name}"
+      @logger.info command
+      @logger.info @session.exec!(command)
+    end
+
+    private
+
+    def hash_to_env_vars(hash)
+      hash.map do |k, v|
+        "#{k.upcase}=#{v}"
+      end.join(' ')
+    end
+
+    def redact_sensitive(s)
+      redactable = s.scan(/KEY|SECRET|TOKEN|PASSPHRASE/)
+
+      if redactable&.empty?
+        s
+      else
+        delimiter = '=' * 25
+        "\n#{delimiter}\n\nOUTPUT REDACTED\n\n#{delimiter}\n"
+      end
+    end
+  end
+end

data/lib/dokku/ssh.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'net/ssh'
+
+module Dokku
+  class SSH
+    def initialize(**params)
+      @host = params[:host]
+      @user = params[:user]
+      @key_file = params[:key_file]
+      @keys_only = params[:keys_only] ||= true
+      @key_type = params[:key_type] ||= 'ssh-rsa'
+    end
+
+    def start
+      Net::SSH.start(
+        @host,
+        @user,
+        host_key: @key_type,
+        keys_only: @keys_only,
+        keys: @key_file,
+        verbose: :error
+      ) do |s|
+        yield Dokku::Session.new(s)
+      end
+    end
+    end
+end

data/lib/dokku/version.rb

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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: dokku-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- robertsimoes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Simple Dokku SSH wrapper in ruby
+email:
+- robertsimoes@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dokku-ruby.gemspec
+- lib/dokku.rb
+- lib/dokku/session.rb
+- lib/dokku/ssh.rb
+- lib/dokku/version.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/robertsimoes/dokku-ruby
+  source_code_uri: https://github.com/robertsimoes/dokku-ruby
+  changelog_uri: https://github.com/robertsimoes/dokku-ruby/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Simple Dokku SSH wrapper in ruby
+test_files: []