module ChefAPI::Defaults

Constants

ENDPOINT

Default API endpoint

USER_AGENT

Default User Agent header string

Public Class Methods

chef_api_config_path() click to toggle source

String representation of path to configuration file

@return [String, nil] Path to config file, or nil

# File lib/chef-api/defaults.rb, line 48
def chef_api_config_path
  ENV["CHEF_API_CONFIG"] || if ENV.key?("HOME")
                              "~/.chef-api"
                            else
                              nil
                            end
end
client() click to toggle source

The name of the Chef API client. This is the equivalent of client_name in Chef terminology. In most cases, this is your Chef username.

@return [String, nil]

# File lib/chef-api/defaults.rb, line 113
def client
  ENV["CHEF_API_CLIENT"] || config["CHEF_API_CLIENT"]
end
config() click to toggle source

The Chef API configuration

@return [Hash]

# File lib/chef-api/defaults.rb, line 27
def config
  path = config_path
  @config ||= path.exist? ? JSON.parse(path.read) : {}
end
config_path() click to toggle source

Pathname to configuration file, or a blank Pathname.

@return [Pathname] an expanded Pathname or a non-existent Pathname

# File lib/chef-api/defaults.rb, line 36
def config_path
  if result = chef_api_config_path
    Pathname(result).expand_path
  else
    Pathname("")
  end
end
endpoint() click to toggle source

The endpoint where the Chef Server lives. This is equivalent to the chef_server_url in Chef terminology. If you are using Enterprise Hosted Chef or Enterprise Chef on premise, this endpoint should include your organization name. For example:

https://api.opscode.com/organizations/bacon

If you are running Open Source Chef Server or Chef Zero, this is the full URL to your Chef Server instance, including the server port and FQDN.

https://chef.server.local:4567/

@return [String] (default: https://api.opscode.com/)

# File lib/chef-api/defaults.rb, line 72
def endpoint
  ENV["CHEF_API_ENDPOINT"] || config["CHEF_API_ENDPOINT"] || ENDPOINT
end
flavor() click to toggle source

The flavor of the target Chef Server. There are two possible values:

- enterprise
- open_source

“Enterprise” covers both Hosted Chef and Enterprise Chef. “Open Source” covers both Chef Zero and Open Source Chef Server.

@return [true, false]

# File lib/chef-api/defaults.rb, line 87
def flavor
  if ENV["CHEF_API_FLAVOR"]
    ENV["CHEF_API_FLAVOR"].to_sym
  elsif config["CHEF_API_FLAVOR"]
    config["CHEF_API_FLAVOR"]
  else
    endpoint.include?("/organizations") ? :enterprise : :open_source
  end
end
key() click to toggle source

The private key to authentication against the Chef Server. This is equivalent to the client_key in Chef terminology. This value can be the client key in plain text or a path to the key on disk.

@return [String, nil]

# File lib/chef-api/defaults.rb, line 124
def key
  ENV["CHEF_API_KEY"] || config["CHEF_API_KEY"]
end
options() click to toggle source

The list of calculated default options for the configuration.

@return [Hash]

# File lib/chef-api/defaults.rb, line 19
def options
  Hash[Configurable.keys.map { |key| [key, send(key)] }]
end
proxy_address() click to toggle source

The HTTP Proxy server address as a string

@return [String, nil]

# File lib/chef-api/defaults.rb, line 133
def proxy_address
  ENV["CHEF_API_PROXY_ADDRESS"] || config["CHEF_API_PROXY_ADDRESS"]
end
proxy_password() click to toggle source

The HTTP Proxy user password as a string

@return [String, nil]

# File lib/chef-api/defaults.rb, line 142
def proxy_password
  ENV["CHEF_API_PROXY_PASSWORD"] || config["CHEF_API_PROXY_PASSWORD"]
end
proxy_port() click to toggle source

The HTTP Proxy server port as a string

@return [String, nil]

# File lib/chef-api/defaults.rb, line 151
def proxy_port
  ENV["CHEF_API_PROXY_PORT"] || config["CHEF_API_PROXY_PORT"]
end
proxy_username() click to toggle source

The HTTP Proxy server username as a string

@return [String, nil]

# File lib/chef-api/defaults.rb, line 160
def proxy_username
  ENV["CHEF_API_PROXY_USERNAME"] || config["CHEF_API_PROXY_USERNAME"]
end
read_timeout() click to toggle source

Network request read timeout in seconds (default: 60)

@return [Integer, nil]

# File lib/chef-api/defaults.rb, line 191
def read_timeout
  timeout_from_env = ENV["CHEF_API_READ_TIMEOUT"] || config["CHEF_API_READ_TIMEOUT"]

  Integer(timeout_from_env) unless timeout_from_env.nil?
end
ssl_pem_file() click to toggle source

The path to a pem file on disk for use with a custom SSL verification

@return [String, nil]

# File lib/chef-api/defaults.rb, line 169
def ssl_pem_file
  ENV["CHEF_API_SSL_PEM_FILE"] || config["CHEF_API_SSL_PEM_FILE"]
end
ssl_verify() click to toggle source

Verify SSL requests (default: true)

@return [true, false]

# File lib/chef-api/defaults.rb, line 178
def ssl_verify
  if ENV["CHEF_API_SSL_VERIFY"].nil? && config["CHEF_API_SSL_VERIFY"].nil?
    true
  else
    %w{t y}.include?(ENV["CHEF_API_SSL_VERIFY"].downcase[0]) || config["CHEF_API_SSL_VERIFY"]
  end
end
user_agent() click to toggle source

The User Agent header to send along.

@return [String]

# File lib/chef-api/defaults.rb, line 102
def user_agent
  ENV["CHEF_API_USER_AGENT"] || config["CHEF_API_USER_AGENT"] || USER_AGENT
end