roda 3.82.0 → 3.83.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdf5797c96af1d28dc4d13f0c95ac0468d60eb30b6a128b2cee2c26a08eb0a7f
-  data.tar.gz: d687b3cd03657bdcfda6f87a7a7a2a3b55e9a0c4f856cabd3d080865cc7d9ad2
+  metadata.gz: 8f3ad50e6de6bdfa7e2019cbcbe4a07b920a23adb30645616340b8bc007951a1
+  data.tar.gz: b5bd2835bb0f5286fb92555c602949482c4730b3497de4506a841a6ab3e80718
 SHA512:
-  metadata.gz: e518b9638e98713ed54fd4c609069edf81a81987adf53ce2b7a09fa7110244f67b109cbe91c9c03d713f824900649d1c4b2ad435823852dcdfd01094f506afae
-  data.tar.gz: '00877a1338b70a5b96dab7fb946e21c7c916c776666286f80251b362e29ca6e040ffeb9b7a7258cf3af4c9246de5a6c35c5332385bd3cb926505776102c9112c'
+  metadata.gz: 8e6937b542ae838a0b4e79171936fc3cd937faf127900b34265ff9e0923144bf5cf25879fe0103b43b51fb9c940e1dfc6c058f91eb02bab23177369e3b0424f7
+  data.tar.gz: d7515ac6becbb47900713e5349b52eb41e284391c5a75743b4e3adcb3609a8ad09a20b8e38e7d85ddb59c52681396a9ec2b1b82b3264752731837b873907835d

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 3.83.0 (2024-08-12)
+
+* Add assume_ssl plugin for making request ssl? method always return true (jeremyevans)
+
 = 3.82.0 (2024-07-12)
 
 * Add :encodings option to public plugin to support configurable encoding order (jeremyevans)

data/doc/release_notes/3.83.0.txt

@@ -0,0 +1,6 @@
+= New Features
+
+* An assume_ssl plugin has been added.  This plugin is designed for
+  cases where the application is being fronted by an SSL-terminating
+  reverse proxy that does not set the X-Forwarded-Proto or similar
+  header to indicate it is forwarding an SSL request.

data/lib/roda/plugins/assume_ssl.rb

@@ -0,0 +1,28 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The assume_ssl plugin makes the request ssl? method always return
+    # true. This is useful when using an SSL-terminating reverse proxy
+    # that doesn't set the X-Forwarded-Proto or similar header to notify
+    # Rack that it is forwarding an SSL request.
+    #
+    # The sessions and sinatra_helpers plugins that ship with Roda both
+    # use the ssl? method internally and can be affected by use of the
+    # plugin.  It's recommended that you use this plugin if you are
+    # using either plugin and an SSL-terminating proxy as described above.
+    #
+    #   plugin :assume_ssl
+    module AssumeSSL
+      module RequestMethods
+        # Assume all requests are protected by SSL.
+        def ssl?
+          true
+        end
+      end
+    end
+
+    register_plugin(:assume_ssl, AssumeSSL)
+  end
+end

data/lib/roda/plugins/multi_public.rb

@@ -21,7 +21,7 @@ class Roda
     #     font: 'assets/fonts',
     #     form: 'static/forms/pdfs'
     #
-    #   r.route do
+    #   route do
     #     r.on "images" do
     #       r.multi_public(:img)
     #     end
@@ -43,7 +43,7 @@ class Roda
     #     'fonts'  => 'assets/fonts',
     #     'forms'  => 'static/forms/pdfs'
     #
-    #   r.route do
+    #   route do
     #     r.on %w"images fonts forms" do |dir|
     #       r.multi_public(dir)
     #     end
@@ -58,7 +58,7 @@ class Roda
     #     'fonts'  => ['assets/fonts', {'Cache-Control'=>'max-age=31536000'}, 'font/ttf'],
     #     'forms'  => ['static/forms/pdfs', nil, 'application/pdf']
     #
-    #   r.route do
+    #   route do
     #     r.on %w"images fonts forms" do |dir|
     #       r.multi_public(dir)
     #     end

data/lib/roda/plugins/public.rb

@@ -31,7 +31,7 @@ class Roda
     #   plugin :public, root: 'static'
     #
     #   # Assuming public is the location of files
-    #   r.route do
+    #   route do
     #     # Make GET /images/foo.png look for public/images/foo.png 
     #     r.public
     #

data/lib/roda/plugins/timestamp_public.rb

@@ -25,7 +25,7 @@ class Roda
     #   plugin :public, root: 'static', prefix: 'public'
     #
     #   # Assuming public is the location of files, and static is the path prefix
-    #   r.route do
+    #   route do
     #     # Make GET /static/1238099123/images/foo.png look for public/images/foo.png 
     #     r.timestamp_public
     #

data/lib/roda/plugins/typecast_params.rb

@@ -735,7 +735,7 @@ class Roda
         # You can use +dig+ to get access to nested arrays by using <tt>:array</tt> or <tt>:array!</tt> as
         # the first argument and providing the type in the second argument:
         #
-        #   tp.dig(:array, :pos_int, 'foo', 'bar', 'baz')  # tp['foo']['bar'].array(:int, 'baz')
+        #   tp.dig(:array, :pos_int, 'foo', 'bar', 'baz')  # tp['foo']['bar'].array(:pos_int, 'baz')
         def dig(type, *nest, key)
           _dig(false, type, nest, key)
         end

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 82
+  RodaMinorVersion = 83
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.82.0
+  version: 3.83.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-12 00:00:00.000000000 Z
+date: 2024-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -243,6 +243,7 @@ extra_rdoc_files:
 - doc/release_notes/3.80.0.txt
 - doc/release_notes/3.81.0.txt
 - doc/release_notes/3.82.0.txt
+- doc/release_notes/3.83.0.txt
 - doc/release_notes/3.9.0.txt
 files:
 - CHANGELOG
@@ -332,6 +333,7 @@ files:
 - doc/release_notes/3.80.0.txt
 - doc/release_notes/3.81.0.txt
 - doc/release_notes/3.82.0.txt
+- doc/release_notes/3.83.0.txt
 - doc/release_notes/3.9.0.txt
 - lib/roda.rb
 - lib/roda/cache.rb
@@ -347,6 +349,7 @@ files:
 - lib/roda/plugins/all_verbs.rb
 - lib/roda/plugins/assets.rb
 - lib/roda/plugins/assets_preloading.rb
+- lib/roda/plugins/assume_ssl.rb
 - lib/roda/plugins/autoload_hash_branches.rb
 - lib/roda/plugins/autoload_named_routes.rb
 - lib/roda/plugins/backtracking_array.rb