qeweney 0.11 → 0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 256f14b402547865d5b7ce2357ef5ac79cd4f1f8e30129544450c7b8a60e39bb
-  data.tar.gz: 94ecbd44f44c1e858873315780ae0661237692a20396bf0a06b96497ea93f76a
+  metadata.gz: a776c09a368fd3b348a685f43dcffb40320e6d181529427f7659e56815994735
+  data.tar.gz: 9ba936914a124c9a21923c147cf5d90b76cb6ea4dde46cbeeb558d99909a9d86
 SHA512:
-  metadata.gz: 794a72410e59205ae66325aea81ee3d8a3b3e2bdaa7053118922e9a855f6d0e474d7d1e741787fe4b753a9c626e2672d9de4b95af14dc80c3f4a62175f72f0e5
-  data.tar.gz: 1775acaaa03ab16287f18dd18deb8d4720febcd2d13d1e502afbe8525a244921bb2b2946dee15da949f1aae9ed803275c2faf7b4675e4f6f6542554769ca0b94
+  metadata.gz: 9f49f57a3c037646789565e1adb8c5ba129b1ed7e3f7b2ddbc3ec6a11c150d9e946728fcb2912af84c69070c1cefab00be707aed104b5eda2a7a9845cc14c5b8
+  data.tar.gz: 214702b726cb0c4c18fd380f3d4d985955002bad65a7e80ac0072da78d2014eea8a0c604256deefaab9c5adbb77fec0c155397df9dbcd868b2410f13a884e89a

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: ciconia

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## 0.15 2022-01-08
+
+- Add `TestAdapter` class for testing requests and responses
+- Add `RoutingMethods#reject` method
+
+## 0.14 2021-08-10
+
+- Fix Request#on with paths containing slashes
+
+## 0.13.1 2021-08-03
+
+- Fix `Request#read`
+
+## 0.13 2021-08-02
+
+- Restore `Request#complete?` method
+- Add buffered_only argument to `Request#next_chunk`
+
+## 0.12 2021-07-30
+
+- Remove `Request#consume` method
+- Remove `Request#complete?` and associated methods
+
 ## 0.11 2021-07-26
 
 - Fix rack env (digital-fabric/tipi#11)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qeweney (0.11)
+    qeweney (0.15)
       escape_utils (~> 1.2.1)
 
 GEM
@@ -21,7 +21,7 @@ GEM
     ruby-progressbar (1.11.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   benchmark-ips (~> 2.8.3)
@@ -31,4 +31,4 @@ DEPENDENCIES
   rake (~> 12.3.3)
 
 BUNDLED WITH
-   2.1.4
+   2.3.3

data/README.md

@@ -1,4 +1,8 @@
-# Qeweney
+# Qeweney - add water, makes its own sauce!
+
+[![Gem Version](https://badge.fury.io/rb/qeweney.svg)](http://rubygems.org/gems/qeweney)
+[![Modulation Test](https://github.com/digital-fabric/qeweney/workflows/Tests/badge.svg)](https://github.com/digital-fabric/qeweney/actions?query=workflow%3ATests)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/digital-fabric/qeweney/blob/master/LICENSE)
 
 ## Cross-library HTTP request / response API for servers
 

data/examples/routing_benchmark.rb

@@ -104,7 +104,7 @@ OptimizedRubyApp = ->(r) do
       else
         return r.respond('Hello')
       end
-    elsif method == 'post' 
+    elsif method == 'post'
       # puts 'Someone said Hello'
       return r.redirect('/')
     end

data/lib/qeweney/rack.rb

@@ -67,12 +67,33 @@ module Qeweney
     end
   end
 
+  # TODO: integrate in env
+  # Implements a rack input stream:
+  # https://www.rubydoc.info/github/rack/rack/master/file/SPEC#label-The+Input+Stream
+  class InputStream
+    def initialize(request)
+      @request = request
+    end
+
+    def gets; end
+
+    def read(length = nil, outbuf = nil); end
+
+    def each(&block)
+      @request.each_chunk(&block)
+    end
+
+    def rewind; end
+  end
+
   def self.rack_env_from_request(request)
     Hash.new do |h, k|
       h[k] = rack_env_value_from_request(request, k)
     end
   end
 
+  # TODO: improve conformance to rack spec
+  # TODO: set values like port, scheme etc from actual connection
   RACK_ENV = {
     'SCRIPT_NAME'                    => '',
     'rack.version'                   => [1, 3],
@@ -89,7 +110,7 @@ module Qeweney
     'rack.multipart.buffer_size'     => nil,
     'rack.multipar.tempfile_factory' => nil
   }
-  
+
   HTTP_HEADER_RE = /^HTTP_(.+)$/.freeze
 
   def self.rack_env_value_from_request(request, key)

data/lib/qeweney/request.rb

@@ -15,28 +15,29 @@ module Qeweney
     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
+    def next_chunk(buffered_only = false)
       if @buffered_body_chunks
         chunk = @buffered_body_chunks.shift
         @buffered_body_chunks = nil if @buffered_body_chunks.empty?
         return chunk
+      elsif buffered_only
+        return nil
       end
 
-      @message_complete ? nil : @adapter.get_body_chunk(self)
+      @adapter.get_body_chunk(self, buffered_only)
     end
-    
+
     def each_chunk
       if @buffered_body_chunks
         while (chunk = @buffered_body_chunks.shift)
@@ -44,60 +45,51 @@ module Qeweney
         end
         @buffered_body_chunks = nil
       end
-      while !@message_complete && (chunk = @adapter.get_body_chunk(self))
+      while (chunk = @adapter.get_body_chunk(self))
         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(self)
-    end
-    
-    def keep_alive?
-      @keep_alive
-    end
-    
     def read
-      buf = @buffered_body_chunks ? @buffered_body_chunks.join : nil
-      while (chunk = @adapter.get_body_chunk(self))
-        (buf ||= +'') << chunk
+      if @buffered_body_chunks
+        body = @buffered_body_chunks.join
+        if !complete?
+          rest = @adapter.get_body(self)
+          body << rest if rest
+        end
+        @buffered_body_chunks = nil
+        return body
       end
-      @buffered_body_chunks = nil
-      buf
+      @adapter.get_body(self)
     end
     alias_method :body, :read
-    
+
+    def complete?
+      @adapter.complete?(self)
+    end
+
     def respond(body, headers = {})
       @adapter.respond(self, body, headers)
       @headers_sent = true
     end
-    
+
     def send_headers(headers = {}, empty_response = false)
       return if @headers_sent
-      
+
       @headers_sent = true
       @adapter.send_headers(self, headers, empty_response: empty_response)
     end
-    
+
     def send_chunk(body, done: false)
       send_headers({}) unless @headers_sent
-      
+
       @adapter.send_chunk(self, body, done: done)
     end
     alias_method :<<, :send_chunk
-    
+
     def finish
       send_headers({}) unless @headers_sent
-      
+
       @adapter.finish(self)
     end
 

data/lib/qeweney/request_info.rb

@@ -25,39 +25,39 @@ module Qeweney
     def protocol
       @protocol ||= @adapter.protocol
     end
-    
+
     def method
       @method ||= @headers[':method'].downcase
     end
-    
+
     def scheme
       @scheme ||= @headers[':scheme']
     end
-    
+
     def uri
       @uri ||= URI.parse(@headers[':path'] || '')
     end
-    
+
     def full_uri
       @full_uri = "#{scheme}://#{host}#{uri}"
     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) ? parse_query(q) : {}
     end
-    
+
     QUERY_KV_REGEXP = /([^=]+)(?:=(.*))?/
-    
+
     def parse_query(query)
       query.split('&').each_with_object({}) do |kv, h|
         k, v = kv.match(QUERY_KV_REGEXP)[1..2]
@@ -89,13 +89,13 @@ module Qeweney
 
     COOKIE_RE = /^([^=]+)=(.*)$/.freeze
     SEMICOLON = ';'
-  
+
     def parse_cookies(cookies)
       return {} unless cookies
 
       cookies.split(SEMICOLON).each_with_object({}) do |c, h|
         raise BadRequestError, 'Invalid cookie format' unless c.strip =~ COOKIE_RE
-  
+
         key, value = Regexp.last_match[1..2]
         h[key] = EscapeUtils.unescape_uri(value)
       end
@@ -151,7 +151,7 @@ module Qeweney
         break if header.empty?
 
         next unless header =~ /^([^\:]+)\:\s?(.+)$/
-        
+
         headers[Regexp.last_match(1).downcase] = Regexp.last_match(2)
       end
       # remove trailing \r\n
@@ -164,16 +164,18 @@ module Qeweney
     MAX_PARAMETER_VALUE_SIZE = 2**20 # 1MB
 
     def parse_urlencoded_form_data(body)
+      return {} unless body
+
       body.force_encoding(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

data/lib/qeweney/response.rb

@@ -14,7 +14,7 @@ module Qeweney
       def file_stat_to_etag(stat)
         "#{stat.mtime.to_i.to_s(36)}#{stat.size.to_s(36)}"
       end
-      
+
       def file_stat_to_last_modified(stat)
         stat.mtime.httpdate
       end
@@ -114,7 +114,7 @@ module Qeweney
       if (modified_since = headers['if-modified-since'])
         return true if modified_since == last_modified
       end
-    
+
       false
     end
 

data/lib/qeweney/routing.rb

@@ -10,7 +10,7 @@ module Qeweney
       (@path_parts ||= path.split('/'))[@path_parts_idx ||= 1]
       res = catch(:stop) { yield self }
       return if res == :found
-  
+
       respond(nil, ':status' => 404)
     end
 
@@ -29,22 +29,24 @@ module Qeweney
       @path_parts.empty? ? '/' : "/#{@path_parts[@path_parts_idx..-1].join('/')}"
     end
 
-    def enter_route
-      @path_parts_idx += 1
+    def enter_route(depth = 1)
+      @path_parts_idx += depth
     end
 
-    def leave_route
-      @path_parts_idx -= 1
+    def leave_route(depth = 1)
+      @path_parts_idx -= depth
     end
 
-    def on(route = nil, &block)
-      if route
-        return unless @path_parts[@path_parts_idx] == route
-      end
-  
-      enter_route
+    def on(route, &block)
+      return route_found(&block) unless route
+
+      route_parts = route.split('/')
+      route_length = route_parts.size
+      return unless @path_parts[@path_parts_idx, route_length] == route_parts
+
+      enter_route(route_length)
       route_found(&block)
-      leave_route
+      leave_route(route_length)
     end
 
     def is(route = '/', &block)
@@ -70,22 +72,22 @@ module Qeweney
 
       route_found(&block)
     end
-  
+
     def on_get(route = nil, &block)
       return unless method == 'get'
-  
+
       on(route, &block)
     end
-  
+
     def on_post(route = nil, &block)
       return unless method == 'post'
-  
+
       on(route, &block)
     end
 
     def on_options(route = nil, &block)
       return unless method == 'options'
-  
+
       on(route, &block)
     end
 
@@ -122,6 +124,11 @@ module Qeweney
       on_upgrade('websocket', &block)
     end
 
+    def reject(body, status)
+      respond(body, ':status' => status)
+      throw :stop, :found
+    end
+
     def stop_routing
       throw :stop, :found
     end

data/lib/qeweney/status.rb

@@ -5,7 +5,7 @@ module Qeweney
   module Status
     # translated from https://golang.org/pkg/net/http/#pkg-constants
     # https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
-    
+
     CONTINUE                        = 100 # RFC 7231, 6.2.1
     SWITCHING_PROTOCOLS             = 101 # RFC 7231, 6.2.2
     PROCESSING                      = 102 # RFC 2518, 10.1

data/lib/qeweney/test_adapter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Qeweney
+  class TestAdapter
+    attr_reader :body, :headers
+
+    def get_body_chunk
+      nil
+    end
+
+    def respond(req, body, headers)
+      @body = body
+      @headers = headers
+    end
+
+    def status
+      headers[':status']
+    end
+
+    def self.mock(headers = {})
+      headers[':method'] ||= ''
+      headers[':path'] ||= ''
+      Request.new(headers, new)
+    end
+  end
+end

data/lib/qeweney/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Qeweney
-  VERSION = '0.11'
+  VERSION = '0.15'
 end

data/lib/qeweney.rb

@@ -5,4 +5,3 @@ end
 
 require_relative 'qeweney/request.rb'
 require_relative 'qeweney/status.rb'
-

data/test/helper.rb

@@ -8,7 +8,6 @@ require 'fileutils'
 require_relative './coverage' if ENV['COVERAGE']
 
 require 'minitest/autorun'
-require 'minitest/reporters'
 
 module Qeweney
   class MockAdapter
@@ -35,7 +34,3 @@ module Qeweney
     end
   end
 end
-
-Minitest::Reporters.use! [
-  Minitest::Reporters::SpecReporter.new
-]

data/test/test_response.rb

@@ -73,7 +73,7 @@ class StaticFileResponeTest < MiniTest::Test
 
     deflate = Zlib::Deflate.new
     deflated_content = deflate.deflate(@content, Zlib::FINISH)
-    
+
     assert_equal [
       [:respond, r, deflated_content, {
         'etag' => @etag,
@@ -94,7 +94,7 @@ class StaticFileResponeTest < MiniTest::Test
     z.flush
     z.close
     gzipped_content = buf.string
-    
+
     assert_equal [
       [:respond, r, gzipped_content, {
         'etag' => @etag,
@@ -127,7 +127,7 @@ class UpgradeTest < MiniTest::Test
       }]
     ], r.response_calls
 
-  
+
     r = Qeweney.mock
     r.upgrade('df', { 'foo' => 'bar' })
 
@@ -148,7 +148,7 @@ class UpgradeTest < MiniTest::Test
       'sec-websocket-version' => '23',
       'sec-websocket-key' => 'abcdefghij'
     )
-    
+
     assert_equal 'websocket', r.upgrade_protocol
 
     r.upgrade_to_websocket('foo' => 'baz')
@@ -179,7 +179,7 @@ class ServeRackTest < MiniTest::Test
     })
 
     assert_equal [
-      [:respond, r, 'get /foo/bar', {':status' => 404, 'Foo' => 'Bar' }]
+      [:respond, r, 'GET /foo/bar', {':status' => 404, 'Foo' => 'Bar' }]
     ], r.response_calls
   end
 end

data/test/test_routing.rb

@@ -81,7 +81,7 @@ class RoutingTest < MiniTest::Test
       default_relative_path = r.route_relative_path
       r.on_root { r.respond(File.join('ROOT', r.route_relative_path)) }
       r.on('foo') { r.respond(File.join('FOO', r.route_relative_path)) }
-      r.on('bar') { 
+      r.on('bar') {
         r.on('baz') { r.respond(File.join('BAR/BAZ', r.route_relative_path)) }
         r.default { r.respond(File.join('BAR', r.route_relative_path)) }
       }
@@ -114,4 +114,16 @@ class RoutingTest < MiniTest::Test
     assert_equal '/baz/d/e/f', default_relative_path
     assert_equal [[:respond, r, '/d/e/f', {}]], r.response_calls
   end
+
+  def test_well_known
+    app = Qeweney.route do |r|
+      r.on('.well-known/acme-challenge') { r.respond(r.route_relative_path) }
+      r.default { r.respond('not found') }
+    end
+
+    r = Qeweney.mock(':path' => '/.well-known/acme-challenge/foo')
+    app.(r)
+    assert_equal [[:respond, r, '/foo', {}]], r.response_calls
+  end
 end
+

data/test/test_test_adapter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+require 'qeweney/test_adapter'
+
+class TestAdapterTest < MiniTest::Test
+  def test_test_adapter
+    adapter = Qeweney::TestAdapter.new
+    req = Qeweney::Request.new({ ':path' => '/foo' }, adapter)
+    req.respond('bar', 'Content-Type' => 'baz')
+
+    assert_equal 'bar', adapter.body
+    assert_equal({'Content-Type' => 'baz'}, adapter.headers)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qeweney
 version: !ruby/object:Gem::Version
-  version: '0.11'
+  version: '0.15'
 platform: ruby
 authors:
 - Sharon Rosner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -80,13 +80,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.3
-description: 
+description:
 email: sharon@noteflakes.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -105,6 +106,7 @@ files:
 - lib/qeweney/response.rb
 - lib/qeweney/routing.rb
 - lib/qeweney/status.rb
+- lib/qeweney/test_adapter.rb
 - lib/qeweney/version.rb
 - qeweney.gemspec
 - test/helper.rb
@@ -112,12 +114,13 @@ files:
 - test/test_request_info.rb
 - test/test_response.rb
 - test/test_routing.rb
+- test/test_test_adapter.rb
 homepage: http://github.com/digital-fabric/qeweney
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/digital-fabric/qeweney
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - Qeweney
@@ -136,8 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Qeweney - cross library HTTP request / response API
 test_files: []