class AdminModule::Client

Attributes

page_factory[W]
password[W]
user[W]

Override credentials

Public Instance Methods

dcs() click to toggle source
# File lib/admin_module/client.rb, line 54
def dcs
  login
  DC.new page_factory
end
env() click to toggle source
# File lib/admin_module/client.rb, line 25
def env
  AdminModule.configuration.current_env
end
env=(environment) click to toggle source
# File lib/admin_module/client.rb, line 21
def env=(environment)
  AdminModule.configuration.current_env = environment
end
guideline() click to toggle source
# File lib/admin_module/client.rb, line 29
def guideline
  login
  Guideline.new page_factory
end
locks() click to toggle source
# File lib/admin_module/client.rb, line 44
def locks
  login
  Locks.new page_factory
end
login(user = nil, pass = nil) click to toggle source

Login to the admin module.

If no credentials are provided, try to get credentials from the config object.

# File lib/admin_module/client.rb, line 84
def login(user = nil, pass = nil)
  if @logged_in
    return true
  end

  user, pass = verify_credentials user, pass

  logout
  page_factory.login_page(true).login_as(user, pass)
  @logged_in = true
end
logout() click to toggle source

Logout of the admin module

# File lib/admin_module/client.rb, line 100
def logout
  page_factory.login_page(true).logout
  @logged_in = false
end
page_factory() click to toggle source
# File lib/admin_module/client.rb, line 74
def page_factory
  @page_factory ||= AdminModule::PageFactory.new
end
ppms() click to toggle source
# File lib/admin_module/client.rb, line 69
def ppms
  login
  Ppms.new page_factory
end
quit() click to toggle source

Logout of the admin module and quit the browser

# File lib/admin_module/client.rb, line 109
def quit
  logout
  page_factory.login_page(false).browser.close
end
rules() click to toggle source
# File lib/admin_module/client.rb, line 39
def rules
  login
  Rules.new page_factory
end
rulesets() click to toggle source
# File lib/admin_module/client.rb, line 34
def rulesets
  login
  Rulesets.new page_factory
end
snapshots() click to toggle source
# File lib/admin_module/client.rb, line 59
def snapshots
  login
  Snapshots.new page_factory
end
stages() click to toggle source
# File lib/admin_module/client.rb, line 49
def stages
  login
  Stages.new page_factory
end
tasks() click to toggle source
# File lib/admin_module/client.rb, line 64
def tasks
  login
  Tasks.new page_factory
end

Private Instance Methods

valid_user_and_pass?(user, pass) click to toggle source
# File lib/admin_module/client.rb, line 134
def valid_user_and_pass? user, pass
  if user.nil? || user.empty?
    return false
  end

  if pass.nil? || pass.empty?
    return false
  end

  true
end
verify_credentials(user, pass) click to toggle source

If credential args are empty, attempt to look them up,

first in the client attributes, then in the config obj.
# File lib/admin_module/client.rb, line 120
def verify_credentials user, pass
  return [user, pass] if valid_user_and_pass? user, pass

  # Pull values stored in this client.
  user, pass = @user, @password
  return [user, pass] if valid_user_and_pass? user, pass

  # Pull values stored in the config.
  user, pass = AdminModule.configuration.user_credentials
  return [user, pass] if valid_user_and_pass? user, pass

  fail AuthenticationRequired.new("Missing credentials for #{env}")
end