cyclid-client 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 078b4e179f24bb0cd378bcd6993fd834bdcb4555
-  data.tar.gz: 0abab651a16850f267229149a11ebd59e58b089e
+  metadata.gz: d4d1024367f882c7fafb1ae3080d8d324c4552c6
+  data.tar.gz: 2ff1efb950368d68163c345f81b2de8cf034b202
 SHA512:
-  metadata.gz: 6635460d43ba93794cf903263d3b0f6341965b79cdd17ef5b1f5c06b5a42df653205c0c997039198a88f55c1ba143397c7f03f70037208e2db305cbf17108026
-  data.tar.gz: 696dd68c6329ac1159616b6174445543ab0c9ee162e2b1f0c9404a3401cdea245b505eed71e76d5c4eecea013f77707f71d84316289ae801ada9b711a495672b
+  metadata.gz: ed3506d6b65119d0cf36d032e88768ca1ba7cb1ed514e98ecafdb1362aa13efd49c0c271dd989e8353bf6b20ebf501faf08772ea9a5a0428e0360b569347ec8c
+  data.tar.gz: d0fdf7cea01e01d6c0f077cb8a0bac01b7739f44d4211417c5df7a0c604fbe262ceeb3f14046baeb34e47182e782f0beb4f9e8634dde36ca63e6298a1a973b20

data/bin/cyclid

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/cli.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/cli/admin.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/cli/formatter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,6 +32,8 @@ module Cyclid
             Kernel.puts t + args.join
           end
           alias colorize puts
+          alias warning puts
+          alias error puts
 
           def ask(question)
             print "#{question}: "
@@ -42,16 +45,30 @@ module Cyclid
       class Terminal < Base
         class << self
           def colorize(title, *args)
+            puts_with_color(:cyan, title, args)
+          end
+
+          def warning(title, *args)
+            puts_with_color(:yellow, title, args)
+          end
+
+          def error(title, *args)
+            puts_with_color(:red, title, args)
+          end
+
+          def ask(question)
+            print "#{question}: ".colorize(:red)
+          end
+
+          private
+
+          def puts_with_color(color, 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)
+            Kernel.puts t.colorize(color) + args.join
           end
         end
       end

data/lib/cyclid/cli/job.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,6 +18,8 @@ require 'yaml'
 require 'json'
 require 'cyclid/constants'
 
+require_relative 'linter'
+
 module Cyclid
   module Cli
     # 'job' sub-command
@@ -33,36 +36,12 @@ module Cyclid
 
         The --json option causes the job file to be parsed as JSON.
       LONGDESC
-      option :yaml, aliases: '-y'
-      option :json, aliases: '-j'
+      option :yaml, type: :boolean, aliases: '-y', desc: 'Force the input file type to YAML'
+      option :json, type: :boolean, aliases: '-j', desc: 'Force the input file type to JSON'
       def submit(filename)
-        job_file = File.expand_path(filename)
-        raise 'Cannot open file' unless File.exist?(job_file)
-
-        job_type = if options[:yaml]
-                     'yaml'
-                   elsif options[:json]
-                     'json'
-                   else
-                     # Detect format
-                     match = job_file.match(/\A.*\.(json|yml|yaml)\z/)
-                     match[1]
-                   end
-        job_type = 'yaml' if job_type == 'yml'
+        job_data, job_type = load_job_file(filename)
 
-        # Do a client-side sanity check by attempting to parse the file; we
-        # don't do anything with the data but it fails-fast if the file has a
-        # syntax error
-        job = File.read(job_file)
-        if job_type == 'yaml'
-          YAML.load(job)
-        elsif job_type == 'json'
-          JSON.parse(job)
-        else
-          raise 'Unknown or unsupported file type'
-        end
-
-        job_info = client.job_submit(client.config.organization, job, job_type)
+        job_info = client.job_submit(client.config.organization, job_data, job_type)
         Formatter.colorize 'Job', job_info['job_id'].to_s
       rescue StandardError => ex
         abort "Failed to submit job: #{ex}"
@@ -138,6 +117,126 @@ module Cyclid
       rescue StandardError => ex
         abort "Failed to get job list: #{ex}"
       end
