cyclid-client 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb286d1fdb3a5a900ad24f35c41fff997b9403eb
-  data.tar.gz: d62a803b0a9597605906bedc394a1277d9e9bf45
+  metadata.gz: 078b4e179f24bb0cd378bcd6993fd834bdcb4555
+  data.tar.gz: 0abab651a16850f267229149a11ebd59e58b089e
 SHA512:
-  metadata.gz: 8f5a28f869c93715ff81ff3e25da32bf088f9a2ca417a78708a9845aa6ab7312a8decafd3dd8e688888bc1a2ed70e99f0b3e66b909172843dc626614489f3916
-  data.tar.gz: 614077b06d871c421644adc3ccd0ad10af187521a6afb6a35bfcfe84d697fe46183750d1f4490b7f9568266a4e2176b5c0f79c86b57fa9aa648c178a10e9d1cb
+  metadata.gz: 6635460d43ba93794cf903263d3b0f6341965b79cdd17ef5b1f5c06b5a42df653205c0c997039198a88f55c1ba143397c7f03f70037208e2db305cbf17108026
+  data.tar.gz: 696dd68c6329ac1159616b6174445543ab0c9ee162e2b1f0c9404a3401cdea245b505eed71e76d5c4eecea013f77707f71d84316289ae801ada9b711a495672b

data/lib/cyclid/cli/admin.rb

@@ -28,6 +28,9 @@ module Cyclid
       desc 'organization', 'Manage organizations'
       subcommand 'organization', AdminOrganization
       map 'org' => :organization
+
+      desc 'job', 'Manage jobs'
+      subcommand 'job', AdminJob
     end
   end
 end

data/lib/cyclid/cli/admin/job.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Cyclid
+  module Cli
+    # 'admin job' sub-commands
+    class AdminJob < Thor
+      desc 'list NAME', 'List all jobs for the organization NAME'
+      def list(name)
+        stats = client.job_stats(name)
+        all = client.job_list(name, limit: stats['total'])
+        jobs = all['records']
+
+        jobs.each do |job|
+          Formatter.colorize 'Name', (job['job_name'] || '')
+          Formatter.colorize "\tJob", job['id'].to_s
+          Formatter.colorize "\tVersion", (job['job_version'] || '')
+        end
+      rescue StandardError => ex
+        abort "Failed to get job list: #{ex}"
+      end
+
+      desc 'stats NAME', 'Show statistics about jobs for the organization NAME'
+      def stats(name)
+        stats = client.job_stats(name)
+
+        Formatter.colorize 'Total jobs', stats['total'].to_s
+      rescue StandardError => ex
+        abort "Failed to get job list: #{ex}"
+      end
+    end
+  end
+end

data/lib/cyclid/cli/admin/organization.rb

@@ -36,16 +36,16 @@ module Cyclid
         public_key = OpenSSL::PKey::RSA.new(der_key)
 
         # Pretty print the organization details
-        puts 'Name: '.colorize(:cyan) + org['name']
-        puts 'Owner Email: '.colorize(:cyan) + org['owner_email']
-        puts 'Public Key: '.colorize(:cyan) + public_key.to_pem
-        puts 'Members:'.colorize(:cyan)
+        Formatter.colorize 'Name', org['name']
+        Formatter.colorize 'Owner Email', org['owner_email']
+        Formatter.colorize 'Public Key', public_key.to_pem
+        Formatter.colorize 'Members:'
         if org['users'].any?
           org['users'].each do |user|
-            puts "\t#{user}"
+            Formatter.puts "\t#{user}"
           end
         else
-          puts "\tNone"
+          Formatter.puts "\tNone"
         end
       rescue StandardError => ex
         abort "Failed to get organization: #{ex}"
@@ -107,7 +107,7 @@ module Cyclid
         if options[:force]
           delete = true
         else
