qeweney 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfb8f3a7995ccb0d35e79ecb1cbc9f2556ee4bc5e0bc7d61d3f1278395ea47df
-  data.tar.gz: 04cf0bbb7ebe8a701ab7a7b4e912e461ffc744ece02a1b75ff791eba22036da6
+  metadata.gz: 82e2e4adbe7c5c163bb7252c666659baea7758f726a3426f9af837c0d09408ac
+  data.tar.gz: b7aee9e0c09876fd2730905dc61617945636bee6c3891bae45573f910aa67398
 SHA512:
-  metadata.gz: 4f2d77164b052af1cdae718a2c44ccb3c0313bcc73cc87b637b9a1ccabee6701fecd5b223020b4ca854e74d218fefc0101a6150a4e426a9b5c2f1e41a8d6a951
-  data.tar.gz: 0030e7024d6a42f0301ba515e49f1e8da52e3b65368b515d81b520396a187dc0adf8107b32b8f0d08eb0f62d0e3c6f2f9e34f617a69444211b01b4971d950ed2
+  metadata.gz: 1225cb063c858b5e3f0e0e465d778771c8a8a4fec55d5b431d93489d637a8768c1787c1ea28aa6417f83d7666504e433bf338e48b483616d3b9165bb8e1f3465
+  data.tar.gz: 4fececba98bf9f24e0accef005c36eb62fe13bb5955e380b9324de71660c6dd156c1fb077a13051d1855b971a685be712f0e8873752cb414466974a15d8b8b4f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5 2021-02-15
+
+- Implement upgrade and WebSocket upgrade responses
+
 ## 0.4 2021-02-12
 
 - Implement caching and compression for serving static files

data/Gemfile.lock

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

data/TODO.md

@@ -3,97 +3,79 @@
 - `#serve_file(path, opts)`
   - See here: https://golang.org/pkg/net/http/#ServeFile
   - support for `Range` header
-  - support for caching (specified in opts)
-  - support for serving from routing path:
-
-    ```ruby
-      req.route do
-        req.on 'assets' do
-          req.serve_file(req.routing_path, base_path: STATIC_PATH)
-        end
-      end
-
-      # or convenience method
-      req.route do
-        req.on_static_route 'assets', base_path: STATIC_PATH
-      end
-    ```
 
 - `#serve_content(io, opts)`
   - See here: https://golang.org/pkg/net/http/#ServeContent
   - support for `Range` header
-  - support for caching (specified in opts)
-  - usage:
 
-    ```ruby
-      req.route do
-        req.on 'mypdf' do
-          File.open('my.pdf', 'r') { |f| req.serve_content(io) }
-        end
-      end
-    ```
+## route on host
 
-## Caching
+- `#on_host`:
 
-```ruby
-req.route do
-  req.on 'assets' do
-    # setting cache to true implies the following:
-    # - etag (calculated from file stat)
-    # - last-modified (from file stat)
-    # - vary: Accept-Encoding
-
-    # before responding, looks at the following headers
-    # if-modified-since: (date from client's cache)
-    # if-none-match: (etag from client's cache)
-    # cache-control: no-cache will prevent caching
-    req.serve_file(path, base_path: STATIC_PATH, cache: true)
-
-    # We can control this manually instead:
-    req.serve_file(path, base_path: STATIC_PATH, cache: {
-      etag: 'blahblah',
-      last_modified: Time.now - 365*86400,
-      vary: 'Accept-Encoding, User-Agent'
-    })
+  ```ruby
+  req.route do
+    req.on_host 'example.com' do
+      req.redirect "https://www.example.com#{req.uri}"
+    end
   end
-end
-```
+  ```
 
-So, the algorithm:
+- `#on_http`:
 
-```ruby
-def validate_client_cache(path)
-  return false if headers['cache-control'] == 'no-cache'
-  
-  stat = File.stat(path)
-  etag = file_stat_to_etag(path, stat)
-  return false if headers['if-none-match'] != etag
+  ```ruby
+  req.route do
+    req.on_http do
+      req.redirect "https://#{req.host}#{req.uri}"
+    end
+  end
+  ```
 
-  modified = file_stat_to_modified_stamp(stat)
-  return false if headers['if-modified-since'] != modified
+- shorthand:
 
-  true
-end
+  ```ruby
+  req.route do
+    req.on_http { req.redirect_to_https }
+    req.on_host 'example.com' do
+      req.redirect_to_host('www.example.com')
+    end
+  end
+  ```
 
-def file_stat_to_etag(path, stat)
-  "#{stat.mtime.to_i.to_s(36)}#{stat.size.to_s(36)}"
-end
+## templates
 
-require 'time'
+- needs to be pluggable - allow any kind of template
 
-def file_stat_to_modified_stamp(stat)
-  stat.mtime.httpdate
+```ruby
+WEBSITE_PATH = File.join(__dir__, 'docs')
+STATIC_PATH = File.join(WEBSITE_PATH, 'static')
+LAYOUTS_PATH = File.join(WEBSITE_PATH, '_layouts')
+
+PAGES = Tipi::PageManager(
+  base_path: WEBSITE_PATH,
+  engine: :markdown,
+  layouts: LAYOUTS_PATH
+)
+
+app = Tipi.app do |r|
+  r.on 'static' do
+    r.serve_file(r.routing_path, base_path: ASSETS_PATH)
+  end
+
+  r.default do
+    PAGES.serve(r)
+  end
 end
 ```
 
-## response compression
+## Rewriting URLs
 
 ```ruby
