Module: Morpheus::Cli::RestCommand

Included in:
Audit, BackupServices, BackupTypes, CredentialTypesCommand, CredentialsCommand, LoadBalancerMonitors, LoadBalancerPoolNodes, LoadBalancerPools, LoadBalancerProfiles, LoadBalancerTypes, LoadBalancerVirtualServers, LoadBalancers, NetworkFloatingIps, NetworkPoolServerTypes, NetworkPoolServersCommand, NetworkSecurityServerTypes, NetworkServerGroups, NetworkServerTypes, NetworkServersCommand, PluginsCommand, ScaleThresholds, SecurityPackageTypesCommand, SecurityPackagesCommand, SecurityScansCommand, StorageServerTypes, StorageServers, StorageVolumeTypes, StorageVolumes
Defined in:
lib/morpheus/cli/mixins/rest_command.rb

Overview

RestCommand is a mixin for Morpheus::Cli command classes. Provides basic CRUD commands: list, get, add, update, remove Currently the command class must also include Morpheus::Cli::CliCommand The command class can define a few variables to dictate what the resource is called and the the api interface used to fetch the records. The command class or helper must also provide several methods to provide the default behavior. In the example below, the command (helper) defines the following methods:

* load_balancer_object_key() - Key name of object returned by the "get" api endpoint.
* load_balancer_list_key() - Key name of array of records returned by the "list" api endpoint.
* load_balancer_column_definitions() - Column definitions for the "get" command display output.
* load_balancer_list_column_definitions() - Column definitions for the "list" command display output.

