wabur 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ca329c76ee3951ecd328480754dd09a2bdcd6a32
-  data.tar.gz: d811b8c2f08585329308d2eef96d395b9f0d3626
+SHA256:
+  metadata.gz: dbf0b84d397a6216caa0d5190e69b2d024a2c3274ddd18137ccc54154cca80ab
+  data.tar.gz: ee17aea00b5048cf3f9cfddc562ec6bbf98b13f48482343e8805dd6e8c03db55
 SHA512:
-  metadata.gz: 4f2fc06292ecba5c5505fe79c20a555d11ee2a0057176495b367ec2c960886cb36a998abd488a888b0fa31b161afd61545b45ab2fc7571c9e9551c8653807307
-  data.tar.gz: e6b7a19e414c9d7a011229e66c76a412406e0bde1d508c1290390d097a637b689c236c6af331ab173e26592a099b6d7df26945d796c0becd5a05749cbfe219ec
+  metadata.gz: dcd2a2c8e493a38300942c9f76ad38b4ccaac4503637bc7d0929774371e55bc855441bebb9b49de76e49a619f86deb438f2b2f5d3a0e1ee9ba69ac1e9a1534a0
+  data.tar.gz: a04cadc7cd14f6ecc69a842334a41e57a2d7c6737590ca453c63bbd542211bdc05a0110c0948287a0057ab5bb0176edfac4f1ef376bf2d514c5b2386cdf2b74b

data/README.md

