Class: Morpheus::Cli::WikiCommand

Inherits:
Object
  • Object
show all
Includes:
CliCommand
Defined in:
lib/morpheus/cli/commands/wiki_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 ⇒ WikiCommand

Returns a new instance of WikiCommand.



8
9
10
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 8

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

Instance Method Details

#add(args) ⇒ Object 



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
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 182

def add(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] [options]")
    build_option_type_options(opts, options, add_wiki_page_option_types)
    build_common_options(opts, options, [:payload, :options, :json, :dry_run, :remote])
  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]['name'] ||= 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!({'page' => passed_options}) unless passed_options.empty?
    else
      payload = {
        'page' => {
        }
      }
      # allow arbitrary -O options
      payload.deep_merge!({'page' => passed_options}) unless passed_options.empty?
      # prompt for options
      params = Morpheus::Cli::OptionTypes.prompt(add_wiki_page_option_types, options[:options], @api_client, options[:params])
      payload.deep_merge!({'page' => params}) unless params.empty?
    end

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

#categories(args) ⇒ Object 



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 343

def categories(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage()
    build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
  end
  optparse.parse!(args)
  if args.count != 0
    raise_command_error "wrong number of arguments, expected 0 and got (#{args.count}) #{args}\n#{optparse}"
  end
  connect(options)
  begin
    params.merge!(parse_list_options(options))
    @wiki_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @wiki_interface.dry.categories(params)
      return 0
    end
    json_response = @wiki_interface.categories(params)
    render_result = render_with_format(json_response, options, 'categories')
    return 0 if render_result
    categories = json_response['categories']
    unless options[:quiet]
      title = "Morpheus Wiki Categories"
      subtitles = []
      subtitles += parse_list_subtitles(options)
      print_h1 title, subtitles
      if categories.empty?
        print cyan,"No wiki categories found.",reset,"\n"
      else
        columns = [
          {"CATEGORY" => lambda {|page| page['name'] } },
          {"# PAGES" => lambda {|it| it['pageCount'] } }
        ]
        if options[:include_fields]
          columns = options[:include_fields]
        end
        print as_pretty_table(categories, columns, options)
        #print_results_pagination(json_response)
      end
      print reset,"\n"
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#connect(opts) ⇒ Object 



12
13
14
15
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 12

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @wiki_interface = @api_client.wiki
end

#get(args) ⇒ Object 



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
119
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
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 81

def get(args)
  options = {}
  params = {}
  open_wiki_link = false
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    opts.on('--view', '--view', "View wiki page in web browser too.") do
      open_wiki_link = true
    end
    build_common_options(opts, options, [:query, :json, :yaml, :csv, :fields, :dry_run, :remote])
  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
    @wiki_interface.setopts(options)
    if options[:dry_run]
      if args[0].to_s =~ /\A\d{1,}\Z/
        print_dry_run @wiki_interface.dry.get(args[0])
      else
        print_dry_run @wiki_interface.dry.list({name: args[0].to_s})
      end
      return 0
    end
    page = find_wiki_page_by_name_or_id(args[0])
    return 1 if page.nil?
    json_response = {'page' => page}
    render_result = render_with_format(json_response, options, 'page')
    return 0 if render_result

    unless options[:quiet]
      print_h1 "Wiki Page Details"
      print cyan
      wiki_columns = {
        "ID" => 'id',
        "Name" => 'name',
        "Category" => 'category',
        # "Ref Type" => 'refType',
        # "Ref ID" => 'refId',
        "Reference" => lambda {|it| it['refType'] ? "#{it['refType']} (#{it['refId']})" : '' },
        #"Owner" => lambda {|it| it['account'] ? it['account']['name'] : '' },
        "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
        "Created By" => lambda {|it| it['createdBy'] ? it['createdBy']['username'] : '' },
        "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) },
        "Updated By" => lambda {|it| it['updatedBy'] ? it['updatedBy']['username'] : '' }
      }
      if page['refType'].nil?
        wiki_columns.delete("Reference")
      end
      print_description_list(wiki_columns, page)
      print reset,"\n"

      print_h2 "Page Content"
      print cyan, page['content'], reset, "\n"

    end
    print reset,"\n"
    if open_wiki_link
      return view([page['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#handle(args) ⇒ Object 



17
18
19
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 17

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object 



21
22
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 21

def list(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage()
    opts.on('--category VALUE', String, "Category") do |val|
      params['category'] = val
    end
    build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
  end
  optparse.parse!(args)
  if args.count != 0
    raise_command_error "wrong number of arguments, expected 0 and got (#{args.count}) #{args}\n#{optparse}"
  end
  connect(options)
  begin
    params.merge!(parse_list_options(options))
    @wiki_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @wiki_interface.dry.list(params)
      return 0
    end
    json_response = @wiki_interface.list(params)
    render_result = render_with_format(json_response, options, 'pages')
    return 0 if render_result
    pages = json_response['pages']
    unless options[:quiet]
      title = "Morpheus Wiki Pages"
      subtitles = []
      if params['category']
        subtitles << "Category: #{params['category']}"
      end
      subtitles += parse_list_subtitles(options)
      print_h1 title, subtitles
      if pages.empty?
        print cyan,"No wiki pages found.",reset,"\n"
      else
        columns = [
          {"ID" => lambda {|page| page['id'] } },
          {"NAME" => lambda {|page| page['name'] } },
          {"CATEGORY" => lambda {|page| page['category'] } },
          {"AUTHOR" => lambda {|page| page['updatedBy'] ? page['updatedBy']['username'] : '' } },
          {"CREATED" => lambda {|page| format_local_dt(page['dateCreated']) } },
          {"UPDATED" => lambda {|page| format_local_dt(page['lastUpdated']) } },
        ]
        if options[:include_fields]
          columns = options[:include_fields]
        end
        print as_pretty_table(pages, columns, options)
        print_results_pagination(json_response)
      end
      print reset,"\n"
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#remove(args) ⇒ Object 



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 303

def remove(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:auto_confirm, :json, :dry_run, :remote])
  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
    page = find_wiki_page_by_name_or_id(args[0])
    return 1 if page.nil?

    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the page #{page['name']}?")
      return 9, "aborted command"
    end
    @wiki_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @wiki_interface.dry.destroy(page['id'])
      return
    end
    json_response = @wiki_interface.destroy(page['id'])
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Wiki page #{page['name']} 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 



238
239
240
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 238

def update(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] [options]")
    build_option_type_options(opts, options, update_wiki_page_option_types)
    build_common_options(opts, options, [:payload, :options, :json, :dry_run, :remote])
  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

    page = find_wiki_page_by_name_or_id(args[0])
    return 1 if page.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!({'page' => passed_options}) unless passed_options.empty?
    else
      payload = {
        'page' => {
        }
      }
      # 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
      if params["category"] && (params["category"].strip == "" || params["category"].strip == "null")
        params["category"] = ""
      end
      payload.deep_merge!({'page' => params}) unless params.empty?
    end
    @wiki_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @wiki_interface.dry.update(page['id'], payload)
      return
    end
    json_response = @wiki_interface.update(page['id'], payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      display_name = json_response['page'] ? json_response['page']['name'] : ''
      print_green_success "Wiki page #{display_name} updated"
      get([json_response['page']['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#view(args) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/morpheus/cli/commands/wiki_command.rb', line 152

def view(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[id]")
    build_common_options(opts, options, [:dry_run, :remote])
    opts.footer = "View a wiki page in a web browser" + "\n" +
                  "[id] is required. This is name or id of the wiki page."
  end
  optparse.parse!(args)
  if args.count != 1
    raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
  end
  connect(options)
  begin
    page = find_wiki_page_by_name_or_id(args[0])
    return 1 if page.nil?

    link = "#{@appliance_url}/login/oauth-redirect?access_token=#{@access_token}\\&redirectUri=/operations/wiki/#{page['urlName']}"

    if options[:dry_run]
      puts Morpheus::Util.open_url_command(link)
      return 0
    end
    return Morpheus::Util.open_url(link)
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end