cpee-resources 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4b15a42bbfec373265af8072b83039a159c0f2da3cb2a61ed25e755f95d878f
-  data.tar.gz: 8fe2ff417e1ed3e6b8010d28418f714232bbdb29d36e09bce328a661d5c69d48
+  metadata.gz: c8bdbb327f22bad0692cac431a470706786274b71d0adf951eef431943baf086
+  data.tar.gz: 92e6e1db36d873ba1ea0d73311ec938a3e59f4b01b994310be2f114b09683db0
 SHA512:
-  metadata.gz: 52dfd64c30e4866075d4fd218d9bec439d0c02a44b028870472788cb9099e96dba95d71fa6a5ff8ce46af0e13eac09b18632624158aca4c6f8cd2fc8c48b4e77
-  data.tar.gz: b86a6b97054fe9d19f1e78ef0e5cd22bee8efa3e19c1d4ae91374ad319c440c1ad11c33ba31b8c0597a3f837983e08b043d3023c0a2981debee8e1742e77f48d
+  metadata.gz: 62ccf144e75434cf153209fde94e34483690d1a6f103e04b06c7e01c9805b294d94b15f8d6a4d453be985de8bbae73cafd60a5529a1411b519a95a7bae94d551
+  data.tar.gz: 55bf1bd602615f1dd360062ce6b54a72bc00b3688a6e99c7e7f0ec05280d4312da461e44d737d170c039aa38c82d62d0fe9498c872dd13dd7acbe980f24e7e60

data/cpee-resources.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "cpee-resources"
-  s.version          = "1.0.3"
+  s.version          = "1.0.4"
   s.platform         = Gem::Platform::RUBY
   s.license          = "LGPL-3.0-or-later"
   s.summary          = "Resources list for the cloud process execution engine (cpee.org)"

data/lib/cpee-resources/implementation.rb

@@ -16,83 +16,207 @@
 # along with CPEE-RESOURCES (file LICENSE in the main directory). If not, see
 # <http://www.gnu.org/licenses/>.
 
-require 'rubygems'
+require 'json'
 require 'riddl/server'
 
 module CPEE
   module Resources
 
     SERVER = File.expand_path(File.join(__dir__,'implementation.xml'))
+    NOT_FOUND = 'Existence really is an imperfect tense that never becomes a present. (Friedrich Nietzsche)'
 
-    class DoExists < Riddl::Implementation #{{{
+    class DoFile < Riddl::Implementation #{{{
       def response
         data = @a[1]
-        dir = File.join(data,@a[0],Riddl::Protocols::Utils::escape(@r[-1]))
-        if Dir.exist?(dir)
-          return Riddl::Parameter::Complex.new('exists','text/xml') do
-            doc = XML::Smart::string('<resource/>')
-            doc.root.add('schema','schema.rng') if File.exist?(File.join(dir,'schema.rng'))
-            doc.root.add('symbol','symbol.svg') if File.exist?(File.join(dir,'symbol.svg'))
-            doc.root.add('properties','properties.json') if File.exist?(File.join(dir,'properties.json'))
-            doc.to_s
+        file = File.join(data,@a[0],*(@r[@a[2]].map{|e| Riddl::Protocols::Utils::escape(e)}))
+        if File.exist?(file)
+          Riddl::Parameter::Complex.new(@a[3],@a[4],File.read(file))
+        else
+          @status = 404
+          Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
+        end
+      end
+    end #}}}
+    class DoPutFile < Riddl::Implementation #{{{
+      def response
+        data = @a[1]
+        name = @r[-1]
+        file = File.join(data,@a[0],Riddl::Protocols::Utils::escape(name))
+        File.open(file,'wb') do |f|
+          IO.copy_stream(@p[0].value,f)
+        end
+        nil
+      end
+    end #}}}
+    class DoPutDescription < Riddl::Implementation #{{{
+      def response
+        data = @a[1]
+        dir = File.join(data,@a[0],Riddl::Protocols::Utils::escape(@r[-3]))
+        unless Dir.exist?(dir)
+          @status = 404
+          return Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
+        end
+        ddir = File.join(dir,'descriptions')
+        Dir.mkdir(ddir) unless Dir.exist?(ddir)
+        File.open(File.join(ddir,@r[-1]),'wb') do |f|
+          IO.copy_stream(@p[0].value,f)
+        end
+        nil
+      end
+    end #}}}
+    class DoPutEndpointFile < Riddl::Implementation #{{{
+      def response
+        data = @a[1]
+        dir = File.join(data,@a[0],Riddl::Protocols::Utils::escape(@r[-2]))
+        file = File.join(dir,@r[-1])
+        unless Dir.exist?(dir)
+          @status = 404
+          return Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
+        end
+        if @p[0].name == 'name'
+          target = File.join('..','..',@a[2],@p[0].value)
+          unless File.exist?(File.join(dir,target))
+            @status = 404
+            return Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
           end
