qeweney 0.7.5 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4a3ab1651dedfc78d9d35aa048db2d77e3eb8873d2cbd81d2944746b07ecee8
-  data.tar.gz: f75a0a000b4c1f690885deb9b163baf9ead6d285ab2c58366821c26e995342d4
+  metadata.gz: ccff703b19924cf5dc8797b02a5338f12d990eacfa4fbcebf35123dae7f8840e
+  data.tar.gz: 385e5518ff1715d6e57b95f01ee6edfbcc45b49dfab3105d51014cd4a68a92cd
 SHA512:
-  metadata.gz: e6aa575224a992f928fd42bec42979798e6656841eb676ca43996776ede7e24b303982a69376f735be0a5ec2ce02ced79b573a10353cd5b5d7097e168f4ce625
-  data.tar.gz: 3870128bb83a47be1fee088bd128e8701098b92f301cc515e863da462001ea65af51018ab3e1ae0e9c2dfd7250fad310690917d47fa2afa8b3fd88c5b2cbb381
+  metadata.gz: 234aac50cd2f39f754d31fac0e401d06a8117f771de69d1840fcfb43f31b748df521a658eae3ff3989eb4683d76d2999fb2b510c80cef578218cf4d4b90f1ed1
+  data.tar.gz: b2c2b1f2a3109f5438862877aa0283c54a0818154f310fde257fdec01e92356972e88cbf3508050843d4434a6735f45ec79e9a559f9a8e3e1819c714957f3161

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## 0.8 2021-03-10
+
+- Pass request as first argument to all adapter methods
+
 ## 0.7.5 2021-03-08
 
-- Set content-type header in 
+- Set content-type header in `#serve_file`
 
 ## 0.7.4 2021-03-07
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qeweney (0.7.5)
+    qeweney (0.8)
       escape_utils (~> 1.2.1)
 
 GEM

data/README.md

@@ -1,11 +1,71 @@
 # Qeweney
 
-## Cross-library feature rich HTTP request / response API
+## Cross-library HTTP request / response API for servers
 
