module Fog

credential() click to toggle source

This is the named credential from amongst the configuration file being used or :default

@note This can be set using the FOG_CREDENTIAL environment variable

@return [Symbol] The credential to use in Fog

# File lib/fog/core/credentials.rb, line 40
def self.credential
  @credential ||= ( ENV["FOG_CREDENTIAL"] && ENV["FOG_CREDENTIAL"].to_sym ) || :default
end

credential=(new_credential) click to toggle source

Assign a new credential to use from configuration file

@param [String, Symbol] new_credential name of new credential to use @return [Symbol] name of the new credential

# File lib/fog/core/credentials.rb, line 30
def self.credential=(new_credential)
  @credentials = nil
  @credential = new_credential && new_credential.to_sym
end

credentials() click to toggle source

@return [Hash] The credentials pulled from the configuration file @raise [LoadError] Configuration unavailable in configuration file

# File lib/fog/core/credentials.rb, line 67
def self.credentials
  @credentials ||= begin
    if credentials_path && File.exists?(credentials_path)
      credentials = Fog::Core::Utils.prepare_service_settings(YAML.load_file(credentials_path))
      (credentials && credentials[credential]) || Fog::Errors.missing_credentials
    else
      {}
    end
  end
end

credentials=(new_credentials) click to toggle source

Sets the global configuration up from a Hash rather than using background loading from a file

@example

Fog.credentials = {
  :default => {
    :example_url => "https://example.com/"
    :example_username => "bob",
    :example_password => "obo"
  },
  :production => {
    :example_username => "bob",
    :example_password => "obo"
  }
}

@return [Hash] The newly assigned credentials

# File lib/fog/core/credentials.rb, line 22
def self.credentials=(new_credentials)
  @credentials = new_credentials
end

credentials_path() click to toggle source

This returns the path to the configuration file being used globally to look for sets of credentials

@note This can be set using the FOG_RC environment variable or defaults to +$HOME/.fog+

@return [String] The path for configuration_file

# File lib/fog/core/credentials.rb, line 50
def self.credentials_path
  @credential_path ||= begin
    path = ENV["FOG_RC"] || (ENV['HOME'] && File.directory?(ENV['HOME']) && '~/.fog')
    File.expand_path(path) if path
  rescue
    nil
  end
end

credentials_path=(new_credentials_path) click to toggle source

@return [String] The new path for credentials file

# File lib/fog/core/credentials.rb, line 60
def self.credentials_path=(new_credentials_path)
  @credentials = nil
  @credential_path = new_credentials_path
end

interval() click to toggle source

# File lib/fog/core/wait_for_defaults.rb, line 3
def self.interval
  @interval
end

interval=(interval) click to toggle source

# File lib/fog/core/wait_for_defaults.rb, line 7
def self.interval=(interval)
  if interval.kind_of?(Proc)
    raise ArgumentError, "interval proc must return a positive" unless interval.call(1) >= 0
  else
    raise ArgumentError, "interval must be non-negative" unless interval >= 0
  end
  @interval = interval
end

max_interval() click to toggle source

# File lib/fog/core/wait_for_defaults.rb, line 27
def self.max_interval
  @max_interval
end

max_interval=(interval) click to toggle source

# File lib/fog/core/wait_for_defaults.rb, line 31
def self.max_interval=(interval)
  raise ArgumentError, "interval must be non-negative" unless interval >= 0
  @max_interval = interval
end

mock!() click to toggle source

# File lib/fog/core/mock.rb, line 5
def self.mock!
  @mocking = true
end

mock?() click to toggle source

# File lib/fog/core/mock.rb, line 13
def self.mock?
  @mocking
end

mocking?() click to toggle source

# File lib/fog/core/mock.rb, line 17
def self.mocking?
  @mocking
end

providers() click to toggle source

# File lib/fog/core/provider.rb, line 3
def self.providers
  @providers ||= {}
end

providers=(new_providers) click to toggle source

# File lib/fog/core/provider.rb, line 7
def self.providers=(new_providers)
  @providers = new_providers
end

services() click to toggle source

# File lib/fog/core/service.rb, line 4
def self.services
  @services ||= {}
end

symbolize_credential?(key) click to toggle source

@deprecated Don't use! @param [Object] key @return [true] if key == :headers

# File lib/fog/core/credentials.rb, line 81
def self.symbolize_credential?(key)
  ![:headers].include?(key)
end

symbolize_credentials(hash) click to toggle source

@deprecated Use {Fog::Core::Utils.prepare_service_settings} instead

# File lib/fog/core/credentials.rb, line 86
def self.symbolize_credentials(hash)
  Fog::Core::Utils.prepare_service_settings(hash)
end

timeout() click to toggle source

# File lib/fog/core/wait_for_defaults.rb, line 17
def self.timeout
  @timeout
end

timeout=(timeout) click to toggle source

# File lib/fog/core/wait_for_defaults.rb, line 21
def self.timeout=(timeout)
  raise ArgumentError, "timeout must be non-negative" unless timeout >= 0
  @timeout = timeout
end

unmock!() click to toggle source

# File lib/fog/core/mock.rb, line 9
def self.unmock!
  @mocking = false
end

wait_for(timeout=Fog.timeout, interval=Fog.interval, &block) click to toggle source

# File lib/fog/core/wait_for.rb, line 2
def self.wait_for(timeout=Fog.timeout, interval=Fog.interval, &block)
  duration = 0
  start = Time.now
  retries = 0
  until yield || duration > timeout
    sleep(interval.respond_to?(:call) ? interval.call(retries += 1).to_f : interval.to_f)
    duration = Time.now - start
  end
  if duration > timeout
    raise Errors::TimeoutError.new("The specified wait_for timeout (#{timeout} seconds) was exceeded")
  else
    { :duration => duration }
  end
end

Constants

Public Class Methods