Class: CopyTunerClient::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/copy_tuner_client/configuration.rb

Overview

Used to set up and modify settings for the client.

Constant Summary collapse

OPTIONS =

These options will be present in the Hash returned by #to_hash.

[:api_key, :development_environments, :environment_name, :host,
:http_open_timeout, :http_read_timeout, :client_name, :client_url,
:client_version, :port, :protocol, :proxy_host, :proxy_pass,
:proxy_port, :proxy_user, :secure, :polling_delay, :sync_interval,
:sync_interval_staging, :sync_ignore_path_regex, :logger,
:framework, :middleware, :disable_middleware, :disable_test_translation,
:ca_file, :exclude_key_regexp, :s3_host, :locales, :ignored_keys, :ignored_key_handler].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Instantiated from CopyTunerClient.configure. Sets defaults.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/copy_tuner_client/configuration.rb', line 143

def initialize
  self.client_name = 'CopyTuner Client'
  self.client_url = 'https://rubygems.org/gems/copy_tuner_client'
  self.client_version = VERSION
  self.development_environments = %w(development staging)
  self.host = 'copy-tuner.com'
  self.http_open_timeout = 5
  self.http_read_timeout = 5
  self.logger = Logger.new($stdout)
  self.polling_delay = 300
  self.sync_interval = 60
  self.sync_interval_staging = 0
  self.secure = true
  self.test_environments = %w(test cucumber)
  self.upload_disabled_environments = %w[production staging]
  self.s3_host = 'copy-tuner-data-prod.s3.amazonaws.com'
  self.disable_copyray_comment_injection = false
  self.html_escape = false
  self.ignored_keys = []
  self.ignored_key_handler = -> (e) { raise e }

  @applied = false
end

Instance Attribute Details

#api_key ⇒ String 



25
26
27
 
# File 'lib/copy_tuner_client/configuration.rb', line 25

def api_key
  @api_key
end

#ca_file ⇒ String 



106
107
108
 
# File 'lib/copy_tuner_client/configuration.rb', line 106

def ca_file
  @ca_file
end

#cache ⇒ Cache 



109
110
111
 
# File 'lib/copy_tuner_client/configuration.rb', line 109

def cache
  @cache
end

#client ⇒ Client 



112
113
114
 
# File 'lib/copy_tuner_client/configuration.rb', line 112

def client
  @client
end

#client_name ⇒ String 



67
68
69
 
# File 'lib/copy_tuner_client/configuration.rb', line 67

def client_name
  @client_name
end

#client_url ⇒ String 



76
77
78
 
# File 'lib/copy_tuner_client/configuration.rb', line 76

def client_url
  @client_url
end

#client_version ⇒ String 



73
74
75
 
# File 'lib/copy_tuner_client/configuration.rb', line 73

def client_version
  @client_version
end

#development_environments ⇒ Array<String> 



55
56
57
 
# File 'lib/copy_tuner_client/configuration.rb', line 55

def development_environments
  @development_environments
end

#disable_copyray_comment_injection ⇒ Boolean 



126
127
128
 
# File 'lib/copy_tuner_client/configuration.rb', line 126

def disable_copyray_comment_injection
  @disable_copyray_comment_injection
end

#disable_middleware ⇒ Boolean 



97
98
99
 
# File 'lib/copy_tuner_client/configuration.rb', line 97

def disable_middleware
  @disable_middleware
end

#disable_test_translation ⇒ Boolean 



103
104
105
 
# File 'lib/copy_tuner_client/configuration.rb', line 103

def disable_test_translation
  @disable_test_translation
end

#environment_name ⇒ String 



64
65
66
 
# File 'lib/copy_tuner_client/configuration.rb', line 64

def environment_name
  @environment_name
end

#exclude_key_regexp ⇒ Regexp 



120
121
122
 
# File 'lib/copy_tuner_client/configuration.rb', line 120

def exclude_key_regexp
  @exclude_key_regexp
end

#framework ⇒ String, NilClass 



70
71
72
 
# File 'lib/copy_tuner_client/configuration.rb', line 70

def framework
  @framework
end

#host ⇒ String 



28
29
30
 
# File 'lib/copy_tuner_client/configuration.rb', line 28

def host
  @host
end

#html_escape ⇒ Boolean 



132
133
134
 
# File 'lib/copy_tuner_client/configuration.rb', line 132

def html_escape
  @html_escape
end

#http_open_timeout ⇒ Fixnum 



37
38
39
 
# File 'lib/copy_tuner_client/configuration.rb', line 37

