Class: OMF::Web::Server

Inherits:
Base::LObject
  • Object
show all
Defined in:
lib/omf-web/thin/server.rb

Overview

Most of the code to run an OMF Web server from a configuration file

USAGE:

Defined Under Namespace

Classes: JSONDataSource, OmspEndpointProxy

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(server_name, description, top_dir, opts) ⇒ Server 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/omf-web/thin/server.rb', line 18

def initialize(server_name, description, top_dir, opts)
  OMF::Base::Loggable.init_log(server_name)
  #OMF::Base::Loggable.init_log server_name
  opts = {
    handlers: {
      pre_parse: lambda do |p, runner|
        p.on("--config CONF_FILE", "File holding description of web site") {|f| runner.options[:omf_config_file] = f}
        p.on("--top-dir DIR", "Directory to start from for relative data paths [directory of config file]") {|td| @top_dir = td }
      end,
      post_parse: lambda { |r| load_environment(r.options) },
    },
    authentication: {
      required: false
    }
  }.merge(opts)

  @server_name = server_name
  @top_dir = top_dir
  @databases = {}
  @omsp_endpoints = {}

  OMF::Web.start(opts)
end

Class Method Details

.start(server_name, description, top_dir, opts = {}) ⇒ Object 



14
15
16
 
# File 'lib/omf-web/thin/server.rb', line 14

def self.start(server_name, description, top_dir, opts = {})
  self.new(server_name, description, top_dir, opts)
end

Instance Method Details

#_rec_sym_keys(hash) ⇒ Object

Recusively Symbolize keys of hash



242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/omf-web/thin/server.rb', line 242

def _rec_sym_keys(hash)
  h = {}
  hash.each do |k, v|
    if v.is_a? Hash
      v = _rec_sym_keys(v)
    elsif v.is_a? Array
      v = v.map {|e| e.is_a?(Hash) ? _rec_sym_keys(e) : e }
    end
    h[k.to_sym] = v
  end
  h
end

#get_database(config) ⇒ Object 



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/omf-web/thin/server.rb', line 131

def get_database(config)
  require 'omf_oml/table'
  require 'omf_oml/sql_source'

  if config.is_a? String
    if db = @databases[config]
      return db
    end
    puts "Database '#{config}' not defined - (#{@databases.keys})"
    abort
  end
  unless id = config.delete(:id)
    puts "Missing id in database configuration"
    abort
  end
  if db = @databases[id.to_s] # already known
    return db
  end

  # unless id = config[:id]
    # puts "Database '#{config}' not defined - (#{@databases.keys})"
    # abort
  # end
  unless url = config.delete(:url)
    puts "Missing URL for database '#{id}'"
    abort
  end
  if url.start_with?('sqlite:') && ! url.start_with?('sqlite:/')
    # inject top dir
    url.insert('sqlite:'.length, '//' + @cfg_dir + '/')
  end
  config[:check_interval] ||= 3.0
  puts "URL: #{url} - #{config}"
  begin
    return @databases[id] = OMF::OML::OmlSqlSource.new(url, config)
  rescue Exception => ex
    puts "Can't connect to database '#{id}' - #{ex}"
    abort
  end
end

#load_database(id, config) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/omf-web/thin/server.rb', line 103

def load_database(id, config)
  unless db_cfg = config[:database]
    puts "Missing database configuration in datasource '#{config}'"
    abort
  end
  db = get_database(db_cfg)
  if query_s = config[:query]
    unless schema = config[:schema]
      puts "Missing schema configuration in datasource '#{config}'"
      abort
    end
    require 'omf_oml/schema'
    config[:schema] = OMF::OML::OmlSchema.create(schema)
    table = db.create_table(id, config)
  else
    unless table_name = config.delete(:table)
      puts "Missing 'table' in datasource configuration '#{config}'"
      abort
    end
    config[:name] = id
    unless table = db.create_table(table_name, config)
      puts "Can't find table '#{table_name}' in database '#{db_cfg}'"
      abort
    end
  end
  OMF::Web.register_datasource table, name: id