-          print "Delete organization #{name}: are you sure? (Y/n): ".colorize(:red)
+          Formatter.ask "Delete organization #{name}: are you sure? (Y/n)"
           delete = STDIN.getc.chr.casecmp('y').zero?
         end
         abort unless delete

data/lib/cyclid/cli/admin/user.rb

@@ -32,16 +32,16 @@ module Cyclid
         user = client.user_get(username)
 
         # Pretty print the user details
-        puts 'Username: '.colorize(:cyan) + user['username']
-        puts 'Name: '.colorize(:cyan) + (user['name'] || '')
-        puts 'Email: '.colorize(:cyan) + user['email']
-        puts 'Organizations:'.colorize(:cyan)
+        Formatter.colorize 'Username', user['username']
+        Formatter.colorize 'Name', (user['name'] || '')
+        Formatter.colorize 'Email', user['email']
+        Formatter.colorize 'Organizations:'
         if user['organizations'].any?
           user['organizations'].each do |org|
-            puts "\t#{org}"
+            Formatter.puts "\t#{org}"
           end
         else
-          puts "\tNone"
+          Formatter.puts "\tNone"
         end
       rescue StandardError => ex
         abort "Failed to get user: #{ex}"
@@ -127,7 +127,7 @@ module Cyclid
         if options[:force]
           delete = true
         else
-          print "Delete user #{username}: are you sure? (Y/n): ".colorize(:red)
+          Formatter.ask "Delete user #{username}: are you sure? (Y/n)"
           delete = STDIN.getc.chr.casecmp('y').zero?
         end
         abort unless delete

data/lib/cyclid/cli/formatter.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'colorize'
+
+module Cyclid
+  module Cli
+    # Output formatter
+    module Formatter
+      # Output with no additional formatting
+      class Base
+        class << self
+          def puts(title, *args)
+            t = if args.empty?
+                  title
+                else
+                  "#{title}: "
+                end
+            Kernel.puts t + args.join
+          end
+          alias colorize puts
+
+          def ask(question)
+            print "#{question}: "
+          end
+        end
+      end
+
+      # Output with XTerm compatible color
+      class Terminal < Base
+        class << self
+          def colorize(title, *args)
+            t = if args.empty?
+                  title
+                else
+                  "#{title}: "
+                end
+            Kernel.puts t.colorize(:cyan) + args.join
+          end
+
+          def ask(question)
+            print "#{question}: ".colorize(:red)
+          end
+        end
+      end
+
+      class << self
+        def method_missing(method, *args, &block) # rubocop:disable Style/MethodMissing
+          @formatter ||= get
+          @formatter.send(method, *args, &block)
+        end
+
+        private
+
+        def get
+          STDOUT.tty? ? Terminal : Base
+        end
+      end
+    end
+  end
+end

data/lib/cyclid/cli/job.rb

@@ -63,7 +63,7 @@ module Cyclid
         end
 
         job_info = client.job_submit(client.config.organization, job, job_type)
-        puts 'Job: '.colorize(:cyan) + job_info['job_id'].to_s
+        Formatter.colorize 'Job', job_info['job_id'].to_s
       rescue StandardError => ex
         abort "Failed to submit job: #{ex}"
       end
@@ -78,13 +78,17 @@ module Cyclid
         started = job['started'].nil? ? nil : Time.parse(job['started'])
         ended = job['ended'].nil? ? nil : Time.parse(job['ended'])
 
+        # Calculate the duration if the job contains a valid start & end time
+        duration = (Time.new(0) + (ended - started) if started && ended)
+
         # Pretty-print the job details (without the log)
-        puts 'Job: '.colorize(:cyan) + job['id'].to_s
-        puts 'Name: '.colorize(:cyan) + (job['job_name'] || '')
-        puts 'Version: '.colorize(:cyan) + (job['job_version'] || '')
-        puts 'Started: '.colorize(:cyan) + (started ? started.asctime : '')
-        puts 'Ended: '.colorize(:cyan) + (ended ? ended.asctime : '')
-        puts 'Status: '.colorize(:cyan) + status
+        Formatter.colorize 'Job', job['id'].to_s
+        Formatter.colorize 'Name', (job['job_name'] || '')
+        Formatter.colorize 'Version', (job['job_version'] || '')
+        Formatter.colorize 'Started', (started ? started.asctime : '')
+        Formatter.colorize 'Ended', (ended ? ended.asctime : '')
+        Formatter.colorize 'Duration', duration.strftime('%H:%M:%S') if duration
+        Formatter.colorize 'Status', status
       rescue StandardError => ex
         abort "Failed to get job status: #{ex}"
       end
@@ -97,7 +101,7 @@ module Cyclid
         status = Cyclid::API::Constants::JOB_STATUSES[status_id]
 
         # Pretty-print the job status
-        puts 'Status: '.colorize(:cyan) + status
+        Formatter.colorize 'Status', status
       rescue StandardError => ex
         abort "Failed to get job status: #{ex}"
       end
@@ -110,6 +114,30 @@ module Cyclid
       rescue StandardError => ex
         abort "Failed to get job log: #{ex}"
       end
+
+      desc 'list', 'List all jobs'
+      def list
+        stats = client.job_stats(client.config.organization)
+        all = client.job_list(client.config.organization, limit: stats['total'])
+        jobs = all['records']
+
+        jobs.each do |job|
+          Formatter.colorize 'Name', (job['job_name'] || '')
+          Formatter.colorize "\tJob", job['id'].to_s
+          Formatter.colorize "\tVersion", (job['job_version'] || '')
+        end
+      rescue StandardError => ex
+        abort "Failed to get job list: #{ex}"
+      end
+
+      desc 'stats', 'Show statistics about jobs'
+      def stats
+        stats = client.job_stats(client.config.organization)
+
+        Formatter.colorize 'Total jobs', stats['total'].to_s
+      rescue StandardError => ex
+        abort "Failed to get job list: #{ex}"
+      end
     end
   end
 end

data/lib/cyclid/cli/organization.rb

@@ -31,10 +31,10 @@ module Cyclid
         public_key = OpenSSL::PKey::RSA.new(der_key)
 
         # Pretty print the organization details
-        puts 'Name: '.colorize(:cyan) + org['name']
-        puts 'Owner Email: '.colorize(:cyan) + org['owner_email']
-        puts 'Public Key: '.colorize(:cyan) + public_key.to_pem
-        puts 'Members:'.colorize(:cyan)
+        Formatter.colorize 'Name', org['name']
+        Formatter.colorize 'Owner Email', org['owner_email']
+        Formatter.colorize 'Public Key', public_key.to_pem
+        Formatter.colorize 'Members'
         if org['users'].any?
           org['users'].each do |user|
             puts "\t#{user}"
@@ -70,11 +70,12 @@ module Cyclid
             # Create a Config from this file and display the details
             config = Cyclid::Client::Config.new(path: fname)
 
-            puts File.basename(fname).colorize(:cyan)
-            uri = URI::HTTP.build(host: config.server, port: config.port)
-            puts "\tServer: ".colorize(:cyan) + uri.to_s
-            puts "\tOrganization: ".colorize(:cyan) + config.organization
-            puts "\tUsername: ".colorize(:cyan) + config.username
+            Formatter.colorize File.basename(fname)
+            scheme = config.tls ? URI::HTTPS : URI::HTTP
+            uri = scheme.build(host: config.server, port: config.port)
+            Formatter.colorize "\tURL", uri.to_s
+            Formatter.colorize "\tOrganization", config.organization
+            Formatter.colorize "\tUsername", config.username
           rescue StandardError => ex
             $stderr.puts "Failed to load config file #{fname}: #{ex}"
           end
@@ -114,7 +115,7 @@ module Cyclid
           # The configuration file exists and appears to be sane, so switch the
           # 'config' symlink to point to it.
           Dir.chdir(CYCLID_CONFIG_DIR) do