Example of a RestCommand for ‘morpheus load-balancers`.

class Morpheus::Cli::LoadBalancers

include Morpheus::Cli::CliCommand
include Morpheus::Cli::RestCommand
include Morpheus::Cli::LoadBalancersHelper

# All of the example settings below are redundant
# and would be the default values if not set.
set_rest_name :load_balancers
set_rest_label "Load Balancer"
set_rest_label_plural "Load Balancers"
set_rest_object_key "load_balancer"
set_rest_has_type true
set_rest_type "load_balancer_types"
register_interfaces :load_balancers, :load_balancer_types

end

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



34
35
36
37
38
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 34

def self.included(base)
  #puts "including RestCommand for #{base}"
  #base.send :include, Morpheus::Cli::CliCommand
  base.extend ClassMethods
end

Instance Method Details

#_get(id, params, options) ⇒ Object 



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 557

def _get(id, params, options)
  if id !~ /\A\d{1,}\Z/ && rest_has_name
    record = rest_find_by_name_or_id(id)
    if record.nil?
      return 1, "#{rest_label} not found for '#{id}'"
    end
    id = record['id']
  end
  rest_interface.setopts(options)
  if options[:dry_run]
    print_dry_run rest_interface.dry.get(id, params)
    return
  end
  json_response = rest_interface.get(id, params)
  render_response_for_get(json_response, options)
  return 0, nil
end

#_get_type(id, params, options) ⇒ Object 



954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 954

def _get_type(id, params, options)
  if id !~ /\A\d{1,}\Z/ # && rest_type_has_name
    record = rest_type_find_by_name_or_id(id)
    if record.nil?
      return 1, "#{rest_type_label} not found for '#{id}'"
    end
    id = record['id']
  end
  rest_type_interface.setopts(options)
  if options[:dry_run]
    print_dry_run rest_type_interface.dry.get(id, params)
    return
  end
  json_response = rest_type_interface.get(id, params)
  render_response_for_get_type(json_response, options)
  return 0, nil
end

#add(args) ⇒ Object 



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 596

def add(args)
  record_type = nil
  record_type_id = nil
  options = {:options => {:context_map => rest_option_context_map}}
  #respond_to?("#{rest_key}_option_context_map", true) ? send("#{rest_key}_option_context_map") : {'domain' => ''}}}
  option_types = respond_to?("add_#{rest_key}_option_types", true) ? send("add_#{rest_key}_option_types") : []
  advanced_option_types = respond_to?("add_#{rest_key}_advanced_option_types", true) ? send("add_#{rest_key}_advanced_option_types") : []
  type_option_type = option_types.find {|it| it['fieldName'] == 'type'} 
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    if rest_has_name
      opts.banner = subcommand_usage("[name]")
    else
      opts.banner = subcommand_usage()
    end
    if rest_has_type && type_option_type.nil?
      opts.on( '-t', "--#{rest_type_arg} TYPE", "#{rest_type_label}" ) do |val|
        record_type_id = val
      end
    end
    build_option_type_options(opts, options, option_types)
    build_option_type_options(opts, options, advanced_option_types)
    build_standard_add_options(opts, options)
    opts.footer = <<-EOT
Create a new #{rest_label.downcase}.
[name] is required. This is the name of the new #{rest_label.downcase}.
EOT
    opts.footer += send "add_#{rest_key}_footer_addn" if respond_to?("add_#{rest_key}_footer_addn", true)
  end
  optparse.parse!(args)
  # todo: make supporting args[0] optional and more flexible
  # for now args[0] is assumed to be the 'name'
  record_name = nil
  if rest_has_name
    if args.count > 0
      record_name = args.join(" ")
    end
    verify_args!(args:args, optparse:optparse, min:0, max: 1)
  else
    verify_args!(args:args, optparse:optparse, count: 0)
  end
  connect(options)
  passed_options = parse_passed_options(options)
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({rest_object_key => passed_options})
  else
    # load or prompt for type
    if rest_has_type && type_option_type.nil?
      if record_type_id.nil?
        #raise_command_error "#{rest_type_label} is required.\n#{optparse}"
        type_list = rest_type_interface.list({max:10000, creatable:true})[rest_type_list_key]
        type_dropdown_options = respond_to?("#{rest_key}_type_list_to_options", true) ? send("#{rest_key}_type_list_to_options", type_list) : type_list.collect {|it| {'name' => it['name'], 'value' => it['code']} }
        record_type_id = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'type', 'fieldLabel' => rest_type_label, 'type' => 'select', 'selectOptions' => type_dropdown_options, 'required' => true}], options[:options], @api_client)['type']
      end
      record_type = rest_type_find_by_name_or_id(record_type_id)
      if record_type.nil?
        return 1, "#{rest_type_label} not found for '#{record_type_id}"
      end
    end
    record_payload = {}
    if record_name
      record_payload['name'] = record_name
      options[:options]['name'] = record_name # injected for prompt
    end
    if rest_has_type && record_type
      # inject type to options for prompting
      record_payload['type'] = record_type['code']
      options[:options]['type'] = record_type['code']
      # initialize params for loading optionSource data
      options[:params] ||= {}
      options[:params]['type'] = record_type['code']
    end
    record_payload.deep_merge!(passed_options)
    if option_types && !option_types.empty?
      v_prompt = Morpheus::Cli::OptionTypes.prompt(option_types, options[:options], @api_client, options[:params])
      v_prompt.deep_compact!
      v_prompt.booleanize! # 'on' => true
      record_payload.deep_merge!(v_prompt)
    end
    # options by type
    if rest_has_type && record_type.nil?
      type_value = record_payload['type'].is_a?(Hash) ? record_payload['type']['id'] : record_payload['type']
      if type_value
        record_type = rest_type_find_by_name_or_id(type_value)
        if record_type.nil?
          return 1, "#{rest_type_label} not found for '#{type_value}"
        end
      end
      # reload the type by id to get all the details ie. optionTypes
      if record_type && record_type['optionTypes'].nil?
        record_type = rest_type_find_by_name_or_id(record_type['id'])
      end
    end
    my_option_types = nil
    if respond_to?("load_option_types_for_#{rest_key}", true)
      my_option_types = send("load_option_types_for_#{rest_key}", record_type, nil)
    else
      my_option_types = record_type ? record_type['optionTypes'] : nil
    end
    if my_option_types && !my_option_types.empty?
      # remove redundant fieldContext
      my_option_types.each do |option_type| 
        if option_type['fieldContext'] == rest_object_key
          option_type['fieldContext'] = nil
        end
      end
      api_params = (options[:params] || {}).merge(record_payload)
      v_prompt = Morpheus::Cli::OptionTypes.prompt(my_option_types, options[:options], @api_client, api_params, false, true)
      v_prompt.deep_compact!
      v_prompt.booleanize! # 'on' => true
      record_payload.deep_merge!(v_prompt)
    end
    # advanced options (uses no_prompt)
    if advanced_option_types && !advanced_option_types.empty?
      v_prompt = Morpheus::Cli::OptionTypes.no_prompt(advanced_option_types, options[:options], @api_client, options[:params])
      v_prompt.deep_compact!
      v_prompt.booleanize! # 'on' => true
      record_payload.deep_merge!(v_prompt)
    end
    # permissions
    if rest_perms_config[:enabled]
      if rest_perms_config[:version] == 2
        perms = prompt_permissions_v2(options.deep_merge(rest_perms_config[:options] || {}), rest_perms_config[:excludes] || [])
      else
        perms = prompt_permissions(options.deep_merge(rest_perms_config[:options] || {}), rest_perms_config[:excludes] || [])
      end
      unless rest_perms_config[:name].nil?
        perms.transform_keys! {|k| k == 'resourcePermissions' ? rest_perms_config[:name] : k}
      end
      unless rest_perms_config[:context].nil?
        perms_context = {}
        perms_context[rest_perms_config[:context]] = perms
      end
      record_payload.merge!(perms)
    end
    payload[rest_object_key] = record_payload
  end
  rest_interface.setopts(options)
  if options[:dry_run]
    print_dry_run rest_interface.dry.create(payload)
    return
  end      
  json_response = rest_interface.create(payload)
  render_response(json_response, options, rest_object_key) do
    record = json_response[rest_object_key]
    print_green_success "Added #{rest_label.downcase} #{record['name'] || record['id']}"
    return _get(record["id"], {}, options)
  end
  return 0, nil
end

#connect(options) ⇒ Object

standard connect method to establish @api_client and @name_interface variables for each registered interface.



484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 484

def connect(options)
  @api_client = establish_remote_appliance_connection(options)
  self.class.registered_interfaces.each do |interface_name|
    if interface_name.is_a?(String) || interface_name.is_a?(Symbol)
      instance_variable_set("@#{interface_name}_interface", @api_client.send(interface_name))
    elsif interface_name.is_a?(Hash)
      interface_name.each do |k,v|
        instance_variable_set("#{k}_interface", @api_client.send(v))
      end
    end
  end
end

#get(args) ⇒ Object 



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 538

def get(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[#{rest_arg}]")
    build_get_options(opts, options, params)
    opts.footer = <<-EOT
Get details about #{a_or_an(rest_label)} #{rest_label.downcase}.
[#{rest_arg}] is required. This is the #{rest_has_name ? 'name or id' : 'id'} of #{a_or_an(rest_label)} #{rest_label.downcase}.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:1)
  connect(options)
  parse_get_options!(args, options, params)
  id = args.join(" ")
  _get(id, params, options)
end

#get_type(args) ⇒ Object 



935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 935

def get_type(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[#{rest_type_arg}]")
    build_get_options(opts, options, params)
    opts.footer = <<-EOT
Get details about #{a_or_an(rest_type_label)} #{rest_type_label.downcase}.
[#{rest_type_arg}] is required. This is the name or id of #{a_or_an(rest_type_label)} #{rest_type_label.downcase}.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:1)
  connect(options)
  parse_get_options!(args, options, params)
  id = args.join(" ")
  _get_type(id, params, options)
end

#handle(args) ⇒ Object 



497
498
499
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 497

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object 



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 501

def list(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[search]")
    build_list_options(opts, options, params)
    opts.footer = <<-EOT
List #{rest_label_plural.downcase}.
[search] is optional. This is a search phrase to filter the results.
EOT
  end
  optparse.parse!(args)
  connect(options)
  parse_list_options!(args, options, params)
  rest_interface.setopts(options)
  if options[:dry_run]
    print_dry_run rest_interface.dry.list(params)
    return
  end
  json_response = rest_interface.list(params)
  render_response(json_response, options, rest_list_key) do
    records = json_response[rest_list_key]
    title = "Morpheus #{rest_label_plural}"
    subtitles = []
    subtitles += parse_list_subtitles(options)
    print_h1 title, subtitles, options
    if records.nil? || records.empty?
      print cyan,"No #{rest_label_plural.downcase} found.",reset,"\n"
    else
      print as_pretty_table(records, rest_list_column_definitions(options).upcase_keys!, options)
      print_results_pagination(json_response) if json_response['meta']
    end
    print reset,"\n"
  end
  return 0, nil
end

#list_types(args) ⇒ Object 



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 898

def list_types(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[search]")
    build_list_options(opts, options, params)
    opts.footer = <<-EOT
List #{rest_type_label_plural.downcase}.
[search] is optional. This is a search phrase to filter the results.
EOT
  end
  optparse.parse!(args)
  connect(options)
  parse_list_options!(args, options, params)
  rest_type_interface.setopts(options)
  if options[:dry_run]
    print_dry_run rest_type_interface.dry.list(params)
    return
  end
  json_response = rest_type_interface.list(params)
  render_response(json_response, options, rest_type_list_key) do
    records = json_response[rest_type_list_key]
    title = "Morpheus #{rest_type_label_plural}"
    subtitles = []
    subtitles += parse_list_subtitles(options)
    print_h1 title, subtitles, options
    if records.nil? || records.empty?
      print cyan,"No #{rest_type_label_plural.downcase} found.",reset,"\n"
    else
      print as_pretty_table(records, rest_type_list_column_definitions(options).upcase_keys!, options)
      print_results_pagination(json_response) if json_response['meta']
    end
    print reset,"\n"
  end
  return 0, nil
end

#registered_interfaces ⇒ Object 



478
479
480
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 478

def registered_interfaces
  self.class.registered_interfaces
end

#remove(args) ⇒ Object 



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 863

def remove(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[#{rest_arg}]")
    build_standard_remove_options(opts, options)
    opts.footer = <<-EOT
Delete an existing #{rest_label.downcase}.
[#{rest_arg}] is required. This is the #{rest_has_name ? 'name or id' : 'id'} of #{a_or_an(rest_label)} #{rest_label.downcase}.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  connect(options)
  params.merge!(parse_query_options(options))
  id = args[0]
  record = rest_find_by_name_or_id(id)
  if record.nil?
    return 1, "#{rest_name} not found for '#{id}'"
  end
  unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the #{rest_label.downcase} #{record['name'] || record['id']}?")
    return 9, "aborted"
  end
  rest_interface.setopts(options)
  if options[:dry_run]
    print_dry_run rest_interface.dry.destroy(record['id'], params)
    return 0, nil
  end
  json_response = rest_interface.destroy(record['id'], params)
  render_response(json_response, options) do
    print_green_success "Removed #{rest_label.downcase} #{record['name'] || record['id']}"
  end
  return 0, nil
end

#render_response_for_get(json_response, options) ⇒ Object 



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 575

def render_response_for_get(json_response, options)
  render_response(json_response, options, rest_object_key) do
    record = json_response[rest_object_key]
    print_h1 rest_label, [], options
    print cyan
    print_description_list(rest_column_definitions(options), record, options)
    # # could always show config eh? or maybe only with --config if that is nicer.
    # # config = record['config'].is_a?(Hash) && !record['config'].empty?
    # if config && !config.empty?
    #   print_h2 "Configuration"
    #   print_description_list(config.keys, config)
    # end
    # Option Types
    if record['optionTypes'] && record['optionTypes'].sort { |x,y| x['displayOrder'].to_i <=> y['displayOrder'].to_i }.size > 0
      print_h2 "Option Types", options
      print format_option_types_table(record['optionTypes'], options, rest_object_key)
    end
    print reset,"\n"
  end
end

#render_response_for_get_type(json_response, options) ⇒ Object 



972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 972

def render_response_for_get_type(json_response, options)
  render_response(json_response, options, rest_type_object_key) do
    record = json_response[rest_type_object_key]
    print_h1 rest_type_label, [], options
    print cyan
    print_description_list(rest_type_column_definitions(options), record, options)
    # # could always show config eh? or maybe only with --config if that is nicer.
    # # config = record['config'].is_a?(Hash) && !record['config'].empty?
    # if config && !config.empty?
    #   print_h2 "Configuration"
    #   print_description_list(config.keys, config)
    # end
    # Option Types
    if record['optionTypes'] && record['optionTypes'].size > 0
      print_h2 "Option Types", options
      print format_option_types_table(record['optionTypes'], options, rest_object_key)
    end
    print reset,"\n"
  end
end

#rest_arg ⇒ Object 



334
335
336
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 334

def rest_arg
  self.class.rest_arg
end

#rest_column_definitions(options) ⇒ Object 



384
385
386
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 384

def rest_column_definitions(options)
  send("#{rest_key}_column_definitions", options)
end

#rest_find_by_name_or_id(val) ⇒ Object 



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 392

def rest_find_by_name_or_id(val)
  # use explicitly defined finders
  # else default to new generic CliCommand method to find anything by type (singular underscore)
  if rest_has_name
    if respond_to?("find_#{rest_key}_by_name_or_id", true)
      send("find_#{rest_key}_by_name_or_id", val)
    else
      find_by_name_or_id(rest_key, val)
    end
  else
    if respond_to?("find_#{rest_key}_by_id", true)
      send("find_#{rest_key}_by_id", val)
    else
      find_by_id(rest_key, val)
    end
  end
end

#rest_has_name ⇒ Object 



338
339
340
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 338

def rest_has_name
  self.class.rest_has_name
end

#rest_has_type ⇒ Object 



410
411
412
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 410

def rest_has_type
  self.class.rest_has_type
end

#rest_interface ⇒ Object

returns the default rest interface, allows using rest_interface_name = “your” or override this method to return @your_interface if needed



364
365
366
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 364

def rest_interface
  instance_variable_get("@#{rest_interface_name}_interface")
end

#rest_interface_name ⇒ Object 



350
351
352
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 350

def rest_interface_name
  self.class.rest_interface_name
end

#rest_key ⇒ Object 



330
331
332
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 330

def rest_key
  self.class.rest_key
end

#rest_label ⇒ Object 



342
343
344
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 342

def rest_label
  self.class.rest_label
end

#rest_label_plural ⇒ Object 



346
347
348
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 346

def rest_label_plural
  self.class.rest_label_plural
end

#rest_list_column_definitions(options) ⇒ Object 



388
389
390
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 388

def rest_list_column_definitions(options)
  send("#{rest_key}_list_column_definitions", options)
end

#rest_list_key ⇒ Object 



376
377
378
379
380
381
382
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 376

def rest_list_key
  if respond_to?("#{rest_key}_list_key", true)
    send("#{rest_key}_list_key")
  else
    rest_name.camelcase
  end
end

#rest_name ⇒ Object 



326
327
328
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 326

def rest_name
  self.class.rest_name
end

#rest_object_key ⇒ Object 



368
369
370
371
372
373
374
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 368

def rest_object_key
  if respond_to?("#{rest_key}_object_key", true)
    send("#{rest_key}_object_key")
  else
    rest_name.camelcase.singularize
  end
end

#rest_option_context_map ⇒ Object 



358
359
360
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 358

def rest_option_context_map
  self.class.rest_option_context_map
end

#rest_perms_config ⇒ Object 



354
355
356
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 354

def rest_perms_config
  self.class.rest_perms_config
end

#rest_type_arg ⇒ Object 



424
425
426
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 424

def rest_type_arg
  self.class.rest_type_arg
end

#rest_type_column_definitions(options) ⇒ Object 



460
461
462
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 460

def rest_type_column_definitions(options)
  send("#{rest_type_key}_column_definitions", options)
end

#rest_type_find_by_name_or_id(val) ⇒ Object 



468
469
470
471
472
473
474
475
476
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 468

def rest_type_find_by_name_or_id(val)
  # use explicately defined finders
  # else default to new generic CliCommand method to find anything by type (singular underscore)
  if respond_to?("find_#{rest_type_key}_by_name_or_id", true)
    send("find_#{rest_type_key}_by_name_or_id", val)
  else
    find_by_name_or_id(rest_type_key, val)
  end
end

#rest_type_interface ⇒ Object 



440
441
442
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 440

def rest_type_interface
  instance_variable_get("@#{rest_type_interface_name}_interface")
end

#rest_type_interface_name ⇒ Object 



436
437
438
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 436

def rest_type_interface_name
  self.class.rest_type_interface_name # || "@#{rest_type_name}_interface"
end

#rest_type_key ⇒ Object 



420
421
422
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 420

def rest_type_key
  self.class.rest_type_key
end

#rest_type_label ⇒ Object 



428
429
430
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 428

def rest_type_label
  self.class.rest_type_label
end

#rest_type_label_plural ⇒ Object 



432
433
434
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 432

def rest_type_label_plural
  self.class.rest_type_label_plural
end

#rest_type_list_column_definitions(options) ⇒ Object 



464
465
466
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 464

def rest_type_list_column_definitions(options)
  send("#{rest_type_key}_list_column_definitions", options)
end

#rest_type_list_key ⇒ Object 



452
453
454
455
456
457
458
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 452

def rest_type_list_key
  if respond_to?("#{rest_type_key}_list_key", true)
    send("#{rest_type_key}_list_key")
  else
    rest_type_name.camelcase
  end
end

#rest_type_name ⇒ Object

duplicated the rest_* settings with rest_type, for the types resource



416
417
418
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 416

def rest_type_name
  self.class.rest_type_name
end

#rest_type_object_key ⇒ Object 



444
445
446
447
448
449
450
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 444

def rest_type_object_key
  if respond_to?("#{rest_type_key}_object_key", true)
    send("#{rest_type_key}_object_key")
  else
    rest_type_name.camelcase.singularize
  end
end

#update(args) ⇒ Object 



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/morpheus/cli/mixins/rest_command.rb', line 748

def update(args)
  record_type = nil
  record_type_id = nil
  options = {}
  option_types = respond_to?("update_#{rest_key}_option_types", true) ? send("update_#{rest_key}_option_types") : []
  advanced_option_types = respond_to?("update_#{rest_key}_advanced_option_types", true) ? send("update_#{rest_key}_advanced_option_types") : []
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[#{rest_arg}] [options]")
    build_option_type_options(opts, options, option_types)
    build_option_type_options(opts, options, advanced_option_types)
    build_standard_update_options(opts, options)
    opts.footer = <<-EOT
Update an existing #{rest_label.downcase}.
[#{rest_arg}] is required. This is the #{rest_has_name ? 'name or id' : 'id'} of #{a_or_an(rest_label)} #{rest_label.downcase}.
EOT
    opts.footer += send "update_#{rest_key}_footer_addn" if respond_to?("update_#{rest_key}_footer_addn", true)
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  connect(options)
  id = args[0]
  record = rest_find_by_name_or_id(id)
  if record.nil?
    return 1, "#{rest_name} not found for '#{id}'"
  end
  # load type so we can prompt for those option types
  if rest_has_type
    record_type_id = record['type']['id']
    record_type = rest_type_find_by_name_or_id(record_type_id)
    if record_type.nil?
      return 1, "#{rest_type_label} not found for '#{record_type_id}"
    end
    # reload the type by id to get all the details ie. optionTypes
    if record_type['optionTypes'].nil?
      record_type = rest_type_find_by_name_or_id(record_type['id'])
    end
  end
  passed_options = parse_passed_options(options)
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({rest_object_key => passed_options}) unless passed_options.empty?
  else
    record_payload = passed_options
    if rest_has_type && record_type
      # inject type to options for prompting
      # record_payload['type'] = record_type['code']
      # options[:options]['type'] = record_type['code']
      # initialize params for loading optionSource data
      options[:params] ||= {}
      options[:params]['type'] = record_type['code']
    end
    # update options without prompting by default
    if option_types && !option_types.empty?
      api_params = (options[:params] || {}).merge(record_payload) # need to merge in values from record too, ughhh
      v_prompt = Morpheus::Cli::OptionTypes.no_prompt(option_types, options[:options], @api_client, api_params)
      v_prompt.deep_compact!
      v_prompt.booleanize! # 'on' => true
      record_payload.deep_merge!(v_prompt)
    end
    # options by type
    my_option_types = nil
    if respond_to?("load_option_types_for_#{rest_key}", true)
      my_option_types = send("load_option_types_for_#{rest_key}", record_type, nil)
    else
      my_option_types = record_type ? record_type['optionTypes'] : nil
    end
    if my_option_types && !my_option_types.empty?
      # remove redundant fieldContext
      # make them optional for updates
      # todo: use current value as default instead of just making things optioanl
      # maybe new prompt() options like {:mode => :edit, :object => storage_server} or something
      my_option_types.each do |option_type| 
        if option_type['fieldContext'] == rest_object_key
          option_type['fieldContext'] = nil
        end
        option_type.delete('required')
        option_type.delete('defaultValue')
      end
      api_params = (options[:params] || {}).merge(record_payload) # need to merge in values from record too, ughhh
      v_prompt = Morpheus::Cli::OptionTypes.no_prompt(my_option_types, options[:options], @api_client, api_params)
      v_prompt.deep_compact!
      v_prompt.booleanize! # 'on' => true
      record_payload.deep_merge!(v_prompt)
    end
    # advanced options
    if advanced_option_types && !advanced_option_types.empty?
      v_prompt = Morpheus::Cli::OptionTypes.no_prompt(advanced_option_types, options[:options], @api_client, options[:params])
      v_prompt.deep_compact!
      v_prompt.booleanize! # 'on' => true
      record_payload.deep_merge!(v_prompt)
    end
    # remove empty config, compact could hanlde this
    if record_payload['config'] && record_payload['config'].empty?
      record_payload.delete('config')
    end
    # prevent updating with empty payload
    if record_payload.empty?
      raise_command_error "Specify at least one option to update.\n#{optparse}"
    end
    payload[rest_object_key] = record_payload
  end
  rest_interface.setopts(options)
  if options[:dry_run]
    print_dry_run rest_interface.dry.update(record['id'], payload)
    return
  end
  json_response = rest_interface.update(record['id'], payload)
  render_response(json_response, options, rest_object_key) do
    print_green_success "Updated #{rest_label.downcase} #{record['name'] || record['id']}"
    _get(record["id"], {}, options)
  end
  return 0, nil
end