Module: Settings

80
81
82

# File 'lib/settings.rb', line 80

def self.default_data_directory
  @@default_data_directory
end

56
57
58

# File 'lib/settings.rb', line 56

def self.get_config_hash
  @@config_hash
end

200
201
202
203
204
205

# File 'lib/settings.rb', line 200

def self.load_action_mailer_smtp_settings(config, settings)
  if settings
    config.action_mailer.delivery_method = :smtp
    config.action_mailer.smtp_settings = settings
  end
end

210
211
212
213
214

# File 'lib/settings.rb', line 210

def self.load_action_mailer_url_host(config, url_host)
  if url_host
    config.action_mailer.default_url_options = { host: url_host }
  end
end

137
138
139
140
141
142
143
144

# File 'lib/settings.rb', line 137

def self.load_backup_directory(path)
  @@backup_directory = nil
  if !path.nil?
    full_path = File.absolute_path(path)
    setup_directory(full_path)
    @@backup_directory = full_path
  end
end

126
127
128
129
130
131
132
133

# File 'lib/settings.rb', line 126

def self.load_default_data_directory(path)
  @@default_data_directory = nil
  if !path.nil?
    full_path = File.absolute_path(path)
    setup_directory(full_path)
    @@default_data_directory = full_path
  end
end

148
149
150
151
152

# File 'lib/settings.rb', line 148

def self.load_exception_notification(config, settings)
  if settings
    config.middleware.use ExceptionNotification::Rack, email: process_exception_notification(settings)
  end
end

63
64
65
66
67
68
69
70
71

# File 'lib/settings.rb', line 63

def self.load_from_file(config, path, set_name)
  hash = YAML.load_file(path)
  if hash.keys.include?(set_name.to_s)
    self.load_from_hash(config, Utilities::Hashes.symbolize_keys(hash[set_name.to_s] || { }))
  else
    # require settings for production, but technically not test/development
    raise Error, "#{set_name} settings set not found" unless %w{production test development}.include?(set_name.to_s)
  end
end

38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# File 'lib/settings.rb', line 38

def self.load_from_hash(config, hash)
  invalid_sections = hash.keys - VALID_SECTIONS
  raise Error, "#{invalid_sections} are not valid sections" unless invalid_sections.empty?

  @@config_hash = hash.deep_dup

  load_exception_notification(config, hash[:exception_notification])
  load_default_data_directory(hash[:default_data_directory])
  load_backup_directory(hash[:backup_directory])
  load_action_mailer_smtp_settings(config, hash[:action_mailer_smtp_settings])
  load_action_mailer_url_host(config, hash[:action_mailer_url_host])
  load_mail_domain(config, hash[:mail_domain])
  load_interface(hash[:interface])
  load_selenium_config(hash[:selenium]) if hash[:selenium]
  true
end

75
76
77

# File 'lib/settings.rb', line 75

def self.load_from_settings_file(config, set_name)
  self.load_from_file(config, 'config/application_settings.yml', set_name) if File.exist?('config/application_settings.yml')
end

171
172
173
174
175
176
177
178
179
180
181

# File 'lib/settings.rb', line 171

def self.load_interface(settings)
  if settings
    invalid = settings.keys - [:sandbox_mode]
    raise Error, "#{invalid} are not valid settings for interface" unless invalid.empty?
    if settings[:sandbox_mode] == true
      @@sandbox_mode = true
      @@sandbox_commit_sha = TaxonworksNet.commit_sha
      @@sandbox_commit_date = TaxonworksNet.commit_date
    end
  end
end

219
220
221

# File 'lib/settings.rb', line 219

def self.load_mail_domain(config, mail_domain)
  @@mail_domain = mail_domain
end

185
186
187
188
189
190
191
192
193
194
195

# File 'lib/settings.rb', line 185

def self.load_selenium_config(settings)
  invalid = settings.keys - [:browser, :marionette, :firefox_binary_path, :chromedriver_path, :headless]

  raise Error, "#{invalid} are not valid settings for test:selenium." unless invalid.empty?
  raise Error, "Can not find Firefox browser binary #{settings[:firefox_binary_path]}." if settings[:browser] == :firefox && !settings[:firefox_binary_path].blank? && !File.exists?(settings[:firefox_binary_path])
  raise Error, "Can not find chromedriver #{ settings[:chromedriver_path] }." if settings[:browser] == :chrome && !settings[:chromedriver_path].blank? && !File.exists?(settings[:chromedriver_path])

  settings.each do |k,v|
    @@selenium_settings[k] = v if !v.blank?
  end
end

225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240

# File 'lib/settings.rb', line 225

def self.load_test_defaults(config)
  load_from_hash(config, {
    exception_notification: {
      email_prefix: '[TW-Error] ',
      sender_address: %{"notifier" <notifier@example.com>},
      exception_recipients: %w{exceptions@example.com},
    },
    mail_domain: 'example.com',
    selenium: {
      browser: 'firefox',
      marionette: false,
      firefox_binary_path: nil,
      chromedriver_path: nil
    }
  })
end

90
91
92

# File 'lib/settings.rb', line 90

def self.mail_domain
  @@mail_domain
end

156
157
158
159
160
161
162
163
164
165
166
167
168

# File 'lib/settings.rb', line 156

def self.process_exception_notification(settings)
  missing = EXCEPTION_NOTIFICATION_SETTINGS - settings.keys
  raise Error, "Missing #{missing} settings in exception_notification" unless missing.empty?

  invalid = settings.keys - EXCEPTION_NOTIFICATION_SETTINGS
  raise Error, "#{invalid} are not valid settings for exception_notification" unless invalid.empty?

  settings[:exception_recipients] =  settings[:exception_recipients].split(',') unless settings[:exception_recipients].class == Array || settings[:exception_recipients].blank?

  raise Error, ':exception_recipients must be an Array' unless settings[:exception_recipients].class == Array

  settings
end

105
106
107

# File 'lib/settings.rb', line 105

def self.sandbox_commit_date
  @@sandbox_commit_date
end

100
101
102

# File 'lib/settings.rb', line 100

def self.sandbox_commit_sha
  @@sandbox_commit_sha
end

95
96
97

# File 'lib/settings.rb', line 95

def self.sandbox_mode?
  @@sandbox_mode
end

110
111
112

# File 'lib/settings.rb', line 110

def self.selenium_settings
  @@selenium_settings
end

115
116
117
118
119
120
121
122

# File 'lib/settings.rb', line 115

def self.setup_directory(path)
  if !Dir.exists?(path)
    # TODO: use/open a logger
    Rainbow("Directory #{path} does not exist, creating").purple
    FileUtils.mkdir_p(path)
    raise Error, "Directory #{path} could not be made, check permissions" unless Dir.exists?(path)
  end
end