web_package 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 39e5ffddf3e4348860d6c29e6aec54631d247c7a
-  data.tar.gz: c1b44063c3c6861c20875709cee60e0f2fa63277
+SHA256:
+  metadata.gz: 1ed6ee8b93f831a07db19a0d5417a95016249684b80e4bf4851734eafa981767
+  data.tar.gz: 56d44e9da44fccf0ec9930b5d3c413cd40c69804b8ece3f623efe708ce648ba6
 SHA512:
-  metadata.gz: b962ea793e579733474c15fe721f8043c9ecd369bc66c99eace2b7a46ac65fd31088812a366a0cd71bdca31c2a33bb52e905555907aca5f58c615d9451778b22
-  data.tar.gz: 0f437161ae65822e028d1d9177f096007de4935dc236b0cdd56096dbf4f268e3fef68d89117e78b993541ff04f2c8b2fc34dfecce10e150f53943de61db036a6
+  metadata.gz: 6c4450c2b1516454768e88c3822a11c6a0ebbb586e23137d63057b567a9a848da0b9d2a23d37094ac6059b73cbd308d373f3522f892e8f2c139b9d695adbaa31
+  data.tar.gz: b18b853f8c241626688110dd57757b7dba2b1f3b762dfd0f17c54c530782429bebea6c1b737c029d9950110352c2431ba1ba1f130a9b4a4343fa6c7459de6879

data/README.md

@@ -1,13 +1,13 @@
 # Web Package
-Ruby implementation of Signed HTTP Exchange format, allowing a browser to trust that a HTTP request-response pair was generated by the origin it claims.
+Not to be confused with [webpack](https://webpack.js.org), this repository holds Ruby implementation of Signed HTTP Exchange format, allowing a browser to trust that a HTTP request-response pair was generated by the origin it claims. For details please refer to the [full list of use cases and resulting requirements](https://wicg.github.io/webpackage/draft-yasskin-webpackage-use-cases.html) ([IETF draft](https://tools.ietf.org/html/draft-yasskin-webpackage-use-cases)).
 
 ## Ever thought of saving the Internet on a flash?
 
 Easily-peasily.
 
-Let's sign a pair of request/response and serve the bundle as `application/signed-exchange` - Chromium browsers understand what it means and unpack them smoothly.
+Let's sign a pair of request/response, store it somewhere out and serve the bundle as `application/signed-exchange`. Chromium browsers understand what such responses mean and unpack them smoothly making it look as if a page is served directly from originating servers.
 
-For that we need a certificate with a special "CanSignHttpExchanges" extension, but for the purpose of this guide we will use just a self-signed one. Please refer [here](https://github.com/WICG/webpackage/tree/master/go/signedexchange#creating-our-first-signed-exchange) to create such.
+For that we need a certificate with a special "CanSignHttpExchanges" extension. However below we will use just a self-signed one for simplicity. Please refer [here](https://github.com/WICG/webpackage/tree/master/go/signedexchange#creating-our-first-signed-exchange) to create such.
 
 Also we need an `https` cdn serving static certificate in `application/cert-chain+cbor` format. We can use `gen-certurl` tool from [here](https://github.com/WICG/webpackage/tree/master/go/signedexchange#creating-our-first-signed-exchange) to convert PEM certificate into this format, so we could than serve it from a cdn.
 
@@ -18,7 +18,7 @@ E.g.
 ```ruby
 # variables can be set all at once:
 WebPackage::Settings.merge! expires_in: ->(uri) { uri.path.start_with?('/news') ? 7.days : 1.day },
-                            url_filter: ->(uri) { uri.host.start_with?('amp') },
+                            filter: ->(env) { env['HTTP_HOST'].start_with?('amp') },
                             sub_extension: '.html'
 # or individually via dot-methods:
 WebPackage::Settings.cert_url = 'https://my.cdn.com/cert.cbor'
@@ -39,10 +39,10 @@ A `String` or `nil`, representing an extension to use for proxying `.sxg` reques
 
 Default value is `nil`, which means that `.sxg` extension is just removed from the path for the rest of Rack middlewares.
 
-#### url_filter
-A `Proc`, accepting a single argument of original URI and returning boolean value. The filter determines for which paths `.sxg` formatted routes should be added.
+#### filter
+A `Proc`, accepting a single argument of environment and returning boolean value. The filter determines for which requests `.sxg` formatted routes should be added.
 
-Default value is `->(uri) { true }`, which means that all known paths are permitted and hence can be processed in SXG format using `.sxg` extension.
+Default value is `->(env) { true }`, which means that all requests are permitted and hence can be processed in SXG format using `.sxg` extension.
 
 #### cert_url, cert_path, priv_path
 

data/lib/web_package/middleware.rb

@@ -9,7 +9,7 @@ module WebPackage
     end
 
     def call(env)
-      Settings.url_filter[uri(env)] ? process(env) : @app.call(env)
+      Settings.filter[env] ? process(env) : @app.call(env)
     end
 
     private

data/lib/web_package/settings.rb

@@ -1,5 +1,5 @@
 module WebPackage
-  OPTIONS = %i[headers expires_in sub_extension url_filter cert_url cert_path priv_path].freeze
+  OPTIONS = %i[headers expires_in sub_extension filter cert_url cert_path priv_path].freeze
   ENV_KEYS = Set.new(%w[SXG_CERT_URL SXG_CERT_PATH SXG_PRIV_PATH]).freeze
   DEFAULTS = {
     headers: { 'Content-Type'           => 'application/signed-exchange;v=b3',
@@ -7,7 +7,7 @@ module WebPackage
                'X-Content-Type-Options' => 'nosniff' },
     expires_in:    60 * 60 * 24 * 7, # 7.days
     sub_extension: nil, # proxy as default format (html)
-    url_filter: ->(_uri) { true } # all paths are permitted
+    filter: ->(_env) { true } # all requests are permitted
   }.freeze
 
   Settings = ConfigurationHash.new(OPTIONS) do |config, key|

data/lib/web_package/version.rb

@@ -1,3 +1,3 @@
 module WebPackage
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web_package
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Oleg Afanasyev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -69,8 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Packaging Websites with Ruby.