Module: Morpheus::Cli::AccountsHelper
- Defined in:
- lib/morpheus/cli/mixins/accounts_helper.rb
Overview
Mixin for Morpheus::Cli command classes Provides common methods for fetching and printing accounts, roles, and users. The including class must establish @accounts_interface, @roles_interface, @users_interface
Class Method Summary collapse
Instance Method Summary collapse
- #accounts_interface ⇒ Object
- #find_account_by_id(id) ⇒ Object
- #find_account_by_name(name) ⇒ Object
- #find_account_by_name_or_id(val) ⇒ Object
- #find_account_from_options(options) ⇒ Object
- #find_role_by_id(account_id, id) ⇒ Object
- #find_role_by_name(account_id, name) ⇒ Object (also: #find_role_by_authority)
- #find_role_by_name_or_id(account_id, val) ⇒ Object
- #find_user_by_id(account_id, id) ⇒ Object
- #find_user_by_username(account_id, username) ⇒ Object
- #find_user_by_username_or_id(account_id, val) ⇒ Object
- #format_role_type(role) ⇒ Object
- #format_user_role_names(user) ⇒ Object
- #get_access_string(val) ⇒ Object
- #print_accounts_table(accounts, opts = {}) ⇒ Object
- #print_roles_table(roles, opts = {}) ⇒ Object
- #print_users_table(users, opts = {}) ⇒ Object
- #roles_interface ⇒ Object
- #users_interface ⇒ Object
Class Method Details
.included(klass) ⇒ Object
9 10 11 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 9 def self.included(klass) klass.send :include, Morpheus::Cli::PrintHelper end |
Instance Method Details
#accounts_interface ⇒ Object
13 14 15 16 17 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 13 def accounts_interface # @api_client.accounts raise "#{self.class} has not defined @accounts_interface" if @accounts_interface.nil? @accounts_interface end |
#find_account_by_id(id) ⇒ Object
39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 39 def find_account_by_id(id) begin json_response = accounts_interface.get(id.to_i) return json_response['account'] rescue RestClient::Exception => e if e.response && e.response.code == 404 print_red_alert "Account not found by id #{id}" else raise e end end end |
#find_account_by_name(name) ⇒ Object
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 52 def find_account_by_name(name) accounts = accounts_interface.list({name: name.to_s})['accounts'] if accounts.empty? print_red_alert "Account not found by name #{name}" return nil elsif accounts.size > 1 print_red_alert "#{accounts.size} accounts found by name #{name}" print_accounts_table(accounts, {color: red}) print_red_alert "Try using -A ID instead" print reset,"\n" return nil else return accounts[0] end end |
#find_account_by_name_or_id(val) ⇒ Object
31 32 33 34 35 36 37 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 31 def find_account_by_name_or_id(val) if val.to_s =~ /\A\d{1,}\Z/ return find_account_by_id(val) else return find_account_by_name(val) end end |
#find_account_from_options(options) ⇒ Object
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 68 def () account = nil if [:account] account = find_account_by_name_or_id([:account]) exit 1 if account.nil? elsif [:account_name] account = find_account_by_name([:account_name]) exit 1 if account.nil? elsif [:account_id] account = find_account_by_id([:account_id]) exit 1 if account.nil? else account = nil # use current account end return account end |
#find_role_by_id(account_id, id) ⇒ Object
93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 93 def find_role_by_id(account_id, id) begin json_response = roles_interface.get(account_id, id.to_i) return json_response['role'] rescue RestClient::Exception => e if e.response && e.response.code == 404 print_red_alert "Role not found by id #{id}" else raise e end end end |
#find_role_by_name(account_id, name) ⇒ Object Also known as:
106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 106 def find_role_by_name(account_id, name) roles = roles_interface.list(account_id, {authority: name.to_s})['roles'] if roles.empty? print_red_alert "Role not found by name #{name}" return nil elsif roles.size > 1 print_red_alert "#{roles.size} roles by name #{name}" print_roles_table(roles, {color: red}) print reset,"\n\n" return nil else return roles[0] end end |
#find_role_by_name_or_id(account_id, val) ⇒ Object
85 86 87 88 89 90 91 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 85 def find_role_by_name_or_id(account_id, val) if val.to_s =~ /\A\d{1,}\Z/ return find_role_by_id(account_id, val) else return find_role_by_name(account_id, val) end end |
#find_user_by_id(account_id, id) ⇒ Object
131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 131 def find_user_by_id(account_id, id) begin json_response = users_interface.get(account_id, id.to_i) return json_response['user'] rescue RestClient::Exception => e if e.response && e.response.code == 404 print_red_alert "User not found by id #{id}" else raise e end end end |
#find_user_by_username(account_id, username) ⇒ Object
144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 144 def find_user_by_username(account_id, username) users = users_interface.list(account_id, {username: username.to_s})['users'] if users.empty? print_red_alert "User not found by username #{username}" return nil elsif users.size > 1 print_red_alert "#{users.size} users by username #{username}" print_users_table(users, {color: red}) print reset,"\n\n" return nil else return users[0] end end |
#find_user_by_username_or_id(account_id, val) ⇒ Object
123 124 125 126 127 128 129 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 123 def find_user_by_username_or_id(account_id, val) if val.to_s =~ /\A\d{1,}\Z/ return find_user_by_id(account_id, val) else return find_user_by_username(account_id, val) end end |
#format_role_type(role) ⇒ Object
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 189 def format_role_type(role) str = "" if role['roleType'] == "account" str = "Account" elsif role['roleType'] == "user" str = "User" else if role['scope'] == 'Account' str = "Legacy" else str = "Admin" # System Admin end end # if role['scope'] && role['filterType'] != 'Account' # str = "(System) #{str}" # end return str end |
#format_user_role_names(user) ⇒ Object
253 254 255 256 257 258 259 260 261 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 253 def format_user_role_names(user) role_names = "" if user && user['roles'] roles = user['roles'] roles = roles.sort {|a,b| a['authority'].to_s.downcase <=> b['authority'].to_s.downcase } role_names = roles.collect {|r| r['authority'] }.join(', ') end role_names end |
#get_access_string(val) ⇒ Object
263 264 265 266 267 268 269 270 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 263 def get_access_string(val) val ||= 'none' if val == 'none' "#{white}#{val.to_s.capitalize}#{cyan}" else "#{green}#{val.to_s.capitalize}#{cyan}" end end |
#print_accounts_table(accounts, opts = {}) ⇒ Object
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 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 159 def print_accounts_table(accounts, opts={}) table_color = opts[:color] || cyan rows = accounts.collect do |account| status_state = nil if account['active'] status_state = "#{green}ACTIVE#{table_color}" else status_state = "#{red}INACTIVE#{table_color}" end { id: account['id'], name: account['name'], description: account['description'], role: account['role'] ? account['role']['authority'] : nil, status: status_state, dateCreated: format_local_dt(account['dateCreated']) } end print table_color tp rows, [ :id, :name, :description, :role, {:dateCreated => {:display_name => "Date Created"} }, :status ] print reset end |
#print_roles_table(roles, opts = {}) ⇒ Object
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 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 208 def print_roles_table(roles, opts={}) table_color = opts[:color] || cyan # tp roles, [ # 'id', # 'name', # 'description', # 'scope', # {'dateCreated' => {:display_name => "Date Created", :display_method => lambda{|it| format_local_dt(it['dateCreated']) } } } # ] rows = roles.collect do |role| { id: role['id'], name: role['authority'], description: role['description'], scope: role['scope'], multitenant: role['multitenant'] ? 'Yes' : 'No', type: format_role_type(role), owner: role['owner'] ? role['owner']['name'] : "System", dateCreated: format_local_dt(role['dateCreated']) } end print table_color tp rows, [ :id, :name, :description, # opts[:is_master_account] ? :scope : nil, opts[:is_master_account] ? :type : nil, opts[:is_master_account] ? :multitenant : nil, opts[:is_master_account] ? :owner : nil, {:dateCreated => {:display_name => "Date Created"} } ].compact print reset end |
#print_users_table(users, opts = {}) ⇒ Object
243 244 245 246 247 248 249 250 251 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 243 def print_users_table(users, opts={}) table_color = opts[:color] || cyan rows = users.collect do |user| {id: user['id'], username: user['username'], first: user['firstName'], last: user['lastName'], email: user['email'], role: format_user_role_names(user), account: user['account'] ? user['account']['name'] : nil} end print table_color tp rows, :id, :account, :first, :last, :username, :email, :role print reset end |
#roles_interface ⇒ Object
25 26 27 28 29 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 25 def roles_interface # @api_client.roles raise "#{self.class} has not defined @roles_interface" if @roles_interface.nil? @roles_interface end |
#users_interface ⇒ Object
19 20 21 22 23 |
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 19 def users_interface # @api_client.users raise "#{self.class} has not defined @users_interface" if @users_interface.nil? @users_interface end |