-Qeweney provides a uniform API for dealing with HTTP requests and responses.
+Qeweney provides a uniform API for dealing with HTTP requests and responses on
+the server side. Qeweney defines a uniform adapter interface that allows
+handling incoming HTTP requests and sending HTTP responses over any protocol or
+transport, be it HTTP/1, HTTP/2 or a Rack interface.
+
+Qeweney is primarily designed to work with
+[Tipi](https://github.com/digital-fabric/tipi), but can also be used directly
+inside Rack apps, or to drive Rack apps.
 
 ## Features
 
-- Works with different web server APIs, notably Tipi, Digital Fabric, and Rack
-- Transport-agnostic
-- High-performance routing API inspired by Roda
+- Works with different web server APIs, notably Tipi, Digital Fabric, and Rack.
+- Transport-agnostic.
+- High-performance routing API inspired by Roda.
+- Rich API for extracting data from HTTP requests: form parsing, cookies, file
+  uploads, etc.
+- Rich API for constructing HTTP responses: streaming responses, HTTP upgrades,
+  static file serving, delate and gzip encoding, caching etc.
+- Suitable for both blocking and non-blocking concurrency models.
+- Allows working with request before request body is read and parsed.
+
+## Overview
+
+In Qeweney, the main class developers will interact with is `Qeweney::Request`,
+which encapsulates an HTTP request (from the server's point of view), and offers
+an API for extracting request information and responding to that request.
+
+A request is always associated with an _adapter_, an object that implements the
+Qeweney adapter interface, and that allows reading request bodies (for uploads
+and form submissions) and sending responses.
+
+## The Qeweney Adapter Interface
+
+```ruby
+class AdapterInterface
+  # Reads a chunk from the request body
+  # @req [Qeweney::Request] request for which the chunk is to be read
+  def get_body_chunk(req)
+  end
+
+  # Send a non-streaming response
+  # @req [Qeweney::Request] request for which the response is sent
+  # @body [String, nil] response body
+  # @headers [Hash] response headers
+  def respond(req, body, headers)
+  end
+
+  # Send only headers
+  # @req [Qeweney::Request] request for which the response is sent
+  # @headers [Hash] response headers
+  # @empty_response [boolean] whether response is empty
+  def send_headers(req, headers, empty_response: nil)
+  end
+
+  # Send a body chunk (this implies chunked transfer encoding)
+  # @req [Qeweney::Request] request for which the response is sent
+  # @body [String, nil] chunk
+  # @done [boolean] whether response is finished
+  def send_chunk(req, body, done: false)
+  end
+
+  # Finishes response
+  # @req [Qeweney::Request] request for which the response is sent
+  def finish(req)
+  end
+end
+```

data/lib/qeweney/rack.rb

@@ -32,20 +32,20 @@ module Qeweney
       headers
     end
 
-    def respond(body, headers)
+    def respond(req, body, headers)
       @response_body << body
       @response_headers = headers
     end
 
-    def send_headers(headers, empty_response: nil)
+    def send_headers(req, headers, empty_response: nil)
       @response_headers = headers
     end
 
-    def send_chunk(body, done: false)
+    def send_chunk(req, body, done: false)
       @response_body << body
     end
 
-    def finish
+    def finish(req)
     end
 
     def rack_response

data/lib/qeweney/request.rb

@@ -34,7 +34,7 @@ module Qeweney
         return chunk
       end
 
-      @message_complete ? nil : @adapter.get_body_chunk
+      @message_complete ? nil : @adapter.get_body_chunk(self)
     end
     
     def each_chunk
@@ -44,7 +44,7 @@ module Qeweney
         end
         @buffered_body_chunks = nil
       end
-      while !@message_complete && (chunk = @adapter.get_body_chunk)
+      while !@message_complete && (chunk = @adapter.get_body_chunk(self))
         yield chunk
       end
     end
@@ -59,7 +59,7 @@ module Qeweney
     end
     
     def consume
-      @adapter.consume_request
+      @adapter.consume_request(self)
     end
     
     def keep_alive?
@@ -68,7 +68,7 @@ module Qeweney
     
     def read
       buf = @buffered_body_chunks ? @buffered_body_chunks.join : nil
-      while (chunk = @adapter.get_body_chunk)
+      while (chunk = @adapter.get_body_chunk(self))
         (buf ||= +'') << chunk
       end
       @buffered_body_chunks = nil
@@ -77,7 +77,7 @@ module Qeweney
     alias_method :body, :read
     
     def respond(body, headers = {})
-      @adapter.respond(body, headers)
+      @adapter.respond(self, body, headers)
       @headers_sent = true
     end
     
@@ -85,24 +85,32 @@ module Qeweney
       return if @headers_sent
       
       @headers_sent = true
-      @adapter.send_headers(headers, empty_response: empty_response)
+      @adapter.send_headers(self, headers, empty_response: empty_response)
     end
     
     def send_chunk(body, done: false)
       send_headers({}) unless @headers_sent
       
-      @adapter.send_chunk(body, done: done)
+      @adapter.send_chunk(self, body, done: done)
     end
     alias_method :<<, :send_chunk
     
     def finish
       send_headers({}) unless @headers_sent
       
-      @adapter.finish
+      @adapter.finish(self)
     end
 
     def headers_sent?
       @headers_sent
     end
+
+    def rx_incr(count)
+      headers[':rx'] ? headers[';rx'] += count : headers[':rx'] = count
+    end
+
+    def tx_incr(count)
+      headers[':tx'] ? headers[':tx'] += count : headers[':tx'] = count
+    end
   end
 end

data/lib/qeweney/request_info.rb

@@ -58,6 +58,7 @@ module Qeweney
     def split_query_string(query)
       query.split('&').each_with_object({}) do |kv, h|
         k, v = kv.split('=')
+        p split_query_string: { k: k, v: v }
         h[k.to_sym] = URI.decode_www_form_component(v)
       end
     end

data/lib/qeweney/response.rb

@@ -159,6 +159,7 @@ module Qeweney
 
       # TODO: send separate chunks for multi-part body
       # TODO: add support for streaming body
+      # TODO: add support for websocket
     end
   end
 end

data/lib/qeweney/version.rb

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

data/test/test_response.rb

@@ -8,7 +8,7 @@ class RedirectTest < MiniTest::Test
     r.redirect('/foo')
 
     assert_equal [
-      [:respond, nil, {":status"=>302, "Location"=>"/foo"}]
+      [:respond, r, nil, {":status"=>302, "Location"=>"/foo"}]
     ], r.response_calls
   end
 
@@ -17,7 +17,7 @@ class RedirectTest < MiniTest::Test
     r.redirect('/bar', Qeweney::Status::MOVED_PERMANENTLY)
 
     assert_equal [
-      [:respond, nil, {":status"=>301, "Location"=>"/bar"}]
+      [:respond, r, nil, {":status"=>301, "Location"=>"/bar"}]
     ], r.response_calls
   end
 end
@@ -37,7 +37,7 @@ class StaticFileResponeTest < MiniTest::Test
     r.serve_file('helper.rb', base_path: __dir__)
 
     assert_equal [
-      [:respond, @content, { 'etag' => @etag, 'last-modified' => @last_modified }]
+      [:respond, r, @content, { 'etag' => @etag, 'last-modified' => @last_modified }]
     ], r.response_calls
   end
 
@@ -45,25 +45,25 @@ class StaticFileResponeTest < MiniTest::Test
     r = Qeweney.mock('if-none-match' => @etag)
     r.serve_file('helper.rb', base_path: __dir__)
     assert_equal [
-      [:respond, nil, { 'etag' => @etag, ':status' => Qeweney::Status::NOT_MODIFIED }]
+      [:respond, r, nil, { 'etag' => @etag, ':status' => Qeweney::Status::NOT_MODIFIED }]
     ], r.response_calls
 
     r = Qeweney.mock('if-modified-since' => @last_modified)
     r.serve_file('helper.rb', base_path: __dir__)
     assert_equal [
-      [:respond, nil, { 'etag' => @etag, ':status' => Qeweney::Status::NOT_MODIFIED }]
+      [:respond, r, nil, { 'etag' => @etag, ':status' => Qeweney::Status::NOT_MODIFIED }]
     ], r.response_calls
 
     r = Qeweney.mock('if-none-match' => 'foobar')
     r.serve_file('helper.rb', base_path: __dir__)
     assert_equal [
-      [:respond, @content, { 'etag' => @etag, 'last-modified' => @last_modified }]
+      [:respond, r, @content, { 'etag' => @etag, 'last-modified' => @last_modified }]
     ], r.response_calls
 
     r = Qeweney.mock('if-modified-since' => Time.now.httpdate)
     r.serve_file('helper.rb', base_path: __dir__)
     assert_equal [
-      [:respond, @content, { 'etag' => @etag, 'last-modified' => @last_modified }]
+      [:respond, r, @content, { 'etag' => @etag, 'last-modified' => @last_modified }]
     ], r.response_calls
   end
 
@@ -75,7 +75,7 @@ class StaticFileResponeTest < MiniTest::Test
     deflated_content = deflate.deflate(@content, Zlib::FINISH)
     
     assert_equal [
-      [:respond, deflated_content, {
+      [:respond, r, deflated_content, {
         'etag' => @etag,
         'last-modified' => @last_modified,
         'vary' => 'Accept-Encoding',
@@ -96,7 +96,7 @@ class StaticFileResponeTest < MiniTest::Test
     gzipped_content = buf.string
     
     assert_equal [
-      [:respond, gzipped_content, {
+      [:respond, r, gzipped_content, {
         'etag' => @etag,
         'last-modified' => @last_modified,
         'vary' => 'Accept-Encoding',
@@ -109,7 +109,7 @@ class StaticFileResponeTest < MiniTest::Test
     r = Qeweney.mock
     r.serve_file('foo.rb', base_path: __dir__)
     assert_equal [
-      [:respond, nil, { ':status' => Qeweney::Status::NOT_FOUND }]
+      [:respond, r, nil, { ':status' => Qeweney::Status::NOT_FOUND }]
     ], r.response_calls
   end
 end
@@ -120,7 +120,7 @@ class UpgradeTest < MiniTest::Test
     r.upgrade('df')
 
     assert_equal [
-      [:respond, nil, {
+      [:respond, r, nil, {
         ':status' => 101,
         'Upgrade' => 'df',
         'Connection' => 'upgrade'
@@ -132,7 +132,7 @@ class UpgradeTest < MiniTest::Test
     r.upgrade('df', { 'foo' => 'bar' })
 
     assert_equal [
-      [:respond, nil, {
+      [:respond, r, nil, {
         ':status' => 101,
         'Upgrade' => 'df',
         'Connection' => 'upgrade',
@@ -155,7 +155,7 @@ class UpgradeTest < MiniTest::Test
     accept = Digest::SHA1.base64digest('abcdefghij258EAFA5-E914-47DA-95CA-C5AB0DC85B11')
 
     assert_equal [
-      [:respond, nil, {
+      [:respond, r, nil, {
         ':status' => 101,
         'Upgrade' => 'websocket',
         'Connection' => 'upgrade',
@@ -179,7 +179,7 @@ class ServeRackTest < MiniTest::Test
     })
 
     assert_equal [
-      [:respond, "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

@@ -19,27 +19,27 @@ class RoutingTest < MiniTest::Test
   def test_app1
     r = Qeweney.mock(':path' => '/foo')
     App1.(r)
-    assert_equal [[:respond, nil, { ':status' => 404 }]], r.response_calls
+    assert_equal [[:respond, r, nil, { ':status' => 404 }]], r.response_calls
 
     r = Qeweney.mock(':path' => '/')
     App1.(r)
-    assert_equal [[:respond, nil, { ':status' => 302, 'Location' => '/hello' }]], r.response_calls
+    assert_equal [[:respond, r, nil, { ':status' => 302, 'Location' => '/hello' }]], r.response_calls
 
     r = Qeweney.mock(':path' => '/hello', ':method' => 'foo')
     App1.(r)
-    assert_equal [[:respond, nil, { ':status' => 404 }]], r.response_calls
+    assert_equal [[:respond, r, nil, { ':status' => 404 }]], r.response_calls
 
     r = Qeweney.mock(':path' => '/hello', ':method' => 'get')
     App1.(r)
-    assert_equal [[:respond, 'Hello', {}]], r.response_calls
+    assert_equal [[:respond, r, 'Hello', {}]], r.response_calls
 
     r = Qeweney.mock(':path' => '/hello', ':method' => 'post')
     App1.(r)
-    assert_equal [[:respond, nil, { ':status' => 302, 'Location' => '/' }]], r.response_calls
+    assert_equal [[:respond, r, nil, { ':status' => 302, 'Location' => '/' }]], r.response_calls
 
     r = Qeweney.mock(':path' => '/hello/world', ':method' => 'get')
     App1.(r)
-    assert_equal [[:respond, 'Hello world', {}]], r.response_calls
+    assert_equal [[:respond, r, 'Hello world', {}]], r.response_calls
   end
 
   def test_on_root
@@ -58,19 +58,19 @@ class RoutingTest < MiniTest::Test
 
     r = Qeweney.mock(':path' => '/')
     app.(r)
-    assert_equal [[:respond, 'root', {}]], r.response_calls
+    assert_equal [[:respond, r, 'root', {}]], r.response_calls
 
     r = Qeweney.mock(':path' => '/foo')
     app.(r)
-    assert_equal [[:respond, 'foo root', {}]], r.response_calls
+    assert_equal [[:respond, r, 'foo root', {}]], r.response_calls
 
     r = Qeweney.mock(':path' => '/foo/bar')
     app.(r)
-    assert_equal [[:respond, 'bar root', {}]], r.response_calls
+    assert_equal [[:respond, r, 'bar root', {}]], r.response_calls
 
     r = Qeweney.mock(':path' => '/foo/bar/baz')
     app.(r)
-    assert_equal [[:respond, 'baz root', {}]], r.response_calls
+    assert_equal [[:respond, r, 'baz root', {}]], r.response_calls
   end
 
   def test_relative_path
@@ -90,27 +90,27 @@ class RoutingTest < MiniTest::Test
     r = Qeweney.mock(':path' => '/')
     app.(r)
     assert_equal '/', default_relative_path
-    assert_equal [[:respond, 'ROOT/', {}]], r.response_calls
+    assert_equal [[:respond, r, 'ROOT/', {}]], r.response_calls
 
 
     r = Qeweney.mock(':path' => '/foo/bar/baz')
     app.(r)
     assert_equal '/foo/bar/baz', default_relative_path
-    assert_equal [[:respond, 'FOO/bar/baz', {}]], r.response_calls
+    assert_equal [[:respond, r, 'FOO/bar/baz', {}]], r.response_calls
 
     r = Qeweney.mock(':path' => '/bar/a/b/c')
     app.(r)
     assert_equal '/bar/a/b/c', default_relative_path
-    assert_equal [[:respond, 'BAR/a/b/c', {}]], r.response_calls
+    assert_equal [[:respond, r, 'BAR/a/b/c', {}]], r.response_calls
 
     r = Qeweney.mock(':path' => '/bar/baz/b/c')
     app.(r)
     assert_equal '/bar/baz/b/c', default_relative_path
-    assert_equal [[:respond, 'BAR/BAZ/b/c', {}]], r.response_calls
+    assert_equal [[:respond, r, 'BAR/BAZ/b/c', {}]], r.response_calls
 
     r = Qeweney.mock(':path' => '/baz/d/e/f')
     app.(r)
     assert_equal '/baz/d/e/f', default_relative_path
-    assert_equal [[:respond, '/d/e/f', {}]], r.response_calls
+    assert_equal [[:respond, r, '/d/e/f', {}]], r.response_calls
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qeweney
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: '0.8'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils