Class/Module Index [+]

Quicksearch

RHC::Rest::ApiMethods

These are methods that belong to the API object but are callable from the client for convenience.

Public Instance Methods

add_authorization(options={}) click to toggle source
# File lib/rhc/rest/client.rb, line 176
def add_authorization(options={})
  raise AuthorizationsNotSupported unless supports_sessions?
  api.rest_method('ADD_AUTHORIZATION', options, options)
end
add_domain(id, payload={}) click to toggle source
# File lib/rhc/rest/client.rb, line 17
def add_domain(id, payload={})
  debug "Adding domain #{id} with options #{payload.inspect}"
  @domains = nil
  payload.delete_if{ |k,v| k.nil? or v.nil? }
  api.rest_method "ADD_DOMAIN", {:id => id}.merge(payload)
end
add_key(name, key, content) click to toggle source
# File lib/rhc/rest/client.rb, line 142
def add_key(name, key, content)
  debug "Adding key #{key} for #{user.login}"
  user.add_key name, key, content
end
applications(options={}) click to toggle source
# File lib/rhc/rest/client.rb, line 38
def applications(options={})
  if link = api.link_href(:LIST_APPLICATIONS)
    api.rest_method :LIST_APPLICATIONS, options
  else
    self.domains.map{ |d| d.applications(options) }.flatten
  end
end
authorization_scope_list() click to toggle source
# File lib/rhc/rest/client.rb, line 191
def authorization_scope_list
  raise AuthorizationsNotSupported unless supports_sessions?
  link = api.links['ADD_AUTHORIZATION']
  scope = link['optional_params'].find{ |h| h['name'] == 'scope' }
  scope['description'].scan(/(?!\n)\*(.*?)\n(.*?)(?:\n|\Z)/).inject([]) do |h, (a, b)|
    h << [a.strip, b.strip] if a.present? && b.present?
    h
  end
end
authorizations() click to toggle source
# File lib/rhc/rest/client.rb, line 157
def authorizations
  raise AuthorizationsNotSupported unless supports_sessions?
  api.rest_method 'LIST_AUTHORIZATIONS'
end
cartridges() click to toggle source
# File lib/rhc/rest/client.rb, line 46
def cartridges
  debug "Getting all cartridges"
  @cartridges ||= api.rest_method("LIST_CARTRIDGES", nil, :lazy_auth => true)
end
delete_authorization(token) click to toggle source
# File lib/rhc/rest/client.rb, line 186
def delete_authorization(token)
  raise AuthorizationsNotSupported unless supports_sessions?
  api.rest_method('SHOW_AUTHORIZATION', nil, {:method => :delete, :params => {':id' => token}})
end
delete_authorizations() click to toggle source
# File lib/rhc/rest/client.rb, line 181
def delete_authorizations
  raise AuthorizationsNotSupported unless supports_sessions?
  api.rest_method('LIST_AUTHORIZATIONS', nil, {:method => :delete})
end
delete_key(name) click to toggle source
# File lib/rhc/rest/client.rb, line 147
def delete_key(name)
  debug "Deleting key '#{name}'"
  key = find_key(name)
  key.destroy
end
domains() click to toggle source
# File lib/rhc/rest/client.rb, line 24
def domains
  debug "Getting all domains"
  @domains ||= api.rest_method "LIST_DOMAINS"
end
find_application(domain, application, options={}) click to toggle source
# File lib/rhc/rest/client.rb, line 66
def find_application(domain, application, options={})
  request(:url => link_show_application_by_domain_name(domain, application), :method => "GET", :payload => options)
end
find_application_aliases(domain, application, options={}) click to toggle source
# File lib/rhc/rest/client.rb, line 74
def find_application_aliases(domain, application, options={})
  request(:url => link_show_application_by_domain_name(domain, application, "aliases"), :method => "GET", :payload => options)
end
find_application_by_id(id, options={}) click to toggle source
# File lib/rhc/rest/client.rb, line 78
def find_application_by_id(id, options={})
  if api.supports? :show_application
    request(:url => link_show_application_by_id(id), :method => "GET", :payload => options)
  else
    applications.find{ |a| a.id == id }
  end or raise ApplicationNotFoundException.new("Application with id #{id} not found")
