Class: Morpheus::Cli::WikiCommand
- Inherits:
-
Object
- Object
- Morpheus::Cli::WikiCommand
- Includes:
- CliCommand
- Defined in:
- lib/morpheus/cli/wiki_command.rb
Instance Attribute Summary
Attributes included from CliCommand
Instance Method Summary collapse
- #add(args) ⇒ Object
- #categories(args) ⇒ Object
- #connect(opts) ⇒ Object
- #get(args) ⇒ Object
- #handle(args) ⇒ Object
-
#initialize ⇒ WikiCommand
constructor
A new instance of WikiCommand.
- #list(args) ⇒ Object
- #remove(args) ⇒ Object
- #update(args) ⇒ Object
- #view(args) ⇒ Object
Methods included from CliCommand
#build_common_options, #build_option_type_options, #command_name, #default_refresh_interval, #default_subcommand, #establish_remote_appliance_connection, #full_command_usage, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_id_list, #parse_list_options, #parse_list_subtitles, #print, #print_error, #puts, #puts_error, #raise_command_error, #render_with_format, #run_command_for_each_arg, #subcommand_aliases, #subcommand_usage, #subcommands, #usage, #verify_access_token!
Constructor Details
#initialize ⇒ WikiCommand
Returns a new instance of WikiCommand.
13 14 15 |
# File 'lib/morpheus/cli/wiki_command.rb', line 13 def initialize() # @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance end |
Instance Method Details
#add(args) ⇒ Object
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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/morpheus/cli/wiki_command.rb', line 199 def add(args) = {} optparse = Morpheus::Cli::OptionParser.new do |opts| opts. = subcommand_usage("[name] [options]") (opts, , add_wiki_page_option_types) (opts, , [: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]['name'] ||= args[0] end connect() begin # construct payload = [:options] ? [:options].reject {|k,v| k.is_a?(Symbol) } : {} payload = nil if [:payload] payload = [:payload] payload.deep_merge!({'page' => }) unless .empty? else payload = { 'page' => { } } # allow arbitrary -O options payload.deep_merge!({'page' => }) unless .empty? # prompt for options params = Morpheus::Cli::OptionTypes.prompt(add_wiki_page_option_types, [:options], @api_client, [:params]) payload.deep_merge!({'page' => params}) unless params.empty? end @wiki_interface.setopts() if [:dry_run] print_dry_run @wiki_interface.dry.create(payload) return end json_response = @wiki_interface.create(payload) if [: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']] + ([:remote] ? ["-r",[:remote]] : [])) end return 0 rescue RestClient::Exception => e print_rest_exception(e, ) exit 1 end end |
#categories(args) ⇒ Object
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 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'lib/morpheus/cli/wiki_command.rb', line 360 def categories(args) = {} params = {} optparse = Morpheus::Cli::OptionParser.new do |opts| opts. = subcommand_usage() (opts, , [: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() begin params.merge!(()) @wiki_interface.setopts() if [: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, , 'categories') return 0 if render_result categories = json_response['categories'] unless [:quiet] title = "Morpheus Wiki Categories" subtitles = [] subtitles += parse_list_subtitles() print_h1 title, subtitles if categories.empty? print yellow,"No wiki categories found.",reset,"\n" else columns = [ {"CATEGORY" => lambda {|page| page['name'] } }, {"# PAGES" => lambda {|it| it['pageCount'] } } ] if [:include_fields] columns = [:include_fields] end print as_pretty_table(categories, columns, ) #print_results_pagination(json_response) end print reset,"\n" end return 0 rescue RestClient::Exception => e print_rest_exception(e, ) exit 1 end end |
#connect(opts) ⇒ Object
17 18 19 20 |
# File 'lib/morpheus/cli/wiki_command.rb', line 17 def connect(opts) @api_client = establish_remote_appliance_connection(opts) @wiki_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).wiki end |
#get(args) ⇒ Object
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 151 152 153 154 155 |
# File 'lib/morpheus/cli/wiki_command.rb', line 86 def get(args) = {} params = {} open_wiki_link = false optparse = Morpheus::Cli::OptionParser.new do |opts| opts. = subcommand_usage("[name]") opts.on('--view', '--view', "View wiki page in web browser too.") do open_wiki_link = true end (opts, , [: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() begin @wiki_interface.setopts() if [: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, , 'page') return 0 if render_result unless [: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']] + ([:remote] ? ["-r",[:remote]] : [])) end return 0 rescue RestClient::Exception => e print_rest_exception(e, ) exit 1 end end |
#handle(args) ⇒ Object
22 23 24 |
# File 'lib/morpheus/cli/wiki_command.rb', line 22 def handle(args) handle_subcommand(args) end |
#list(args) ⇒ Object
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 80 81 82 83 84 |
# File 'lib/morpheus/cli/wiki_command.rb', line 26 def list(args) = {} params = {} optparse = Morpheus::Cli::OptionParser.new do |opts| opts. = subcommand_usage() opts.on('--category VALUE', String, "Category") do |val| params['category'] = val end (opts, , [: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() begin params.merge!(()) @wiki_interface.setopts() if [: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, , 'pages') return 0 if render_result pages = json_response['pages'] unless [:quiet] title = "Morpheus Wiki Pages" subtitles = [] if params['category'] subtitles << "Category: #{params['category']}" end subtitles += parse_list_subtitles() print_h1 title, subtitles if pages.empty? print yellow,"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 [:include_fields] columns = [:include_fields] end print as_pretty_table(pages, columns, ) print_results_pagination(json_response) end print reset,"\n" end return 0 rescue RestClient::Exception => e print_rest_exception(e, ) exit 1 end end |
#remove(args) ⇒ Object
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'lib/morpheus/cli/wiki_command.rb', line 320 def remove(args) = {} optparse = Morpheus::Cli::OptionParser.new do |opts| opts. = subcommand_usage("[name]") (opts, , [: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() begin page = find_wiki_page_by_name_or_id(args[0]) return 1 if page.nil? unless [:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the page #{page['name']}?") return 9, "aborted command" end @wiki_interface.setopts() if [:dry_run] print_dry_run @wiki_interface.dry.destroy(page['id']) return end json_response = @wiki_interface.destroy(page['id']) if [: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, ) exit 1 end end |
#update(args) ⇒ Object
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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/morpheus/cli/wiki_command.rb', line 255 def update(args) = {} optparse = Morpheus::Cli::OptionParser.new do |opts| opts. = subcommand_usage("[name] [options]") (opts, , update_wiki_page_option_types) (opts, , [: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() begin page = find_wiki_page_by_name_or_id(args[0]) return 1 if page.nil? # construct payload = [:options] ? [:options].reject {|k,v| k.is_a?(Symbol) } : {} payload = nil if [:payload] payload = [:payload] payload.deep_merge!({'page' => }) unless .empty? else payload = { 'page' => { } } # allow arbitrary -O options payload.deep_merge!({'page' => }) unless .empty? # prompt for options #params = Morpheus::Cli::OptionTypes.prompt(update_wiki_page_option_types, options[:options], @api_client, options[:params]) params = 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() if [:dry_run] print_dry_run @wiki_interface.dry.update(page['id'], payload) return end json_response = @wiki_interface.update(page['id'], payload) if [: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']] + ([:remote] ? ["-r",[:remote]] : [])) end return 0 rescue RestClient::Exception => e print_rest_exception(e, ) exit 1 end end |
#view(args) ⇒ Object
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/morpheus/cli/wiki_command.rb', line 157 def view(args) = {} optparse = Morpheus::Cli::OptionParser.new do |opts| opts. = subcommand_usage("[id]") (opts, , [:dry_run, :remote]) opts. = "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() 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']}" open_command = nil if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/ open_command = "start #{link}" elsif RbConfig::CONFIG['host_os'] =~ /darwin/ open_command = "open #{link}" elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/ open_command = "xdg-open #{link}" end if [:dry_run] puts "system: #{open_command}" return 0 end system(open_command) return 0 rescue RestClient::Exception => e print_rest_exception(e, ) exit 1 end end |