-req.route do
-  req.on 'assets' do
-    # gzip on the fly
-    req.serve_file(path, base_path: STATIC_PATH, gzip: :gzip)
-  end
-end
+app = Tipi.app do |r|
+  r.rewrite '/' => '/docs/index.html'
+  r.rewrite '/docs' => '/docs/'
+  r.rewrite '/docs/' => '/docs/index.html'
 
+  # or maybe
+  r.on '/docs/'
+end
 ```

data/lib/qeweney/request_info.rb

@@ -17,6 +17,10 @@ module Qeweney
       connection == 'upgrade' && @headers['upgrade']&.downcase
     end
 
+    def websocket_version
+      headers['sec-websocket-version'].to_i
+    end
+
     def protocol
       @protocol ||= @adapter.protocol
     end

data/lib/qeweney/response.rb

@@ -3,6 +3,7 @@
 require 'time'
 require 'zlib'
 require 'stringio'
+require 'digest/sha1'
 
 require_relative 'status'
 
@@ -20,10 +21,44 @@ module Qeweney
   end
 
   module ResponseMethods
+    def upgrade(protocol, custom_headers = nil)
+      upgrade_headers = {
+        ':status' => Status::SWITCHING_PROTOCOLS,
+        'Upgrade' => protocol,
+        'Connection' => 'upgrade'
+      }
+      upgrade_headers.merge!(custom_headers) if custom_headers
+
+      respond(nil, upgrade_headers)
+    end
+
+    WEBSOCKET_GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
+
+    def upgrade_to_websocket(custom_headers = nil)
+      key = "#{headers['sec-websocket-key']}#{WEBSOCKET_GUID}"
+      upgrade_headers = {
+        'Sec-WebSocket-Accept' => Digest::SHA1.base64digest(key)
+      }
+      upgrade_headers.merge!(custom_headers) if custom_headers
+      upgrade('websocket', upgrade_headers)
+
+      adapter.websocket_connection(self)
+    end
+
     def redirect(url, status = Status::FOUND)
       respond(nil, ':status' => status, 'Location' => url)
     end
 
+    def redirect_to_https(status = Status::MOVED_PERMANENTLY)
+      secure_uri = "https://#{host}#{uri}"
+      redirect(secure_uri, status)
+    end
+
+    def redirect_to_host(new_host, status = Status::FOUND)
+      secure_uri = "//#{new_host}#{uri}"
+      redirect(secure_uri, status)
+    end
+
     def serve_file(path, opts)
       full_path = file_full_path(path, opts)
       stat = File.stat(full_path)

data/lib/qeweney/routing.rb

@@ -44,6 +44,18 @@ module Qeweney
 
       route_found(&block)
     end
+
+    def on_host(route, &block)
+      return unless host == route
+
+      route_found(&block)
+    end
+
+    def on_plain_http(route, &block)
+      return unless scheme == 'http'
+
+      route_found(&block)
+    end
   
     def on_get(route = nil, &block)
       return unless method == 'get'
@@ -86,8 +98,22 @@ module Qeweney
       route_found(&block)
     end
 
+    def on_upgrade(protocol, &block)
+      return unless upgrade_protocol == protocol
+
+      route_found(&block)
+    end
+
+    def on_websocket_upgrade(&block)
+      on_upgrade('websocket', &block)
+    end
+
     def stop_routing
-      yield if block_given?
+      throw :stop, :found
+    end
+
+    def default
+      yield
       throw :stop, :found
     end
   end

data/lib/qeweney/version.rb

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

data/test/test_response.rb

@@ -113,3 +113,56 @@ class StaticFileResponeTest < MiniTest::Test
     ], r.response_calls
   end
 end
+
+class UpgradeTest < MiniTest::Test
+  def test_upgrade
+    r = Qeweney.mock
+    r.upgrade('df')
+
+    assert_equal [
+      [:respond, nil, {
+        ':status' => 101,
+        'Upgrade' => 'df',
+        'Connection' => 'upgrade'
+      }]
+    ], r.response_calls
+
+  
+    r = Qeweney.mock
+    r.upgrade('df', { 'foo' => 'bar' })
+
+    assert_equal [
+      [:respond, nil, {
+        ':status' => 101,
+        'Upgrade' => 'df',
+        'Connection' => 'upgrade',
+        'foo' => 'bar'
+      }]
+    ], r.response_calls
+  end
+
+  def test_websocket_upgrade
+    r = Qeweney.mock(
+      'connection' => 'upgrade',
+      'upgrade' => 'websocket',
+      'sec-websocket-version' => '23',
+      'sec-websocket-key' => 'abcdefghij'
+    )
+    
+    assert_equal 'websocket', r.upgrade_protocol
+
+    r.upgrade_to_websocket('foo' => 'baz')
+    accept = Digest::SHA1.base64digest('abcdefghij258EAFA5-E914-47DA-95CA-C5AB0DC85B11')
+
+    assert_equal [
+      [:respond, nil, {
+        ':status' => 101,
+        'Upgrade' => 'websocket',
+        'Connection' => 'upgrade',
+        'foo' => 'baz',
+        'Sec-WebSocket-Accept' => accept
+      }],
+      [:websocket_connection, r]
+    ], r.response_calls
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qeweney
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils