Module: Morpheus::Cli::AccountsHelper

Included in:
Accounts, KeyPairs, Roles, 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

#find_account_by_id(id) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 13

def (id)
  raise "#{self.class} has not defined @accounts_interface" if @accounts_interface.nil?
  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 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 27

def (name)
  raise "#{self.class} has not defined @accounts_interface" if @accounts_interface.nil?
  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_from_options(options) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 44

def (options)
   = nil
  if 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_role_by_id(account_id, id) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 58

def find_role_by_id(, id)
  raise "#{self.class} has not defined @roles_interface" if @roles_interface.nil?
  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 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 72

def find_role_by_name(, name)
  raise "#{self.class} has not defined @roles_interface" if @roles_interface.nil?
  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})
    print reset,"\n\n"
    return nil
  else
    return roles[0]
  end
end

#find_user_by_id(account_id, id) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 90

def find_user_by_id(, id)
  raise "#{self.class} has not defined @users_interface" if @users_interface.nil?
  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 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 104

def find_user_by_username(, username)
  raise "#{self.class} has not defined @users_interface" if @users_interface.nil?
  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})
    print reset,"\n\n"
    return nil
  else
    return users[0]
  end
end

#format_role_type(role) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 151

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 



215
216
217
218
219
220
221
222
223
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 215

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 



225
226
227
228
229
230
231
232
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 225

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 



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

def print_accounts_table(accounts, opts={})
  table_color = opts[: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, opts = {}) ⇒ Object 



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
198
199
200
201
202
203
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 170

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 



205
206
207
208
209
210
211
212
213
 
# File 'lib/morpheus/cli/mixins/accounts_helper.rb', line 205

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