cyclid-client 0.3.0

data/lib/cyclid/cli/organization.rb

@@ -0,0 +1,129 @@
+# 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'
+require 'uri'
+
+require_rel 'organization/*.rb'
+
+module Cyclid
+  module Cli
+    # 'organization' sub-command
+    class Organization < Thor
+      desc 'show', 'Show details of the organization'
+      def show
+        org = client.org_get(client.config.organization)
+
+        # 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 'modify', 'Modify the organization'
+      long_desc <<-LONGDESC
+        Modify the organization.
+
+        The --email option sets the owners email address.
+      LONGDESC
+      option :email, aliases: '-e'
+      def modify
+        client.org_modify(client.config.organization,
+                          owner_email: options[:email])
+      rescue StandardError => ex
+        abort "Failed to modify organization: #{ex}"
+      end
+
+      desc 'list', 'List your available organizations'
+      def list
+        Dir.glob("#{CYCLID_CONFIG_DIR}/*").each do |fname|
+          next if File.symlink?(fname)
+          next unless File.file?(fname)
+
+          begin
+            # 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
+          rescue StandardError => ex
+            $stderr.puts "Failed to load config file #{fname}: #{ex}"
+          end
+        end
+      end
+
+      desc 'use NAME', 'Select the organization NAME to use by default'
+      def use(name = nil)
+        # If 'use' was called without an argument, print the name of the
+        # current configuration
+        if name.nil?
+          fname = if File.symlink?(options[:config])
+                    File.readlink(options[:config])
+                  else
+                    options[:config]
+                  end
+          puts File.basename(fname)
+        else
+          # List the avialble configurations
+          fname = File.join(CYCLID_CONFIG_DIR, name)
+
+          # Sanity check that the configuration file exists and is valid
+          abort 'No such organization' unless File.exist?(fname)
+          abort 'Not a valid organization' unless File.file?(fname)
+
+          begin
+            config = Cyclid::Client::Config.new(path: fname)
+
+            raise if config.server.nil? or \
+                     config.organization.nil? or \
+                     config.username.nil? or \
+                     config.secret.nil?
+          rescue StandardError
+            abort 'Invalid configuration file'
+          end
+
+          # 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.symlink(name, 'config')
+          end
+        end
+      end
+
+      desc 'member', 'Manage organization members'
+      subcommand 'member', Member
+
+      desc 'config', 'Manage organization configuration'
+      subcommand 'config', Config
+    end
+  end
+end

data/lib/cyclid/cli/organization/config.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.
+
+module Cyclid
+  module Cli
+    # Commands for managing per. organization configuration
+    class Config < Thor
+      desc 'show TYPE PLUGIN', 'Show a plugin configuration'
+      def show(type, plugin)
+        plugin_data = client.org_config_get(client.config.organization, type, plugin)
+
+        config = plugin_data['config']
+        schema = plugin_data['schema']
+        schema.each do |setting|
+          name = setting['name']
+          type = setting['type']
+
+          case type
+          when 'string', 'integer'
+            data = config[name] || 'Not set'
+            puts "#{setting['description']}: ".colorize(:cyan) + data
+          when 'boolean'
+            data = config[name] || 'Not set'
+            puts "#{setting['description']}: ".colorize(:cyan) + (data ? 'true' : 'false')
+          when 'list'
+            puts setting['description'].colorize(:cyan)
+            data = config[name]
+            if data.empty?
+              puts "\tNone"
+            else
+              data.each do |item|
+                puts "\t#{item}"
+              end
+            end
+          when 'hash-list'
+            puts setting['description'].colorize(:cyan)
+            data = config[name]
+            if data.empty?
+              puts "\tNone"
+            else
+              data.each do |item|
+                item.each do |k, v|
+                  puts "\t#{k}: #{v}"
+                end
+              end
+            end
+          else
+            raise "unknown schema type #{type}"
+          end
+        end
+      rescue StandardError => ex
+        abort "Failed to get plugin configuration: #{ex}"
+      end
+
+      desc 'edit TYPE PLUGIN', 'Edit a plugin configuration'
+      def edit(type, plugin)
+        plugin_data = client.org_config_get(client.config.organization, type, plugin)
+
+        # Inject the schema description into each config item
+        schema = plugin_data['schema']
+        config = plugin_data['config'].each do |k, v|
+          description = ''
+          schema.each do |item|
+            description = item['description'] if item['name'] == k
+          end
+          { k => v, 'description' => description }
+        end
+
+        # Open a text editor on the configuration
+        config = invoke_editor(config)
+
+        # Submit it to the server
+        client.org_config_set(client.config.organization, type, plugin, config)
+      rescue StandardError => ex
+        abort "Failed to update plugin configuration: #{ex}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+# 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
+    # Commands for managing organization members
+    class Member < Thor
+      desc 'add USERS', 'Add users to the organization'
+      def add(*users)
+        org = client.org_get(client.config.organization)
+
+        # Concat the new list with the existing list and remove any
+        # duplicates.
+        user_list = org['users']
+        user_list.concat users
+        user_list.uniq!
+
+        client.org_modify(client.config.organization,
+                          members: user_list)
+      rescue StandardError => ex
+        abort "Failed to add users to the organization: #{ex}"
+      end
+
+      desc 'permission USER PERMISSION', 'Modify a members organization permissions'
+      long_desc <<-LONGDESC
+        Modify the organization permissions for USER.
+
+        PERMISSION must be one of:
+          * admin - Give the user organization administrator permissions.
+          * write - Give the user organization create/modify permissions.
+          * read  - Give the user organization read permissions.
+          * none  - Remove all organization permissions.
+
+        With 'none' the user remains an organization member but can not
+        interact with it. See the 'member remove' command if you want to
+        actually remove a user from your organization.
+      LONGDESC
+      def permission(user, permission)
+        perms = case permission.downcase
+                when 'admin'
+                  { 'admin' => true, 'write' => true, 'read' => true }
+                when 'write'
+                  { 'admin' => false, 'write' => true, 'read' => true }
+                when 'read'
+                  { 'admin' => false, 'write' => false, 'read' => true }
+                when 'none'
+                  { 'admin' => false, 'write' => false, 'read' => false }
+                else
+                  raise "invalid permission #{permission}"
+                end
+
+        client.org_user_permissions(client.config.organization, user, perms)
+      rescue StandardError => ex
+        abort "Failed to modify user permissions: #{ex}"
+      end
+      map 'perms' => :permission
+
+      desc 'list', 'List organization members'
+      def list
+        org = client.org_get(client.config.organization)
+        org['users'].each do |user|
+          puts user
+        end
+      rescue StandardError => ex
+        abort "Failed to get organization members: #{ex}"
+      end
+
+      desc 'show USER', 'Show details of an organization member'
+      def show(user)
+        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)
+        user['permissions'].each do |k, v|
+          puts "\t#{k.capitalize}: ".colorize(:cyan) + v.to_s
+        end
+      rescue StandardError => ex
+        abort "Failed to get user: #{ex}"
+      end
+
+      desc 'remove USERS', 'Remove users from the organization'
+      long_desc <<-LONGDESC
+        Remove the list of USERS from the organization.
+
+        The --force option will remove the users without asking for confirmation.
+      LONGDESC
+      option :force, aliases: '-f', type: :boolean
+      def remove(*users)
+        org = client.org_get(client.config.organization)
+
+        # Remove any users that exist as members of this organization;
+        # ask for confirmation on a per-user basis (unless '-f' was passed)
+        user_list = org['users']
+        user_list.delete_if do |user|
+          if users.include? user
+            if options[:force]
+              true
+            else
+              print "Remove user #{user}: are you sure? (Y/n): ".colorize(:red)
+              STDIN.getc.chr.casecmp('y') == 0
+            end
+          end
+        end
+        user_list.uniq!
+
+        client.org_modify(client.config.organization,
+                          members: user_list)
+      rescue StandardError => ex
+        abort "Failed to remove users from the organization: #{ex}"
+      end
+    end
+  end
+end

data/lib/cyclid/cli/secret.rb

