qeweney 0.14 → 0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f515f9637f0d993c9dfbea4d425695f76915871ad0c62e090cbb31a4a57b4a7
-  data.tar.gz: 80a6bf6da6a0d2b85771deff0cb24ad9bcf389e4af37042a6fd62c215617a657
+  metadata.gz: 70524001d652ee7b23a7a08b8c09aae2a7bf484148fa693b1c6b23a9c868ba51
+  data.tar.gz: 17c5254f9b07b242cc673219f2738bd6f4f0176bb4f076273b10f2aed9a21530
 SHA512:
-  metadata.gz: d08170e772a3fad93d49a06bc8ee6c656e5057e5368d3dfba6687d1f838dff50e7cfb8895315480f3f85ea519d8ee0ae20a3a480ee26293bd86bfec2c4912918
-  data.tar.gz: a1918424e95a70891eb4f8fb1b163cdf62167bb3847c16192be9f8dffd95c77513cca4f0e6d4a759275b14bc7891d770585b3625b4601177195ade7a731f6814
+  metadata.gz: be74c2f1c96b8a4b4cd6b7e081f71b2c2019c2ab9c37b8680bdead5f4de1eddddca1522658ee56869837851bb6752fc147b3ffb42d0a49c4d7bd1f98822a0c98
+  data.tar.gz: 6f252321dc1f79d69e635d47ee34efefd1274a704122bfc736aa589618836d6e29e0cbb495669d1a96321569e75559c0a441ff0ebf91c71c4f38b2543383d27a

data/.github/FUNDING.yml

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

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.18 2022-02-16
+
+- Implement `Request#rewrite!` (#2)
+
+## 0.17 2022-02-10
+
+- Fix default return value in `TestAdapter#status`
+
+## 0.16 2022-01-22
+
+- Use frozen empty hash as default headers in response methods
+- Add `text` key in registered MIME types
+
+## 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

data/Gemfile.lock

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

@@ -8,6 +8,7 @@ module Qeweney
       'css'   => 'text/css',
       'js'    => 'application/javascript',
       'txt'   => 'text/plain',
+      'text'  => 'text/plain',
 
       'gif'   => 'image/gif',
       'jpg'   => 'image/jpeg',

data/lib/qeweney/rack.rb

@@ -74,15 +74,15 @@ module Qeweney
     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
 
@@ -110,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,13 +15,12 @@ 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
@@ -38,7 +37,7 @@ module Qeweney
 
       @adapter.get_body_chunk(self, buffered_only)
     end
-    
+
     def each_chunk
       if @buffered_body_chunks
         while (chunk = @buffered_body_chunks.shift)
@@ -68,29 +67,31 @@ module Qeweney
     def complete?
       @adapter.complete?(self)
     end
-    
-    def respond(body, headers = {})
+
+    EMPTY_HEADERS = {}.freeze
+
+    def respond(body, headers = EMPTY_HEADERS)
       @adapter.respond(self, body, headers)
       @headers_sent = true
     end
-    
-    def send_headers(headers = {}, empty_response = false)
+
+    def send_headers(headers = EMPTY_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,43 +25,58 @@ module Qeweney
     def protocol
       @protocol ||= @adapter.protocol
     end
-    
+
     def method
       @method ||= @headers[':method'].downcase
     end
-    
+
     def scheme
       @scheme ||= @headers[':scheme']
     end
-    
+
+    # Rewrites the request path by replacing the given src with the given
+    # replacement.
+    #
+    # @param src [String, Regexp] src pattern
+    # @param replacement [String] replacement
+    # @return [Qeweney::Request] self
+    def rewrite!(src, replacement)
+      @headers[':path'] = @headers[':path']
+        .gsub(src, replacement)
+        .gsub('//', '/')
+      @path = nil
+      @uri = nil
+      @full_uri = nil
+      self
+    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]
-        # k, v = kv.split('=')
         h[k.to_sym] = v ? URI.decode_www_form_component(v) : true
       end
     end
@@ -89,13 +104,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 +166,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
@@ -169,13 +184,13 @@ module Qeweney
       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

@@ -7,10 +7,11 @@ module Qeweney
 
   module RoutingMethods
     def route(&block)
-      (@path_parts ||= path.split('/'))[@path_parts_idx ||= 1]
+      @path_parts ||= path.split('/')
+      @path_parts_idx ||= 1
       res = catch(:stop) { yield self }
       return if res == :found
-  
+
       respond(nil, ':status' => 404)
     end
 
@@ -39,11 +40,11 @@ module Qeweney
 
     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(route_length)
@@ -72,22 +73,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
 
@@ -124,6 +125,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'] || Qeweney::Status::OK
+    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.14'
+  VERSION = '0.18'
 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_request_info.rb

@@ -65,4 +65,26 @@ class RequestInfoTest < MiniTest::Test
       'signin_ref' => '/'
     }, r.cookies)
   end
+
+  def test_rewrite!
+    r = Qeweney.mock(
+      ':scheme' => 'https',
+      'host' => 'foo.bar',
+      ':path' => '/hey/ho?a=b&c=d'
+    )
+
+    assert_equal '/hey/ho', r.path
+    assert_equal URI.parse('/hey/ho?a=b&c=d'), r.uri
+    assert_equal 'https://foo.bar/hey/ho?a=b&c=d', r.full_uri
+
+    r.rewrite!('/hhh', '/')
+    assert_equal '/hey/ho', r.path
+    assert_equal URI.parse('/hey/ho?a=b&c=d'), r.uri
+    assert_equal 'https://foo.bar/hey/ho?a=b&c=d', r.full_uri
+
+    r.rewrite!('/hey', '/')
+    assert_equal '/ho', r.path
+    assert_equal URI.parse('/ho?a=b&c=d'), r.uri
+    assert_equal 'https://foo.bar/ho?a=b&c=d', r.full_uri
+  end
 end

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')

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)) }
       }

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.14'
+  version: '0.18'
 platform: ruby
 authors:
 - Sharon Rosner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 2022-02-16 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: []