qeweney 0.7.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 693c85b30e907232ff7bfa77a8c058a8ef1155a108b7b554ecaf68482b6bfe9a
-  data.tar.gz: 13a9d1c4d6277f90346193b4c56cae0cf44735947268136a7d853071535b3241
+  metadata.gz: 43b284ffdbd86680bb9e5c34738006fa8b3e0d48f36ce45df533e8afcd3f2961
+  data.tar.gz: 5d69cc440ed42251b6970a86e9b63ec3419aa0fad946f9353d29ec58526c6d0f
 SHA512:
-  metadata.gz: 9e34c036534ec0899b251628f666e0f5752c10d38bb98c07765a3149ae901be85a56128880889f71148fec4e90aa2324cce78817f311b79b52b9f2cefb2b19c1
-  data.tar.gz: ccbd53e40b78a60a5665c187c2dd65b4330c1c68c13eb15209f49551df3b0c35c070251662538a3de63cfb56ae507c170c88e767da95178e896a72d5835492ef
+  metadata.gz: 5fd5ce37b83afc129ae262d8dcfc0288bd206e6b3c260577c00a89a5bcc7b44a3337d67087a9b05c281f49aa9f35b6202d44c8c5f535023c9c30929232e5bee5
+  data.tar.gz: cb7636b76961093665c6cf92c882a377ed028d0afa2a048dfd92da51fae88ca2815353287de5f2c34f75f81ddf056fc434c9cc71c34c4b6429f594c6b1c30068

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 0.8.1 2021-03-10
+
+- Add `Request#transfer_counts`, `Request#total_transfer`
+- Fix `Request#rx_incr`
+
+## 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 `#serve_file`
+
+## 0.7.4 2021-03-07
+
+- Add `Request#cookies`
+- Add `Request#full_uri`
+
+## 0.7.3 2021-03-05
+
+- Fix `parse_urlencoded_form_data`
+
 ## 0.7.2 2021-03-04
 
 - Add `#route_relative_path` method

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qeweney (0.7.2)
+    qeweney (0.8.1)
       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/mime_types.rb

@@ -7,7 +7,7 @@ module Qeweney
       'html'  => 'text/html',
       'css'   => 'text/css',
       'js'    => 'application/javascript',
-      'txt'   => 'text/plain'
+      'txt'   => 'text/plain',
 
       'gif'   => 'image/gif',
       'jpg'   => 'image/jpeg',
@@ -19,7 +19,7 @@ module Qeweney
       'json'  => 'application/json',
     }.freeze
 
-    def [](ref)
+    def self.[](ref)
       case ref
       when Symbol
         TYPES[ref.to_s]

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,40 @@ 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
+
+    def transfer_counts
+      [headers[':rx'], headers[':tx']]
+    end
+
+    def total_transfer
+      (headers[':rx'] || 0) + (headers[':tx'] || 0)
+    end
   end
 end

data/lib/qeweney/request_info.rb

@@ -37,6 +37,10 @@ module Qeweney
       @uri ||= URI.parse(@headers[':path'] || '')
     end
     
+    def full_uri
+      @full_uri = "#{scheme}://#{host}#{uri}"
+    end
+    
     def path
       @path ||= uri.path
     end
@@ -54,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
@@ -74,6 +79,24 @@ module Qeweney
 
       encoding.split(',').map { |i| i.strip }
     end
+
+    def cookies
+      @cookies ||= parse_cookies(headers['cookie'])
+    end
+
+    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
+    end
   end
 
   module RequestInfoClassMethods
@@ -138,7 +161,7 @@ module Qeweney
     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.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
   

data/lib/qeweney/response.rb

@@ -6,6 +6,7 @@ require 'stringio'
 require 'digest/sha1'
 
 require_relative 'status'
+require_relative 'mime_types'
 
 module Qeweney
   module StaticFileCaching
@@ -59,7 +60,7 @@ module Qeweney
       redirect(secure_uri, status)
     end
 
-    def serve_file(path, opts)
+    def serve_file(path, opts = {})
       full_path = file_full_path(path, opts)
       stat = File.stat(full_path)
       etag = StaticFileCaching.file_stat_to_etag(stat)
@@ -72,17 +73,25 @@ module Qeweney
         })
       end
 
+      mime_type = Qeweney::MimeTypes[File.extname(path)]
+      (opts[:headers] ||= {})['Content-Type'] ||= mime_type if mime_type
+
       respond_with_static_file(full_path, etag, last_modified, opts)
     rescue Errno::ENOENT => e
       respond(nil, ':status' => Status::NOT_FOUND)
     end
 
     def respond_with_static_file(path, etag, last_modified, opts)
+      cache_headers = {
+        'etag' => etag,
+        'last-modified' => last_modified,
+      }
       File.open(path, 'r') do |f|
-        opts = opts.merge(headers: {
-          'etag' => etag,
-          'last-modified' => last_modified,
-        })
+        if opts[:headers]
+          opts[:headers].merge!(cache_headers)
+        else
+          opts[:headers] = cache_headers
+        end
 
         # accept_encoding should return encodings in client's order of preference
         accept_encoding.each do |encoding|
@@ -150,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.2'
+  VERSION = '0.8.1'
 end

data/test/test_request_info.rb

@@ -20,4 +20,30 @@ class RequestInfoTest < MiniTest::Test
     r = Qeweney.mock('host' => 'my.example.com')
     assert_equal 'my.example.com', r.host
   end
+
+  def test_full_uri
+    r = Qeweney.mock(
+      ':scheme' => 'https',
+      'host' => 'foo.bar',
+      ':path' => '/hey?a=b&c=d'
+    )
+
+    assert_equal 'https://foo.bar/hey?a=b&c=d', r.full_uri
+  end
+
+  def test_cookies
+    r = Qeweney.mock
+
+    assert_equal({}, r.cookies)
+
+    r = Qeweney.mock(
+      'cookie' => 'uaid=a%2Fb; lastLocus=settings; signin_ref=/'
+    )
+
+    assert_equal({
+      'uaid' => 'a/b',
+      'lastLocus' => 'settings',
+      'signin_ref' => '/'
+    }, r.cookies)
+  end
 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.2
+  version: 0.8.1
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Qeweney - cross library HTTP request / response API