+          File.unlink(file) if File.symlink?(file) || File.exist?(file)
+          File.symlink(target,file)
+        else
+          File.unlink(file) if File.symlink?(file)
+          File.open(file,'wb') do |f|
+            IO.copy_stream(@p[0].value,f)
+          end
+        end
+        nil
+      end
+    end #}}}
+    class DoDeleteFile < Riddl::Implementation #{{{
+      def response
+        data = @a[1]
+        file = File.join(data,@a[0],*(@r[@a[2]].map{|e| Riddl::Protocols::Utils::escape(e)}))
+        if File.exist?(file) || File.symlink?(file)
+          File.delete(file)
+          nil
         else
           @status = 404
-          Riddl::Parameter::Complex.new('exists','text/plain','Existence really is an imperfect tense that never becomes a present. (Friedrich Nietzsche)')
+          Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
         end
       end
     end #}}}
-    class DoModExists < Riddl::Implementation #{{{
+    class DoProperties < Riddl::Implementation #{{{
       def response
         data = @a[1]
-        dir = File.join(data,'modifiers',Riddl::Protocols::Utils::escape(@r[-2]),Riddl::Protocols::Utils::escape(@r[-1]))
+        dir = File.join(data,@a[0],Riddl::Protocols::Utils::escape(@r[-2]))
+        file = File.join(dir,'properties.json')
         if Dir.exist?(dir)
-          Riddl::Parameter::Complex.new('exists','text/xml') do
-            doc = XML::Smart::string('<resource/>')
-            doc.root.add('patch','patch.xml') if File.exist?(File.join(dir,'patch.xml'))
-            doc.root.add('unpatch','unpatch.xml') if File.exist?(File.join(dir,'unpatch.xml'))
-            doc.root.add('condition','condition.json') if File.exist?(File.join(dir,'condition.json'))
-            doc.root.add('ui','ui.rng') if File.exist?(File.join(dir,'ui.rng'))
-            doc.to_s
-          end
+          props = File.exist?(file) ? JSON.parse(File.read(file)) : {}
+          props['global-schema'] = File.symlink?(File.join(dir,'schema.rng'))
+          props['global-symbol'] = File.symlink?(File.join(dir,'symbol.svg'))
+          Riddl::Parameter::Complex.new('json','application/json',JSON.generate(props))
         else
           @status = 404
-          Riddl::Parameter::Complex.new('exists','text/plain','Existence really is an imperfect tense that never becomes a present. (Friedrich Nietzsche)')
+          Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
         end
       end
     end #}}}
-    class DoFile < Riddl::Implementation #{{{
+    class DoGetProperty < Riddl::Implementation #{{{
       def response
         data = @a[1]
