cyclid-client 0.3.0

data/bin/cyclid

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# 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.
+
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'cyclid/cli'
+
+Cyclid::Cli::Command.start(ARGV)

data/lib/cyclid/auth_methods.rb

@@ -0,0 +1,25 @@
+# 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 Client
+    # Possible authentication methods
+    module AuthMethods
+      AUTH_NONE = 0,
+      AUTH_HMAC = 1,
+      AUTH_BASIC = 2,
+      AUTH_TOKEN = 3
+    end
+  end
+end

data/lib/cyclid/cli.rb

@@ -0,0 +1,90 @@
+# 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 'thor'
+require 'require_all'
+
+require_rel 'cli/*.rb'
+require 'cyclid/client'
+
+# Add some helpers to the Thor base class
+class Thor
+  private
+
+  def client
+    @client ||= Cyclid::Client::Tilapia.new(path: options[:config], log_level: debug?)
+  end
+
+  def debug?
+    options[:debug] ? Logger::DEBUG : Logger::FATAL
+  end
+
+  # Open a text editor against a temporary file with the data rendered to
+  # JSON, and then re-parse the file after the user has completed editing.
+  def invoke_editor(data)
+    # Sanity check that EDITOR is set in the environment before we try to run
+    # it
+    abort('ERROR: '.colorize(:red) + 'You must set your EDITOR environment variable') \
+      if ENV['EDITOR'].nil?
+
+    # Write the data to a temporary file
+    tmpfile = Tempfile.new('cyclid')
+    tmpfile.write(JSON.pretty_generate(data))
+    tmpfile.flush
+
+    # Run the editor
+    system("#{ENV['EDITOR']} #{tmpfile.path}")
+
+    # Re-open and read it back in now that the user has finished editing it
+    tmpfile.open
+    data = JSON.parse(tmpfile.read)
+
+    tmpfile.close
+    tmpfile.unlink
+
+    return data
+  end
+end
+
+module Cyclid
+  module Cli
+    CYCLID_CONFIG_DIR = File.join(ENV['HOME'], '.cyclid')
+    CYCLID_CONFIG_PATH = File.join(CYCLID_CONFIG_DIR, 'config')
+
+    # Top level Thor-based CLI
+    class Command < Thor
+      class_option :config, aliases: '-c', type: :string, default: CYCLID_CONFIG_PATH
+      class_option :debug, aliases: '-d', type: :boolean, default: false
+
+      desc 'admin', 'Administrator commands'
+      subcommand 'admin', Admin
+
+      desc 'user', 'Manage users'
+      subcommand 'user', User
+
+      desc 'organization', 'Manage organizations'
+      subcommand 'organization', Organization
+      map 'org' => :organization
+
+      desc 'job', 'Manage jobs'
+      subcommand 'job', Job
+
+      desc 'secret', 'Manage secrets'
+      subcommand 'secret', Secret
+
+      desc 'stage', 'Manage stages'
+      subcommand 'stage', Stage
+    end
+  end
+end

data/lib/cyclid/cli/admin.rb