def http_open_timeout
  @http_open_timeout
end

#http_read_timeout ⇒ Fixnum 



40
41
42
 
# File 'lib/copy_tuner_client/configuration.rb', line 40

def http_read_timeout
  @http_read_timeout
end

#ignored_key_handler ⇒ Proc 



138
139
140
 
# File 'lib/copy_tuner_client/configuration.rb', line 138

def ignored_key_handler
  @ignored_key_handler
end

#ignored_keys ⇒ Array<String> 



135
136
137
 
# File 'lib/copy_tuner_client/configuration.rb', line 135

def ignored_keys
  @ignored_keys
end

#inline_translation ⇒ Boolean 



117
118
119
 
# File 'lib/copy_tuner_client/configuration.rb', line 117

def inline_translation
  @inline_translation
end

#locales ⇒ Array<Symbol> 



129
130
131
 
# File 'lib/copy_tuner_client/configuration.rb', line 129

def locales
  @locales
end

#logger ⇒ Logger 



91
92
93
 
# File 'lib/copy_tuner_client/configuration.rb', line 91

def logger
  @logger
end

#middleware ⇒ Object 



94
95
96
 
# File 'lib/copy_tuner_client/configuration.rb', line 94

def middleware
  @middleware
end

#middleware_position ⇒ Object

OtherMiddleware or OtherMiddleware



100
101
102
 
# File 'lib/copy_tuner_client/configuration.rb', line 100

def middleware_position
  @middleware_position
end

#poller ⇒ Object

Returns the value of attribute poller.



114
115
116
 
# File 'lib/copy_tuner_client/configuration.rb', line 114

def poller
  @poller
end

#polling_delay ⇒ Integer 



79
80
81
 
# File 'lib/copy_tuner_client/configuration.rb', line 79

def polling_delay
  @polling_delay
end

#port ⇒ Fixnum 



31
32
33
 
# File 'lib/copy_tuner_client/configuration.rb', line 31

def port
  @port
end

#proxy_host ⇒ String, NilClass 



43
44
45
 
# File 'lib/copy_tuner_client/configuration.rb', line 43

def proxy_host
  @proxy_host
end

#proxy_pass ⇒ String, NilClass 



52
53
54
 
# File 'lib/copy_tuner_client/configuration.rb', line 52

def proxy_pass
  @proxy_pass
end

#proxy_port ⇒ String, Fixnum 



46
47
48
 
# File 'lib/copy_tuner_client/configuration.rb', line 46

def proxy_port
  @proxy_port
end

#proxy_user ⇒ String, NilClass 



49
50
51
 
# File 'lib/copy_tuner_client/configuration.rb', line 49

def proxy_user
  @proxy_user
end

#s3_host ⇒ String 



123
124
125
 
# File 'lib/copy_tuner_client/configuration.rb', line 123

def s3_host
  @s3_host
end

#secure ⇒ Boolean Also known as: secure? 



34
35
36
 
# File 'lib/copy_tuner_client/configuration.rb', line 34

def secure
  @secure
end

#sync_ignore_path_regex ⇒ Regex 



88
89
90
 
# File 'lib/copy_tuner_client/configuration.rb', line 88

def sync_ignore_path_regex
  @sync_ignore_path_regex
end

#sync_interval ⇒ Object

Sync interval for Rack Middleware



82
83
84
 
# File 'lib/copy_tuner_client/configuration.rb', line 82

def sync_interval
  @sync_interval
end

#sync_interval_staging ⇒ Integer 



85
86
87
 
# File 'lib/copy_tuner_client/configuration.rb', line 85

def sync_interval_staging
  @sync_interval_staging
end

#test_environments ⇒ Array<String> 



58
59
60
 
# File 'lib/copy_tuner_client/configuration.rb', line 58

def test_environments
  @test_environments
end

#upload_disabled_environments ⇒ Array<String> 



61
62
63
 
# File 'lib/copy_tuner_client/configuration.rb', line 61

def upload_disabled_environments
  @upload_disabled_environments
end

Instance Method Details

#[](option) ⇒ Object

Allows config options to be read like a hash



171
172
173
 
# File 'lib/copy_tuner_client/configuration.rb', line 171

def [](option)
  send(option)
end

#applied? ⇒ Boolean

Determines if the configuration has been applied (internal)



222
223
224
 
# File 'lib/copy_tuner_client/configuration.rb', line 222

def applied?
  @applied
end

#apply ⇒ Object

Applies the configuration (internal).

Called automatically when CopyTunerClient.configure is called in the application.

