riddl 1.0.16 → 1.0.18

data/lib/ruby/riddl/server.rb

@@ -53,6 +53,7 @@ module Riddl
         :secure       => false,
         :verbose      => false,
         :http_only    => false,
+        :server       => 'thin',
         :runtime_opts => [
           ["--port [PORT]", "-p [PORT]", "Specify http port.", ->(p){
             @riddl_opts[:port] = p.to_i
@@ -102,12 +103,16 @@ module Riddl
         app.use Rack::CommonLogger, @riddl_logger
       end
 
+      if @riddl_opts[:secure] && @riddl_opts[:server].to_s != 'thin'
+        raise NotImplementedError, "secure (TLS) mode is not yet supported with the '#{@riddl_opts[:server]}' backend, only 'thin'"
+      end
+
       server = Rack::Server.new(
         :app => app,
         :Host => @riddl_opts[:bind],
         :Port => @riddl_opts[:port],
         :environment => @riddl_opts[:verbose] ? 'deployment' : 'none',
-        :server => 'thin',
+        :server => @riddl_opts[:server],
         :signals => false
       )
       @riddl_opts[:startup].call if @riddl_opts[:startup]
@@ -115,46 +120,68 @@ module Riddl
         @riddl_opts[:custom_protocol] = @riddl_opts[:custom_protocol].new(@riddl_opts)
         puts @riddl_opts[:custom_protocol].support if @riddl_opts[:custom_protocol].support
       end
-      begin
-        EM.run do
-          if @riddl_opts[:secure]
-            server.start do |srv|
-              srv.ssl = true
-              srv.ssl_options = @riddl_opts[:secure_options]
+
+      if @riddl_opts[:server].to_s == 'thin'
+        begin
+          EM.run do
+            if @riddl_opts[:secure]
+              server.start do |srv|
+                srv.ssl = true
+                srv.ssl_options = @riddl_opts[:secure_options]
+              end
+            else
+              server.start
             end
-          else
-            server.start
-          end
 
-          if @riddl_opts[:custom_protocol] && !@riddl_opts[:http_only]
-            @riddl_opts[:custom_protocol].start
-          end
+            if @riddl_opts[:custom_protocol] && !@riddl_opts[:http_only]
+              @riddl_opts[:custom_protocol].start
+            end
 
-          [:INT, :TERM].each do |signal|
-            Signal.trap(signal) do
-              if @riddl_opts[:cleanup]
-                @riddl_opts[:cleanup].call
+            [:INT, :TERM].each do |signal|
+              Signal.trap(signal) do
+                if @riddl_opts[:cleanup]
+                  @riddl_opts[:cleanup].call
+                end
+                EM.stop
               end
-              EM.stop
             end
-          end
-          [:HUP].each do |signal|
-            Signal.trap(signal) do
-              EM.stop
+            [:HUP].each do |signal|
+              Signal.trap(signal) do
+                EM.stop
+              end
             end
-          end
 
-          if @riddl_opts[:parallel]
-            EM.defer do
-              @riddl_opts[:parallel].call
+            if @riddl_opts[:parallel]
+              EM.defer do
+                @riddl_opts[:parallel].call
+              end
             end
           end
+        rescue => e
+          if @riddl_opts[:custom_protocol] && !@riddl_opts[:http_only]
+            @riddl_opts[:custom_protocol].error_handling(e)
+          end
+          puts "Server (#{@riddl_opts[:cmdl_info]}) stopped due to connection error (PID:#{Process.pid})"
         end
-      rescue => e
+      else # other servers like PUMA
+        Faye::WebSocket.ensure_reactor_running
+
         if @riddl_opts[:custom_protocol] && !@riddl_opts[:http_only]
-          @riddl_opts[:custom_protocol].error_handling(e)
+          @riddl_opts[:custom_protocol].start
+        end
+
+        Thread.new { @riddl_opts[:parallel].call } if @riddl_opts[:parallel]
+
+        begin
+          server.start do |launcher|
+            launcher.events.after_stopped { @riddl_opts[:cleanup].call if @riddl_opts[:cleanup] }
+          end
+        rescue => e
+          if @riddl_opts[:custom_protocol] && !@riddl_opts[:http_only]
+            @riddl_opts[:custom_protocol].error_handling(e)
+          end
+          puts "Server (#{@riddl_opts[:cmdl_info]}) stopped due to connection error (PID:#{Process.pid})"
         end
-        puts "Server (#{@riddl_opts[:cmdl_info]}) stopped due to connection error (PID:#{Process.pid})"
       end
     end #}}}
 
@@ -237,6 +264,7 @@ module Riddl
       @riddl_log = @riddl_logger || @riddl_env['rack.errors']
       @riddl_res = Rack::Response.new
       @riddl_status = 404
+      @riddl_async_response = nil
 
       @riddl_pinfo = Riddl::Protocols::Utils::unescape(@riddl_env["PATH_INFO"].gsub(/\/+/,'/'))
       @riddl_matching_path = @riddl_paths.find{ |e| @riddl_pinfo.match(e[1]).to_s.length == @riddl_pinfo.length }
@@ -294,7 +322,7 @@ module Riddl
               end
             end
           end
-          throw :async
+          throw :async if @riddl_opts[:server].to_s == 'thin'
         elsif @riddl_info[:env]['HTTP_ACCEPT'] == 'text/event-stream'
           @riddl_info[:m] = @riddl_method = 'sse'
           @riddl_message = @riddl.io_messages(@riddl_matching_path[0],'sse',@riddl_parameters,@riddl_headers)
@@ -313,7 +341,7 @@ module Riddl
               end
             end
           end
-          throw :async
+          throw :async if @riddl_opts[:server].to_s == 'thin'
         else
           __call
         end
@@ -321,6 +349,7 @@ module Riddl
         @riddl_log.write "404: this resource for sure does not exist.\n"
         @riddl_status = 404 # client requests wrong path
       end
+      return @riddl_async_response if @riddl_async_response
       if @riddl_exe
         parts = Protocols::HTTP::Generator.new(@riddl_exe.response,@riddl_res).generate
         @riddl_exe.headers.each do |n,h|
@@ -382,22 +411,14 @@ module Riddl
           @riddl_headers.map { |key, value|  [key.downcase.gsub('_','-'), value] }
         ]
         w = what.new(@riddl_info.merge!(:a => args, :match => matching_path))
-        w.io = Riddl::Protocols::SSE.new(w, @riddl_env)
-        w.io.dispatch(data, @riddl_cross_site_xhr)
+        sse = @riddl_opts[:server].to_s == 'thin' ? Riddl::Protocols::SSE::Thin : Riddl::Protocols::SSE::Generic
+        w.io = sse.new(w, @riddl_env)
+        @riddl_async_response = w.io.dispatch(data, @riddl_cross_site_xhr)
       end
       if what.class == Class && what.superclass == Riddl::WebSocketImplementation
-        data = Riddl::Protocols::WebSocket::ParserData.new
-        data.request_path = @riddl_pinfo
-        data.request_url = @riddl_pinfo + '?' + @riddl_query_string
-        data.query_string = @riddl_query_string
-        data.http_method = @riddl_env['REQUEST_METHOD']
-        data.body = @riddl_env['rack.input'].read
-        data.headers = Hash[
-          @riddl_headers.map { |key, value|  [key.downcase.gsub('_','-'), value] }
-        ]
-        w = what.new(@riddl_info.merge!(:a => args, :version => @riddl_env['HTTP_SEC_WEBSOCKET_VERSION'], :match => matching_path))
-        w.io = Riddl::Protocols::WebSocket.new(w, @riddl_env['thin.connection'])
-        w.io.dispatch(data)
+        w = what.new(@riddl_info.merge!(:a => args, :match => matching_path))
+        w.io = Riddl::Protocols::WebSocket.new(w, @riddl_env)
+        @riddl_async_response = w.io.dispatch
       end
       if what.class == Class && what.superclass == Riddl::Implementation
         w = what.new(@riddl_info.merge!(:a => args, :match => matching_path))

data/lib/ruby/riddl/wrapper.rb

@@ -90,7 +90,8 @@ module Riddl
             xml = Typhoeus.get(name, ssl_verifypeer: false).response_body
           end
           @doc = XML::Smart.string(xml)
-        rescue
+        rescue => e
+          raise SpecificationError, "#{name.inspect} is not well-formed XML: #{e.message}" if e.is_a?(Nokogiri::XML::SyntaxError) && !xml.to_s.strip.empty?
           begin
             @doc = XML::Smart.string(name)
           rescue
@@ -99,11 +100,12 @@ module Riddl
         end
       end
 
-      @doc.register_namespace 'x', XINCLUDE
-      @doc.find('//x:include/@href').each do |i|
-        if i.value =~ /^http:\/\/(www\.)?riddl\.org(\/ns\/common-patterns\/.*)/
-          t = File.expand_path(File.dirname(__FILE__)) + $2
-          i.value = t if File.exist?(t)
+      if @doc.register_namespace 'x', XINCLUDE
+        @doc.find('//x:include/@href').each do |i|
+          if i.value =~ /^http:\/\/(www\.)?riddl\.org(\/ns\/common-patterns\/.*)/
+            t = File.expand_path(File.dirname(__FILE__)) + $2
+            i.value = t if File.exist?(t)
+          end
         end
       end
       fpath.nil? ? @doc.xinclude! : @doc.xinclude!(fpath)
@@ -119,13 +121,19 @@ module Riddl
         rrds = XML::Smart::open_unprotected(RIDDL_DESCRIPTION_RESOURCE_SHOW)
         rds.register_namespace('des','http://riddl.org/ns/description/1.0')
         rrds.register_namespace('des','http://riddl.org/ns/description/1.0')
-        @doc.root.prepend rds.find('/des:description/des:message')
-        @doc.root.prepend rrds.find('/des:description/des:message')
+        prepend = lambda do |node,what,allowed|
+          first = node.find(allowed.map{ |e| "des:#{e}" }.join('|')).first
+          first ? first.add_before(what) : node.add(what)
+        end
+        des_allowed = %w{message transformation resource}
+        res_allowed = %w{post get put patch delete request websocket sse resource}
+        prepend.call @doc.root, rds.find('/des:description/des:message'), des_allowed
+        prepend.call @doc.root, rrds.find('/des:description/des:message'), des_allowed
         @doc.find("/des:description/des:resource").each do |r|
-          r.prepend rds.find('/des:description/des:resource/*')
+          prepend.call r, rds.find('/des:description/des:resource/*'), res_allowed
         end
         @doc.find("/des:description//des:resource").each do |r|
-          r.prepend rrds.find('/des:description/des:resource/*')
+          prepend.call r, rrds.find('/des:description/des:resource/*'), res_allowed
         end
       end
       if @is_declaration  && get_description
@@ -247,13 +255,13 @@ module Riddl
     def validate!
       #{{{
       if @is_description
-        xval = @doc.validate_against(XML::Smart.open_unprotected(DESCRIPTION_FILE))
+        xval = @doc.validate_against(XML::Smart.open_unprotected(DESCRIPTION_FILE)) { |err| puts err }
         xchk = ResourceChecker.new(@doc).check
         puts xchk.join("\n") unless xchk.empty?
         return xval && xchk.empty?
       end
       if @is_declaration
-        xval = @doc.validate_against(XML::Smart.open_unprotected(DECLARATION_FILE))
+        xval = @doc.validate_against(XML::Smart.open_unprotected(DECLARATION_FILE)) { |err| puts err }
         xchk = LayerChecker.new(@doc).check
         puts xchk.join("\n") unless xchk.empty?
         return xval && xchk.empty?

data/ns/description/1.0/description.rng

@@ -14,21 +14,23 @@
       <data type="anyURI"/>
     </attribute>
     <ref name="riddl-description-other-atts"/>
-    <zeroOrMore>
-      <choice>
-        <element name="message">
-          <ref name="riddl-description-other-atts"/>
-          <ref name="riddl-message"/>
-        </element>
-        <element name="transformation">
-          <ref name="riddl-description-other-atts"/>
-          <ref name="riddl-transformation"/>
-        </element>
-      </choice>
-    </zeroOrMore>
-    <element name="resource">
-      <ref name="riddl-resource-dynamic"/>
-    </element>
+    <interleave>
+      <zeroOrMore>
+        <choice>
+          <element name="message">
+            <ref name="riddl-description-other-atts"/>
+            <ref name="riddl-message"/>
+          </element>
+          <element name="transformation">
+            <ref name="riddl-description-other-atts"/>
+            <ref name="riddl-transformation"/>
+          </element>
+        </choice>
+      </zeroOrMore>
+      <element name="resource">
+        <ref name="riddl-resource-dynamic"/>
+      </element>
+    </interleave>
   </define>
 
   <define name="riddl-message">
@@ -199,7 +201,6 @@
         <data type="anyURI"/>
       </attribute>
     </optional>
-    <ref name="riddl-description-others"/>
   </define>
 
   <define name="riddl-resource-recursive-choice">
@@ -222,21 +223,28 @@
         <data type="boolean"/>
       </attribute>
     </optional>
-    <ref name="riddl-resource-sub"/>
+  </define>
+
+  <define name="riddl-resource-body">
+    <interleave>
+      <ref name="riddl-description-others"/>
+      <ref name="riddl-resource-content"/>
+      <ref name="riddl-resource-sub"/>
+    </interleave>
   </define>
 
   <define name="riddl-resource-dynamic">
     <ref name="riddl-resource-attributes"/>
-    <ref name="riddl-resource-content"/>
     <ref name="riddl-resource-recursive-choice"/>
+    <ref name="riddl-resource-body"/>
   </define>
   <define name="riddl-resource-named">
     <ref name="riddl-resource-attributes"/>
     <attribute name="relative">
       <ref name="riddl-datatype-relpath"/>
     </attribute>
-    <ref name="riddl-resource-content"/>
     <ref name="riddl-resource-recursive-choice"/>
+    <ref name="riddl-resource-body"/>
   </define>
 
   <define name="riddl-resource-sub">

data/riddl.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "riddl"
-  s.version          = "1.0.16"
+  s.version          = "1.0.18"
   s.platform         = Gem::Platform::RUBY
   s.license          = "LGPL-3.0-or-later"
   s.summary          = "Restful Interface Description and Declaration Language: tools and client/server libs"
@@ -31,8 +31,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rdf-smart', '>=0.0.160', '~>0'
   s.add_runtime_dependency 'rack', '~>2.2'
   s.add_runtime_dependency 'thin', '~>1.6'
+  s.add_runtime_dependency 'puma', '~>8.0'
   s.add_runtime_dependency 'eventmachine', '>= 1.0.0', '~>1.0'
-  s.add_runtime_dependency 'em-websocket', '>= 0.5.2', '~>0'
   s.add_runtime_dependency 'faye-websocket', '>= 0.1', '~>0'
   s.add_runtime_dependency 'mime-types', '>= 3.0', '~>3'
   s.add_runtime_dependency 'minitest', '>= 5.0.0', '~>5'

data/test/tc_sse.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/smartrunner.rb')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/ruby/riddl/client')
+require 'net/http'
+require 'timeout'
+
+module SSEScenario
+  def test_sse
+    info = self.class::SERVER[0]
+    ep = Riddl::Client.interface(info.url, info.schema)
+
+    test = ep.resource('/')
+    status, res = test.get
+    assert status == 200
+    assert res.length == 1
+    assert res[0].mimetype == 'text/plain'
+    assert res[0].value.read == 'hello world'
+
+    uri = URI(info.url)
+    events = Queue.new
+    opened = Queue.new
+
+    reader = Thread.new do
+      begin
+        Net::HTTP.start(uri.host, info.port) do |http|
+          req = Net::HTTP::Get.new('/', { 'Accept' => 'text/event-stream' })
+          http.request(req) do |response|
+            opened << response.code
+            buffer = +''
+            response.read_body do |chunk|
+              buffer << chunk
+              while (idx = buffer.index("\r\n\r\n"))
+                events << buffer.slice!(0..idx + 3)
+              end
+            end
+          end
+        end
+      rescue IOError, Errno::ECONNRESET
+        # expected once the reader thread is killed below
+      end
+    end
+
+    assert Timeout.timeout(5) { opened.pop } == '200'
+
+    # a plain GET on the same server broadcasts to every open SSE connection
+    # (examples/sse/server.rb's Bar#response) -- deterministic, no need to
+    # wait on the 15s heartbeat from the `parallel` block.
+    status, _res = test.get
+    assert status == 200
+
+    event = Timeout.timeout(5) { events.pop }
+    assert event == "data: some data\r\n\r\n"
+
+    reader.kill
+    reader.join
+  end
+end
+
+class TestSSEThin < Minitest::Test
+  include ServerCase
+  include SSEScenario
+
+  SERVER = [
+    TestServerInfo.new(
+      File.expand_path(File.dirname(__FILE__) + '/../examples/sse/server.rb') + ' -o server=thin',
+      File.expand_path(File.dirname(__FILE__) + '/../examples/sse/description.xml')
+    )
+  ]
+  NORUN = false
+end
+
+class TestSSEPuma < Minitest::Test
+  include ServerCase
+  include SSEScenario
+
+  SERVER = [
+    TestServerInfo.new(
+      File.expand_path(File.dirname(__FILE__) + '/../examples/sse/server.rb') + ' -o server=puma',
+      File.expand_path(File.dirname(__FILE__) + '/../examples/sse/description.xml')
+    )
+  ]
+  NORUN = false
+end

data/test/tc_websocket.rb

@@ -1,21 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/smartrunner.rb')
 require File.expand_path(File.dirname(__FILE__) + '/../lib/ruby/riddl/client')
 require 'xml/smart'
-require 'pp'
-
-class TestWebsocket <  Minitest::Test
-  include ServerCase
-
-  SERVER = [
-    TestServerInfo.new(
-      File.expand_path(File.dirname(__FILE__) + '/../examples/websocket/server.rb'),
-      File.expand_path(File.dirname(__FILE__) + '/../examples/websocket/description.xml')
-    )
-  ]
-  NORUN = false
 
+module WebSocketScenario
   def test_websocket
-    ep = Riddl::Client.interface(SERVER[0].url,SERVER[0].schema)
+    info = self.class::SERVER[0]
+    ep = Riddl::Client.interface(info.url, info.schema)
 
     test = ep.resource('/')
     status, res = test.get
@@ -61,3 +51,29 @@ class TestWebsocket <  Minitest::Test
 
   end
 end
+
+class TestWebsocketThin < Minitest::Test
+  include ServerCase
+  include WebSocketScenario
+
+  SERVER = [
+    TestServerInfo.new(
+      File.expand_path(File.dirname(__FILE__) + '/../examples/websocket/server.rb') + ' -o server=thin',
+      File.expand_path(File.dirname(__FILE__) + '/../examples/websocket/description.xml')
+    )
+  ]
+  NORUN = false
+end
+
+class TestWebsocketPuma < Minitest::Test
+  include ServerCase
+  include WebSocketScenario
+
+  SERVER = [
+    TestServerInfo.new(
+      File.expand_path(File.dirname(__FILE__) + '/../examples/websocket/server.rb') + ' -o server=puma',
+      File.expand_path(File.dirname(__FILE__) + '/../examples/websocket/description.xml')
+    )
+  ]
+  NORUN = false
+end

data/tools/riddlcheck

@@ -21,7 +21,12 @@ if ARGV.length == 0 || !File.exist?(ARGV[0])
 end
 fname = ARGV[0]
 
-riddl = Riddl::Wrapper::new(fname)
+riddl = begin
+  Riddl::Wrapper::new(fname)
+rescue Riddl::SpecificationError => e
+  puts e.message
+  exit 1
+end
 
 if riddl.description?
   puts 'RIDDL description found.'
@@ -29,8 +34,9 @@ elsif riddl.declaration?
   puts 'RIDDL declaration found.'
 else
   puts 'Neither a RIDDL description, nor a RIDDL declaration.'
-  exit
+  exit 1
 end
 
 messages = riddl.validate!
 puts messages ? "RIDDL looks valid." : "RIDDL not valid."
+exit 1 unless messages

data/tools/riddlprocess

@@ -27,7 +27,12 @@ if ARGV.length == 0 || !File.exist?(ARGV[0]) || dowhat.nil?
 end
 fname = ARGV[0]
 
-riddl = Riddl::Wrapper.new(fname)
+riddl = begin
+  Riddl::Wrapper.new(fname)
+rescue Riddl::SpecificationError => e
+  puts e.message
+  exit 1
+end
 
 unless riddl.declaration?
   puts 'Not a RIDDL declaration.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riddl
 version: !ruby/object:Gem::Version
-  version: 1.0.16
+  version: 1.0.18
 platform: ruby
 authors:
 - Juergen 'eTM' Mangler
@@ -115,45 +115,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: eventmachine
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: em-websocket
+  name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 1.0.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -325,7 +319,6 @@ files:
 - examples/declaration-test/declaration2.xml
 - examples/declaration-test/goal/goal.txt
 - examples/declaration-test/goal/goal.xml
-- examples/declaration-test/main.log
 - examples/declaration-test/main.rb
 - examples/declaration-test/main.xml
 - examples/declaration-test/over.xml
@@ -463,10 +456,8 @@ files:
 - lib/ruby/riddl/ns/description/1.0/description.rng
 - lib/ruby/riddl/option.rb
 - lib/ruby/riddl/parameter.rb
-- lib/ruby/riddl/protocols/generator.rb
 - lib/ruby/riddl/protocols/http/generator.rb
 - lib/ruby/riddl/protocols/http/parser.rb
-- lib/ruby/riddl/protocols/parser.rb
 - lib/ruby/riddl/protocols/sse.rb
 - lib/ruby/riddl/protocols/utils.rb
 - lib/ruby/riddl/protocols/websocket.rb
@@ -533,6 +524,7 @@ files:
 - test/tc_library.rb
 - test/tc_producer.rb
 - test/tc_properties.rb
+- test/tc_sse.rb
 - test/tc_websocket.rb
 - tools/flash-policy-server.rb
 - tools/riddlcheck
@@ -541,7 +533,7 @@ homepage: http://github.com/etm/riddl/
 licenses:
 - LGPL-3.0-or-later
 metadata:
-  documentation_uri: https://gemdocs.org/gems/riddl/1.0.16/
+  documentation_uri: https://gemdocs.org/gems/riddl/1.0.18/
 rdoc_options: []
 require_paths:
 - lib/ruby
@@ -569,4 +561,5 @@ test_files:
 - test/tc_library.rb
 - test/tc_producer.rb
 - test/tc_properties.rb
+- test/tc_sse.rb
 - test/tc_websocket.rb