riddl 1.0.15 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2e9a50976d0b6de45b2dde536b79656902e3a319b420231655e424fb2a51f05
-  data.tar.gz: fc60670fa785dac51d294ec087471a9e08cd2347a7b89f80f6efb60d872b3560
+  metadata.gz: e69bd3fbaa637fa772cb4be483543ea4add9a415688d76c39a01aa3cc627f31e
+  data.tar.gz: 9750596f66325159bc58d156cb1ff71e7fa6b862034d8bf6de25a5f3960a165d
 SHA512:
-  metadata.gz: 21748d3e9e4aa3c0b03ff2d4a16a115a49cbfe0dee3646c3c7d0c5df8ca63403aa427148fe64e99297a07e63b8dcd61da9f73250b7d504b3c29766f27af9ae6d
-  data.tar.gz: 96daa49aeda77e9bad74be5b71f3b5ce6227affd7943f76726503915212b39ae64051913443a7ac6c6b6cb8a58c2c9a325dd09f0826a93ad947df52c2463d338
+  metadata.gz: 06f71177f1844c68b56a2c5a022882304f1932b5c21b961cf89dc1ff13f8c4338bc1c196d72e454035cbafd4acaaaaba4ddb41e0d9693dde0a9d8e1c8b090b1e
+  data.tar.gz: fd9102d88a796ccb51f4cb881dc7694d04570b4159c80c5e0a4f5e99b8294b999bc01ec6329e8bbfbd5565eb19e9d991f7b6a8042e3d4b18d3e301417f08bab5

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

@@ -0,0 +1,150 @@
+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 StreamingBody
+        CHUNK_SIZE = 1 << 16  # 64 KiB
+
+        def initialize(parts)
+          @parts = parts
+        end
+
+        def each
+          @parts.each do |part|
+            if part.respond_to?(:read)
+              part.rewind if part.respond_to?(:rewind)
+              while chunk = part.read(CHUNK_SIZE)
+                yield chunk
+              end
+            else
+              yield part.to_s
+            end
+          end
+        end
+
+        def close
+          @parts.each do |part|
+            part.close if part.respond_to?(:close) && !part.is_a?(String)
+          end
+        end
+      end
+
+      class Generator
+        def initialize(params,headers)
+          @params = params
+          @headers = headers
+        end
+
+        def self.merge(parts)
+          parts.map do |p|
+            if p.respond_to?(:read)
+              p.rewind if p.respond_to?(:rewind)
+              p.read
+            else
+              p.to_s
+            end
+          end.join
+        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'
+            end
+            []
+          end
+        end
+
+        def body(r,mode)
+          parts = []
+          case r
+            when Riddl::Parameter::Simple
+              if mode == :output
+                parts << r.value
+                @headers['Content-Type'] = 'text/plain'
+                @headers['Content-ID'] = r.name
+                @headers['RIDDL-TYPE'] = 'simple'
+              else
+                @headers['Content-Type'] = 'application/x-www-form-urlencoded'
+                parts << Riddl::Protocols::Utils::escape(r.name) + '=' + Riddl::Protocols::Utils::escape(r.value)
+              end
+            when Riddl::Parameter::Complex
+              parts << 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
+          parts
+        end
+        private :body
+
+        def multipart(mode)
+          parts = []
+          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
+            parts << 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
+                    parts << '--' + BOUNDARY + EOL +
+                             'RIDDL-TYPE: simple' + EOL +
+                             "Content-Disposition: form-data; name=\"#{r.name}\"" + EOL +
+                             EOL +
+                             r.value.to_s +
+                             EOL
+                  when Riddl::Parameter::Complex
+                    parts << '--' +  BOUNDARY + EOL +
+                             'RIDDL-TYPE: complex' + EOL +
+                             "Content-Disposition: form-data; name=\"#{r.name}\"" +
+                                (r.filename.nil? ? EOL : "; filename=\"#{r.filename}\"" + EOL) +
+                             'Content-Transfer-Encoding: binary' + EOL +
+                             'Content-Type: ' + r.mimetype + r.mimextra + EOL +
+                             EOL
+                    parts << r.value
+                    parts << EOL
+                end
+              end
+              parts << '--' + BOUNDARY + '--' + EOL
+            end
+          end
+          parts
+        end
+        private :multipart
+
+      end
+    end
+  end
+end

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

@@ -17,7 +17,8 @@ module Riddl
           @parts.each do |part|
             if part.respond_to?(:read)
               part.rewind if part.respond_to?(:rewind)
-              yield chunk while (chunk = part.read(CHUNK_SIZE))
+              while chunk = part.read(CHUNK_SIZE)
+              yield chunk
             else
               yield part.to_s
             end

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

@@ -0,0 +1,208 @@
+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)
+          #{{{
+          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
+            # should never happen normally, but leave it in, as sombody might
+            # decide to use parse_content independently
+            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)
+
+          if body.length > 0
+            add_to_params(name,body,filename,ctype,nil)
+          else
+            if body.respond_to?(:binmode)
+              body.close
+              body.unlink
+            end
+          end
+          #}}}
+        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
+
+            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
+
+          # fixing for chunked
+          content_length = content_length && content_length.to_i > 0 ? content_length.to_i : input.size
+
+          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          = "1.0.15"
+  s.version          = "1.0.16"
   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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riddl
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 1.0.16
 platform: ruby
 authors:
 - Juergen 'eTM' Mangler
@@ -463,8 +463,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
@@ -539,7 +541,7 @@ homepage: http://github.com/etm/riddl/
 licenses:
 - LGPL-3.0-or-later
 metadata:
-  documentation_uri: https://gemdocs.org/gems/riddl/1.0.15/
+  documentation_uri: https://gemdocs.org/gems/riddl/1.0.16/
 rdoc_options: []
 require_paths:
 - lib/ruby