omf_web 0.9.9 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a076091a3915e52b1dddc6ed1f2f65b4a28c6905
+  data.tar.gz: b861770697dad3299f6f9a8e1c0b800b9c32058a
+SHA512:
+  metadata.gz: d5d66a617e076f8960fe39656f1fe6ce77b82d5df76bcf6f12fc6f61822d57b5d8aef43b3a6df72a46a09b60a44f29c18301ab3a2a383c7e579bd1aae44d6497
+  data.tar.gz: ab162397635d906b9d0ded7117723d75dd81ce53bacb8f64e5f6b5547ccbf4bac985964785e946663140e0a7b093919fae6e1ed1b3a253ff8c60901b07607129

data/README.md

@@ -4,6 +4,37 @@ This Ruby 1.9 gem provides the components for building a web-based data visualiz
 The typical use case is to allow a user to investigate a data set stored in one or more databases
 as well as life data streams.
 
+Installation
+------------
+
+At this stage the best course of action is to clone the repository
+
+    % git clone https://github.com/mytestbed/omf_web.git
+    % cd omf_web
+    % export OMF_WEB=`pwd`
+    % bundle install
+
+
+Getting Started
+---------------
+
+There are a few example sites in the 'example' directory. They have been developed in the context of various demos and 
+may not always be kept up to date. The one which should always work is 'example/simple'. Try it out.
+
+    % $OMF_WEB/bin/omf_web_server.rb --config $OMF_WEB/example/simple/simple.yaml start
+    
+This starts a webserver which can be accessed locally via 'http:localhost:4050'. Connecting to it through your favorite 
+web browser should display a web page approx. looking like:
+
+![Screenshot of starting page](https://raw.github.com/mytestbed/omf_web/master/doc/screenshot2.png "Screenshot")
+
+Don't forget to press the icon buttons 
+![icon buttons](https://raw.github.com/mytestbed/omf_web/master/doc/widget_detail.png "icon buttons")
+on the left widget header.
+
+Overview
+--------
+
 The core components are:
 
 * A **DataSource** which holds a specific data set organised as a table. It is defined

data/bin/omf_web_server.rb

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+BIN_DIR = File.dirname(File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__)
+TOP_DIR = File.join(BIN_DIR, '..')
+$: << File.join(TOP_DIR, 'lib')
+
+DESCR = %{
+Start an OMF WEB site ...
+}
+
+require 'omf_common/lobject'
+require 'omf_oml/table'
+require 'omf_oml/sql_source'
+
+
+OMF::Common::Loggable.init_log 'omf_web'
+
+$config_file_dir = nil
+
+require 'omf_oml/table'
+
+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
+
+  $config_file_dir = File.dirname(cf)
+  cfg = YAML.load_file(cf)
+  (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
+  databases = {}
+  (cfg['data_sources'] || []).each do |ds|
+    load_datasource(ds, databases)
+  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
+
+def load_datasource(config, databases)
+  unless id = config['id']
+    puts "Missing id in datasource configuration"
+    abort
+  end
+  unless table_name = config['table']
+    puts "Missing 'table' in datasource configuration '#{id}'"
+    abort
+  end
+  unless db_cfg = config['database']
+    puts "Missing database configuration in datasource '#{id}'"
+    abort
+  end
+  db = get_database(db_cfg, databases)
+  unless table = db.create_table(table_name, :limit => config['limit'], :check_interval => config['dynamic'])
+    puts "Can't find table '#{table_name}' in database '#{db}'"
+    abort
+  end
+
+  OMF::Web.register_datasource table, name: id
+end
+
+def get_database(config, databases)
+  if config.is_a? String
+    if db = databases[config]
+      return db
+    end
+    puts "Database '#{config}' not defined - (#{databases.keys})"
+    abort
+  end
+  unless id = config['id']
+    puts "Missing id in database configuration"
+    abort
+  end
+  unless id = config['id']
+    puts "Database '#{config}' not defined - (#{databases.keys})"
+    abort
+  end
+  unless url = config['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, $config_file_dir + '/')
+  end
+  puts "URL: #{url}"
+  begin
+    return databases[id] = OMF::OML::OmlSqlSource.new(url, :check_interval => 3.0)
+  rescue Exception => ex
+    puts "Can't connect to database '#{id}' - #{ex}"
+    abort
+  end
+end
+
+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($config_file_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
+
+# Configure the web server
+#
+opts = {
+  app_name: 'simple',
+  page_title: 'Simple Demo',
+  port: 4000,
+  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}
+    end,
+    # delay connecting to databases to AFTER we may run as daemon
+    post_parse: lambda { |r| load_environment(r.options) },
+  }
+}
+require 'omf_web'
+OMF::Web.start(opts)

data/example/demo/data_sources/downloads.rb

@@ -7,7 +7,8 @@ require 'omf_web'
 OMF::Web.register_datasource table
 
 skip_first_line = true
-File.open("#{File.dirname(__FILE__)}/downloads.csv", "r").read.gsub!(/\r\n?/, "\n").each_line do |line|
+#puts File.open("#{File.dirname(__FILE__)}/downloads.csv", "r").read.gsub(/\r\n?/, "\n")
+File.open("#{File.dirname(__FILE__)}/downloads.csv", "r").read.gsub(/\r\n?/, "\n").each_line do |line|
   if skip_first_line
     skip_first_line = false
   else

data/example/simple/README.md

@@ -6,25 +6,24 @@ Essentially the 'Hello World' example of a viz server. Taking data out of a data
 Start the server through:
 
     ruby -I$OMF_WEB_HOME/lib $OMF_WEB_HOME/example/simple/simple_viz_server.rb start
-
+    ruby --I$OMF_WEB_HOME/lib $OMF_WEB_HOME/bin/omf_web_server.rb --config simple.yaml start
+    
 where $OMF_WEB_HOME points to the directory containing the __omf_web__ code. You will also need to __omf_oml__ package. 
 You may either install the Gem, or download the source code from https://github.com/mytestbed/omf_oml. In the later case you
-will need to add a '-I$OMF_OML_HOME/lib' falg to the above command.
+will need to add a '-I$OMF_OML_HOME/lib' flag to the above command.
 
 After all that, the console putput should look like:
 
-    DEBUG OmlSqlSource: Opening DB (sqlite:///Users/max/src/omf_web/example/simple/data_sources/gimi31.sq3)
-    DEBUG OmlSqlSource: DB: #<Sequel::SQLite::Database: "sqlite:///Users/max/src/omf_web/example/simple/data_sources/gimi31.sq3">
-    DEBUG OmlSqlSource: Finding tables [:_senders, :_experiment_metadata, :pingmonitor_myping]
-    DEBUG OmlSqlSource: Found table: pingmonitor_myping
-    DEBUG OmlSchema: schema: '[{:name=>:oml_sender, :type=>:string, :title=>"Oml Sender"}, {:name=>:oml_sender_id, :type=>:integer, :title=>"Oml Sender Id"}, {:name=>:oml_seq, :type=>:integer, :title=>"Oml Seq"}, {:name=>:oml_ts_client, :type=>:float, :title=>"Oml Ts Client"}, {:name=>:oml_ts_server, :type=>:float, :title=>"Oml Ts Server"}, {:name=>:dest_addr, :type=>:string, :title=>"Dest Addr"}, {:name=>:ttl, :type=>:integer, :title=>"Ttl"}, {:name=>:rtt, :type=>:float, :title=>"Rtt"}, {:name=>:rtt_unit, :type=>:string, :title=>"Rtt Unit"}]'
-    INFO PingDB: Stream: pingmonitor_myping
-    DEBUG OmlSqlRow-pingmonitor_myping: Read 145/145 rows from 'pingmonitor_myping'
-    INFO Server: >> Thin web server (v1.3.1 codename Triple Espresso)
+    DEBUG OmlSqlSource: Opening DB (sqlite://sample.sq3)
+    DEBUG OmlSqlSource: DB: #<Sequel::SQLite::Database: "sqlite://sample.sq3">
+    DEBUG OmlSchema: schema: '[{:name=>:oml_sender_id, :type=>:integer, :title=>"Oml Sender Id"} ...
+    DEBUG OmlSqlRow-wave: Read 1000 (total 1000) rows from 'wave'
+    INFO Server: >> Thin web server (v1.5.1 codename Straight Razor)
     DEBUG Server: >> Debugging ON
     DEBUG Server: >> Tracing ON
     INFO Server: >> Maximum connections set to 1024
-    INFO Server: >> Listening on 0.0.0.0:3000, CTRL+C to stop
+    INFO Server: >> Listening on 0.0.0.0:4050, CTRL+C to stop
+
 
-This starts a web server on the local machine listening on port 3000. Now point your browser there and you should see the
-result of a  'ping' experiment.
+This starts a web server on the local machine listening on port 4050. Now point your browser there and you should see the
+result of a some experiment.

data/example/simple/create_waveform.rb

@@ -0,0 +1,29 @@
+#
+# File to create a very simple waveform.
+#
+
+time_step = 0.001
+
+amplitude = [0.2, 0.8, 0.6]
+frequency = [10, 14, 18]
+
+f = File.open('sample.sql', 'w')
+f.write %{
+BEGIN TRANSACTION;
+CREATE TABLE _senders (name TEXT PRIMARY KEY, id INTEGER UNIQUE);
+INSERT INTO "_senders" VALUES('ch1',1);
+CREATE TABLE _experiment_metadata (key TEXT PRIMARY KEY, value TEXT);
+INSERT INTO "_experiment_metadata" VALUES('start_time','#{Time.now.to_i}');
+CREATE TABLE "wave" (oml_sender_id INTEGER, oml_seq INTEGER, oml_ts_client REAL, oml_ts_server REAL, "t" REAL, "y" REAL);
+}
+
+1000.times do |i|
+  time = i * time_step
+  y = 0
+  3.times do |j|
+    y += amplitude[j] * Math.sin(2 * Math::PI * frequency[j] * time)
+  end
+  f.write "INSERT INTO \"wave\" VALUES(1,#{i},#{time},#{time},#{time},#{y});\n"
+end
+f.write "END TRANSACTION;\n"
+f.close

data/example/simple/introduction.md

@@ -0,0 +1,17 @@
+title: Introduction
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin
+sollicitudin nibh eu ligula lobortis ornare. Sed nibh nibh,
+ullamcorper at vehicula ac, molestie ac nunc. Duis sodales, nisi vel
+pellentesque imperdiet, nisi massa accumsan lorem, gravida scelerisque
+velit est vitae eros. Suspendisse eu lacinia elit.  
+
+
+Suspendisse laoreet, lacus quis dignissim volutpat, dolor augue convallis lectus,
+ac consectetur yyyy sem iaculis diam. Donec iaculis mattis iaculis.
+Curabitur ut nisl in sapien semper ullamcorper in id turpis. Vivamus
+sed sapien justo, ac scelerisque nibh. Sed eget quam velit.  Lorem
+ipsum dolor sit amet, consectetur adipiscing elit. 
+
+