-        file = File.join(data,@a[0],*(@r[@a[2]].map{|e| Riddl::Protocols::Utils::escape(e)}))
-        if File.exist?(file)
-          Riddl::Parameter::Complex.new(@a[3],@a[4],File.read(file))
+        dir = File.join(data,@a[0],Riddl::Protocols::Utils::escape(@r[-3]))
+        file = File.join(dir,'properties.json')
+        key = @r[-1]
+        props = File.exist?(file) ? JSON.parse(File.read(file)) : {}
+        props['global-schema'] = File.symlink?(File.join(dir,'schema.rng'))
+        props['global-symbol'] = File.symlink?(File.join(dir,'symbol.svg'))
+        if Dir.exist?(dir) && props.key?(key)
+          Riddl::Parameter::Complex.new('value','text/plain',props[key].to_s)
         else
           @status = 404
-          Riddl::Parameter::Complex.new('exists','text/plain','Existence really is an imperfect tense that never becomes a present. (Friedrich Nietzsche)')
+          Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
         end
       end
     end #}}}
+    class DoPutProperty < Riddl::Implementation #{{{
+      def response
+        data = @a[1]
+        dir = File.join(data,@a[0],Riddl::Protocols::Utils::escape(@r[-3]))
+        file = File.join(dir,'properties.json')
+        key = @r[-1]
+        unless Dir.exist?(dir)
+          @status = 404
+          return Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
+        end
+        props = File.exist?(file) && !File.read(file).strip.empty? ? JSON.parse(File.read(file)) : {}
+        props[key] = @p[0].value
+        File.write(file,JSON.pretty_generate(props))
+        nil
+      end
+    end #}}}
+    class DoDeleteProperty < Riddl::Implementation #{{{
+      def response
+        data = @a[1]
+        dir = File.join(data,@a[0],Riddl::Protocols::Utils::escape(@r[-3]))
+        file = File.join(dir,'properties.json')
+        key = @r[-1]
+        props = File.exist?(file) ? JSON.parse(File.read(file)) : {}
+        if props.key?(key)
+          props.delete(key)
+          File.write(file,JSON.pretty_generate(props))
+          nil
+        else
+          @status = 404
+          Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
+        end
+      end
+    end #}}}
+    class DoNewEndpoint < Riddl::Implementation #{{{
+      def response
+        data = @a[1]
+        dir = File.join(data,@a[0],Riddl::Protocols::Utils::escape(@p[0].value))
+        Dir.mkdir(dir)
+        File.write(File.join(dir,'properties.json'),'{}')
+        @status = 201
+        nil
+      rescue Errno::EEXIST
+        @status = 409
+        Riddl::Parameter::Complex.new('exists','text/plain','Endpoint already exists.')
+      end
+    end #}}}
     class DoList < Riddl::Implementation #{{{
       def response
         data = @a[1]
         @a[2] ||= 0...0
         dir = File.join(data,@a[0],*(@r[@a[2]].map{|e| Riddl::Protocols::Utils::escape(e)}))
+        if @a[3] && !Dir.exist?(dir)
+          @status = 404
+          return Riddl::Parameter::Complex.new('exists','text/plain',NOT_FOUND)
+        end
         return Riddl::Parameter::Complex.new('list','text/xml') do
           doc = XML::Smart::string('<resources/>')
-          Dir.glob(File.join(dir,'*')).sort.each do |f|
-           doc.root.add('resource',File.basename(f))
+          names = Dir.glob(File.join(dir,'*')).map{ |f| File.basename(f) } | (@a[5] || [])
+          names.sort.each do |n|
+            next if @a[4] && !@a[4].include?(n)
+            doc.root.add('resource',n)
           end
           doc.to_s
         end
       end
     end #}}}
-
-    class DoFile < Riddl::Implementation #{{{
+    class DoDescList < Riddl::Implementation #{{{
       def response
         data = @a[1]
