gleis 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36d72081ace4b3db129e059c2b84038eb15311ad69435baf4c7282347fc65fa3
-  data.tar.gz: 10b3055f4c9b8cf02702a54bb0f05b8ef995bc677aba9797ca82bffa24274792
+  metadata.gz: 2481657ba18d0dc9d1c9c159ffd3057158ae6febb5aeb234ff1d17d9c26607d3
+  data.tar.gz: 5b2a4ad6053130dd3c4c8fb1381835c6d430df696a89cc556e2ad8466968fe08
 SHA512:
-  metadata.gz: 6c908bfca9308da3d7666434f6d2451d404adf5636fae5dcf2ad8bc1e5c0a4a5c494517821fc7db095f83fd37d63e6532a83451e74c8e468b6b055825b72aa87
-  data.tar.gz: e3604132f93cd919f242913e21c56d439793cc902b4708b5281ac622edf36c8c57ca680bfac1208828dc597aa0046459c6f390382939b29651bead35135998a0
+  metadata.gz: abb5525578089f01e36cfcb20a63f546e5f0fcefb7dfd605aab827474119d393fc9d5fd6ed77a16f3642217284582fb78c55f6f19c4fbc13dacd78e950ad0aee
+  data.tar.gz: 1f7354bd6d77d462d3384e41dbc5419ee19f682c79571bbc9a80be8434073caa4413418043bd8937dd45b92bbcf6ed218bfb97ce426ee6c3d9ae3924cd600380

data/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to the Gleis CLI will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.3.0 - 2018-12-10
+
+### Added
+
+- Comment when adding new Host entry in user git config file
+- Management of SSH public keys for the authentication with git server using "auth key" sub-commands
+
+### Changed
+
+- Generation of exec parameters for supporting additional future storage types
+- Possibility to enter login password as command parameter for automation to bypass interactive password prompt
+
 ## 0.2.0 - 2018-12-02
 
 ### Added

data/lib/gleis.rb

@@ -3,8 +3,10 @@ require 'gleis/authentication'
 require 'gleis/addon'
 require 'gleis/api'
 require 'gleis/application'
+require 'gleis/auth_key'
 require 'gleis/cli/addon'
 require 'gleis/cli/app'
+require 'gleis/cli/auth_key'
 require 'gleis/cli/auth'
 require 'gleis/cli/db'
 require 'gleis/cli/domain'

data/lib/gleis/auth_key.rb

@@ -0,0 +1,50 @@
+module Gleis
+  # The class implements the methods required to manage git authentication keys
+  class AuthKey
+    def self.add(key_file, key_name = nil, run_server = false)
+      token = Token.check
+      abort("SSH public key file #{key_file} does not exist.") unless File.exist?(key_file)
+      ssh_public_key = SSH.load_public_key(key_file)
+      body = API.request('post', 'keys', token, 'key' => ssh_public_key, 'name' => key_name, 'run_server' => run_server)
+      if body['success'] == 1
+        puts "Successfully uploaded your SSH public key #{key_file}"
+        SSH.add_host_to_config(body['git_server'], key_file.gsub(/\.pub$/, ''))
+        # Get run server name and add Host to SSH config
+        if run_server
+          params = Params.get_cli_parameters(token)
+          SSH.add_host_to_config(params['run_server'], key_file.gsub(/\.pub$/, ''))
+        end
+      else
+        puts "Failed to upload SSH public key: #{body['message']}"
+      end
+    end
+
+    def self.list
+      token = Token.check
+      body = API.request('get', 'keys', token)
+      keys = body ['data']
+      if keys.any?
+        puts "SSH public keys configured for your account:\n\n"
+        printf("\t%-39s %s\n", 'KEY NAME', 'CREATED ON')
+        printf("\t%-39s %s\n", 'PUBLIC KEY', '----------')
+        printf("\t%-39s\n\n", '----------')
+        keys.each do |_id, key|
+          printf("\t%-39s %s\n", key['title'], Time.parse(key['created_at']).localtime.strftime('%c'))
+          printf("\t%s\n\n", key['key'])
+        end
+      else
+        puts 'No keys found.'
+      end
+    end
+
+    def self.remove(key_name)
+      token = Token.check
+      body = API.request('delete', "keys/#{CGI.escape(key_name)}", token)
+      if body['success'] == 1
+        puts 'Successfully removed SSH public key'
+      else
+        puts "Failed to remove SSH public key: #{body['message']}"
+      end
+    end
+  end
+end

