riddl 0.125 → 0.126

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 260b0959b5e3cd03e5346a8e6002e6e7ab35ac81a90c099fabed18667b724f51
-  data.tar.gz: 163523a732236a6e81fce5976437e2e7610f2a3fd171e2425b7eac36e7f6fe32
+  metadata.gz: 0eac3402149b89b4f1f94b4737e73be5c0f312951a70976703b8151a417e853e
+  data.tar.gz: 1d159b5d6baffd6f50b8dcf744c3f8e5fa8206bf47b346a2be9822e74228453a
 SHA512:
-  metadata.gz: e6a4e14075147239fd64cf140c2d5feb563c2076ac7ffe2fd3d799ac7d66c58e44bcb3945a676a5e04d255e23c0c4a4bcd86283a88ae9292c3a3e938a1de0d45
-  data.tar.gz: 89f7414265c9764de654494b43b736a234a62663abd01ec88ef1bf7e26dcbdb3a7a7c3399360c105930097ff08b21491f1acec58fd9aa0144e381856691dd4ee
+  metadata.gz: e13489f6872f3d2c383c3c8a4dcf9a555f018aaee385ace34687e10043095129768c5a8c03fe849052777a5f613a1cd8c1a949313603ebfd39d8a97ed96f29f1
+  data.tar.gz: c4601e98d3c48e28749328467b0451d9b373dc7f46c96ee49f9ff02e6992661af79dc3689d293c13f09db3dc07ea7717b5bb1bd03186f08ffc8c3ae2ae360604

data/lib/ruby/riddl/protocols/generator.rb

@@ -0,0 +1,118 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../constants')
+require File.expand_path(File.dirname(__FILE__) + '/../utils')
+require 'stringio'
+
+module Riddl
+  module Protocols
+    module HTTP
+      class Generator
+        def initialize(params,headers)
+          @params = params
+          @headers = headers
+        end
+
+        def generate(mode=:output)
+          if @params.is_a?(Array) && @params.length == 1
+            body(@params[0],mode)
+          elsif @params.class == Riddl::Parameter::Simple || @params.class == Riddl::Parameter::Complex
+            body(@params,mode)
+          elsif @params.is_a?(Array) && @params.length > 1
+            multipart(mode)
+          else
+            if mode == :output
+              @headers['Content-Type'] = 'text/plain'
+              StringIO.new('','r+b')
+            else
+              StringIO.new('','r+b')
+            end
+          end
+        end
+
+        def body(r,mode)
+          tmp = StringIO.new('','r+b')
+          case r
+            when Riddl::Parameter::Simple
+              if mode == :output
+                tmp.write r.value
+                @headers['Content-Type'] = 'text/plain'
+                @headers['Content-ID'] = r.name
+                @headers['RIDDL-TYPE'] = 'simple'
+              end
+              if mode == :input
+                @headers['Content-Type'] = 'application/x-www-form-urlencoded'
+                tmp.write Riddl::Protocols::Utils::escape(r.name) + '=' + Riddl::Protocols::Utils::escape(r.value)
+              end
+            when Riddl::Parameter::Complex
+              tmp.write(r.value.respond_to?(:read) ? r.value.read : r.value)
+              @headers['Content-Type'] = r.mimetype + r.mimextra
+              @headers['RIDDL-TYPE'] = 'complex'
+              if r.filename.nil?
+                @headers['Content-ID'] = r.name
+              else
+                @headers['Content-Disposition'] = "riddl-data; name=\"#{r.name}\"; filename=\"#{r.filename}\""
+              end
+          end
+          tmp.flush
+          tmp.rewind
+          tmp
+        end
+        private :body
+
+        def multipart(mode)
+          tmp = StringIO.new('','r+b')
+          scount = ccount = 0
+          @params.each do |r|
+            case r
+              when Riddl::Parameter::Simple
+                scount += 1
+              when Riddl::Parameter::Complex
+                ccount += 1
+            end
+          end
+          if scount > 0 && ccount == 0
+            @headers['Content-Type'] = 'application/x-www-form-urlencoded'
+            res = []
+            @params.each do |r|
+              case r
+                when Riddl::Parameter::Simple
+                  res << Riddl::Protocols::Utils::escape(r.name) + '=' + Riddl::Protocols::Utils::escape(r.value)
+              end
+            end
+            tmp.write res.join('&')
+          else
+            if scount + ccount > 0
+              @headers['Content-Type'] = "multipart/#{mode == :input ? 'form-data' : 'mixed'}; boundary=\"#{BOUNDARY}\""
+              @params.each do |r|
+                case r
+                  when Riddl::Parameter::Simple
+                    tmp.write '--' + BOUNDARY + EOL
+                    tmp.write 'RIDDL-TYPE: simple' + EOL
+                    tmp.write "Content-Disposition: #{mode == :input ? 'form-data' : 'riddl-data'}; name=\"#{r.name}\"" + EOL
+                    tmp.write EOL
+                    tmp.write r.value
+                    tmp.write EOL
+                  when Riddl::Parameter::Complex
+                    tmp.write '--' +  BOUNDARY + EOL
+                    tmp.write 'RIDDL-TYPE: complex' + EOL
+                    tmp.write "Content-Disposition: #{mode == :input ? 'form-data' : 'riddl-data'}; name=\"#{r.name}\""
+                    tmp.write r.filename.nil? ? '; filename=""' + EOL : "; filename=\"#{r.filename}\"" + EOL
+                    tmp.write 'Content-Transfer-Encoding: binary' + EOL
+                    tmp.write 'Content-Type: ' + r.mimetype + r.mimextra + EOL
+                    tmp.write EOL
+                    tmp.write(r.value.respond_to?(:read) ? r.value.read : r.value)
+                    tmp.write EOL
+                end
+              end
+              tmp.write '--' + BOUNDARY + EOL
+            end
+          end
+          tmp.flush
+          tmp.rewind
+          tmp
+        end
+        private :multipart
+
+      end
+    end
+  end
+end