-        file = File.join(data,@a[0],*(@r[@a[2]].map{|e| Riddl::Protocols::Utils::escape(e)}))
-        File.write(file,@p[0])
+        @a[2] ||= 0...0
+        dir = File.join(data,@a[0],*(@r[@a[2]].map{|e| Riddl::Protocols::Utils::escape(e)}))
+        return Riddl::Parameter::Complex.new('list','text/xml') do
+          doc = XML::Smart::string('<resources/>')
+          Dir.glob(File.join(dir,'*','descriptions')).each do |f|
+            n = doc.root.add('resource', 'endpoint' => File.basename(File.dirname(f)))
+            n.add('endpoint', File.read(File.join(f,'endpoint.md'))) if File.exist?(File.join(f,'endpoint.md'))
+            n.add('functionality', File.read(File.join(f,'functionality.md'))) if File.exist?(File.join(f,'functionality.md'))
+            n.add('output', File.read(File.join(f,'output.md'))) if File.exist?(File.join(f,'output.md'))
+          end
+          doc.to_s
+        end
       end
     end #}}}
 
@@ -101,12 +225,13 @@ module CPEE
 
       Proc.new do
         on resource do
+          run DoList, '', opts[:data_dir] if get
           on resource 'modifiers' do
             run DoList, 'modifiers', opts[:data_dir] if get
             on resource do
               run DoList, 'modifiers', opts[:data_dir], (-1..-1) if get
               on resource do
-                run DoModExists, 'modifiers', opts[:data_dir] if get
+                run DoList, 'modifiers', opts[:data_dir], (-2..-1), true, %w{patch.xml unpatch.xml condition.json ui.rng} if get
                 on resource 'patch.xml' do
                   run DoFile, 'modifiers', opts[:data_dir], (-3..-1), 'testset', 'text/xml' if get
                 end
@@ -122,19 +247,63 @@ module CPEE
               end
             end
           end
+          on resource 'symbols' do
+            run DoList, 'symbols', opts[:data_dir] if get
+            on resource '[a-z][a-zA-Z0-9_-]*\.svg' do
+              run DoFile, 'symbols', opts[:data_dir], (-1..-1), 'svg', 'image/svg+xml' if get
+              run DoPutFile, 'symbols', opts[:data_dir] if put 'symbol'
+              run DoDeleteFile, 'symbols', opts[:data_dir], (-1..-1) if delete
+            end
+          end
+          on resource 'schemas' do
+            run DoList, 'schemas', opts[:data_dir] if get
+            on resource '[a-z][a-zA-Z0-9_-]*\.rng' do
+              run DoFile, 'schemas', opts[:data_dir], (-1..-1), 'rng', 'text/xml' if get
+              run DoPutFile, 'schemas', opts[:data_dir] if put 'schema'
+              run DoDeleteFile, 'schemas', opts[:data_dir], (-1..-1) if delete
+            end
+          end
           on resource 'endpoints' do
+            run DoDescList, 'endpoints', opts[:data_dir] if get 'dfilter'
             run DoList, 'endpoints', opts[:data_dir] if get
+            run DoNewEndpoint, 'endpoints', opts[:data_dir] if post 'endpoint'
             on resource do
-              run DoExists, 'endpoints', opts[:data_dir] if get
+              run DoList, 'endpoints', opts[:data_dir], (-1..-1), true, %w{schema.rng symbol.svg properties.json descriptions}, %w{properties.json} if get
               on resource 'symbol.svg' do
                 run DoFile, 'endpoints', opts[:data_dir], (-2..-1), 'svg', 'image/svg+xml'  if get
+                run DoPutEndpointFile, 'endpoints', opts[:data_dir], 'symbols' if put 'endpoint-symbol'
+                run DoDeleteFile, 'endpoints', opts[:data_dir], (-2..-1) if delete
               end
               on resource 'schema.rng' do
                 run DoFile, 'endpoints', opts[:data_dir], (-2..-1), 'rng', 'text/xml' if get