data/lib/gleis/authentication.rb

@@ -1,10 +1,10 @@
 module Gleis
   # This class implements all authentication related commands of the CLI
   class Authentication
-    def self.login(username)
+    def self.login(username, password = nil)
       puts 'Login to Gleis'
       username = username.downcase
-      password = Utils.prompt_password
+      password ||= Utils.prompt_password
 
       body = API.request('post', 'login', nil, 'username': username, 'password': password)
       token = body['token']
@@ -14,7 +14,7 @@ module Gleis
       puts "\nNEWS: #{body['data']}\n\n" unless body['data'].nil?
       # Generate SSH key pair if not found and upload pub key
       ssh_key_filename = Config::SSH_KEY_FILE_BASE + '_' + Utils.convert_username_to_filename(username)
-      upload_ssh_public_key(ssh_key_filename, token) if SSH.generate_key(ssh_key_filename, username)
+      AuthKey.add("#{ssh_key_filename}.pub", nil, true) if SSH.generate_key(ssh_key_filename, username)
     end
 
     def self.register(email)
@@ -59,18 +59,5 @@ module Gleis
       Token.delete
       puts 'Logout successful'
     end
-
-    def self.upload_ssh_public_key(filename, token)
-      ssh_public_key = SSH.load_public_key(filename)
-      body = API.request('post', 'upload_ssh_pub_key', token, 'ssh_public_key' => ssh_public_key)
-      if body['success'] == 1
-        puts "Successfully uploaded your SSH public key #{filename}.pub"
-        # Get run server name
-        params = Params.get_cli_parameters(token)
-        SSH.add_host_to_config(body['git_server'], params['run_server'], filename)
-      else
-        puts "Failed to upload SSH public key: #{body['message']}"
-      end
-    end
   end
 end

data/lib/gleis/cli/auth.rb

@@ -2,9 +2,12 @@ module Gleis
   module CLI
     # Authentication-related CLI commands
     class Auth < Thor
-      desc 'login USERNAME', 'Login into Gleis'
-      def login(username)
-        Authentication.login(username)
+      desc 'key COMMAND', 'Manage git public keys: add, list, remove'
+      subcommand 'key', CLI::AuthKey
+
+      desc 'login USERNAME [PASSWORD]', 'Login into Gleis'
+      def login(username, password = nil)
+        Authentication.login(username, password)
       end
 
       desc 'logout', 'Logout of Gleis'

data/lib/gleis/cli/auth_key.rb

@@ -0,0 +1,21 @@
+module Gleis
+  module CLI
+    # Git authentication key related CLI commands
+    class AuthKey < Thor
+      desc 'add FILENAME [KEYNAME]', 'Add SSH public key file for git authentication'
+      def add(key_file, key_name = nil)
+        Gleis::AuthKey.add(key_file, key_name)
+      end
+
+      desc 'list', 'List all SSH public keys allowed for git authentication'
+      def list
+        Gleis::AuthKey.list
+      end
+
+      desc 'remove KEYNAME', 'Remove SSH public key from git authentication'
+      def remove(key_name)
+        Gleis::AuthKey.remove(key_name)
+      end
+    end
+  end
+end

data/lib/gleis/main.rb

@@ -20,7 +20,7 @@ module Gleis
     desc 'app COMMAND', 'Manage applications: create, start, stop, logs, etc.'
     subcommand 'app', CLI::App
 