data/lib/ruby/riddl/protocols/parser.rb

@@ -0,0 +1,205 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../constants')
+require File.expand_path(File.dirname(__FILE__) + '/../../parameter')
+require File.expand_path(File.dirname(__FILE__) + '/../utils')
+
+module Riddl
+  module Protocols
+    module HTTP
+      class Parser
+        MULTIPART_CONTENT_TYPES = [
+          #{{{
+          'multipart/form-data',
+          'multipart/related',
+          'multipart/mixed'
+          #}}}
+        ].freeze
+        FORM_CONTENT_TYPES = [
+          #{{{
+          'application/x-www-form-urlencoded'
+          #}}}
+        ].freeze
+
+        def parse_content(input,ctype,content_length,content_disposition,content_id,riddl_type)
+          #{{{
+          # fixing for chunked?
+
+          ctype = nil if riddl_type == 'simple'
+          filename = content_disposition[/ filename="?([^\";]*)"?/ni, 1]
+          name = content_disposition[/ name="?([^\";]*)"?/ni, 1] || content_id
+
+          if ctype || filename
+            body = Parameter::Tempfile.new("RiddlMultipart")
+            body.binmode if body.respond_to?(:binmode)
+          else
+            body = ''
+          end
+
+          if content_length == 0
+            bufsize = 16384
+            until input.eof?
+              c = input.read(bufsize)
+              raise EOFError, "bad content body"  if c.nil? || c.empty?
+              body << c
+              content_length -= c.size
+            end
+            body << input.read
+          else
+            bufsize = 16384
+            until content_length <= 0
+              c = input.read(bufsize < content_length ? bufsize : content_length)
+              raise EOFError, "bad content body"  if c.nil? || c.empty?
+              body << c
+              content_length -= c.size
+            end
+          end
+          body.rewind if body.respond_to?(:binmode)
+
+          add_to_params(name,body,filename,ctype,nil) if body.length > 0
+          #}}}
+        end
+        private :parse_content
+
+        def parse_multipart(input,content_type,content_length)
+          #{{{
+          content_type =~ %r|\Amultipart/.*boundary=\"?([^\";,]+)\"?|n
+          boundary = "--#{$1}"
+
+          boundary_size = boundary.size + EOL.size
+          content_length -= boundary_size
+          status = input.read(boundary_size)
+          raise EOFError, "bad content body" unless status == boundary + EOL
+
+          rx = /(?:#{EOL})?#{Regexp.quote boundary}(#{EOL}|--)/n
+
+          buf = ""
+          bufsize = 16384
+          loop do
+            head = nil
+            body = ''
+            filename = ctype = name = nil
+
+            until head && buf =~ rx
+              if !head && i = buf.index(EOL+EOL)
+                head = buf.slice!(0, i+2) # First \r\n
+                buf.slice!(0, 2)          # Second \r\n
+
+                filename = head[/Content-Disposition:.* filename="?([^\";]*)"?/ni, 1]
+                ctype = head[/Content-Type: (.*)#{EOL}/ni, 1]
+                name = head[/Content-Disposition:.*\s+name="?([^\";]*)"?/ni, 1] || head[/Content-ID:\s*([^#{EOL}]*)/ni, 1]
+
+                if ctype || filename
+                  body = Parameter::Tempfile.new("RiddlMultipart")
+                  body.binmode  if body.respond_to?(:binmode)
+                end
+
+                next
+              end
+
+              # Save the read body part.
+              if head && (boundary_size+4 < buf.size)
+                body << buf.slice!(0, buf.size - (boundary_size+4))
+              end
+
+              c = input.read(bufsize < content_length ? bufsize : content_length)
+              raise EOFError, "bad content body"  if c.nil? || c.empty?
+              content_length -= c.size
+
+              buf << c
+            end
+
+            # Save the rest.
+            if i = buf.index(rx)
+              body << buf.slice!(0, i)
+              buf.slice!(0, boundary_size+2)
+              content_length = -1  if $1 == "--"
+            end
+
+            p name
+            p body
+            p filename
+            p ctype
+            p head
+            p '----'
+
+            add_to_params(name,body,filename == '' ? nil : filename,ctype,head)
+
+            break if buf.empty? || content_length == -1
+          end
+          #}}}
+        end
+        private :parse_multipart
+
+        def add_to_params(name,body,filename,ctype,head)
+          #{{{
+          if filename == ""
+            # filename is blank which means no file has been selected
+          elsif filename && ctype
+            body.rewind
+
+            # Take the basename of the upload's original filename.
+            # This handles the full Windows paths given by Internet Explorer
+            # (and perhaps other broken user agents) without affecting
+            # those which give the lone filename.
+            filename =~ /^(?:.*[:\\\/])?(.*)/m
+            filename = $1
+
+            @params << Parameter::Complex.new(name, ctype, body, filename, head)
+          elsif !filename && ctype
+            body.rewind
+
+            # Generic multipart cases, not coming from a form
+            @params << Parameter::Complex.new(name, ctype, body, nil, head)
+          else
+            @params << Parameter::Simple.new(name, body, :body)
+          end
+          #}}}
+        end
+        private :add_to_params
+
+        def parse_nested_query(qs, type)
+          #{{{
+          (qs || '').split(/[#{D}] */n).each do |p|
+            k, v = Riddl::Protocols::Utils::unescape(p).split('=', 2)
+            @params << Parameter::Simple.new(k,v,type)
+          end
+          #}}}
+        end
+        private :parse_nested_query
+
+        def initialize(query_string,input,content_type,content_length,content_disposition,content_id,riddl_type)
+          #{{{
+          # rewind because in some cases it is not at start (when multipart without length)
+
+          begin
+            input.rewind if input.respond_to?(:rewind)
+          rescue Errno::ESPIPE
+            # Handles exceptions raised by input streams that cannot be rewound
+            # such as when using plain CGI under Apache
+          end
+
+          media_type = content_type && content_type.split(/\s*[;,]\s*/, 2).first.downcase
+          @params = Riddl::Parameter::Array.new
+          parse_nested_query(query_string,:query)
+          if MULTIPART_CONTENT_TYPES.include?(media_type)
+            parse_multipart(input,content_type,content_length.to_i)
+          elsif FORM_CONTENT_TYPES.include?(media_type)
+            # sub is a fix for Safari Ajax postings that always append \0
+            parse_nested_query(input.read.sub(/\0\z/, ''),:body)
+          else
+            parse_content(input,content_type,content_length.to_i,content_disposition||'',content_id||'',riddl_type||'')
+          end
+
+          begin
+            input.rewind if input.respond_to?(:rewind)
+          rescue Errno::ESPIPE
+            # Handles exceptions raised by input streams that cannot be rewound
+            # such as when using plain CGI under Apache
+          end
+          #}}}
+        end
+
+        attr_reader :params
+      end
+    end
+  end
+end

data/riddl.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "riddl"
-  s.version          = "0.125"
+  s.version          = "0.126"
   s.platform         = Gem::Platform::RUBY
   s.license          = "LGPL-3.0"
   s.summary          = "restful interface description and declaration language: tools and client/server libs"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riddl
 version: !ruby/object:Gem::Version
-  version: '0.125'
+  version: '0.126'
 platform: ruby
 authors:
 - Juergen 'eTM' Mangler
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: tools
 cert_chain: []
-date: 2023-02-19 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemonite
@@ -459,8 +459,10 @@ 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