+
+      desc 'lint FILENAME', 'Check your job file for errors'
+      long_desc <<-LONGDESC
+        Lint a Cyclid job file for errors and potential problems. FILENAME should be the path to a
+        valid Cyclid job file, in either YAML or JSON format.
+
+        Cyclid will attempt to detect the format of the job file automatically. You can force the
+        parsing format using either the --yaml or --json options.
+
+        The --yaml option causes the job file to be parsed as YAML.
+
+        The --json option causes the job file to be parsed as JSON.
+      LONGDESC
+      option :yaml, type: :boolean, aliases: '-y', desc: 'Force the input file type to YAML'
+      option :json, type: :boolean, aliases: '-j', desc: 'Force the input file type to JSON'
+      def lint(filename)
+        job = parse_job_file(filename)
+
+        # Now run the job through the Verifier to find problems
+        verifier = RemoteVerifier.new(client: client)
+        verifier.verify(job)
+
+        # Display the result summary
+        verifier.status.messages.each do |message|
+          case message[:type]
+          when Cyclid::Linter::StatusLogger::MessageTypes::WARNING
+            Formatter.warning 'Warning', message[:text]
+          when Cyclid::Linter::StatusLogger::MessageTypes::ERROR
+            Formatter.error 'Error', message[:text]
+          end
+        end
+
+        Formatter.puts ''
+        Formatter.error 'Errors', verifier.status.errors \
+          unless verifier.status.errors.zero?
+        Formatter.warning 'Warnings', verifier.status.warnings \
+          unless verifier.status.warnings.zero?
+
+        # Finish with an exit code of 1 if there were problems
+        exit 1 unless verifier.status.errors.zero? && verifier.status.warnings.zero?
+      end
+
+      desc 'format FILENAME', 'Re-format or convert your job file'
+      long_desc <<-LONGDESC
+        Pretty-format a Cyclid job file. FILENAME should be the path to a valid Cyclid job file,
+        in either YAML or JSON format. The output format can be YAML or JSON, regardless of the
+        input format.
+
+        Cyclid will attempt to detect the format of the job file automatically. You can force the
+        parsing format using either the --yaml or --json options.
+
+        The --yaml option causes the job file to be parsed as YAML.
+
+        The --json option causes the job file to be parsed as JSON.
+
+        The --yamlout option sets the output format the YAML.
+
+        The --jsonout option sets the output format the JSON.
+      LONGDESC
+
+      option :yaml, type: :boolean, aliases: '-y', desc: 'Force the input file type to YAML'
+      option :json, type: :boolean, aliases: '-j', desc: 'Force the input file type to JSON'
+      option :yamlout, type: :boolean, aliases: '-Y', desc: 'Set the output format to YAML'
+      option :jsonout, type: :boolean,
+                       aliases: '-J',
+                       desc: 'Set the input format to JSON',
+                       default: true
+      def format(filename)
+        job = parse_job_file(filename)
+
+        # Re-emit; Oj & YAML are nice and trustworthy in that they wont re-order objects. This
+        # means that we can nicely indent, or convert, without worrying that things like the
+        # Sequence is going to get re-ordered.
+        #
+        # The downside is that we can't force things like ordering of top-level elements,
+        # although users may consider that an advantage.
+        if options[:yamlout]
+          puts YAML.dump(job)
+        else
+          puts Oj.dump(job, indent: 2)
+        end
+      end
+
+      private
+
+      # Load a Cyclid job file, including format detection
+      def load_job_file(filename)
+        job_file = File.expand_path(filename)
+        raise 'Cannot open file' unless File.exist?(job_file)
+
+        job_type = if options[:yaml]
+                     'yaml'
+                   elsif options[:json]
+                     'json'
+                   else
+                     # Detect format
+                     match = job_file.match(/\A.*\.(json|yml|yaml)\z/)
+                     match[1]
+                   end
+        job_type = 'yaml' if job_type == 'yml'
+
+        # Attempt to load & parse the job file; any JSON or YAML syntax errors
+        # will be caught here
+        job_data = File.read(job_file)
+
+        [job_data, job_type]
+      end
+
+      # Load and parse a Cyclid job file
+      def parse_job_file(filename)
+        job_data, job_type = load_job_file(filename)
+
+        if job_type == 'yaml'
+          YAML.safe_load(job_data)
+        elsif job_type == 'json'
+          JSON.parse(job_data)
+        else
+          raise 'Unknown or unsupported file type'
+        end
+      end
     end
   end
 end

data/lib/cyclid/cli/linter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2017 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 'yaml'
+require 'json'
+require 'cyclid/linter'
+
+module Cyclid
+  module Cli
+    # Verify by fetching Stages from a remote server
+    class RemoteVerifier < Cyclid::Linter::Verifier
+      def initialize(args)
+        @client = args[:client]
+
+        super
+      end
+
+      # Find a Stage by it's name on a remote server
+      def stage_exists?(name)
+        @client.stage_get(@client.config.organization, name)
+
+        Bertrand::EXIST
+      rescue StandardError => ex
+        if ex.to_s == 'stage does not exist'
+          Bertrand::NOT_EXIST
+        else
+          Bertrand::UNKNOWN
+        end
+      end
+    end
+  end
+end

data/lib/cyclid/cli/organization.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/cli/secret.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/cli/stage.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -63,8 +64,8 @@ module Cyclid
 
         The --json option causes the file to be parsed as JSON.
       LONGDESC
-      option :yaml, aliases: '-y'
-      option :json, aliases: '-j'
+      option :yaml, type: :boolean, aliases: '-y', desc: 'Force the input file type to YAML'
+      option :json, type: :boolean, aliases: '-j', desc: 'Force the input file type to JSON'
       option :version, aliases: '-v'
       def create(filename)
         stage_file = File.expand_path(filename)