-    desc 'auth COMMAND', 'Authentication commands: login, logout, whoami'
+    desc 'auth COMMAND', 'Authentication commands: key, login, logout, whoami'
     subcommand 'auth', CLI::Auth
 
     desc 'db COMMAND', 'Manage databases: info, new, promote, psql, etc.'

data/lib/gleis/ssh.rb

@@ -16,20 +16,20 @@ module Gleis
              "-C generated by Gleis CLI for #{username} by #{ENV['USER']}@#{hostname} on #{datetime}")
     end
 
-    def self.load_public_key(key_file)
-      public_key_file = key_file + '.pub'
+    def self.load_public_key(public_key_file)
       return File.read(public_key_file).chomp if File.exist?(public_key_file)
     end
 
-    def self.add_host_to_config(git_host, run_host, key_file)
+    def self.add_host_to_config(host_name, private_key_file)
       config_file = Dir.home + '/.ssh/config'
-      ssh_host_line = "Host #{git_host} #{run_host}"
+      ssh_host_line = "Host #{host_name}"
       # Check if SSH config for hosts already exists
-      return if Utils.line_exists_in_file(key_file, ssh_host_line)
+      return if Utils.line_exists_in_file(config_file, ssh_host_line)
 
       f = File.open(config_file, 'a')
+      f.puts "\n# Added by Gleis CLI on #{Time.now.strftime('%Y-%m-%d %H:%M')}"
       f.puts ssh_host_line
-      f.puts "\tIdentityFile #{key_file}"
+      f.puts "\tIdentityFile #{private_key_file}"
       f.close
     end
   end

data/lib/gleis/utils.rb

@@ -92,14 +92,23 @@ module Gleis
     def self.generate_exec_mount_param(body, app_name)
       mount_param = ''
       if body['success'] == 1
-        storage_type = body['storage_type']
-        if storage_type
-          storage = body['storage']
-          mount_src = "#{storage_type['mount_source']}/#{body['namespace']}/#{app_name}"
-          mount_param = "--mount type=#{storage_type['mount_type']},src=#{mount_src},dst=#{storage['mount_target']}"
+        if body['data']['storage'].any?
+          storage = body['data']['storage'].pop
+          storage_type = get_storage_type_by_name(body['data']['storage_types'], storage['storage_type_name'])
+          if storage_type
+            mount_src = "#{storage_type['mount_source']}/#{body['data']['namespace']}/#{app_name}"
+            mount_param = "--mount type=#{storage_type['mount_type']},src=#{mount_src},dst=#{storage['mount_target']}"
+          end
         end
       end
       mount_param
     end
+
+    def self.get_storage_type_by_name(storage_types, name)
+      storage_types.each do |storage_type|
+        return storage_type if storage_type['name'] == name
+      end
+      nil
+    end
   end
 end

data/lib/gleis/version.rb

@@ -1,3 +1,3 @@
 module Gleis
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gleis
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Marc Bigler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-02 00:00:00.000000000 Z
+date: 2018-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.20.0
 description: Command-line interface to deploy and manage your Rails apps on the Swiss
-  PaaS named Gleis
+  PaaS https://gleis.cloud
 email:
 - gleis@towards.ch
 executables:
@@ -140,10 +140,12 @@ files:
 - lib/gleis/addon.rb
 - lib/gleis/api.rb
 - lib/gleis/application.rb
+- lib/gleis/auth_key.rb
 - lib/gleis/authentication.rb
 - lib/gleis/cli/addon.rb
 - lib/gleis/cli/app.rb
 - lib/gleis/cli/auth.rb
+- lib/gleis/cli/auth_key.rb
 - lib/gleis/cli/db.rb
 - lib/gleis/cli/domain.rb
 - lib/gleis/cli/management.rb
@@ -185,5 +187,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Gleis CLI to deploy and manage Rails apps on Gleis PaaS
+summary: Gleis CLI to deploy and manage Rails apps on the Gleis PaaS
 test_files: []