riddl 0.129 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6316fd15d163902d1742764b42bc4886aaeb270a4957f540c2f617b099c5b15a
-  data.tar.gz: 35713bac9ab94975e7aa396966443d54c11b45085ad640280faa9fd6e63225e7
+  metadata.gz: 1165e53ea063eba2efa24ca6185499ac1b53883d5dc7304c1a38459a2a46689d
+  data.tar.gz: 6db6f0a89532c7b821ab7028ecd471177441a68922b7c7c82502264fd6568d04
 SHA512:
-  metadata.gz: 268485523d1c71d829e7f9576244d438fd914f89dba9e1c039adf90155e2d0eb2f5bfb784344780f8fd97bc5627579f6ae7174f74629c5632396c438c3bb3137
-  data.tar.gz: f80e80903d09ae3c4b756ab3dd75897fb3d4586e02e4c04e0c4ffc852b5b694cd7fc79b76d82d03a4e79a512331d5140ab45a2f5d8394f0482ca0edc306bc882
+  metadata.gz: fdb2fd41778924d8dd9d7c7958aa84302bebe855730d7cc1577ac9fba069dd2246b8ef774e6a19e89196db18d9d1149535ad6d0559a39fd16e354f932f07d063
+  data.tar.gz: 3bcc2e81831a7c771925796f1c0123f92b0d31337fcf69687937793e1e27984bade37c4560c92f6f6be46f42e6e49265cb01f5bb87d58caeedaf132fd6dbe4b2

data/AUTHORS

@@ -2,3 +2,4 @@ Jürgen Mangler <juergen.mangler@gmail.com>
 Florian Stertz <florian.stertz@gmail.com>
 Sonja Biedermann <s.bdrmnn@gmail.com>
 Matthias Ehrendorfer <matthias.ehrendorfer@gmail.com>
+Heinrich Fenkart <hnrch02@gmail.com>

data/{INSTALL → INSTALL.md}

@@ -1,15 +1,17 @@
-== Ubuntu & Debian
+## Ubuntu & Debian
 
+```bash
 sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev ruby-dev build-essential ruby ruby
-sudo gem install pkg/riddl.gem
+gem --user install pkg/riddl.gem
+```
 
 If "pkg/riddl.gem" not exists, then create it with "rake gem".
 
-== Others
+## Others
 
 find out yourself
 
-== Gem Dependencies
+## Gem Dependencies
 
 You don't need to care about them, as they will be automatically installed
 during the installation of the riddl.gem. Here is a list of them just in case

data/examples/properties/server.properties.xml

@@ -11,6 +11,6 @@
   </endpoints>
   <handlerwrapper>Test</handlerwrapper>
   <description>lala</description>
-  <state changed="2020-10-01T20:41:21+02:00">stopped</state>
+  <state changed="2024-02-09T15:08:51+01:00">running</state>
   <transformation>xxx</transformation>
 </properties>

data/examples/recursive/description.xml

@@ -0,0 +1,20 @@
+<description datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes" xmlns="http://riddl.org/ns/description/1.0" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+  <message name="test">
+    <parameter name="test" mimetype="text/plain"/>
+  </message>
+  <message name="sub">
+    <parameter name="sub" mimetype="text/plain"/>
+  </message>
+
+  <resource>
+    <get out="test"/>
+    <resource relative="hello" recursive="true">
+      <get out="test"/>
+      <resource relative="sub">
+        <get out="test"/>
+      </resource>
+    </resource>
+  </resource>
+
+</description>

data/examples/recursive/riddlcheck

@@ -0,0 +1 @@
+/home/mangler/Projects/riddl/tools/riddlcheck

data/examples/recursive/server.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby
+require 'pp'
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/ruby/riddl/server')
+
+class Test < Riddl::Implementation
+  def response
+    Riddl::Parameter::Complex.new("test","text/plain") do
+      <<-END
+        hello #{@r.length}
+      END
+    end
+  end
+end
+
+class Sub < Riddl::Implementation
+  def response
+    Riddl::Parameter::Complex.new("sub","text/plain") do
+      <<-END
+        sub #{@r.length}
+      END
+    end
+  end
+end
+
+
+Riddl::Server.new(File.dirname(__FILE__) + '/description.xml', :port => 9001, :bind => '::') do
+  accessible_description true
+
+  on resource do
+    run Test if get
+    on resource "hello" do
+      run Test if get
+      on resource "sub" do
+        run Sub if get
+      end
+    end
+  end
+end.loop!

data/examples/sse/sample.html

