gleis 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e259aa0549f7f0a6e982128032b6229870ec360d1f8ff5df5cde09d0b56ac46b
-  data.tar.gz: 79c8e30feb451306648f510cc03fabdfc7d1d38f5c80c722c18e70b0baa5781d
+  metadata.gz: 130f0b723f904109cb4cb38df148a8dc5a7748e40e3e4106ea646a004ccf1aa8
+  data.tar.gz: 2a9754ec31b238984825eb7d6a22f54e90528de1b3feb6c178f765bb18375057
 SHA512:
-  metadata.gz: c9c407ddec056aa78d8b05675bdc7563444aa5978eb0cdf073fda9bffa62ad7ed348d1cfde96a51e4fe1ff6ff1405e31985e305d6bba6b8cf01c2b7f0eece7a5
-  data.tar.gz: ad2c83adeab38fe45a52024f2e9df85ca2f6fc2f370b4aa9220079ed00ab0b20048e26793b9c4e3c06f2eb0345cb36c313a5d60b90b70795598be63b1cc731af
+  metadata.gz: b122513b42305f9764f184e65772db36fb7bcec1743e9404b3836c8c78d2efe0ed01f7a1c9445ddf83a4a2032b816c0b54fa245fa3af87b840d99234ed76c297
+  data.tar.gz: 5cb296c2bfcf9529328a7efaf73efa34963deffbf1bb7097d5fd831820089707f79cd077ab91e4fe3a2235bdbfa1ecc526da95051509d4f55b4ac36545d5fe04

data/CHANGELOG.md

@@ -5,6 +5,28 @@ 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.5.0 - 2019-02-25
+
+### Added
+
+- New command called scheduler in order to manage scheduled job for an app
+- Parameter --process/-p to app logs command to specify the process type (default: web)
+- Check for new version of CLI after successfull login
+
+### Changed
+
+- Status of app to inform under the Deployment field in case the app has not yet been deployed
+- Forbidden rescue in API request to handle the case where the message is provided by the API
+
+### Fixed
+
+- Wrong command description for removing an add-on
+- Alias command parameters to include a leading dash
+
+### Removed
+
+- Support for legacy rest-client (version <2.0) in API request
+
 ## 0.4.0 - 2019-02-10
 
 ### Added

data/lib/gleis/api.rb

@@ -5,8 +5,6 @@ module Gleis
   class API
     def self.request(method, action, token = nil, body = {})
       url = Config::API_URL + Config::API_VERSION + '/cli/' + action
-      # Support legacy rest-client (<2.0) which does not have RestClient::NotFound
-      notfound_exception = defined?(RestClient::ResourceNotFound) ? RestClient::ResourceNotFound : RestClient::NotFound
       begin
         case method
         when 'get', 'delete'
@@ -23,9 +21,14 @@ module Gleis
         abort('Authentication failed.')
       rescue RestClient::Unauthorized
         abort('Not authenticated, please login first.')
-      rescue RestClient::Forbidden
-        abort('You do not have the required permissions, please contact the app owner.')
-      rescue notfound_exception
+      rescue RestClient::Forbidden => e
+        message = if e.response.body.empty?
+                    'You do not have the required permissions, please contact the app owner.'
+                  else
+                    JSON.parse(e.response.body)['message']
+                  end
+        abort(message)
+      rescue RestClient::NotFound
         abort('Application not found.')
       rescue RestClient::InternalServerError
         abort('An error occured on the platform. Please contact support if this problem persists.')

data/lib/gleis/application.rb

@@ -108,14 +108,16 @@ module Gleis
       end
     end
 
-    def self.logs(app_name)
+    def self.logs(app_name, process)
       token = Token.check
-      action = 'logs/' + app_name
+      action = "logs/#{app_name}/#{process}"
       body = API.request('get', action, token)
-      if body['log'].nil? || body['log'].empty?
+      if body['log'].nil?
+        puts 'Failed to get logs: ' + body['message']
+      elsif body['log'].empty?
         puts 'No log entries found yet.'
       else
