Module: Morpheus::Cli::AccountsHelper

Included in:
Accounts, Apps, ChangePasswordCommand, Hosts, Instances, KeyPairs, PoliciesCommand, RecentActivityCommand, Roles, TenantsCommand, UserGroupsCommand, UserSourcesCommand, Users, Whoami
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

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 (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 (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 (val)
  if val.to_s =~ /\A\d{1,}\Z/
    return (val)
  else
    return (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 (options)
   = nil
  if options[:account]
     = (options[:account])
    exit 1 if .nil?
  elsif options[:account_name]
     = (options[:account_name])
    exit 1 if .nil?
  elsif options[:account_id]
     = (options[:account_id])
    exit 1 if .nil?
  else
     = nil # use current account
  end
  return 
end

#find_all_user_ids(account_id, usernames) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 159

def find_all_user_ids(, usernames)
  user_ids = []
  if usernames.is_a?(String)
    usernames = usernames.split(",").collect {|it| it.to_s.strip }.select {|it| it }.uniq
  else
    usernames = usernames.collect {|it| it.to_s.strip }.select {|it| it }.uniq
  end
  usernames.each do |username|
    # save a query
    #user = find_user_by_username_or_id(nil, username)
    if username.to_s =~ /\A\d{1,}\Z/
      user_ids << username.to_i
    else
      user = find_user_by_username(, username)
      if user.nil?
        return nil
      else
        user_ids << user['id']
      end
    end
  end
  user_ids
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(, id)
  begin
    json_response = roles_interface.get(, 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: find_role_by_authority 



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(, name)
  roles = roles_interface.list(, {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, thin: true})
    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(, val)
  if val.to_s =~ /\A\d{1,}\Z/
    return find_role_by_id(, val)
  else
    return find_role_by_name(, 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(, id)
  begin
    json_response = users_interface.get(, 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(, username)
  users = users_interface.list(, {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, thin: true})
    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(, val)
  if val.to_s =~ /\A\d{1,}\Z/
    return find_user_by_id(, val)
  else
    return find_user_by_username(, val)
  end
end

#format_role_type(role) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 213

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 



285
286
287
288
289
290
291
292
293
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 285

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 



295
296
297
298
299
300
301
302
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 295

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, options = {}) ⇒ Object 



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
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 183

def print_accounts_table(accounts, options={})
  table_color = options.key?(:color) ? options[:color] : cyan
  rows = accounts.collect do ||
    status_state = nil
    if ['active']
      status_state = "#{green}ACTIVE#{table_color}"
    else
      status_state = "#{red}INACTIVE#{table_color}"
    end
    {
      id: ['id'],
      name: ['name'],
      description: ['description'],
      role: ['role'] ? ['role']['authority'] : nil,
      status: status_state,
      dateCreated: format_local_dt(['dateCreated'])
    }
  end
  print table_color
  tp rows, [
    :id,
    :name,
    :description,
    :role,
    {:dateCreated => {:display_name => "Date Created"} },
    :status
  ]
  print reset
end

#print_roles_table(roles, options = {}) ⇒ Object 



232
233
234
235
236
237
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
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 232

def print_roles_table(roles, options={})
  table_color = options.key?(:color) ? options[: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
  columns = [
    :id,
    :name,
    :description,
    # options[:is_master_account] ? :scope : nil,
    options[:is_master_account] ? :type : nil,
    options[:is_master_account] ? :multitenant : nil,
    options[:is_master_account] ? :owner : nil,
    {:dateCreated => {:display_name => "Date Created"} }
  ].compact
  if options[:include_fields]
    columns = options[:include_fields]
  end
  # print table_color if table_color
  print as_pretty_table(rows, columns, options)
  # print reset if table_color
end

#print_users_table(users, options = {}) ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 271

def print_users_table(users, options={})
  table_color = options[:color] || cyan
  rows = users.collect do |user|
    {id: user['id'], username: user['username'], name: user['displayName'], first: user['firstName'], last: user['lastName'], email: user['email'], role: format_user_role_names(user), account: user['account'] ? user['account']['name'] : nil}
  end
  columns = [:id, :account, :first, :last, :username, :email, :role]
  if options[:include_fields]
    columns = options[:include_fields] 
  end
  #print table_color if table_color
  print as_pretty_table(rows, columns, options)
  #print reset if table_color
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