Class: Jamf::Configuration

Inherits:
Object show all
Includes:
Singleton
Defined in:
lib/jamf/configuration.rb

Overview

Note:

Passwords are not saved in prefs files. Your application will have to acquire them using the :prompt or :stdin options to APIConnection#connect, or by custom means.

A class for working with pre-defined settings & preferences for the JAMF Gem

This is a singleton class, only one instance can exist at a time.

When the JAMF module loads, that instance is created and stored in the constant CONFIG, which can then be used in applications to avoid always having to pass in server names, API user names and so on.

When the Jamf::Configuration instance is created, the GLOBAL_CONF file (/etc/jss_gem.conf) is examined if it exists, and the items in it are loaded into the attributes.

Then the user-specific USER_CONF file (~/.ruby-jss.conf) is examined if it exists, and any attributes defined there will override those values from the GLOBAL_CONF.

The file format is one attribute per line, thus:

attr_name: value

Lines that don’t start with a known attribute name followed by a colon are ignored. If an attribute is defined more than once, the last one wins.

The known attributes are:

  • api_server_name [String] the hostname of the JAMF API server

  • api_server_port [Integer] the port number for the API connection

  • api_ssl_version [String] the SSL version (from the open_ssl module) to use for the connection.

  • api_verify_cert [Boolean] if SSL is used, should the SSL certificate be verified (usually false for a self-signed cert)

  • api_username [String] the JAMF username for connecting to the API

  • api_timeout_open [Integer] the number of seconds for the open-connection timeout

  • api_timeout [Integer] the number of seconds for the response timeout

The APIConnection#connect method will first use any values given as method arguments. For any not given, it will look at the Preferences instance for any values there, and if still none, will use default values or raise an exception.

At any point, the attributes can read or changed using standard Ruby getter/setter methods matching the name of the attribute, e.g.

Jamf::CONFIG.api_server_name  # => 'myjss.mycompany.com'
Jamf::CONFIG.api_server_name = 'otherjss.mycompany.com'  # sets the api_server_name to a new value

The current settings may be saved to the GLOBAL_CONF file, the USER_CONF file, or an arbitrary file using #save. The argument to #save should be either :user, :global, or a String or Pathname file path. NOTE: This overwrites any existing file.

To re-load the settings use #reload. This clears the current settings, and re-reads both the global and user files. If a pathname is provided, e.g.

Jamf::CONFIG.reload '/path/to/other/file'

the current settings are cleared and reloaded from that other file.

To view the current settings, use #print.

Constant Summary collapse

CONF_FILENAME =

The filename for storing the config, globally or user-level. The first matching file is used - the array provides backward compatibility with earlier versions. Saving will always happen to the first filename

'ruby-jss.conf'.freeze
GLOBAL_CONF_FILE =

The Pathname to the machine-wide preferences

Pathname.new "/etc/#{CONF_FILENAME}"
USER_CONF_FILE =

The Pathname to the user-specific preferences plist if there is one

Pathname.new("#{ENV['HOME']}/.#{CONF_FILENAME}")
CONF_KEYS =

The attribute keys we maintain, and the type they should be stored as

{
  api_server_name: :to_s,
  api_server_port: :to_i,
  api_ssl_version: :to_s,
  api_verify_cert: :j_to_bool,
  api_username: :to_s,
  api_timeout_open: :to_i,
  api_timeout: :to_i,
  db_server_name: :to_s,
  db_server_port: :to_i,
  db_server_socket: :to_s,
  db_username: :to_s,
  db_name: :to_s,
  db_connect_timeout: :to_i,
  db_read_timeout: :to_i,
  db_write_timeout: :to_i
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Initialize!



139
140
141
142
 
# File 'lib/jamf/configuration.rb', line 139

def initialize
  read_global
  read_user
end

Instance Method Details

#clear_all ⇒ void

This method returns an undefined value.

Clear all values



151
152
153
 
# File 'lib/jamf/configuration.rb', line 151

def clear_all
  CONF_KEYS.keys.each { |k| send "#{k}=".to_sym, nil }
end

#print ⇒ void

This method returns an undefined value.

Print out the current settings to stdout



236
237
238
 
# File 'lib/jamf/configuration.rb', line 236

def print
  CONF_KEYS.keys.sort.each { |k| puts "#{k}: #{send k}" }
end

#read_global ⇒ void

This method returns an undefined value.

(Re)read the global prefs, if it exists.



159
160
161
 
# File 'lib/jamf/configuration.rb', line 159

def read_global
  read GLOBAL_CONF_FILE if GLOBAL_CONF_FILE.file? && GLOBAL_CONF_FILE.readable?
end

#read_user ⇒ void

This method returns an undefined value.

(Re)read the user prefs, if it exists.



167
168
169
 
# File 'lib/jamf/configuration.rb', line 167

def read_user
  read USER_CONF_FILE if USER_CONF_FILE.file? && USER_CONF_FILE.readable?
end

#reload(file = nil) ⇒ void

This method returns an undefined value.

Clear the settings and reload the prefs files, or another file if provided

Parameters:

  • file (String, Pathname) (defaults to: nil) —

    a non-standard prefs file to load



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/jamf/configuration.rb', line 177

def reload(file = nil)
  clear_all
  if file
    read file
    return true
  end
  read_global
  read_user
  true
end

#save(file) ⇒ void

This method returns an undefined value.

Save the prefs into a file

Parameters:

  • file (Symbol, String, Pathname) —

    either :user, :global, or an arbitrary file to save.

Raises:



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/jamf/configuration.rb', line 194

def save(file)
  path =
    case file
    when :global then GLOBAL_CONF_FILE
    when :user then USER_CONF_FILE
    else Pathname.new(file)
    end

  raise Jamf::MissingDataError, "No HOME environment variable, can't write to user conf file." if path.nil?

  # file already exists? read it in and update the values.
  if path.readable?
    data = path.read

    # go thru the known attributes/keys
    CONF_KEYS.keys.sort.each do |k|
      # if the key exists, update it.
      if data =~ /^#{k}:/
        data.sub!(/^#{k}:.*$/, "#{k}: #{send k}")

      # if not, add it to the end unless it's nil
      else
        data += "\n#{k}: #{send k}" unless send(k).nil?
      end # if data =~ /^#{k}:/
    end # each do |k|

  else # not readable, make a new file
    data = ''
    CONF_KEYS.keys.sort.each do |k|
      data << "#{k}: #{send k}\n" unless send(k).nil?
    end
  end # if path readable

  # make sure we end with a newline, the save it.
  data << "\n" unless data.end_with?("\n")
  path.j_save data
end