-        puts "Last 100 lines of consolidated log output for #{app_name}:"
+        puts "Most recent entries of consolidated log for #{app_name} (#{process} process):"
         puts
         puts body['log']
       end
@@ -196,13 +198,15 @@ module Gleis
       puts "Status of app #{app_name}:\n\n"
       if body['success'] == 1
         status = body['data']
-        if status['deployment_commit'] && status['deployment_version']
-          deployment = "\tDeployment:\t#{status['deployment_commit']} (v#{status['deployment_version']})\n"
-        end
+        deployment = if status['deployment_commit'] && status['deployment_version']
+                       "#{status['deployment_commit']} (v#{status['deployment_version']})"
+                     else
+                       'app not deployed yet'
+                     end
         puts "\tStatus:\t\trunning\n" \
              "\tStarted at:\t#{Time.parse(status['createdat']).localtime.strftime('%c')}\n" \
              "\tUpdated at:\t#{Time.parse(status['updatedat']).localtime.strftime('%c')}\n" \
-             "#{deployment}" \
+             "\tDeployment:\t#{deployment}\n" \
              "\tUpdate count:\t#{status['forceupdate']}\n" \
              "\tReplicas:\t#{status['replicas']}"
       else

data/lib/gleis/authentication.rb

@@ -16,6 +16,8 @@ module Gleis
       ssh_key_filename = Config::SSH_KEY_FILE_BASE + '_' + Utils.convert_username_to_filename(username)
       AuthKey.add("#{ssh_key_filename}.pub", nil, true) \
         if skip_keygen == false && SSH.generate_key(ssh_key_filename, username)
+      puts "\nINFO: New Gleis CLI version available, please update by running \"gem update gleis\"\n\n" \
+        if Utils.update_available?(Params.get_cli_parameters(token)['version'])
     end
 
     def self.register(email)

data/lib/gleis/cli/addon.rb

@@ -2,7 +2,7 @@ module Gleis
   module CLI
     # Add-ons-related CLI commands
     class Addon < Thor
-      class_option :app, aliases: :a, type: :string, default: Utils.app_name, desc: 'Name of application'
+      class_option :app, aliases: :'-a', type: :string, default: Utils.app_name, desc: 'Name of application'
 
       desc 'add ADDON', 'Add add-on to app'
       def add(name)
@@ -14,7 +14,7 @@ module Gleis
         Gleis::Addon.list(options[:app])
       end
 
-      desc 'remove ADDON', 'Add add-on to app'
+      desc 'remove ADDON', 'Remove add-on from app'
       def remove(name)
         Gleis::Addon.remove(options[:app], name)
       end

data/lib/gleis/cli/app.rb

@@ -2,7 +2,7 @@ module Gleis
   module CLI
     # Application-related CLI commands
     class App < Thor
-      class_option :app, aliases: :a, type: :string, default: Utils.app_name, desc: 'Name of application'
+      class_option :app, aliases: :'-a', type: :string, default: Utils.app_name, desc: 'Name of application'
 
       desc 'config [VAR=value]', 'Show, set or delete environment variables'
       def config(env_var = '')
@@ -24,20 +24,22 @@ module Gleis
         Application.deployments(options[:app])
       end
 
-      desc 'exec COMMAND', 'Execute a one-time-command (e.g. rails db:migrate)'
+      desc 'exec COMMAND', 'Execute a one-time-command (e.g. "rails db:migrate")'
       def exec(command)
         Application.exec(options[:app], command)
       end
 
       desc 'git', 'Show URL of git repository'
-      option :quiet, aliases: :q, type: :boolean, default: false
+      option :quiet, aliases: :'-q', type: :boolean, default: false
       def git
         Application.git(options[:app], options[:quiet])
       end
 
-      desc 'logs', 'View last log entries'
+      desc 'logs', 'View last log entries of a process'
+      option :process, aliases: :'-p', type: :string, default: 'web',
+                       desc: 'Process type (valid types are: scheduler, worker and web)'
       def logs
-        Application.logs(options[:app])
+        Application.logs(options[:app], options[:process])
       end
 
       desc 'maintenance', 'Enable or disable maintenance mode'