@@ -0,0 +1,32 @@
+# 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 'base64'
+require 'openssl'
+
+require_rel 'admin/*.rb'
+
+module Cyclid
+  module Cli
+    # 'admin' sub-command
+    class Admin < Thor
+      desc 'user', 'Manage users'
+      subcommand 'user', AdminUser
+
+      desc 'organization', 'Manage organizations'
+      subcommand 'organization', AdminOrganization
+      map 'org' => :organization
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+# 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 organization' sub-commands
+    class AdminOrganization < Thor
+      desc 'list', 'List all of the organizations'
+      def list
+        orgs = client.org_list
+        orgs.each do |org|
+          puts org
+        end
+      rescue StandardError => ex
+        abort "Failed to retrieve list of organizations: #{ex}"
+      end
+
+      desc 'show NAME', 'Show details of the organization NAME'
+      def show(name)
+        org = client.org_get(name)
+
+        # Convert the public key to PEM
+        der_key = Base64.decode64(org['public_key'])
+        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)
+        if org['users'].any?
+          org['users'].each do |user|
+            puts "\t#{user}"
+          end
+        else
+          puts "\tNone"
+        end
+      rescue StandardError => ex
+        abort "Failed to get organization: #{ex}"
+      end
+
+      desc 'create NAME OWNER-EMAIL', 'Create a new organization NAME'
+      long_desc <<-LONGDESC
+        Create an organization NAME with the owner email address EMAIL.
+
+        The --admin option adds a user as the initial organization administrator.
+      LONGDESC
+      option :admin, aliases: '-a'
+      def create(name, email)
+        client.org_add(name, email)
+
+        if options[:admin]
+          # Add the user to the organization and create the appropriate admin
+          # permissions for them.
+          client.org_modify(name,
+                            members: options[:admin])
+
+          perms = { 'admin' => true, 'write' => true, 'read' => true }
+          client.org_user_permissions(name,
+                                      options[:admin],
+                                      perms)
+        end
+      rescue StandardError => ex
+        abort "Failed to create new organization: #{ex}"
+      end
+
+      desc 'modify NAME', 'Modify the organization NAME'
+      long_desc <<-LONGDESC
+        Modify the organization NAME.
+
+        The --email option sets the owners email address.
+
+        The --members options sets the list of organization members.
+
+        *WARNING* --members will overwrite the existing list of members, so use with care!
+      LONGDESC
+      option :email, aliases: '-e'
+      option :members, aliases: '-m', type: :array
+      def modify(name)
+        client.org_modify(name,
+                          owner_email: options[:email],
+                          members: options[:members])
+      rescue StandardError => ex
+        abort "Failed to modify organization: #{ex}"
+      end
+
+      desc 'delete NAME', 'Delete the organization NAME'
+      long_desc <<-LONGDESC
+        Delete the organization NAME from the server.
+
+        The --force option will delete the organization without asking for confirmation.
+      LONGDESC
+      option :force, aliases: '-f', type: :boolean
+      def delete(name)
+        if options[:force]
+          delete = true
+        else
+          print "Delete organization #{name}: are you sure? (Y/n): ".colorize(:red)
+          delete = STDIN.getc.chr.casecmp('y') == 0
+        end
+        abort unless delete
+
+        begin
+          client.org_delete(name)
+        rescue StandardError => ex
+          abort "Failed to delete organization: #{ex}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+# 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 user' sub-commands
+    class AdminUser < Thor
+      desc 'list', 'List all of the users'
+      def list
+        users = client.user_list
+        users.each do |user|
+          puts user
+        end
+      rescue StandardError => ex
+        abort "Failed to retrieve list of users: #{ex}"
+      end
+
+      desc 'show USERNAME', 'Show details of the user USERNAME'
+      def show(username)
+        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)
+        if user['organizations'].any?
+          user['organizations'].each do |org|
+            puts "\t#{org}"
+          end
+        else
+          puts "\tNone"
+        end
+      rescue StandardError => ex
+        abort "Failed to get user: #{ex}"
+      end
+
+      desc 'create USERNAME EMAIL', 'Create a new user USERNAME'
+      long_desc <<-LONGDESC
+        Create a user USERNAME with the email address EMAIL. The new user will not be a member of
+        any organization.
+
+        The --name option sets the users real name.
+
+        The --password option sets an encrypted password for HTTP Basic authentication and Cyclid
+        UI console logins.
+
+        The --secret option sets a shared secret which is used for signing Cyclid API requests.
+
+        One of either --password or --secret should be used if you want the user to be able to
+        authenticate with the server.
+      LONGDESC
+      option :name, aliases: '-n'
+      option :password, aliases: '-p'
+      option :secret, aliases: '-s'
+      def create(username, email)
+        client.user_add(username, email, options[:name], options[:password], options[:secret])
+      rescue StandardError => ex
+        abort "Failed to create new user: #{ex}"
+      end
+
+      desc 'modify USERNAME', 'Modify the user USERNAME'
+      long_desc <<-LONGDESC
+        Modify the user USERNAME.
+
+        The --name option sets the users real name.
+
+        The --email option sets the users email address.
+
+        The --password option sets an encrypted password for HTTP Basic authentication and Cyclid
+        UI console logins.
+
+        The --secret option sets a shared secret which is used for signing Cyclid API requests.
+      LONGDESC
+      option :name, aliases: '-n'
+      option :email, aliases: '-e'
+      option :password, aliases: '-p'
+      option :secret, aliases: '-s'
+      def modify(username)
+        client.user_modify(username,
+                           name: options[:name],
+                           email: options[:email],
+                           password: options[:password],
+                           secret: options[:secret])
+      rescue StandardError => ex
+        abort "Failed to modify user: #{ex}"
+      end
+
+      desc 'passwd USERNAME', 'Change the password of the user USERNAME'
+      def passwd(username)
+        # Get the new password
+        print 'Password: '
+        password = STDIN.noecho(&:gets).chomp
+        print "\nConfirm password: "
+        confirm = STDIN.noecho(&:gets).chomp
+        print "\n"
+        abort 'Passwords do not match' unless password == confirm
+
+        # Modify the user with the new password
+        begin
+          client.user_modify(username, password: password)
+        rescue StandardError => ex
+          abort "Failed to modify user: #{ex}"
+        end
+      end
+
+      desc 'delete USERNAME', 'Delete the user USERNAME'
+      long_desc <<-LONGDESC
+        Delete the user USERNAME from the server.
+
+        The --force option will delete the user without asking for confirmation.
+      LONGDESC
+      option :force, aliases: '-f', type: :boolean
+      def delete(username)
+        if options[:force]
+          delete = true
+        else
+          print "Delete user #{username}: are you sure? (Y/n): ".colorize(:red)
+          delete = STDIN.getc.chr.casecmp('y') == 0
+        end
+        abort unless delete
+
+        begin
+          client.user_delete(username)
+        rescue StandardError => ex
+          abort "Failed to delete user: #{ex}"
+        end
+      end
+    end
+  end
+end