This creates the I18nBackend and puts them together.

When #test? returns false, the poller will be started.



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/copy_tuner_client/configuration.rb', line 233

def apply
  self.locales ||= begin
    if defined?(::Rails)
      self.locales = ::Rails.application.config.i18n.available_locales.presence || Array(::Rails.application.config.i18n.default_locale)
    else
      self.locales = [:en]
    end
  end

  self.client ||= Client.new(to_hash)
  self.cache ||= Cache.new(client, to_hash)
  @poller = Poller.new(cache, to_hash)
  process_guard = ProcessGuard.new(cache, @poller, to_hash)
  I18n.backend = I18nBackend.new(cache)

  if enable_middleware?
    logger.info "Using copytuner sync middleware"
    request_sync_options = {:poller => @poller, :cache => cache, :interval => sync_interval, :ignore_regex => sync_ignore_path_regex}
    if middleware_position.is_a?(Hash) && middleware_position[:before]
      middleware.insert_before middleware_position[:before], RequestSync, request_sync_options
      middleware.insert_before middleware_position[:before], CopyTunerClient::CopyrayMiddleware
    elsif middleware_position.is_a?(Hash) && middleware_position[:after]
      middleware.insert_after middleware_position[:after], RequestSync, request_sync_options
      middleware.insert_after middleware_position[:after], CopyTunerClient::CopyrayMiddleware
    else
      middleware.use RequestSync, request_sync_options
      middleware.use CopyTunerClient::CopyrayMiddleware
    end
  else
    logger.info "[[[Warn]]] Not using copytuner sync middleware" unless middleware
  end

  @applied = true
  logger.info "Client #{VERSION} ready (s3_download)"
  logger.info "Environment Info: #{environment_info}"
  logger.info "Available locales: #{self.locales.join(' ')}"

  unless test?
    process_guard.start
  end

  if !(test? && disable_test_translation)
    logger.info "Download translation now"
    cache.download
  end
end

#development? ⇒ Boolean

Determines if the content will be editable



202
203
204
 
# File 'lib/copy_tuner_client/configuration.rb', line 202

def development?
  development_environments.include? environment_name
end

#enable_middleware? ⇒ Boolean 



206
207
208
 
# File 'lib/copy_tuner_client/configuration.rb', line 206

def enable_middleware?
  middleware && development? && !disable_middleware
end

#environment_info ⇒ String

For logging/debugging (internal).



296
297
298
299
 
# File 'lib/copy_tuner_client/configuration.rb', line 296

def environment_info
  parts = ["Ruby: #{RUBY_VERSION}", framework, "Env: #{environment_name}"]
  parts.compact.map { |part| "[#{part}]" }.join(" ")
end

#merge(hash) ⇒ Hash

Returns a hash of all configurable options merged with hash



189
190
191
 
# File 'lib/copy_tuner_client/configuration.rb', line 189

def merge(hash)
  to_hash.merge hash
end

#project_url ⇒ String 



318
319
320
 
# File 'lib/copy_tuner_client/configuration.rb', line 318

def project_url
  URI::Generic.build(:scheme => self.protocol, :host => self.host, :port => self.port.to_i, :path => "/projects/#{self.api_key}").to_s
end

#protocol ⇒ String

The protocol that should be used when generating URLs to CopyTuner.



286
287
288
289
290
291
292
 
# File 'lib/copy_tuner_client/configuration.rb', line 286

def protocol
  if secure?
    'https'
  else
    'http'
  end
end

#public? ⇒ Boolean

Determines if the published or draft content will be used environment, true otherwise.



196
197
198
 
# File 'lib/copy_tuner_client/configuration.rb', line 196

def public?
  !(development_environments + test_environments).include?(environment_name)
end

#test? ⇒ Boolean

Determines if the content will fetched from the server



212
213
214
 
# File 'lib/copy_tuner_client/configuration.rb', line 212

def test?
  test_environments.include?(environment_name)
end

#to_hash ⇒ Hash

Returns a hash of all configurable options



177
178
179
180
181
182
183
 
# File 'lib/copy_tuner_client/configuration.rb', line 177

def to_hash
  base_options = { public: public?, upload_disabled: upload_disabled? }

  OPTIONS.inject(base_options) do |hash, option|
    hash.merge option.to_sym => send(option)
  end
end

#upload_disabled? ⇒ Boolean 



216
217
218
 
# File 'lib/copy_tuner_client/configuration.rb', line 216

def upload_disabled?
  upload_disabled_environments.include?(environment_name)
end