data/lib/gleis/cli/auth.rb

@@ -6,7 +6,7 @@ module Gleis
       subcommand 'key', CLI::AuthKey
 
       desc 'login USERNAME [PASSWORD]', 'Login into Gleis'
-      option :skip_keygen, aliases: :s, type: :boolean, default: false
+      option :skip_keygen, aliases: :'-s', type: :boolean, default: false
       def login(username, password = nil)
         Authentication.login(username, password, options[:skip_keygen])
       end

data/lib/gleis/cli/db.rb

@@ -2,7 +2,7 @@ module Gleis
   module CLI
     # Database-related CLI subcommands
     class Db < Thor
-      class_option :app, aliases: :a, type: :string, default: Utils.app_name, desc: 'Name of application'
+      class_option :app, aliases: :'-a', type: :string, default: Utils.app_name, desc: 'Name of application'
 
       desc 'backup', 'Backup locally database DATABASE_URL'
       def backup

data/lib/gleis/cli/domain.rb

@@ -2,7 +2,7 @@ module Gleis
   module CLI
     # Domain-related CLI commands
     class Domain < Thor
-      class_option :app, aliases: :a, type: :string, default: Utils.app_name, desc: 'Name of application'
+      class_option :app, aliases: :'-a', type: :string, default: Utils.app_name, desc: 'Name of application'
 
       desc 'add DOMAIN', 'Add domain name to app'
       def add(name)

data/lib/gleis/cli/scheduler.rb

@@ -0,0 +1,27 @@
+module Gleis
+  module CLI
+    # Add-ons-related CLI commands
+    class Scheduler < Thor
+      class_option :app, aliases: :'-a', type: :string, default: Utils.app_name, desc: 'Name of application'
+
+      desc 'add COMMAND', 'Add command to be scheduled for this app'
+      option :frequency, aliases: :'-f', type: :string, required: true,
+                         desc: 'Frequency to run job: 10minutes, hourly or daily'
+      option :time, aliases: :'-t', type: :string,
+                    desc: 'Time in HH:MM format to run a job for the hourly (e.g. :15) or daily (e.g. 23:30) frequency'
+      def add(command)
+        Gleis::Scheduler.add(options[:app], options[:frequency], options[:time], command)
+      end
+
+      desc 'list', 'List scheduled job for this app'
+      def list
+        Gleis::Scheduler.list(options[:app])
+      end
+
+      desc 'remove', 'Remove scheduled job from app'
+      def remove
+        Gleis::Scheduler.remove(options[:app])
+      end
+    end
+  end
+end

data/lib/gleis/cli/sharing.rb

@@ -2,7 +2,7 @@ module Gleis
   module CLI
     # Sharing-related CLI commands
     class Sharing < Thor
-      class_option :app, aliases: :a, type: :string, default: Utils.app_name, desc: 'Name of application'
+      class_option :app, aliases: :'-a', type: :string, default: Utils.app_name, desc: 'Name of application'
 
       desc 'add EMAIL ROLE', 'Allow user to access app (roles: collaborator, owner)'
       def add(email, role)

data/lib/gleis/cli/storage.rb

@@ -2,7 +2,7 @@ module Gleis
   module CLI
     # Storage-related CLI commands
     class Storage < Thor
-      class_option :app, aliases: :a, type: :string, default: Utils.app_name, desc: 'Name of application'
+      class_option :app, aliases: :'-a', type: :string, default: Utils.app_name, desc: 'Name of application'
 
       desc 'add TYPE', 'Add storage to app'
       def add(type)
@@ -20,7 +20,7 @@ module Gleis
       end
 
       desc 'sync DIRECTORY', 'Synchronise local directory to Gleis storage (from local to remote)'
-      option :reverse, aliases: :x, type: :boolean, default: false,
+      option :reverse, aliases: :'-x', type: :boolean, default: false,
                        desc: 'Reverse synchronisation (from remote to local)'
       def sync(dir)
         Gleis::Storage.sync(options[:app], dir, options[:reverse])