end

#load_datasource(config) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/omf-web/thin/server.rb', line 87

def load_datasource(config)
  unless id = config[:id]
    puts "Missing id in datasource configuration"
    abort
  end
  if config[:database]
    load_database(id, config)
  elsif config[:file]
    load_datasource_file(id, config)
  elsif config[:omsp]
    load_omsp_endpoint(id, config)
  else
    abort "Unknown datasource type - #{config}"
  end
end

#load_datasource_file(name, opts) ⇒ Object

The data to be served as a datasource is contained in a file. We currently support CSV with headers, and JSON which turns into a 1 col by 1 row datasource.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/omf-web/thin/server.rb', line 176

def load_datasource_file(name, opts)
  unless file = opts[:file]
    puts "Data source file is not defined in '#{opts}'"
    abort
  end
  unless file.start_with? '/'
    file = File.join(@top_dir, file)
  end
  unless File.readable? file
    puts "Can't read file '#{file}'"
    abort
  end
  case content_type = opts[:content_type].to_s
  when 'json'
    ds = JSONDataSource.new(file)
  when 'csv'
    require 'omf_oml/csv_table'
    ds = OMF::OML::OmlCsvTable.create name, file, has_csv_header: true
  else
    puts "Unknown content type '#{content_type}'"
    abort
  end
  OMF::Web.register_datasource ds, name: name
end

#load_environment(opts) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/omf-web/thin/server.rb', line 42

def load_environment(opts)
  unless cf = opts[:omf_config_file]
    puts "Missing config file"
    abort
  end

  unless File.readable? cf
    puts "Can't read config file '#{cf}'"
    abort
  end

  @cfg_dir = File.dirname(cf)
  opts[:static_dirs].insert(0, File.absolute_path(File.join(@cfg_dir, 'htdocs')))
  @top_dir ||= @cfg_dir
  cfg = _rec_sym_keys(YAML.load_file(cf))

  if log_opts = cfg[:logging]
    # TODO: Deal with custom logging option
  end

  (cfg[:server] || {}).each do |k, v|
    k = k.to_sym
    case k
    when :port
      opts[:port] = v.to_i
    else
      opts[k] = v
    end
  end
  (cfg[:data_sources] || []).each do |ds|
    load_datasource(ds)
  end
  (cfg[:repositories] || []).each do |repo|
    load_repository(repo)
  end

  unless wa = cfg[:widgets]
    puts "Can't find 'widgets' section in config file '#{cf}' - #{cfg.keys}"
    abort
  end
  wa.each do |w|
    OMF::Web.register_widget w
  end
end

#load_omsp_endpoint(id, config) ⇒ Object 



201
202
203
204
205
206
207
208
209
 
# File 'lib/omf-web/thin/server.rb', line 201

def load_omsp_endpoint(id, config)
  oconfig = config[:omsp]
  unless port = oconfig[:port]
    puts "Need port in OMSP definition '#{oconfig}' - datasource '#{id}'"
    abort
  end
  ep = @omsp_endpoints[port] ||= OmspEndpointProxy.new(port)
  ep.add_datasource(id, config)
end

#load_repository(config) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/omf-web/thin/server.rb', line 212

def load_repository(config)
  unless id = config[:id]
    puts "Missing id in respository configuration"
    abort
  end
  unless type = config[:type]
    puts "Missing 'type' in respository configuration '#{id}'"
    abort
  end

  require 'omf-web/content/repository'
  case type
  when 'file'
    unless top_dir = config[:top_dir]
      puts "Missing 'top_dir' in respository configuration '#{id}'"
      abort
    end
    unless top_dir.start_with? '/'
      top_dir = File.join(@top_dir, top_dir)
    end
    OMF::Web::ContentRepository.register_repo(id, type: :file, top_dir: top_dir)
  else
    puts "Unknown repository type '#{type}'. Only supporting 'file'."
    abort
  end

end