-            File.delete('config')
+            File.delete('config') if File.exist?('config')
             File.symlink(name, 'config')
           end
         end

data/lib/cyclid/cli/organization/config.rb

@@ -30,32 +30,32 @@ module Cyclid
           case type
           when 'string', 'integer'
             data = config[name] || 'Not set'
-            puts "#{setting['description']}: ".colorize(:cyan) + data
+            Formatter.colorize setting['description'], data
           when 'password'
             data = config[name] ? '*' * config[name].length : 'Not set'
-            puts "#{setting['description']}: ".colorize(:cyan) + data
+            Formatter.colorize setting['description'], data
           when 'boolean'
             data = config[name] || 'Not set'
-            puts "#{setting['description']}: ".colorize(:cyan) + (data ? 'true' : 'false')
+            Formatter.colorize setting['description'], (data ? 'true' : 'false')
           when 'list'
-            puts setting['description'].colorize(:cyan)
+            Formatter.colorize setting['description']
             data = config[name]
             if data.empty?
-              puts "\tNone"
+              Formatter.puts "\tNone"
             else
               data.each do |item|
-                puts "\t#{item}"
+                Formatter.puts "\t#{item}"
               end
             end
           when 'hash-list'
-            puts setting['description'].colorize(:cyan)
+            Formatter.colorize setting['description']
             data = config[name]
             if data.empty?
-              puts "\tNone"
+              Formatter.puts "\tNone"
             else
               data.each do |item|
                 item.each do |k, v|
-                  puts "\t#{k}: #{v}"
+                  Formatter.puts "\t#{k}: #{v}"
                 end
               end
             end

data/lib/cyclid/cli/organization/member.rb

@@ -82,11 +82,11 @@ module Cyclid
         user = client.org_user_get(client.config.organization, user)
 
         # Pretty print the user details
-        puts 'Username: '.colorize(:cyan) + user['username']
-        puts 'Email: '.colorize(:cyan) + user['email']
-        puts 'Permissions'.colorize(:cyan)
+        Formatter.colorize 'Username', user['username']
+        Formatter.colorize 'Email: ', user['email']
+        Formatter.colorize 'Permissions'
         user['permissions'].each do |k, v|
-          puts "\t#{k.capitalize}: ".colorize(:cyan) + v.to_s
+          Formatter.colorize "\t#{k.capitalize}", v.to_s
         end
       rescue StandardError => ex
         abort "Failed to get user: #{ex}"
@@ -110,7 +110,7 @@ module Cyclid
             if options[:force]
               true
             else
-              print "Remove user #{user}: are you sure? (Y/n): ".colorize(:red)
+              Formatter.ask "Remove user #{user}: are you sure? (Y/n)"
               STDIN.getc.chr.casecmp('y').zero?
             end
           end

data/lib/cyclid/cli/secret.rb

@@ -34,7 +34,7 @@ module Cyclid
         # Encrypt with the public key
         encrypted = public_key.public_encrypt(secret)
 
-        puts 'Secret: '.colorize(:cyan) + Base64.strict_encode64(encrypted)
+        Formatter.colorize 'Secret', Base64.strict_encode64(encrypted)
       rescue StandardError => ex
         abort "Failed to encrypt secret: #{ex}"
       end

data/lib/cyclid/cli/stage.rb

@@ -21,7 +21,7 @@ module Cyclid
       def list
         stages = client.stage_list(client.config.organization)
         stages.each do |stage|
-          puts "#{stage[:name]} v#{stage[:version]}"
+          Formatter.puts "#{stage[:name]} v#{stage[:version]}"
         end
       rescue StandardError => ex
         abort "Failed to get stages: #{ex}"
@@ -33,14 +33,14 @@ module Cyclid
 
         # Pretty print the stage details
         stages.each do |stage|
