Class: Chef::Knife::UserKeyList

Inherits:
Chef::Knife show all
Includes:
KeyListBase
Defined in:
lib/chef/knife/user_key_list.rb

Overview

Implements knife user key list using Chef::Knife::KeyList as a service class.

Author:

  • Tyler Cloke

Constant Summary

Constants inherited from Chef::Knife

OFFICIAL_PLUGINS

Instance Attribute Summary collapse

Attributes inherited from Chef::Knife

#name_args, #ui

Instance Method Summary collapse

Methods included from KeyListBase

included

Methods inherited from Chef::Knife

#api_key, #apply_computed_config, category, chef_config_dir, #cli_keys, common_name, #config_file_settings, config_loader, #config_source, #configure_chef, #create_object, #delete_object, dependency_loaders, deps, #format_rest_error, guess_category, #humanize_exception, #humanize_http_exception, inherited, list_commands, load_commands, load_config, load_deps, #maybe_setup_fips, #merge_configs, msg, #noauth_rest, #parse_options, reset_config_loader!, reset_subcommands!, #rest, run, #run_with_pretty_exceptions, #server_url, #show_usage, snake_case_name, subcommand_category, subcommand_class_from, subcommand_files, subcommand_loader, subcommands, subcommands_by_category, #test_mandatory_field, ui, unnamed?, use_separate_defaults?, #username

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #normalize_snake_case_name, #snake_case_basename

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Constructor Details

#initialize(argv = []) ⇒ UserKeyList

Returns a new instance of UserKeyList.



38
39
40
41
 
# File 'lib/chef/knife/user_key_list.rb', line 38

def initialize(argv = [])
  super(argv)
  @service_object = nil
end

Instance Attribute Details

#actor ⇒ String (readonly)

the name of the client that this key is for

Returns:

  • (String) —

    the current value of actor



31
32
33
 
# File 'lib/chef/knife/user_key_list.rb', line 31

def actor
  @actor
end

Instance Method Details

#actor_missing_error ⇒ Object 



52
53
54
 
# File 'lib/chef/knife/user_key_list.rb', line 52

def actor_missing_error
  "You must specify a user name"
end

#apply_params!(params) ⇒ Object 



60
61
62
63
64
65
66
67
 
# File 'lib/chef/knife/user_key_list.rb', line 60

def apply_params!(params)
  @actor = params[0]
  if @actor.nil?
    show_usage
    ui.fatal(actor_missing_error)
    exit 1
  end
end

#list_method ⇒ Object 



48
49
50
 
# File 'lib/chef/knife/user_key_list.rb', line 48

def list_method
  :list_by_user
end

#run ⇒ Object 



43
44
45
46
 
# File 'lib/chef/knife/user_key_list.rb', line 43

def run
  apply_params!(@name_args)
  service_object.run
end

#service_object ⇒ Object 



56
57
58
 
# File 'lib/chef/knife/user_key_list.rb', line 56

def service_object
  @service_object ||= Chef::Knife::KeyList.new(@actor, list_method, ui, config)
end