@@ -5,7 +5,7 @@
 
   <script type="text/javascript">
     function init() {
-      es = new EventSource('http://localhost:9292/');
+      es = new EventSource('https://echo.bpm.in.tum.de/ssetest/');
       es.onopen = function() {
         output("onopen");
       };

data/examples/sse/server.rb

@@ -4,32 +4,41 @@ require File.expand_path(File.dirname(__FILE__) + '/../../lib/ruby/riddl/server'
 
 class Bar < Riddl::Implementation
   def response
+    $connections.each do |c|
+      c.send('some data')
+    end
     Riddl::Parameter::Complex.new("return","text/plain","hello world")
   end
 end
 
+$connections = []
+
 class Echo < Riddl::SSEImplementation
   def onopen
-    // if true (or any object for that matter) is returned, then 200 is sent
-    // if false (or nil) is returned 404, the sse is denied
+    # if true (or any object for that matter) is returned, then 200 is sent
+    # if false (or nil) is returned 404, the sse is denied
     puts "Connection established"
-    Thread.new do
-      1.upto 10 do |i|
-        send("oasch #{i}")
-        sleep 1
-      end
-      close
-    end
+    $connections << self
   end
 
   def onclose
     puts "Connection closed"
+    $connections.delete(self)
   end
 end
 
 Riddl::Server.new(File.dirname(__FILE__) + '/description.xml', :port => 9292) do
   cross_site_xhr true
 
+  parallel do
+    loop do
+      $connections.each do |c|
+        c.send('heartbeat')
+      end
+      sleep 15
+    end
+  end
+
   on resource do
     run Bar if get
     run Bar if get 'rrrr'

data/examples/websocket/client.rb

@@ -6,17 +6,18 @@ ep = Riddl::Client.interface('http://localhost:9292/',File.join(__dir__,'/descri
 test = ep.resource('/')
 
 test.ws do |conn|
-  conn.on :open do
-    ### called on connection
-    conn.send "Hello world"
-    conn.send "done"
-  end
 
   conn.on :error do |e|
     ### called on error
     puts "Got error: #{e}"
   end
 
+  conn.on :open do
+    ### called on connection
+    conn.send "Hello world"
+    conn.send "done"
+  end
+
   conn.on :message do |msg|
     ### called when server responds
     puts "<#{msg.data}>"
@@ -30,4 +31,5 @@ test.ws do |conn|
     puts "gone"
     EM::stop_event_loop
   end
+
 end

data/examples/websocket/client.sh

@@ -0,0 +1,9 @@
+curl --include \
+     --no-buffer \
+     --header "Connection: Upgrade" \
+     --header "Upgrade: websocket" \
+     --header "Host: localhost:9292" \
+     --header "Origin: http://localhost:9292" \
+     --header "Sec-WebSocket-Key: SGVsbG8sIHdvcmxkIQ==" \
+     --header "Sec-WebSocket-Version: 13" \
+     http://localhost:9292/

data/lib/ruby/riddl/client.rb

@@ -151,8 +151,10 @@ unless Module.constants.include?('CLIENT_INCLUDED')
         attr_reader :rpath
 
         def ws(&blk) #{{{
-          EM.run do
-            conn = Faye::WebSocket::Client.new((@base + @rpath).sub(/^http/,'ws'))
+          EM.run {
+            url = (@base + @rpath).sub(/^http/,'ws')
+            url = url.sub(/:\/\/localhost/,'://127.0.0.1')
+            conn = Faye::WebSocket::Client.new(url)
 
             if @options[:debug]
               conn.on :error do |e|
@@ -161,7 +163,7 @@ unless Module.constants.include?('CLIENT_INCLUDED')
             end
 
             blk.call(conn)
-          end
+          }
         end #}}}
 
         def get(parameters = []) #{{{
@@ -354,8 +356,8 @@ unless Module.constants.include?('CLIENT_INCLUDED')
               :method         => riddl_method,
               :headers        => headers,
               :body           => tmp.read,
-              :ssl_verifypeer => false
-              #:followlocation => true
+              :ssl_verifypeer => false,
+              :followlocation => true
             }
             if url.user && url.password
               opts[:username] = Protocols::Utils::unescape(url.user)

data/lib/ruby/riddl/ns/common-patterns/properties/1.0/properties.schema.xsl

@@ -2,7 +2,7 @@
 <xsl:stylesheet version="1.0" xmlns="http://relaxng.org/ns/structure/1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:p="http://riddl.org/ns/common-patterns/properties/1.0">
   <xsl:output method="xml" indent="yes"/>
 
-  <xsl:template match="/p:properties">
+  <xsl:template match="/p:properties" priority="1">
     <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes" ns="http://riddl.org/ns/common-patterns/properties/1.0">
 
       <start>

data/lib/ruby/riddl/ns/description/1.0/description.rng

@@ -203,6 +203,12 @@
   </define>
 
   <define name="riddl-resource-recursive-choice">
+  <!--
+    It was a choice when no resources inside recursive resources were allowed.
+    Beacause i doubted that worked.
+    But it works just fine.
+    Maybe its bad for facades but i cant find cases for that.
+    Please report them if you find them.
     <choice>
       <attribute name="recursive">
         <data type="boolean"/>
@@ -210,7 +216,13 @@
       <group>
         <ref name="riddl-resource-sub"/>
       </group>
-    </choice>
+    </choice-->
+    <optional>
+      <attribute name="recursive">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <ref name="riddl-resource-sub"/>
   </define>
 
   <define name="riddl-resource-dynamic">

data/lib/ruby/riddl/utils/oauth2-helper.rb

@@ -25,7 +25,7 @@ module Riddl
             end
 
             def key?(key)
-              @redis.exists(key)
+              @redis.exists?(key)
             end
 
             def each
@@ -40,9 +40,9 @@ module Riddl
 
             def set(key,value,dur=nil)
               value = value.is_a?(String) ? value.to_s : (JSON::generate(value) rescue '')
-              @redis.multi do
-                @redis.set key, value
-                @redis.expire key, dur unless dur.nil?
+              @redis.multi do |transaction|
+                transaction.set key, value
+                transaction.expire key, dur unless dur.nil?
               end
               nil
             end

data/ns/common-patterns/properties/1.0/properties.schema.xsl

@@ -2,7 +2,7 @@
 <xsl:stylesheet version="1.0" xmlns="http://relaxng.org/ns/structure/1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:p="http://riddl.org/ns/common-patterns/properties/1.0">
   <xsl:output method="xml" indent="yes"/>
 
-  <xsl:template match="/p:properties">
+  <xsl:template match="/p:properties" priority="1">
     <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes" ns="http://riddl.org/ns/common-patterns/properties/1.0">
 
       <start>

data/ns/description/1.0/description.rng

@@ -203,6 +203,12 @@
   </define>
 
   <define name="riddl-resource-recursive-choice">
+  <!--
+    It was a choice when no resources inside recursive resources were allowed.
+    Beacause i doubted that worked.
+    But it works just fine.
+    Maybe its bad for facades but i cant find cases for that.
+    Please report them if you find them.
     <choice>
       <attribute name="recursive">
         <data type="boolean"/>
@@ -210,7 +216,13 @@
       <group>
         <ref name="riddl-resource-sub"/>
       </group>
-    </choice>
+    </choice-->
+    <optional>
+      <attribute name="recursive">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <ref name="riddl-resource-sub"/>
   </define>
 
   <define name="riddl-resource-dynamic">

data/riddl.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name             = "riddl"
-  s.version          = "0.129"
+  s.version          = "1.0"
   s.platform         = Gem::Platform::RUBY
   s.license          = "LGPL-3.0"
   s.summary          = "Restful Interface Description and Declaration Language: tools and client/server libs"
 
   s.description      = "REST service interface definition, mixing, and evolution. Supports mixed http and xmpp servers."
 
-  s.files            = Dir['{lib/ruby/riddl/ns/**/*,tools/**/*,ns/**/*,contrib/**/*,lib/ruby/riddl/**/*,examples/**/*}'] + %w(COPYING Rakefile riddl.gemspec README.md TODO AUTHORS INSTALL)
+  s.files            = Dir['{lib/ruby/riddl/ns/**/*,tools/**/*,ns/**/*,contrib/**/*,lib/ruby/riddl/**/*,examples/**/*}'] + %w(COPYING Rakefile riddl.gemspec README.md TODO AUTHORS INSTALL.md)
 
   s.require_path     = 'lib/ruby'
   s.extra_rdoc_files = ['README.md']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riddl
 version: !ruby/object:Gem::Version
-  version: '0.129'
+  version: '1.0'
 platform: ruby
 authors:
 - Juergen 'eTM' Mangler
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: tools
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemonite
@@ -261,7 +261,7 @@ extra_rdoc_files:
 files:
 - AUTHORS
 - COPYING
-- INSTALL
+- INSTALL.md
 - README.md
 - Rakefile
 - TODO
@@ -406,6 +406,9 @@ files:
 - examples/propnew/server.properties.schema
 - examples/propnew/server.properties.xml
 - examples/propnew/test
+- examples/recursive/description.xml
+- examples/recursive/riddlcheck
+- examples/recursive/server.rb
 - examples/simulate/test.rb
 - examples/sse/description.xml
 - examples/sse/sample.html
@@ -417,6 +420,7 @@ files:
 - examples/twitter/twitpic.xml
 - examples/twitter/twitter.xml
 - examples/websocket/client.rb
+- examples/websocket/client.sh
 - examples/websocket/description.xml
 - examples/websocket/sample.html
 - examples/websocket/server.rb
@@ -551,7 +555,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: 'Restful Interface Description and Declaration Language: tools and client/server