end
find_application_by_id_gear_groups(id, options={}) click to toggle source
# File lib/rhc/rest/client.rb, line 86
def find_application_by_id_gear_groups(id, options={})
  if api.supports? :show_application
    request(:url => link_show_application_by_id(id, 'gear_groups'), :method => "GET", :payload => options)
  else
    applications.find{ |a| return a.gear_groups if a.id == id }
  end or raise ApplicationNotFoundException.new("Application with id #{id} not found")
end
find_application_gear_groups(domain, application, options={}) click to toggle source
# File lib/rhc/rest/client.rb, line 70
def find_application_gear_groups(domain, application, options={})
  request(:url => link_show_application_by_domain_name(domain, application, "gear_groups"), :method => "GET", :payload => options)
end
find_cartridges(name) click to toggle source

Find Cartridge by name or regex

# File lib/rhc/rest/client.rb, line 112
def find_cartridges(name)
  debug "Finding cartridge #{name}"
  if name.is_a?(Hash)
    regex = name[:regex]
    type = name[:type]
    name = name[:name]
  end

  filtered = Array.new
  cartridges.each do |cart|
    if regex
      filtered.push(cart) if cart.name.match(regex) and (type.nil? or cart.type == type)
    else
      filtered.push(cart) if (name.nil? or cart.name == name) and (type.nil? or cart.type == type)
    end
  end
  return filtered
end
find_domain(id) click to toggle source

Find Domain by namesapce

# File lib/rhc/rest/client.rb, line 57
def find_domain(id)
  debug "Finding domain #{id}"
  if link = api.link_href(:SHOW_DOMAIN, ':name' => id)
    request(:url => link, :method => "GET")
  else
    domains.find{ |d| d.name.downcase == id.downcase }
  end or raise DomainNotFoundException.new("Domain #{id} not found")
end
find_key(name) click to toggle source

find Key by name

# File lib/rhc/rest/client.rb, line 132
def find_key(name)
  debug "Finding key #{name}"
  user.find_key(name) or raise RHC::KeyNotFoundException.new("Key #{name} does not exist")
end
new_session(options={}) click to toggle source

Returns nil if creating sessions is not supported, raises on error, otherwise returns an Authorization object.

# File lib/rhc/rest/client.rb, line 166
def new_session(options={})
  if supports_sessions?
    api.rest_method('ADD_AUTHORIZATION', {
      :scope => 'session',
      :note => "RHC/#{RHC::VERSION::STRING} (from #{Socket.gethostname rescue 'unknown'} on #{RUBY_PLATFORM})",
      :reuse => true
    }, options)
  end
end
owned_domains() click to toggle source
# File lib/rhc/rest/client.rb, line 29
def owned_domains
  debug "Getting owned domains"
  if link = api.link_href(:LIST_DOMAINS_BY_OWNER)
    @owned_domains ||= api.rest_method 'LIST_DOMAINS_BY_OWNER', :owner => '@self'
  else
    domains
  end
end
reset() click to toggle source
# File lib/rhc/rest/client.rb, line 201
def reset
  (instance_variables - [
    :@end_point, :@debug, :@preferred_api_versions, :@auth, :@options, :@headers,
    :@last_options, :@httpclient, :@self_signed, :@current_api_version, :@api
  ]).each{ |sym| instance_variable_set(sym, nil) }
  self
end
sshkeys() click to toggle source
# File lib/rhc/rest/client.rb, line 137
def sshkeys
  debug "Finding all keys for #{user.login}"
  user.keys
end
supports_sessions?() click to toggle source
# File lib/rhc/rest/client.rb, line 153
def supports_sessions?
  api.supports? 'ADD_AUTHORIZATION'
end
user() click to toggle source
# File lib/rhc/rest/client.rb, line 51
def user
  debug "Getting user info"
  @user ||= api.rest_method "GET_USER"
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.