@@ -0,0 +1,42 @@
+# 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
+    # 'secret' sub-command
+    class Secret < Thor
+      desc 'encrypt', 'Encrypt a secret with the organizations public key'
+      def encrypt
+        # Get the organizations public key in a form we can use
+        org = client.org_get(client.config.organization)
+        der_key = Base64.decode64(org['public_key'])
+        public_key = OpenSSL::PKey::RSA.new(der_key)
+
+        # Get the secret in a safe manner
+        print 'Secret: '
+        secret = STDIN.noecho(&:gets).chomp
+        print "\r"
+
+        # Encrypt with the public key
+        encrypted = public_key.public_encrypt(secret)
+
+        puts 'Secret: '.colorize(:cyan) + Base64.strict_encode64(encrypted)
+      rescue StandardError => ex
+        abort "Failed to encrypt secret: #{ex}"
+      end
+    end
+  end
+end

data/lib/cyclid/cli/stage.rb

@@ -0,0 +1,121 @@
+# 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
+    # 'stage' sub-command
+    class Stage < Thor
+      desc 'list', 'List the defined stages'
+      def list
+        stages = client.stage_list(client.config.organization)
+        stages.each do |stage|
+          puts "#{stage[:name]} v#{stage[:version]}"
+        end
+      rescue StandardError => ex
+        abort "Failed to get stages: #{ex}"
+      end
+
+      desc 'show NAME', 'Show details of a stage'
+      def show(name)
+        stages = client.stage_get(client.config.organization, name)
+
+        # 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)
+          stage['steps'].each do |step|
+            puts "\t\tAction: ".colorize(:cyan) + step['action']
+            step.delete('action')
+            step.each do |k, v|
+              puts "\t\t#{k.capitalize}: ".colorize(:cyan) + v.to_s
+            end
+          end
+        end
+      rescue StandardError => ex
+        abort "Failed to get stage: #{ex}"
+      end
+
+      desc 'create FILENAME', 'Create a new stage from a file'
+      long_desc <<-LONGDESC
+        Create a new stage. FILENAME should be the path to a valid Cyclid stage definition, in
+        either YAML or JSON format.
+
+        You can create multiple versions of a stage with the same name. You can either set the
+        version in the stage definition itself or use the --version option.
+
+        Cyclid will attempt to detect the format of the file automatically. You can force the
+        parsing format using either the --yaml or --json options.
+
+        The --yaml option causes the file to be parsed as YAML.
+
+        The --json option causes the file to be parsed as JSON.
+      LONGDESC
+      option :yaml, aliases: '-y'
+      option :json, aliases: '-j'
+      option :version, aliases: '-v'
+      def create(filename)
+        stage_file = File.expand_path(filename)
+        raise 'Cannot open file' unless File.exist?(stage_file)
+
+        stage_type = if options[:yaml]
+                       'yaml'
+                     elsif options[:json]
+                       'json'
+                     else
+                       # Detect format
+                       match = stage_file.match(/\A.*\.(json|yml|yaml)\z/)
+                       match[1]
+                     end
+        stage_type = 'yaml' if stage_type == 'yml'
+
+        # Do a client-side sanity check by attempting to parse the file; it
+        # will fail-fast if the file has a syntax error
+        stage = File.read(stage_file)
+        stage_data = if stage_type == 'yaml'
+                       YAML.load(stage)
+                     elsif stage_type == 'json'
+                       JSON.parse(stage)
+                     else
+                       raise 'Unknown or unsupported file type'
+                     end
+
+        # Inject the version if it was passed on the command line
+        stage_data['version'] = options[:version] if options[:version]
+
+        client.stage_create(client.config.organization, stage_data)
+      rescue StandardError => ex
+        abort "Failed to create stage: #{ex}"
+      end
+
+      desc 'edit NAME', 'Edit a stage definition'
+      long_desc <<-LONGDESC
+        Edit a stage. Individual stages are immutable, but you may create a new
+        version of an existing stage using this command.
+      LONGDESC
+      def edit(name)
+        stages = client.stage_get(client.config.organization, name)
+
+        # XXX This is a hack. The API returns all stages from this endpoint;
+        # we might need to add or extend the API to return "latest" only.
+        stage = stages.last
+
+        stage = invoke_editor(stage)
+        client.stage_modify(client.config.organization, stage)
+      rescue StandardError => ex
+        abort "Failed to edit stage: #{ex}"
+      end
+    end
+  end
+end