-          puts 'Name: '.colorize(:cyan) + stage['name']
-          puts 'Version: '.colorize(:cyan) + stage['version']
-          puts 'Steps'.colorize(:cyan)
+          Formatter.colorize 'Name', stage['name']
+          Formatter.colorize 'Version', stage['version']
+          Formatter.colorize 'Steps'
           stage['steps'].each do |step|
-            puts "\t\tAction: ".colorize(:cyan) + step['action']
+            Formatter.colorize"\t\tAction", step['action']
             step.delete('action')
             step.each do |k, v|
-              puts "\t\t#{k.capitalize}: ".colorize(:cyan) + v.to_s
+              Formatter.colorize "\t\t#{k.capitalize}: ", v.to_s
             end
           end
         end

data/lib/cyclid/cli/user.rb

@@ -25,16 +25,16 @@ module Cyclid
         user = client.user_get(client.config.username)
 
         # Pretty print the user details
-        puts 'Username: '.colorize(:cyan) + user['username']
-        puts 'Name: '.colorize(:cyan) + (user['name'] || '')
-        puts 'Email: '.colorize(:cyan) + user['email']
-        puts 'Organizations'.colorize(:cyan)
+        Formatter.colorize 'Username', user['username']
+        Formatter.colorize 'Name', (user['name'] || '')
+        Formatter.colorize 'Email', user['email']
+        Formatter.colorize 'Organizations'
         if user['organizations'].any?
           user['organizations'].each do |org|
-            puts "\t#{org}"
+            Formatter.puts "\t#{org}"
           end
         else
-          puts "\tNone"
+          Formatter.puts "\tNone"
         end
       rescue StandardError => ex
         abort "Failed to get user: #{ex}"
@@ -80,6 +80,62 @@ module Cyclid
           abort "Failed to modify user: #{ex}"
         end
       end
+
+      desc 'authenticate', 'Authenticate your client with a server'
+      long_desc <<-LONGDESC
+        Authenticate against a Cyclid server with your username & password and
+        create your client configuration files.
+
+        The --server option sets the Cyclid server URL. The default is 'https://api.cyclid.io'
+
+        The --username option sets your username to authenticate with.
+      LONGDESC
+
+      option :server, aliases: '-s'
+      option :username, aliases: '-u'
+      def authenticate
+        url = options[:server] || 'https://api.cyclid.io'
+        username = options[:username]
+
+        # Get the username if one wasn't provided
+        if username.nil?
+          print 'Username: '
+          username = STDIN.gets.chomp
+        end
+
+        # Get the users password
+        print 'Password: '
+        password = STDIN.noecho(&:gets).chomp
+        puts
+
+        # Create a client that can authenticate with HTTP BASIC
+        Formatter.colorize "Authenticating #{username} with #{url}"
+
+        basic_client = Cyclid::Client::Tilapia.new(auth: Cyclid::Client::AuthMethods::AUTH_BASIC,
+                                                   url: url,
+                                                   username: username,
+                                                   password: password,
+                                                   log_level: debug?)
+
+        # Get the user information
+        user = basic_client.user_get(username)
+
+        # Ensure the configuration directory exists
+        Dir.mkdir(CYCLID_CONFIG_DIR, 0o700) unless Dir.exist? CYCLID_CONFIG_DIR
+
+        # Generate a configuration file for each organization
+        user['organizations'].each do |org|
+          Formatter.colorize "Creating configuration file for organization #{org}"
+
+          org_config = File.new(File.join(CYCLID_CONFIG_DIR, org), 'w+', 0o600)
+          org_config.write "url: #{url}\n"
+          org_config.write "organization: #{org}\n"
+          org_config.write "username: #{username}\n"
+          org_config.write "secret: #{user['secret']}\n"
+        end
+      rescue StandardError => ex
+        abort "Failed to authenticate user: #{ex}"
+      end
     end
   end
 end

data/lib/cyclid/client.rb

