Class: Morpheus::Cli::ClientsCommand

Inherits:
Object
  • Object
show all
Includes:
CliCommand
Defined in:
lib/morpheus/cli/commands/clients_command.rb

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from CliCommand

#add_query_parameter, #apply_options, #build_common_options, #build_get_options, #build_list_options, #build_option_type_options, #build_standard_add_many_options, #build_standard_add_options, #build_standard_api_options, #build_standard_delete_options, #build_standard_get_options, #build_standard_list_options, #build_standard_post_options, #build_standard_put_options, #build_standard_remove_options, #build_standard_update_options, #command_description, #command_name, #confirm, #confirm!, #default_refresh_interval, #default_sigdig, #default_subcommand, #establish_remote_appliance_connection, #execute_api, #execute_api_payload, #execute_api_request, #find_all, #find_all_json, #find_by_id, #find_by_name, #find_by_name_or_id, #find_record, #find_record_json, #full_command_usage, #get_interface, #get_list_key, #get_object_key, #get_subcommand_description, #handle_each_payload, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_array, #parse_bytes_param, #parse_get_options!, #parse_id_list, #parse_labels, #parse_list_options, #parse_list_options!, #parse_list_subtitles, #parse_options, #parse_parameter_as_resource_id!, #parse_passed_options, #parse_payload, #parse_query_options, #print, #print_error, #println, #prog_name, #puts, #puts_error, #raise_args_error, #raise_command_error, #render_response, #run_command_for_each_arg, #subcommand_aliases, #subcommand_description, #subcommand_usage, #subcommands, #usage, #validate_outfile, #verify_args!, #visible_subcommands

Constructor Details

#initialize ⇒ ClientsCommand

Returns a new instance of ClientsCommand.



10
11
12
 
# File 'lib/morpheus/cli/commands/clients_command.rb', line 10

def initialize()
  #@appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
end

Instance Method Details

#add(args) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/morpheus/cli/commands/clients_command.rb', line 120