-                run SaveFile, 'endpoints', opts[:data_dir], (-2..-1), 'rng', 'text/xml' if put 'schema'
+                run DoPutEndpointFile, 'endpoints', opts[:data_dir], 'schemas' if put 'endpoint-schema'
+                run DoDeleteFile, 'endpoints', opts[:data_dir], (-2..-1) if delete
               end
               on resource 'properties.json' do
-                run DoFile, 'endpoints', opts[:data_dir], (-2..-1), 'json', 'application/json' if get
+                run DoProperties, 'endpoints', opts[:data_dir] if get
+                on resource do
+                  run DoGetProperty, 'endpoints', opts[:data_dir] if get
+                  run DoPutProperty, 'endpoints', opts[:data_dir] if put 'property'
+                  run DoDeleteProperty, 'endpoints', opts[:data_dir] if delete
+                end
+              end
+              on resource 'descriptions' do
+                run DoList, 'endpoints', opts[:data_dir], (-2..-1), true, %w{functionality.md output.md endpoint.md} if get
+                on resource 'functionality.md' do
+                  run DoFile, 'endpoints', opts[:data_dir], (-3..-1), 'markdown', 'text/markdown' if get
+                  run DoPutDescription, 'endpoints', opts[:data_dir] if put 'description-file'
+                  run DoDeleteFile, 'endpoints', opts[:data_dir], (-3..-1) if delete
+                end
+                on resource 'output.md' do
+                  run DoFile, 'endpoints', opts[:data_dir], (-3..-1), 'markdown', 'text/markdown' if get
+                  run DoPutDescription, 'endpoints', opts[:data_dir] if put 'description-file'
+                  run DoDeleteFile, 'endpoints', opts[:data_dir], (-3..-1) if delete
+                end
+                on resource 'endpoint.md' do
+                  run DoFile, 'endpoints', opts[:data_dir], (-3..-1), 'markdown', 'text/markdown' if get
+                  run DoPutDescription, 'endpoints', opts[:data_dir] if put 'description-file'
+                  run DoDeleteFile, 'endpoints', opts[:data_dir], (-3..-1) if delete
+                end
               end
             end
           end

data/lib/cpee-resources/implementation.xml

@@ -17,14 +17,14 @@
 -->
 
 <description xmlns="http://riddl.org/ns/description/1.0" xmlns:ann="http://riddl.org/ns/annotation/1.0" xmlns:xi="http://www.w3.org/2001/XInclude" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <message name="dfilter">
+    <parameter name="description" type="string"/>
+  </message>
   <message name="list">
     <parameter name="list" mimetype="*/xml"/>
   </message>
-  <message name="exists">
-    <choice>
-      <parameter name="exists" mimetype="*/xml"/>
-      <parameter name="exists" mimetype="text/plain"/>
-    </choice>
+  <message name="endpoint">
+    <parameter name="name" type="string"/>
   </message>
   <message name="testset">
     <choice>
@@ -33,15 +33,25 @@
     </choice>
   </message>
   <message name="symbol">
+    <parameter name="*" mimetype="image/svg+xml"/>
+  </message>
+  <message name="schema">
+    <parameter name="*" mimetype="*/xml"/>
+  </message>
+  <message name="endpoint-symbol">
     <choice>
-      <parameter name="svg" mimetype="image/svg+xml"/>
-      <parameter name="exists" mimetype="text/plain"/>
+      <parameter name="file" mimetype="image/svg+xml"/>
+      <parameter name="name" type="string">
+        <param name="pattern">[a-z][a-zA-Z0-9_-]*\.svg</param>
+      </parameter>
     </choice>
   </message>
-  <message name="schema">
+  <message name="endpoint-schema">
     <choice>
-      <parameter name="rng" mimetype="*/xml"/>
-      <parameter name="exists" mimetype="text/plain"/>
+      <parameter name="file" mimetype="*/xml"/>
+      <parameter name="name" type="string">
+        <param name="pattern">[a-z][a-zA-Z0-9_-]*\.rng</param>
+      </parameter>
     </choice>
   </message>
   <message name="json">