data/lib/gleis/main.rb

@@ -32,6 +32,9 @@ module Gleis
     desc 'mgmt COMMAND', 'Administration and management related commands'
     subcommand 'mgmt', CLI::Management
 
+    desc 'scheduler COMMAND', 'Manage scheduled job: add, list, remove'
+    subcommand 'scheduler', CLI::Scheduler
+
     desc 'sharing COMMAND', 'Manage collaboration: add, list, remove'
     subcommand 'sharing', CLI::Sharing
 

data/lib/gleis/scheduler.rb

@@ -0,0 +1,44 @@
+module Gleis
+  # The class implements the methods required to manage the scheduler service of a Gleis app
+  class Scheduler
+    def self.add(app_name, frequency, time, command)
+      token = Token.check
+      body = API.request('post', 'scheduler', token, 'name': app_name, 'frequency': frequency, 'time': time,
+                                                     'command': command)
+      if body['success'] == 1
+        puts "Successfully added scheduler job to #{app_name}."
+      else
+        puts "Failed to add scheduler job: #{body['message']}"
+      end
+    end
+
+    def self.list(app_name)
+      token = Token.check
+      body = API.request('get', "scheduler/#{app_name}", token)
+      jobs = body ['data']
+      if jobs.first.empty?
+        puts 'No scheduled jobs.'
+      else
+        puts "List of scheduled jobs:\n\n"
+        printf("\t%s\n", 'TIME')
+        printf("\t%-30s %-15s %s\n", 'COMMAND', 'FREQUENCY', 'LAST RUN')
+        printf("\t%-30s %-15s %s\n\n", '-------', '---------', '--------')
+        jobs.each do |job|
+          last_run = job['last_run'] ? Time.parse(job['last_run']).localtime.strftime('%c') : 'never'
+          printf("\t%-30s %-15s %s\n", job['cron_time'], job['frequency'], last_run)
+          puts "\t#{job['command']}\n\n"
+        end
+      end
+    end
+
+    def self.remove(app_name)
+      token = Token.check
+      body = API.request('delete', "scheduler/#{app_name}", token)
+      if body['success'] == 1
+        puts "Successfully removed scheduled job from #{app_name}."
+      else
+        puts "Failed to remove scheduled job: #{body['message']}"
+      end
+    end
+  end
+end

data/lib/gleis/utils.rb

@@ -115,5 +115,9 @@ module Gleis
       end
       nil
     end
+
+    def self.update_available?(actual_version)
+      Gem::Version.new(Gleis::VERSION) < Gem::Version.new(actual_version)
+    end
   end
 end

data/lib/gleis/version.rb

@@ -1,3 +1,3 @@
 module Gleis
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/gleis.rb

@@ -11,6 +11,7 @@ require 'gleis/cli/auth'
 require 'gleis/cli/db'
 require 'gleis/cli/domain'
 require 'gleis/cli/management'
+require 'gleis/cli/scheduler'
 require 'gleis/cli/sharing'
 require 'gleis/cli/storage'
 require 'gleis/config'
@@ -18,6 +19,7 @@ require 'gleis/database'
 require 'gleis/domain'
 require 'gleis/management'
 require 'gleis/params'
+require 'gleis/scheduler'
 require 'gleis/sharing'
 require 'gleis/ssh'
 require 'gleis/storage'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gleis
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Marc Bigler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-10 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,6 +149,7 @@ files:
 - lib/gleis/cli/db.rb
 - lib/gleis/cli/domain.rb
 - lib/gleis/cli/management.rb
+- lib/gleis/cli/scheduler.rb
 - lib/gleis/cli/sharing.rb
 - lib/gleis/cli/storage.rb
 - lib/gleis/config.rb
@@ -157,6 +158,7 @@ files:
 - lib/gleis/main.rb
 - lib/gleis/management.rb
 - lib/gleis/params.rb
+- lib/gleis/scheduler.rb
 - lib/gleis/sharing.rb
 - lib/gleis/ssh.rb
 - lib/gleis/storage.rb