data/lib/cyclid/cli/job.rb

@@ -0,0 +1,114 @@
+# 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 'yaml'
+require 'json'
+require 'cyclid/constants'
+
+module Cyclid
+  module Cli
+    # 'job' sub-command
+    class Job < Thor
+      desc 'submit FILENAME', 'Submit a job to be run'
+      long_desc <<-LONGDESC
+        Submit a job to be run by the server. 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, aliases: '-y'
+      option :json, aliases: '-j'
+      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'
+
+        # 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)
+        puts 'Job: '.colorize(:cyan) + job_info['job_id'].to_s
+      rescue StandardError => ex
+        abort "Failed to submit job: #{ex}"
+      end
+
+      desc 'show JOBID', 'Show details of a job'
+      def show(jobid)
+        job = client.job_get(client.config.organization, jobid)
+
+        status_id = job['status']
+        status = Cyclid::API::Constants::JOB_STATUSES[status_id]
+
+        started = job['started'].nil? ? nil : Time.parse(job['started'])
+        ended = job['ended'].nil? ? nil : Time.parse(job['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
+      rescue StandardError => ex
+        abort "Failed to get job status: #{ex}"
+      end
+
+      desc 'status JOBID', 'Show the status of a job'
+      def status(jobid)
+        job_status = client.job_status(client.config.organization, jobid)
+
+        status_id = job_status['status']
+        status = Cyclid::API::Constants::JOB_STATUSES[status_id]
+
+        # Pretty-print the job status
+        puts 'Status: '.colorize(:cyan) + status
+      rescue StandardError => ex
+        abort "Failed to get job status: #{ex}"
+      end
+
+      desc 'log JOBID', 'Show the job log'
+      def log(jobid)
+        job_log = client.job_log(client.config.organization, jobid)
+
+        puts job_log['log']
+      rescue StandardError => ex
+        abort "Failed to get job log: #{ex}"
+      end
+    end
+  end
+end