@@ -5,27 +5,115 @@
 [![Gem Version](https://badge.fury.io/rb/wabur.svg)](https://rubygems.org/gems/wabur)
 [![Gem](https://img.shields.io/gem/dt/wabur.svg)](https://rubygems.org/gems/wabur)
 
-WABuR is a Web Application Builder using Ruby. It employs a modern NoSQL JSON
-data store and a single-page UI using JavaScript. The best part is that it is
-simple and very fast, hitting over 200,000 fetches a second with a Ruby core!
+WABuR is a Web Application Builder using Ruby. It is easy to use, taking just
+a minute to create a `Hello World` web application and it is _FAST_, hitting
+over 200,000 fetches a second with a Ruby core! It employs a modern NoSQL JSON
+data store and a single-page UI using JavaScript.
 
 It is pluggable and extendable in many ways to allow new additions,
 alternative databases, and any number of UIs.
 
-A natural question is *"What about Rails?"*. Rails is well established and has
-a huge user base. WABuR is not a replacement for Rails. It is an alternative
-for those who want to explore using JSON databases with a single-page dynamic
-JavaScript UI.
+## Quick Start
+
+With WABuR you are up and running in minutes with only one file to modify to
+specify attributes. It doesn't get any simpler. Heres how.
+
+Install the wabur gem.
+
+```
+$ gem install wabur
+```
+
+Create a new project and `cd` into the directory.
 
-For further reading there is an [architecture page](pages/Architecture.md)
+```
+$ wabur new --base blog Entry
+$ cd blog
+```
 
-## Try It!
+Define attributes for the data elements along with the attributes that will be
+displayed in a list view. Open `lib/ui_controller.rb` and modify by adding two
+lines and changing one.
+
+```ruby
+require 'wab/ui'
+
+class UIController < WAB::UI::MultiFlow
+
+  def initialize(shell)
+    super
+    add_flow(WAB::UI::RestFlow.new(shell,
+                                   {
+                                     kind: 'Entry',
+                                     title: '',
+                                     content: "\n\n\n\n",
+                                   }, ['$ref', 'title']))
+  end
+end
+```
+
+Just run the `wabur` command from inside the project directory. Open
+`localhost:6363` in a browser.
+
+```
+$ wabur
+```
 
 Want to know more? A tutorial is available in the [tutorial](tutorial/README.md)
-directory.
+directory. It takes a couple of minutes to go through the first lesson.
+
+## WABuR Benchmarks
+
+<img src="pages/setup.svg" width="400">
+<table>
+<tr><td><img src="pages/throughput.svg" width="400"></td><td><img src="pages/latency.svg" width="400"></td></tr>
+</table>
+
+| Runner        | Read Throughput | Read Latency | Create Throughput | Create Latency | Setup time |
+| ------------- | --------------- | ------------ | ----------------- | -------------- | ---------- |
+| WAB Pure Ruby | 2.8K Reads/sec  | 1.4 msecs    | 2.2K Creates/sec  | 1.8 msecs      |  1 minute  |
+| OpO-Rub       | 212K Reads/sec  | 0.09 msecs   | 134K Creates/sec  | 0.15 msecs     |  1 minute  |
+| OpO Direct    | 364K Reads/sec  | 0.05 msecs   | 157K Creates/sec  | 0.13 msecs     |  1 minute  |
+| Ruby on Rails |  123 Reads/sec  | 175 msecs    | ---- Creates/sec  | ---- msecs     | 20 minutes |
+| Sinatra       | 1.5K Reads/sec  |  13 msecs    | ---- Creates/sec  | ---- msecs     | 60 minutes |
 
 More interested in the benchmarks? Then take a look at the [benchmarks page](benchmarks/README.md).
 
+## Where to use WABuR
+
+WABuR takes a different approach which opens up new possibilities for uses of
+Ruby. Some examples that WABuR is suitable for are:
+
+ * Race Results - With the ability to handle massive traffic WABuR can keep up
+   with the load imposed by hundreds of thousands of users requesting results
+   during the race and with the ability to have multiple UIs realtime displays
+   can be different than those used to display results after the race.
+
+ * Voting Systems - Voting systems collect and forward results to central
+   servers. Loads are high during peak periods but well within the limits that
+   WABuR is able to handle. The ease extending WABuR makes it easy to
+   implement the migration of data to a central server or multiple servers.
+
+ * Operations Monitoring - Log using JSON and WABuR can be used to monitor and
+   query logs.
+
+ * Market Data - With the high throughput and low latency WABuR is a good
+   candidate for systems that need to display market data and processing of
+   market data.
+
+ * Mapping - Systems that display data on a map can use WABuRs flexibility
+   with regard to the UI.
+
+ * Directory - As an example of a quick and easy build, an directory or
+   address book can be started in minutes.
+
+## Rails
+
+A natural question is *"What about Rails?"*. Rails is well established and has
+a huge user base. WABuR is not a replacement for Rails. It is an alternative
+for those who want to explore using JSON databases with a single-page dynamic
+JavaScript UI.
+
 ## Participate and Contribute
 
 If you like the idea and want to help out, or become a core developer on the
@@ -36,20 +124,23 @@ and lets make something awesome together.
 
 These are the simple guidelines for contributing.
 
-1. Coordinate with me first before getting started to avoid duplication of
+1. Take a look at the [architecture page](pages/Architecture.md) and the source code.
+
+2. Coordinate with me first before getting started to avoid duplication of
    effort or implementing something in conflict with the plans.
 
-2. Branch off the develop branch and submit a PR.
+3. Branch off the `develop` branch and submit a PR.
 
-3. Write unit tests.
+4. Write unit tests.
 
-4. Write straight forward, clean, and simple code. No magic stuff, no monkey
+5. Write straight forward, clean, and simple code. No magic stuff, no monkey
    patching Ruby core classes, and no inheriting from core classes.
 
 ## References and Links
 
+ - [Agoo](https://github.com/ohler55/agoo) Web Server GemBuR.
  - [Oj](https://github.com/ohler55/oj) JSON parser used in WABuR.
  - [OpO](http://opo.technology) home of the Opo-Rub runner.
  - [Sass](http://sass-lang.com) used to build the reference implementation UI CSS.
  - [SystemJS Babel Plugin](https://github.com/systemjs/plugin-babel) also used to transpile JavaScript.
- - [SystemJS](https://github.com/systemjs/systemjs) used to convert JavaScript ES6 to ES5 in the browser.
+ - [SystemJS](https://github.com/systemjs/systemjs) used to convert JavaScript ES6 to ES5 in the browser.

data/bin/wabur

@@ -107,6 +107,12 @@ options = {
       doc: 'HTTP Port to listen on.',
       arg: 'PORT',
     },
+    server: {
+      val: 'WEBrick',
+      type: String,
+      doc: 'Web server to use. Can be Agoo, Sinatra, or WEBRick.',
+      arg: 'GEM',
+    },
   },
   indent: {
     val: 0,

data/export/assets/js/ui.js

@@ -205,6 +205,24 @@ export class ObjectDisplay extends Display {
                 value = obj[key];
                 if (value instanceof Object) {
                     this._setFields(`${path}.${key}`, value);
+                } else if (undefined != element.alt) {
+                    switch (element.getAttribute('alt')) {
+                        case 'local-time':
+                            element.value = new Date(obj[key]).toLocaleString();
+                            break;
+                        case 'zulu-time':
+                            element.value = new Date(obj[key]).toUTCString();
+                            break;
+                        case 'long-time':
+                            element.value = new Date(obj[key]).toString();
+                            break;
+                        case 'date':
+                            element.value = new Date(obj[key]).toDateString();
+                            break;
+                        default:
+                            element.value = obj[key];
+                            break;
+                    }
                 } else {
                     element.value = obj[key];
                 }

data/lib/wab.rb

@@ -11,12 +11,17 @@ module WAB
     end
     raise ForbiddenError.new(path) if path.include?('..')
     path = File.expand_path("#{__dir__}/../export#{path}")
-    File.open(path) { |f| f.read() }
+    begin
+      File.open(path) { |f| f.read() }
+    rescue Exception
+      nil
+    end
   end
 
 end
 
 require 'wab/controller'
+require 'wab/racker'
 require 'wab/data'
 require 'wab/errors'
 require 'wab/open_controller'
@@ -25,3 +30,4 @@ require 'wab/shell_logger'
 require 'wab/utils'
 require 'wab/uuid'
 require 'wab/version'
+require 'wab/client'

data/lib/wab/client.rb

@@ -0,0 +1,145 @@
+
+require 'net/http'
+require 'oj'
+
+module WAB
+
+  # A client for a WAB server. It is not specific to any particular
+  # runner. The client allows direct access to the server data. It is just
+  # another view implementation.
+  class Client
+    # Address of the WAB server.
+    attr_accessor :server_address
+    # The port the WAB serer is listening on.
+    attr_accessor :server_port
+    # Prefix to add to the URL path.
+    attr_accessor :path_prefix
+    # The URL path to execute TQL,
+    attr_accessor :tql_path
+    # The key for the type. The default is 'kind'.
+    attr_accessor :type_key
+    # If true the connection to the server is Keep-Alive.
+    attr_accessor :keep_alive
+
+    # Create a new Client for the server at +addr+ and +port+. The provided
+    # options should match the attribute names and types.
+    def initialize(addr, port, options={})
+      @server_address = addr
+      @server_port = port
+      @path_prefix = options.fetch(:path_prefix, '/v1/')
+      @tql_path = options.fetch(:tql_path, '/tql')
+      @type_key = options.fetch(:type_key, 'kind').to_sym
+      @keep_alive = !!options.fetch(:keep_alive, true)
+      @http = nil
+    end
+
+    # Create a new data object. If a query is provided it is treated as a
+    # check against an existing object with the same key/value pairs.
+    #
+    # On error an Exception will be raised.
+    #
+    # data:: the data to use as a new object.
+    # kind:: the kind of the data. If nil the kind is taken from the data
+    # query:: query parameters to match against existing instances. A match fails the insert.
+    def create(data, kind=nil, query=nil)
+      kind ||= data[@type_key] || data[@type_key.to_s]
+      send_request('PUT', kind, query, data)
+    end
+
+    # Return the objects according to the kind and query arguments. The
+    # following patterns supported:
+    #
+    # * query is a ref [12345] looks for MyType with reference ID of 12345
+    # * query is a Hash {name:fred,age:63} looks for all MyTypes with a name
+    #                                      of 'fred' and an age of 63.
+    #
+    # kind:: the data type
+    # query:: query parameters as a Hash.
+    def read(kind, query=nil)
+      send_request('GET', kind, query, nil)
+    end
+    
+    # Replaces the object data for the identified object. The query can be a
+    # reference to a specific object or a set of parameters to match.
+    #
+    # The return should be the identifiers for the object updated.
+    #
+    # On error an Exception should be raised.
+    #
+    # kind:: the data type
+    # data:: the data to use as a new object.
+    # query:: query parameters.
+    def update(kind, data, query)
+      raise ArgError.new('data') if data.nil?
+      raise ArgError.new('query') if query.nil?
+      send_request('POST', kind, query, data)
+    end
+
+    # Deletes the data for the identified object(s). The query can be a
+    # reference to a specific object or a set of parameters to match.
+    #
+    # The return is the identifiers for the object updated.
+    #
+    # On error an Exception should be raised.
+    #
+    # kind:: the data type
+    # query:: query parameters.
+    def delete(kind, query=nil)
+      send_request('DELETE', kind, query, nil)
+    end
+
+    # Request the server evaluate a TQL query.
+    #
+    # tql:: query to evaluate.
+    def find(tql)
+      raise ArgError.new('tql') if tql.nil?
+      send_request('POST', 'tql', nil, tql)
+    end
+
+    private
+
+    def connect
+      @http ||= Net::HTTP.new(@server_address, @server_port)
+    end
+
+    def form_path(kind, query)
+      return @tql_path if kind == 'tql'
+      path = "#{@path_prefix}#{kind}"
+      if query.is_a?(Hash)
+        first = true
+        query.each_pair { |k,v|
+          if first
+            path << '?'
+            first = false
+          else
+            path << '&'
+          end
+          path << "#{k}=#{v}"
+        }
+      elsif !query.nil?
+        path << '/'
+        path << query.to_s
+      end
+      path
+    end
+    
+    def send_request(method, kind, query, content)
+      connect
+      header = {'Connection' => (@keep_alive ? 'Keep-Alive' : 'Close') }
+      unless content.nil?
+        if content.is_a?(Data)
+          content = content.json
+        else
+          content = Oj.dump(content, mode: :wab, indent: 0)
+        end
+        header['Content-Type'] = 'application/json'
+        resp = @http.send_request(method, form_path(kind, query), content, header)
+      else
+        resp = @http.send_request(method, form_path(kind, query))
+      end
+      raise Error.new(resp.body) unless resp.is_a?(Net::HTTPOK)
+      Oj.load(resp.body, mode: :wab)
+    end
+
+  end # Client
+end # WAB

data/lib/wab/controller.rb

@@ -21,7 +21,7 @@ module WAB
     end
 
     # Handler for paths that do not match the REST pattern or for unregistered
-    # types. Only called on the default controller.
+    # types.
     #
     # Processing result are passed back to the view which forward the result
     # on to the requester. The result, if not nil, should be a Data instance.

data/lib/wab/errors.rb

@@ -28,4 +28,10 @@ module WAB
     end
   end
 
+  class ArgError < Error
+    def initialize(arg)
+      super("#{arg} missing or nil")
+    end
+  end
+
 end # WAB

data/lib/wab/impl.rb

@@ -26,9 +26,9 @@ require 'wab/impl/expr'
 require 'wab/impl/path_expr'
 require 'wab/impl/bool_expr'
 require 'wab/impl/shell'
-require 'wab/impl/export_proxy'
 require 'wab/impl/utils'
 require 'wab/impl/init'
+require 'wab/impl/rack_error'
 
 # Require the concrete Expr subclasses so a mapping table can be created for
 # the parser.

data/lib/wab/impl/agoo.rb

@@ -0,0 +1,18 @@
+
+require 'wab'
+
+module WAB
+  module Impl
+
+    # The Agoo module contains handlers for the Agoo web server.
+    module Agoo
+
+    end # Agoo
+  end # Impl
+end # WAB
+
+require 'wab/impl/agoo/sender'
+require 'wab/impl/agoo/handler'
+require 'wab/impl/agoo/tql_handler'
+require 'wab/impl/agoo/export_proxy'
+require 'wab/impl/agoo/server'

data/lib/wab/impl/agoo/export_proxy.rb

@@ -0,0 +1,55 @@
+
+module WAB
+  module Impl
+    module Agoo
+
+      # A handler that provides missing files in an assets directory where the
+      # files are the wab and wab UI files.
+      class ExportProxy
+	include Sender
+
+	def initialize(shell)
+          @shell = shell
+	end
+
+	def on_request(req, res)
+	  path = (req.script_name + req.path_info)
+	  query = parse_query(req.query_string)
+          path = '/index.html' if '/' == path
+          mime = nil
+          index = path.rindex('.')
+          unless index.nil?
+	    mime = {
+	      'css' => 'text/css',
+	      'eot' => 'application/vnd.ms-fontobject',
+	      'es5' => 'application/javascript',
+	      'es6' => 'application/javascript',
+	      'gif' => 'image/gif',
+	      'html' => 'text/html',
+	      'ico' => 'image/x-icon',
+	      'jpeg' => 'image/jpeg',
+	      'jpg' => 'image/jpeg',
+	      'js' => 'application/javascript',
+	      'json' => 'application/json',
+	      'png' => 'image/png',
+	      'sse' => 'text/plain',
+	      'svg' => 'image/svg+xml',
+	      'ttf' => 'application/font-sfnt',
+	      'txt' => 'text/plain',
+	      'woff' => 'application/font-woff',
+	      'woff2' => 'font/woff2',
+	    }[path[index + 1..-1].downcase]
+          end
+          mime = 'text/plain' if mime.nil?
+          content = WAB.get_export(path)
+          res.code = 200
+          res['Content-Type'] = mime
+          res.body = content
+        rescue Exception => e
+          send_error(e, res)
+        end
+	
+      end # ExportProxy
+    end # Agoo
+  end # Impl
+end # WAB