@@ -85,7 +86,7 @@ module Cyclid
         # will fail-fast if the file has a syntax error
         stage = File.read(stage_file)
         stage_data = if stage_type == 'yaml'
-                       YAML.load(stage)
+                       YAML.safe_load(stage)
                      elsif stage_type == 'json'
                        JSON.parse(stage)
                      else

data/lib/cyclid/cli/user.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client/api.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -80,6 +81,7 @@ module Cyclid
         def api_request(uri, req)
           http = Net::HTTP.new(uri.hostname, uri.port)
           http.use_ssl = uri.scheme == 'https'
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @config.ssl_verify_none
 
           res = http.request(req)
 

data/lib/cyclid/client/api/basic.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client/api/hmac.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -42,7 +43,7 @@ module Cyclid
           nonce = SecureRandom.hex
           headers = signer.sign_request(uri.path,
                                         @config.secret,
-                                        auth_header_format: '%{auth_scheme} %{username}:%{signature}', # rubocop:disable Metrics/LineLength
+                                        auth_header_format: '%<auth_scheme>s %<username>s:%<signature>s', # rubocop:disable Metrics/LineLength
                                         username: @config.username,
                                         nonce: nonce,
                                         method: method)

data/lib/cyclid/client/api/none.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client/api/token.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client/auth.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client/health.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client/job.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client/organization.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client/stage.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/cyclid/client/user.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -66,13 +67,15 @@ module Cyclid
         user['secret'] = secret unless secret.nil?
 
         # Add the password if one was supplied
-        user['password'] = if password =~ /\A\$2a\$.+\z/
-                             # Password is already encrypted
-                             password
-                           else
-                             # Encrypt the plaintext password
-                             BCrypt::Password.create(password).to_s
-                           end unless password.nil?
+        unless password.nil?
+          user['password'] = if password =~ /\A\$2a\$.+\z/
+                               # Password is already encrypted
+                               password
+                             else
+                               # Encrypt the plaintext password
+                               BCrypt::Password.create(password).to_s
+                             end
+        end
 
         @logger.debug user
 
@@ -114,13 +117,15 @@ module Cyclid
         user['secret'] = args[:secret] if args.key? :secret and args[:secret]
 
         # Add the password if one was supplied
-        user['password'] = if args[:password] =~ /\A\$2a\$.+\z/
-                             # Password is already encrypted
-                             args[:password]
-                           else
-                             # Encrypt the plaintext password
-                             BCrypt::Password.create(args[:password]).to_s
-                           end if args.key? :password and args[:password]
+        if args.key? :password and args[:password]
+          user['password'] = if args[:password] =~ /\A\$2a\$.+\z/
+                               # Password is already encrypted
+                               args[:password]
+                             else
+                               # Encrypt the plaintext password
+                               BCrypt::Password.create(args[:password]).to_s
+                             end
+        end
 
         @logger.debug user
 

data/lib/cyclid/config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright 2016 Liqwyd Ltd.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,6 +26,7 @@ module Cyclid
                   :server,
                   :port,
                   :tls,
+                  :ssl_verify_none,
                   :organization,
                   :username,
                   :secret,
@@ -65,6 +67,10 @@ module Cyclid
       def initialize(options = {})
         # Load the config if a path was provided
         @path = options[:path] || nil
+        unless File.file?(@path)
+          raise "no config found at #{@path} - Have you selected an organisation with " \
+                '`cyclid organization use <name>`?'
+        end
         @config = @path.nil? ? nil : YAML.load_file(@path)
 
         # Select the authentication type & associated authentication data.
@@ -72,6 +78,7 @@ module Cyclid
         case @auth
         when AUTH_NONE
           # Nothing
+          nil
         when AUTH_HMAC
           @secret = options[:secret] || @config['secret']
         when AUTH_BASIC
@@ -85,6 +92,7 @@ module Cyclid
         @server = options[:server] || nil
         @port = options[:port] || nil
         @tls = options[:tls] || nil
+        @ssl_verify_none = options[:ssl_verify_none] || nil
         @organization = options[:organization] || nil
         @username = options[:username] || nil
 
@@ -94,6 +102,7 @@ module Cyclid
           @server ||= @config['server']
           @port ||= @config['port'] || 8361
           @tls ||= @config['tls'] || false
+          @ssl_verify_none ||= @config['ssl_verify_none'] || false
           @organization ||= @config['organization']
           @username ||= @config['username']
         end

data/lib/cyclid/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Cyclid
   module Client
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cyclid-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Kristian Van Der Vliet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-28 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -113,6 +113,7 @@ files:
 - lib/cyclid/cli/admin/user.rb
 - lib/cyclid/cli/formatter.rb
 - lib/cyclid/cli/job.rb
+- lib/cyclid/cli/linter.rb
 - lib/cyclid/cli/organization.rb
 - lib/cyclid/cli/organization/config.rb
 - lib/cyclid/cli/organization/member.rb
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Cyclid command line client & library