@@ -83,10 +83,12 @@ module Cyclid
       private
 
       # Build a URI for the configured server & required resource
-      def server_uri(path)
-        URI::HTTP.build(host: @config.server,
-                        port: @config.port,
-                        path: path)
+      def server_uri(path, query = nil)
+        scheme = @config.tls ? URI::HTTPS : URI::HTTP
+        scheme.build(host: @config.server,
+                     port: @config.port,
+                     path: URI.escape(path),
+                     query: query ? URI.escape(query) : nil)
       end
 
       def method_missing(method, *args, &block) # rubocop:disable Style/MethodMissing

data/lib/cyclid/client/api.rb

@@ -79,6 +79,8 @@ module Cyclid
         # Perform an API HTTP request & return the parsed response body
         def api_request(uri, req)
           http = Net::HTTP.new(uri.hostname, uri.port)
+          http.use_ssl = uri.scheme == 'https'
+
           res = http.request(req)
 
           parse_response(res)

data/lib/cyclid/client/job.rb

@@ -84,6 +84,25 @@ module Cyclid
 
         return res_data
       end
+
+      def job_stats(organization)
+        uri = server_uri("/organizations/#{organization}/jobs", 'stats_only=true')
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      def job_list(organization, args = {})
+        # Convert the args hash into a query string
+        query = args.map { |k, v| "#{k}=#{v}" }.join('&')
+
+        uri = server_uri("/organizations/#{organization}/jobs", query)
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
     end
   end
 end

data/lib/cyclid/config.rb

@@ -14,13 +14,23 @@
 # limitations under the License.
 
 require 'yaml'
+require 'uri'
 require 'cyclid/auth_methods'
 
 module Cyclid
   module Client
     # Cyclid client per-organization configuration
     class Config
-      attr_reader :auth, :server, :port, :organization, :username, :secret, :password, :token, :path
+      attr_reader :auth,
+                  :server,
+                  :port,
+                  :tls,
+                  :organization,
+                  :username,
+                  :secret,
+                  :password,
+                  :token,
+                  :path
       # @!attribute [r] auth
       #   @return [Fixnum] the authentication method. (Default is AUTH_HMAC)
       # @!attribute [r] server
@@ -71,19 +81,34 @@ module Cyclid
         end
 
         # Set defaults from the options
+        @url = options[:url] || nil
         @server = options[:server] || nil
         @port = options[:port] || nil
+        @tls = options[:tls] || nil
         @organization = options[:organization] || nil
         @username = options[:username] || nil
 
         # Get anything provided in the config file
         if @config
+          @url ||= @config['url']
           @server ||= @config['server']
           @port ||= @config['port'] || 8361
+          @tls ||= @config['tls'] || false
           @organization ||= @config['organization']
           @username ||= @config['username']
         end
 
+        # Parse the URL if one was given
+        if @url
+          uri = URI.parse(@url)
+
+          # Items parsed from the uri always over-write any individual
+          # configuration settings
+          @server = uri.host
+          @port = uri.port
+          @tls = uri.scheme == 'https' ? true : false
+        end
+
         # Server & Username *must* be set
         raise 'server address must be provided' if @server.nil?
         raise 'username must be provided' if @username.nil? and @auth != AUTH_NONE

data/lib/cyclid/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Cyclid
   module Client
-    VERSION = '0.3.3'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cyclid-client
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Kristian Van Der Vliet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-10 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -108,8 +108,10 @@ files:
 - lib/cyclid/auth_methods.rb
 - lib/cyclid/cli.rb
 - lib/cyclid/cli/admin.rb
+- lib/cyclid/cli/admin/job.rb
 - lib/cyclid/cli/admin/organization.rb
 - lib/cyclid/cli/admin/user.rb
+- lib/cyclid/cli/formatter.rb
 - lib/cyclid/cli/job.rb
 - lib/cyclid/cli/organization.rb
 - lib/cyclid/cli/organization/config.rb