Class: Wovnrb::Store

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/wovnrb/store.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Store

Returns a new instance of Store.



40
41
42
 
# File 'lib/wovnrb/store.rb', line 40

def initialize
  reset
end

Class Method Details

.default_settings ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/wovnrb/store.rb', line 15

def self.default_settings
  Settings.new.merge(
    'project_token' => '',
    'log_path' => 'log/wovn_error.log',
    'ignore_paths' => [],
    'ignore_globs' => [],
    'url_pattern' => 'path',
    'url_pattern_reg' => "/(?<lang>[^/.?]+)",
    'query' => [],
    'ignore_class' => [],
    'api_url' => 'https://wovn.global.ssl.fastly.net/v0/',
    'api_timeout_seconds' => 0.5,
    'default_lang' => 'en',
    'supported_langs' => ['en'],
    'test_mode' => false,
    'test_url' => '',
    'cache_megabytes' => nil,
    'ttl_seconds' => nil,
    'use_proxy' => false, # use env['HTTP_X_FORWARDED_HOST'] instead of env['HTTP_HOST'] and env['SERVER_NAME'] when this setting is true.
    'custom_lang_aliases' => {},
    'translate_fragment' => true,
    'wovn_dev_mode' => false
  )
end

Instance Method Details

#custom_lang_aliases ⇒ Object 



158
159
160
 
# File 'lib/wovnrb/store.rb', line 158

def custom_lang_aliases
  @setttings['custom_lang_aliases'] || {}
end

#default_lang ⇒ Object 



162
163
164
 
# File 'lib/wovnrb/store.rb', line 162

def default_lang
  @settings['default_lang']
end

#default_lang_alias ⇒ Object 



166
167
168
169
 
# File 'lib/wovnrb/store.rb', line 166

def default_lang_alias
  custom_alias = custom_lang_aliases[default_lang]
  custom_alias || default_lang
end

#format_settings ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/wovnrb/store.rb', line 128

def format_settings
  if @settings.has_key?('custom_lang_aliases')
    stringify_keys! @settings['custom_lang_aliases']
  end

  @settings['default_lang'] = Lang.get_code(@settings['default_lang'])
  if !@settings.has_key?('supported_langs')
    @settings['supported_langs'] = [@settings['default_lang']]
  end

  if @settings.has_key?('user_token') && @settings['project_token'].empty?
    @settings['project_token'] = @settings['user_token']
  end
  @settings.delete('user_token')

  if @settings['url_pattern'] == 'path'
    @settings['url_pattern_reg'] = "/(?<lang>[^/.?]+)"
  elsif @settings['url_pattern'] == 'query'
    @settings['url_pattern_reg'] = "((\\?.*&)|\\?)wovn=(?<lang>[^&]+)(&|$)"
  elsif @settings['url_pattern'] == 'subdomain'
    @settings['url_pattern_reg'] = "^(?<lang>[^.]+)\."
  end

  @settings['test_mode'] = if @settings['test_mode'] != true || @settings['test_mode'] != 'on'
                             false
                           else
                             true
                           end
end

#load_settings ⇒ Object

Load Rails config.wovnrb



113
114
115
116
117
118
 
# File 'lib/wovnrb/store.rb', line 113

def load_settings
  if Object.const_defined?('Rails') && Rails.configuration.respond_to?(:wovnrb)
    @config_loaded = true
    update_settings(Rails.configuration.wovnrb)
  end
end

#reset ⇒ nil

Reset @settings and @config_loaded variables to default.

Returns:

  • (nil) 


47
48
49
50
51
 
# File 'lib/wovnrb/store.rb', line 47

def reset
  @settings = Store.default_settings
  # When Store is initialized, the Rails.configuration object is not yet initialized
  @config_loaded = false
end

#settings ⇒ Object

Returns the settings object, pulling from Rails config the first time this is called



106
107
108
109
 
# File 'lib/wovnrb/store.rb', line 106

def settings
  load_settings unless @config_loaded
  @settings
end

#supported_langs ⇒ Object 



171
172
173
 
# File 'lib/wovnrb/store.rb', line 171

def supported_langs
  @settings['supported_langs'] || []
end

#update_settings(new_settings) ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/wovnrb/store.rb', line 120

def update_settings(new_settings)
  load_settings unless @config_loaded
  if !new_settings.nil?
    @settings.merge!(new_settings.stringify_keys)
    format_settings
  end
end

#valid_settings? ⇒ Boolean

Returns true or false based on whether the settings are valid or not, logs any invalid settings to ../error.log

Returns:

  • (Boolean) —

    Returns true if the settings are valid, and false if they are not



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/wovnrb/store.rb', line 63

def valid_settings?
  valid = true
  errors = []
  # if valid_token?(!settings.has_key?('project_token') || settings['project_token'].length < 5 || settings['project_token'].length > 6
  if !valid_token?(settings['project_token'])
    errors.push("Project token #{settings['project_token']} is not valid.")
  end
  if settings.has_key?('ignore_paths') && !settings['ignore_paths'].kind_of?(Array)
    errors.push("Ignore Paths #{settings['ignore_paths']} should be Array.")
  end
  if !settings.has_key?('url_pattern') || settings['url_pattern'].length == 0
    errors.push("Url pattern #{settings['url_pattern']} is not valid.")
  end
  if !settings.has_key?('query') || !settings['query'].kind_of?(Array)
    errors.push("query config #{settings['query']} is not valid.")
  end
  if !settings.has_key?('ignore_class') || !settings['ignore_class'].kind_of?(Array)
    errors.push("ignore_class config #{settings['ignore_class']} should be Array.")
  end
  if !settings.has_key?('api_url') || settings['api_url'].length == 0
    errors.push("API URL is not configured.")
  end
  if !settings.has_key?('default_lang') || settings['default_lang'].nil?
    errors.push("Default lang #{settings['default_lang']} is not valid.")
  end
  if !settings.has_key?('supported_langs') || !settings['supported_langs'].kind_of?(Array) || settings['supported_langs'].size < 1
    errors.push("Supported langs configuration is not valid.")
  end
  if !settings.has_key?('custom_lang_aliases') || !settings['custom_lang_aliases'].kind_of?(Hash)
    errors.push("Custom lang aliases is not valid.")
  end
  # log errors
  if errors.length > 0
    valid = false
    errors.each do |e|
      WovnLogger.instance.error(e)
    end
  end
  valid
end

#valid_token?(token) ⇒ Boolean

Returns true or false based on whether the token is valid or not

Returns:

  • (Boolean) —

    Returns true if the token is valid, and false if it is not



56
57
58
 
# File 'lib/wovnrb/store.rb', line 56

def valid_token?(token)
  !token.nil? && (token.length == 5 || token.length == 6)
end

#wovn_host ⇒ Object 



175
176
177
178
179
180
181
 
# File 'lib/wovnrb/store.rb', line 175

def wovn_host
  if @settings['wovn_dev_mode']
    'dev-wovn.io:3000'
  else
    'wovn.io'
  end
end