tipi 0.34 → 0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cb2e4515c63ad20d116bf1aecb175db3b927bb2bf07d71b66fe90517fa5ab14
-  data.tar.gz: fbddc482cd4172ad87e07c55718770051f9659f7efbfbd48c5eca41fee667ce7
+  metadata.gz: '0381d5d135a88937862fe5e22d3f39d2dd6a9353af83a655c13c641af3dd0ec2'
+  data.tar.gz: 17e20767ca22950023d44135fb2e20fdc469898fd2298e32158d791a111730cd
 SHA512:
-  metadata.gz: f7a5ff1142ddcb938e1c78b16bdc27fb466f07e90a68306d39176557ca5913bf24a6e37a866d2a193a18d3f63171efcc580843ae5d34750e11d4653b7e601b65
-  data.tar.gz: 4b8c357af526b53a687161b38edf7c7d3ca086c39958f7e202060cb2551b1f2e27c7d041fcbdafd8840c159e8f25303b63f4a1bd8e1af99f43ed3f709ad122c5
+  metadata.gz: e15c3197e3ca5dff97071f34c6bb18e006bd338b0c182ae046af8cf9b0d22f7451f0230f2430c65400bc81999e1c269d5868db8bce0cec1843453cf00ae883aa
+  data.tar.gz: a486df80bd50ff8069bc0abe1bca9df13e58ad8c0d84b7e24a86b284fb6fcfc4c679824692049fc27c1435d6c0598a45a6461a8b48fe4540722061399bf7c5e3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.35 2021-02-10
+
+* Extract Request class into separate [qna](https://github.com/digital-fabric/qna) gem
+
 ## 0.34 2021-02-07
 
 * Implement digital fabric service and agents

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    tipi (0.34)
-      escape_utils (~> 1.2.1)
+    tipi (0.35)
       http-2 (~> 0.10.0)
       http_parser.rb (~> 0.6.0)
       msgpack (~> 1.4.2)
       polyphony (~> 0.51.0)
+      qna (~> 0.1)
       rack (>= 2.0.8, < 2.3.0)
       websocket (~> 1.2.8)
 
@@ -29,6 +29,8 @@ GEM
       ruby-progressbar
     msgpack (1.4.2)
     polyphony (0.51.0)
+    qna (0.1)
+      escape_utils (~> 1.2.1)
     rack (2.2.3)
     rake (12.3.3)
     ruby-progressbar (1.10.1)

data/examples/routing_server.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'tipi'
+
+opts = {
+  reuse_addr:  true,
+  dont_linger: true
+}
+
+puts "pid: #{Process.pid}"
+puts 'Listening on port 4411...'
+
+app = Tipi.route do |r|
+  r.root do
+    r.redirect '/hello'
+  end
+  r.on 'hello' do
+    r.get 'world' do
+      r.respond 'Hello world'
+    end
+    r.get do
+      r.respond 'Hello'
+    end
+    r.post do
+      puts 'Someone said Hello'
+      r.redirect '/'
+    end
+  end
+end
+
+spin do
+  Tipi.serve('0.0.0.0', 4411, opts, &app)
+end.await

data/lib/tipi.rb

@@ -49,5 +49,9 @@ module Tipi
       klass = use_http2 ? HTTP2Adapter : HTTP1Adapter
       klass.new(socket, opts)
     end
+
+    def route(&block)
+      proc { |req| req.route(&block) }
+    end
   end
 end

data/lib/tipi/digital_fabric/agent.rb

@@ -180,7 +180,7 @@ module DigitalFabric
     end
 
     def prepare_http_request(msg)
-      req = Tipi::Request.new(msg['headers'], RequestAdapter.new(self, msg))
+      req = QNA::Request.new(msg['headers'], RequestAdapter.new(self, msg))
       req.buffer_body_chunk(msg['body']) if msg['body']
       req.complete! if msg['complete']
       req
@@ -199,7 +199,7 @@ module DigitalFabric
     end
 
     def recv_ws_request(msg)
-      req = Tipi::Request.new(msg['headers'], RequestAdapter.new(self, msg))
+      req = QNA::Request.new(msg['headers'], RequestAdapter.new(self, msg))
       id = msg['id']
       @requests[id] = @long_running_requests[id] = spin do
         ws_request(req)

data/lib/tipi/http1_adapter.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'http/parser'
-require_relative './request'
 require_relative './http2_adapter'
+require 'qna/request'
 
 module Tipi
   # HTTP1 protocol implementation
@@ -87,7 +87,7 @@ module Tipi
       headers = normalize_headers(headers)
       headers[':path'] = @parser.request_url
       headers[':method'] = @parser.http_method.downcase
-      queue_request(Request.new(headers, self))
+      queue_request(QNA::Request.new(headers, self))
     end
 
     def normalize_headers(headers)

data/lib/tipi/http2_stream.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'http/2'
-require_relative './request'
+require 'qna/request'
 
 module Tipi
   # Manages an HTTP 2 stream
@@ -46,7 +46,7 @@ module Tipi
     end
     
     def on_headers(headers)
-      @request = Request.new(headers.to_h, self)
+      @request = QNA::Request.new(headers.to_h, self)
       if @first
         @request.headers[':first'] = true
         @first = false

data/lib/tipi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tipi
-  VERSION = '0.34'
+  VERSION = '0.35'
 end

data/test/test_request.rb

@@ -62,7 +62,7 @@ class RequestHeadersTest < MiniTest::Test
 
     snooze
 
-    assert_kind_of Tipi::Request, req
+    assert_kind_of QNA::Request, req
     assert_equal 'blah.com', req.headers['host']
     assert_equal 'bar', req.headers['foo']
     assert_equal ['1', '3', '2'], req.headers['hi']

data/tipi.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |s|
   s.executables   = ['tipi']
 
   s.add_runtime_dependency      'polyphony',          '~>0.51.0'
+  s.add_runtime_dependency      'qna',                '~>0.1'
   
   s.add_runtime_dependency      'http_parser.rb',     '~>0.6.0'
   s.add_runtime_dependency      'http-2',             '~>0.10.0'
   s.add_runtime_dependency      'rack',               '>=2.0.8', '<2.3.0'
   s.add_runtime_dependency      'websocket',          '~>1.2.8'
-  s.add_runtime_dependency      'escape_utils',       '~>1.2.1'
 
   # for digital fabric
   s.add_runtime_dependency      'msgpack',            '~>1.4.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tipi
 version: !ruby/object:Gem::Version
-  version: '0.34'
+  version: '0.35'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polyphony
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: qna
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
   requirement: !ruby/object:Gem::Requirement
@@ -86,20 +100,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.8
-- !ruby/object:Gem::Dependency
-  name: escape_utils
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -235,6 +235,7 @@ files:
 - examples/rack_server.rb
 - examples/rack_server_https.rb
 - examples/rack_server_https_forked.rb
+- examples/routing_server.rb
 - examples/websocket_client.rb
 - examples/websocket_demo.rb
 - examples/websocket_secure_server.rb
@@ -257,7 +258,6 @@ files:
 - lib/tipi/http2_adapter.rb
 - lib/tipi/http2_stream.rb
 - lib/tipi/rack_adapter.rb
-- lib/tipi/request.rb
 - lib/tipi/version.rb
 - lib/tipi/websocket.rb
 - test/coverage.rb

data/lib/tipi/request.rb

@@ -1,239 +0,0 @@
-# frozen_string_literal: true
-
-require 'uri'
-require 'escape_utils'
-
-module Tipi
-  module RequestInfoInstanceMethods
-    def host
-      @headers['host']
-    end
-
-    def connection
-      @headers['connection']
-    end
-
-    def upgrade_protocol
-      connection == 'upgrade' && @headers['upgrade']&.downcase
-    end
-
-    def protocol
-      @protocol ||= @adapter.protocol
-    end
-    
-    def method
-      @method ||= @headers[':method']
-    end
-    
-    def scheme
-      @scheme ||= @headers[':scheme']
-    end
-    
-    def uri
-      @uri ||= URI.parse(@headers[':path'] || '')
-    end
-    
-    def path
-      @path ||= uri.path
-    end
-    
-    def query_string
-      @query_string ||= uri.query
-    end
-    
-    def query
-      return @query if @query
-      
-      @query = (q = uri.query) ? split_query_string(q) : {}
-    end
-    
-    def split_query_string(query)
-      query.split('&').each_with_object({}) do |kv, h|
-        k, v = kv.split('=')
-        h[k.to_sym] = URI.decode_www_form_component(v)
-      end
-    end
-
-    def request_id
-      @headers['x-request-id']
-    end
-
-    def forwarded_for
-      @headers['x-forwarded-for']
-    end
-  end
-
-  module RequestInfoClassMethods
-    def parse_form_data(body, headers)
-      case (content_type = headers['content-type'])
-      when /multipart\/form\-data; boundary=([^\s]+)/
-        boundary = "--#{Regexp.last_match(1)}"
-        parse_multipart_form_data(body, boundary)
-      when 'application/x-www-form-urlencoded'
-        parse_urlencoded_form_data(body)
-      else
-        raise "Unsupported form data content type: #{content_type}"
-      end
-    end
-
-    def parse_multipart_form_data(body, boundary)
-      parts = body.split(boundary)
-      parts.each_with_object({}) do |p, h|
-        next if p.empty? || p == "--\r\n"
-
-        # remove post-boundary \r\n
-        p.slice!(0, 2)
-        parse_multipart_form_data_part(p, h)
-      end
-    end
-
-    def parse_multipart_form_data_part(part, hash)
-      body, headers = parse_multipart_form_data_part_headers(part)
-      disposition = headers['content-disposition'] || ''
-
-      name = (disposition =~ /name="([^"]+)"/) ? Regexp.last_match(1) : nil
-      filename = (disposition =~ /filename="([^"]+)"/) ? Regexp.last_match(1) : nil
-
-      if filename
-        hash[name] = { filename: filename, content_type: headers['content-type'], data: body }
-      else
-        hash[name] = body
-      end
-    end
-
-    def parse_multipart_form_data_part_headers(part)
-      headers = {}
-      while true
-        idx = part.index("\r\n")
-        break unless idx
-
-        header = part[0, idx]
-        part.slice!(0, idx + 2)
-        break if header.empty?
-
-        next unless header =~ /^([^\:]+)\:\s?(.+)$/
-        
-        headers[Regexp.last_match(1).downcase] = Regexp.last_match(2)
-      end
-      # remove trailing \r\n
-      part.slice!(part.size - 2, 2)
-      [part, headers]
-    end
-
-    PARAMETER_RE = /^(.+)=(.*)$/.freeze
-    MAX_PARAMETER_NAME_SIZE = 256
-    MAX_PARAMETER_VALUE_SIZE = 2**20 # 1MB
-
-    def parse_urlencoded_form_data(body)
-      body.force_encoding(UTF_8) unless body.encoding == Encoding::UTF_8
-      body.split('&').each_with_object({}) do |i, m|
-        raise 'Invalid parameter format' unless i =~ PARAMETER_RE
-  
-        k = Regexp.last_match(1)
-        raise 'Invalid parameter size' if k.size > MAX_PARAMETER_NAME_SIZE
-  
-        v = Regexp.last_match(2)
-        raise 'Invalid parameter size' if v.size > MAX_PARAMETER_VALUE_SIZE
-  
-        m[EscapeUtils.unescape_uri(k)] = EscapeUtils.unescape_uri(v)
-      end
-    end
-  end
-
-  # HTTP request
-  class Request
-    include RequestInfoInstanceMethods
-    extend RequestInfoClassMethods
-
-    attr_reader :headers, :adapter
-    attr_accessor :__next__
-    
-    def initialize(headers, adapter)
-      @headers  = headers
-      @adapter  = adapter
-    end
-        
-    def buffer_body_chunk(chunk)
-      @buffered_body_chunks ||= []
-      @buffered_body_chunks << chunk
-    end
-
-    def next_chunk
-      if @buffered_body_chunks
-        chunk = @buffered_body_chunks.shift
-        @buffered_body_chunks = nil if @buffered_body_chunks.empty?
-        return chunk
-      end
-
-      @message_complete ? nil : @adapter.get_body_chunk
-    end
-    
-    def each_chunk
-      if @buffered_body_chunks
-        while (chunk = @buffered_body_chunks.shift)
-          yield chunk
-        end
-        @buffered_body_chunks = nil
-      end
-      while !@message_complete && (chunk = @adapter.get_body_chunk)
-        yield chunk
-      end
-    end
-
-    def complete!(keep_alive = nil)
-      @message_complete = true
-      @keep_alive = keep_alive
-    end
-    
-    def complete?
-      @message_complete
-    end
-    
-    def consume
-      @adapter.consume_request
-    end
-    
-    def keep_alive?
-      @keep_alive
-    end
-    
-    def read
-      buf = @buffered_body_chunks ? @buffered_body_chunks.join : nil
-      while (chunk = @adapter.get_body_chunk)
-        (buf ||= +'') << chunk
-      end
-      @buffered_body_chunks = nil
-      buf
-    end
-    alias_method :body, :read
-    
-    def respond(body, headers = {})
-      @adapter.respond(body, headers)
-      @headers_sent = true
-    end
-    
-    def send_headers(headers = {}, empty_response = false)
-      return if @headers_sent
-      
-      @headers_sent = true
-      @adapter.send_headers(headers, empty_response: empty_response)
-    end
-    
-    def send_chunk(body, done: false)
-      send_headers({}) unless @headers_sent
-      
-      @adapter.send_chunk(body, done: done)
-    end
-    alias_method :<<, :send_chunk
-    
-    def finish
-      send_headers({}) unless @headers_sent
-      
-      @adapter.finish
-    end
-
-    def headers_sent?
-      @headers_sent
-    end
-  end
-end