dokku-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c1c3ba24f4e2e7cb273efb5f0da3be07790e636aa0f0c7494f0947d1797688
-  data.tar.gz: df3ea07a87442ed43a0eb3aa91f3dd679a4d757431055f7392a8e9087e525f54
+  metadata.gz: 2e4326cf5810a609f4d73b786316dee42a0d5f57fb169c8158d78fc78e50e3af
+  data.tar.gz: db2664bf2c55e26c77467c326a2578c2677a8c16a5cf2fb885b4130fc41f3e15
 SHA512:
-  metadata.gz: 26f4956de70aba19cc7527535065d8eb3012f20f3640ed9fdfc148f1a625d3be291c7b646ae4f497abbc5c1dab3cd3f89c976772a98fb3b7e94584993ec73c69
-  data.tar.gz: d5829309b50407a0590b0d704e9227c1009e66a145b207fa543f1039e10fc61358da95a73750716578dc4607509c0aed6544d6a036aa06f12f63dfb6061e1153
+  metadata.gz: d2c497d00df8ae74350a839f2d49d9482cf3a5f8442e12ba69d87df851d8dc47981e89acdb1c5a98e2793d14e20bca97f885d171f76c4bad869de4c44ed56b1e
+  data.tar.gz: ad1b909a7a02c864d2804110c40aa9e1a6826158f32006e59ce3734d09796e5b353bb662227725ea0918114fe4c88a94d326963806a0a7131c017bce75468bf1

data/Gemfile

@@ -5,10 +5,12 @@ 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'
+gem 'sshkit', '~>1.21.0'
+
+group :development, :test do
+  gem 'pry'
+  gem 'rake', '~> 12.0'
+  gem 'rspec', '~> 3.9'
+end

data/Gemfile.lock

@@ -1,15 +1,22 @@
 PATH
   remote: .
   specs:
-    dokku-ruby (0.1.0)
+    dokku-ruby (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     bcrypt_pbkdf (1.0.1)
+    coderay (1.1.3)
     diff-lcs (1.4.4)
     ed25519 (1.2.4)
-    net-ssh (5.2.0)
+    method_source (1.0.0)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -24,6 +31,9 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    sshkit (1.21.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
 
 PLATFORMS
   ruby
@@ -32,9 +42,10 @@ DEPENDENCIES
   bcrypt_pbkdf (~> 1.0.1)
   dokku-ruby!
   ed25519 (~> 1.2.4)
-  net-ssh (~> 5.2.0)
+  pry
   rake (~> 12.0)
   rspec (~> 3.9)
+  sshkit (~> 1.21.0)
 
 BUNDLED WITH
    2.1.2

data/README.md

@@ -1,6 +1,6 @@
 # Dokku::Ruby
 
-Small [Dokku](https://github.com/dokku/dokku) API for Ruby over SSH
+Small [Dokku](https://github.com/dokku/dokku) API for Ruby over SSHKit.
 
 ## Installation
 
@@ -20,26 +20,20 @@ Or install it yourself as:
 
 ## Usage
 
-Start a Dokku Session:
+Configure the Dokku client with desired set user, host and ssh options.
+
 ```
-ssh = Dokku::SSH.new(
- host: 'http://example.com',
- user: 'deploy-user',
- key_file: '~/.ssh/id_dokku'
- )
+Dokku.config do |c|
+  c.user = 'root'
+  c.host = 'tradingbotplatformbook.com'
+  c.ssh_options = { keys: '~/.ssh/id_trading_platform' }
+end
 ```
 
-Use that session to create apps on server:
-
+Start a session, use the yielded block argument's DSL to create, delete and set environments for Dokku apps
 ```
-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)
+Dokku.start_session! do |d|
+  d.create!('app')
 end
 ```
 

data/lib/dokku.rb

@@ -1,10 +1,55 @@
 # frozen_string_literal: true
 
+require 'sshkit'
+require 'sshkit/dsl'
 require 'dokku/version'
-require 'dokku/session'
-require 'dokku/ssh'
+require 'dokku/configuration'
+require 'dokku/dsl'
 
 module Dokku
-  class Error < StandardError; end
-  # Your code goes here...
+  extend SSHKit::DSL
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.config
+    yield(configuration)
+
+    SSHKit::Backend::Netssh.configure do |ssh|
+      unless configuration.ssh_options.nil?
+        ssh.ssh_options = configuration.ssh_options
+      end
+    end
+  end
+
+  class DokkuError < StandardError; end
+  class MissingUserError < DokkuError; end
+  class MissingHostError < DokkuError; end
+
+  def self.start_session!
+    on ssh_target do
+      # self is an SSH context
+      yield Dokku::DSL.new(self)
+    end
+  end
+
+  def self.ssh_target
+    user = configuration.user
+    host = configuration.host
+
+    if user.nil? || user == ''
+      raise MissingUserError, 'User not set. Did you add it to the configuration?'
+    end
+
+    if host.nil? || host == ''
+      raise MissingHostError, 'Host is not set. Did you add it to the configuration?'
+    end
+
+    "#{user}@#{host}"
+   end
 end

data/lib/dokku/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Dokku
+  class Configuration
+    attr_accessor :ssh_options, :host, :user
+  end
+end

data/lib/dokku/dsl.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'sshkit/dsl'
+
+module Dokku
+  class DSL
+    include SSHKit::DSL
+
+    CREATE_APP_CMD = 'apps:create'
+    CONFIG_SET_CMD = 'config:set'
+    FORCE_DELETE_APP_CMD = '--force apps:destroy'
+
+    def initialize(runner, logger = Logger.new(STDOUT))
+      @runner = runner
+      @logger = logger
+    end
+
+    def create!(app_name)
+      @logger.info("dokku #{CREATE_APP_CMD} #{app_name}")
+      @runner.execute :dokku, CREATE_APP_CMD, app_name
+    end
+
+    def destroy!(app_name)
+      @logger.info("dokku #{FORCE_DELETE_APP_CMD} #{app_name}")
+      @runner.execute :dokku, FORCE_DELETE_APP_CMD, app_name
+    end
+
+    def set_config(app_name:, **config)
+      @logger.info("dokku #{CONFIG_SET_CMD} #{app_name} REDACTED")
+      @runner.execute :dokku, CONFIG_SET_CMD, app_name, redact(hash_to_env_vars(config))
+    end
+
+    private
+
+    def hash_to_env_vars(hash)
+      hash.map do |k, v|
+        "#{k.upcase}=#{v}"
+      end.join(' ')
+    end
+  end
+end

data/lib/dokku/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dokku-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - robertsimoes
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -42,8 +42,8 @@ files:
 - bin/setup
 - dokku-ruby.gemspec
 - lib/dokku.rb
-- lib/dokku/session.rb
-- lib/dokku/ssh.rb
+- lib/dokku/configuration.rb
+- lib/dokku/dsl.rb
 - lib/dokku/version.rb
 homepage:
 licenses:

data/lib/dokku/session.rb

@@ -1,57 +0,0 @@
-# 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

@@ -1,28 +0,0 @@
-# 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