@@ -50,14 +60,30 @@
       <parameter name="exists" mimetype="text/plain"/>
     </choice>
   </message>
+  <message name="property">
+    <parameter name="value" type="string"/>
+  </message>
+  <message name="property-value">
+    <parameter name="value" mimetype="text/plain"/>
+  </message>
+  <message name="markdown">
+    <choice>
+      <parameter name="markdown" mimetype="text/markdown"/>
+      <parameter name="exists" mimetype="text/plain"/>
+    </choice>
+  </message>
+  <message name="description-file">
+    <parameter name="*" mimetype="text/markdown"/>
+  </message>
 
   <resource>
+    <get out="list"/>
     <resource relative='modifiers'> <!--{{{-->
       <get out="list"/>
       <resource>
         <get out="list"/>
         <resource>
-          <get out="exists"/>
+          <get out="list"/>
           <resource relative="patch.xml">
             <get out="testset"/>
           </resource>
@@ -73,19 +99,63 @@
         </resource>
       </resource>
     </resource> <!--}}}-->
-    <resource relative='endpoints'>
+    <resource relative='symbols'>
+      <get out="list"/>
+      <resource relative="[a-z][a-zA-Z0-9_-]*\.svg">
+        <get out="symbol"/>
+        <put in="symbol"/>
+        <delete/>
+      </resource>
+    </resource>
+    <resource relative='schemas'>
       <get out="list"/>
+      <resource relative="[a-z][a-zA-Z0-9_-]*\.rng">
+        <get out="schema"/>
+        <put in="schema"/>
+        <delete/>
+      </resource>
+    </resource>
+    <resource relative='endpoints'>
+      <get in="dfilter" out="list"/>
+      <get in="*" out="list"/>
+      <post in="endpoint"/>
       <resource>
-        <get out="exists"/>
+        <get out="list"/>
         <resource relative="symbol.svg">
           <get out="symbol"/>
+          <put in="endpoint-symbol"/>
+          <delete/>
         </resource>
         <resource relative="schema.rng">
           <get out="schema"/>
-          <put in="schema"/>
+          <put in="endpoint-schema"/>
+          <delete/>
         </resource>
         <resource relative="properties.json">
           <get out="json"/>
+          <resource>
+            <get out="property-value"/>
+            <put in="property"/>
+            <delete/>
+          </resource>
+        </resource>
+        <resource relative="descriptions">
+          <get out="list"/>
+          <resource relative="functionality.md">
+            <get out="markdown"/>
+            <put in="description-file"/>
+            <delete/>
+          </resource>
+          <resource relative="output.md">
+            <get out="markdown"/>
+            <put in="description-file"/>
+            <delete/>
+          </resource>
+          <resource relative="endpoint.md">
+            <get out="markdown"/>
+            <put in="description-file"/>
+            <delete/>
+          </resource>
         </resource>
       </resource>
     </resource>

data/server/resources

@@ -16,8 +16,13 @@
 # along with CPEE-RESOURCES (file LICENSE in the main directory).  If not, see
 # <http://www.gnu.org/licenses/>.
 
-require 'rubygems'
-require 'cpee-resources/implementation'
+if File.exist?(File.join(__dir__,'..','lib','cpee-resources','implementation.rb'))
+  require_relative File.join(__dir__,'..','lib','cpee-resources','implementation')
+elsif File.exist?(File.join(Dir.home,'Projects','cpee-resources','lib','cpee-resources','implementation.rb'))
+  require_relative File.join(Dir.home, 'Projects','cpee-resources','lib','cpee-resources','implementation')
+else
+  require 'cpee-resources/implementation'
+end
 
 options = {
   :host => 'localhost',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cpee-resources
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Juergen eTM Mangler
 - Ralph Vigne
 bindir: tools
 cert_chain: []
-date: 2025-05-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riddl
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Resources list for the cloud process execution engine (cpee.org)
 test_files: []