def add(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[clientId] [options]")
    build_option_type_options(opts, options, add_client_option_types)
    build_common_options(opts, options, [:payload, :options, :json, :dry_run, :remote])
    opts.footer = "Add New Oauth Client Record."
  end
  optparse.parse!(args)
  if args.count > 1
    raise_command_error "wrong number of arguments, expected 0-1 and got (#{args.count}) #{args}\n#{optparse}"
  end
  if args[0]
    options[:options] ||= {}
    options[:options]['clientId'] ||= args[0]
  end
  connect(options)
  begin
     # construct payload
    passed_options = options[:options] ? options[:options].reject {|k,v| k.is_a?(Symbol) } : {}
    payload = nil
    if options[:payload]
      payload = options[:payload]
      payload.deep_merge!({'client' => passed_options}) unless passed_options.empty?
    else
      payload = {
        'client' => {
        }
      }
      # allow arbitrary -O options
      payload.deep_merge!({'client' => passed_options}) unless passed_options.empty?
      # prompt for options
      params = Morpheus::Cli::OptionTypes.prompt(add_client_option_types, options[:options], @api_client, options[:params])
      payload.deep_merge!({'client' => params}) unless params.empty?
    end

    @clients_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @clients_interface.dry.create(payload)
      return
    end
    json_response = @clients_interface.create(payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      display_name = json_response['client']  ? json_response['client']['clientId'] : ''
      print_green_success "Client #{display_name} added"
      get([json_response['client']['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#connect(opts) ⇒ Object 



14
15
16
17
 
# File 'lib/morpheus/cli/commands/clients_command.rb', line 14

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @clients_interface = @api_client.clients
end

#get(args) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/morpheus/cli/commands/clients_command.rb', line 67

def get(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[client]")
    build_standard_get_options(opts, options)
    opts.footer = "Get details about an oath client.\n" + 
                  "[client] is required. This is the name or id of a client."

  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 1
  end
  connect(options)
  begin
    @clients_interface.setopts(options)
    if options[:dry_run]
      if args[0].to_s =~ /\A\d{1,}\Z/
        print_dry_run @clients_interface.dry.get(args[0])
      else
        print_dry_run @clients_interface.dry.list({name: args[0].to_s})
      end
      return 0
    end
    client = find_client_by_name_or_id(args[0])
    return 1 if client.nil?
    json_response = {'client' => client}
    render_result = render_with_format(json_response, options, 'client')
    return 0 if render_result

    unless options[:quiet]
      print_h1 "Client Details"
      print cyan
      client_columns = {
        "ID" => 'id',
        "Client ID" => 'clientId',
        "Access Token Validity Seconds" => 'accessTokenValiditySeconds',
        "Refresh Token Validity Seconds" => 'refreshTokenValiditySeconds' 
      }
      
      print_description_list(client_columns, client)
      print reset,"\n"

    end
    print reset,"\n"
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#handle(args) ⇒ Object 



19
20
21
 
# File 'lib/morpheus/cli/commands/clients_command.rb', line 19

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/morpheus/cli/commands/clients_command.rb', line 23

def list(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage()
    build_standard_list_options(opts, options)
    opts.footer = "List Oauth Clients."
  end
  optparse.parse!(args)
  connect(options)

  params.merge!(parse_list_options(options))
  @clients_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @clients_interface.dry.list(params)
    return 0
  end

  json_response = @clients_interface.list(params)
  render_response(json_response, options, "clients") do 
    clients = json_response["clients"]
    if clients.empty?
      print cyan,"No clients found",reset,"\n"
    else
      rows = clients.collect {|client|
        row = {
          id: client['id'],
          client_id: client['clientId'],
          access_token_seconds: client['accessTokenValiditySeconds'],
          refresh_token_seconds: client['refreshTokenValiditySeconds']
        }
        row
      }
      columns = [:id, {:client_id => {:max_width => 50}}, :access_token_seconds, :refresh_token_seconds]
      print_h1 "Morpheus Clients", [], options
      print as_pretty_table(rows, columns, options)
      print reset
      print_results_pagination(json_response)
    end
    print reset,"\n"
  end
  return 0, nil
end

#remove(args) ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/morpheus/cli/commands/clients_command.rb', line 241

def remove(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[clientId]")
    build_common_options(opts, options, [:auto_confirm, :json, :dry_run, :remote])
    opts.footer = "Deletes Oauth Client."
  end
  optparse.parse!(args)

  if args.count != 1
    raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args}\n#{optparse}"
  end

  connect(options)
  begin
    client = find_client_by_name_or_id(args[0])
    return 1 if client.nil?

    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the client #{client['clientId']}?")
      return 9, "aborted command"
    end
    @clients_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @clients_interface.dry.destroy(client['id'])
      return
    end
    json_response = @clients_interface.destroy(client['id'])
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Client #{client['clientId']} removed"
      # list([] + (options[:remote] ? ["-r",options[:remote]] : []))
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#update(args) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/morpheus/cli/commands/clients_command.rb', line 177

def update(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[clientId] [options]")
    build_option_type_options(opts, options, client_option_types)
    build_common_options(opts, options, [:payload, :options, :json, :dry_run, :remote])
    opts.footer = "Update Oauth Client Record."
  end
  optparse.parse!(args)

  if args.count != 1
    raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args}\n#{optparse}"
  end

  connect(options)
  begin

    client = find_client_by_name_or_id(args[0])
    return 1 if client.nil?

    # construct payload
    passed_options = options[:options] ? options[:options].reject {|k,v| k.is_a?(Symbol) } : {}
    payload = nil
    if options[:payload]
      payload = options[:payload]
      payload.deep_merge!({'client' => passed_options}) unless passed_options.empty?
    else
      payload = {
        'client' => {
        }
      }
      # allow arbitrary -O options
      payload.deep_merge!({'page' => passed_options}) unless passed_options.empty?
      # prompt for options
      #params = Morpheus::Cli::OptionTypes.prompt(update_wiki_page_option_types, options[:options], @api_client, options[:params])
      params = passed_options

      if params.empty?
        raise_command_error "Specify at least one option to update.\n#{optparse}"
      end

      payload.deep_merge!({'client' => params}) unless params.empty?
    end
    @clients_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @clients_interface.dry.update(client['id'], payload)
      return
    end
    json_response = @clients_interface.update(client['id'], payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      display_name = json_response['client'] ? json_response['client']['clientId'] : ''
      print_green_success "Client #{display_name} updated"
      get([json_response['client']['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end