roda 3.27.0 → 3.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1aaf8be3e1a6fa8d822436561e48f5a5978e94e3430c0287b32be3a0a292d351
-  data.tar.gz: 84ed6cd43e59574cc1264889578296d30c96c91d4b53a45bb2b839619f2d1786
+  metadata.gz: 2de9e0d72db9d2f1d1143c71738067798dbcc3f2786611f8f0a5f85c32f26167
+  data.tar.gz: 92645c4e9792b1217cfae3d8b430741f64212a30003cf81b393c37636dc531c0
 SHA512:
-  metadata.gz: 7e339e3062178e6e47bf5b7fb59b32076f5e48131ce14480e3c685f5eb4d0d59903fa635ac790410ef88a2d5cdc46a5e3792d98c511c21acee7931ec5d15d16a
-  data.tar.gz: 38f9c91a1b9356d07854c364a10a901c2a126162e42e25e112cdca59b9b065e587f17c2019f4c785ed6610fc0b98011f0ab7adb8cfab0da51acb13e1a0477c34
+  metadata.gz: 35a615a610ca645130cbd15482f6864a50a3a8727e6e4cf7bad8d63a00e40118f7a0443f88931ec24a5f416ae822a9bd8ebc101f930efff178831660d5125849
+  data.tar.gz: a6b9f48cfe249297ce8abfd3a856c65634364ea0490910b956f25fe4cd54c4b77096bd980a59276e6ed0fb4db537e99fa8b4e1e0e35441afaaf942ca7e92bb02

data/CHANGELOG

@@ -1,3 +1,11 @@
+= 3.28.0 (2020-01-15)
+
+* Add session_created_at and session_updated_at methods to the sessions plugin (jeremyevans)
+
+* Make upgrading from rack session cookie in sessions plugin work with rack 2.0.8 (jeremyevans)
+
+* Make json_parser parse request body as json even if request body has already been read (jeremyevans)
+
 = 3.27.0 (2019-12-13)
 
 * Allow json_parser return correct result for invalid JSON if the params_capturing plugin is used (jeremyevans) (#180)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2019 Jeremy Evans
+Copyright (c) 2014-2020 Jeremy Evans
 Copyright (c) 2010-2014 Michel Martens, Damian Janowski and Cyril David
 Copyright (c) 2008-2009 Christian Neukirchen
 

data/Rakefile

@@ -77,6 +77,11 @@ task "spec_cov" do
   spec.call('COVERAGE'=>'1')
 end
   
+desc "Run specs with branch coverage"
+task "spec_branch_cov" do
+  spec.call('COVERAGE'=>'1', 'BRANCH_COVERAGE'=>'1')
+end
+  
 desc "Run specs with -w, some warnings filtered"
 task "spec_w" do
   rubyopt = ENV['RUBYOPT']

data/doc/release_notes/3.28.0.txt

@@ -0,0 +1,13 @@
+= New Features
+
+* The sessions plugin now supports RodaRequest#session_created_at
+  and RodaRequest#session_updated_at for the times of session
+  creation and last update.
+
+= Other Improvements
+
+* The json_parser plugin now correctly parses the request body even
+  if the request body has already been read.
+
+* The sessions plugin now correctly handles upgrading rack cookie
+  sessions when using rack 2.0.8+.

data/lib/roda.rb

@@ -125,10 +125,12 @@ class Roda
                   # Complexity of handling keyword arguments using define_method is too high,
                   # Fallback to instance_exec in this case.
                   b = block
-                  if RUBY_VERSION >= '2.7'
-                    block = eval('lambda{|*a, **kw| instance_exec(*a, **kw, &b)}', nil, __FILE__, __LINE__) # Keyword arguments fallback
+                  block = if RUBY_VERSION >= '2.7'
+                    eval('lambda{|*a, **kw| instance_exec(*a, **kw, &b)}', nil, __FILE__, __LINE__) # Keyword arguments fallback
                   else
-                    block = lambda{|*a| instance_exec(*a, &b)} # Keyword arguments fallback
+                    # :nocov:
+                    lambda{|*a| instance_exec(*a, &b)} # Keyword arguments fallback
+                    # :nocov:
                   end
                 else
                   arity_meth = meth

data/lib/roda/plugins/assets.rb

@@ -297,7 +297,7 @@ class Roda
     #         can use nil to disable subresource integrity.
     # :timestamp_paths :: Include the timestamp of assets in asset paths in non-compiled mode. Doing this can
     #                     slow down development requests due to additional requests to get last modified times,
-    #                     put it will make sure the paths change in development when there are modifications,
+    #                     but it will make sure the paths change in development when there are modifications,
     #                     which can fix issues when using a caching proxy in non-compiled mode. This can also
     #                     be specified as a string to use that string to separate the timestamp from the asset.
     #                     By default, <tt>/</tt> is used as the separator if timestamp paths are enabled.

data/lib/roda/plugins/default_status.rb

@@ -17,7 +17,7 @@ class Roda
     module DefaultStatus
       def self.configure(app, &block)
         raise RodaError, "default_status plugin requires a block" unless block
-       if check_arity = app.opts.fetch(:check_arity, true)
+        if check_arity = app.opts.fetch(:check_arity, true)
           unless block.arity == 0
             if check_arity == :warn
               RodaPlugins.warn "Arity mismatch in block passed to plugin :default_status. Expected Arity 0, but arguments required for #{block.inspect}"

data/lib/roda/plugins/json_parser.rb

@@ -52,6 +52,7 @@ class Roda
           if post_params = (env["roda.json_params"] || env["rack.request.form_hash"])
             post_params
           elsif (input = env["rack.input"]) && content_type =~ /json/
+            input.rewind
             str = input.read
             input.rewind
             return super if str.empty?

data/lib/roda/plugins/mail_processor.rb

@@ -332,7 +332,7 @@ class Roda
           string_meth = nil
           regexp_meth = nil
           addresses.each do |address|
-            key = case address
+            case address
             when String
               unless string_meth
                 string_meth = define_roda_method("mail_processor_string_route_#{address}", 1, &convert_route_block(block))

data/lib/roda/plugins/render.rb

@@ -143,9 +143,11 @@ class Roda
           template.send(:compiled_method, locals_keys, scope_class)
         end
       else
+        # :nocov:
         def self.tilt_template_compiled_method(template, locals_keys, scope_class)
           template.send(:compiled_method, locals_keys)
         end
+        # :nocov:
       end
 
       # Setup default rendering options.  See Render for details.

data/lib/roda/plugins/sessions.rb

@@ -172,7 +172,6 @@ class Roda
 
       # Configure the plugin, see Sessions for details on options.
       def self.configure(app, opts=OPTS)
-        plugin_opts = opts
         opts = (app.opts[:sessions] || DEFAULT_OPTIONS).merge(opts)
         co = opts[:cookie_options] = DEFAULT_COOKIE_OPTIONS.merge(opts[:cookie_options] || OPTS).freeze
         opts[:remove_cookie_options] = co.merge(:max_age=>'0', :expires=>Time.at(0))
@@ -239,6 +238,18 @@ class Roda
           @env['rack.session'] ||= _load_session
         end
 
+        # The time the session was originally created. nil if there is no active session.
+        def session_created_at
+          session
+          Time.at(@env[SESSION_CREATED_AT]) if @env[SESSION_SERIALIZED]
+        end
+
+        # The time the session was last updated. nil if there is no active session.
+        def session_updated_at
+          session
+          Time.at(@env[SESSION_UPDATED_AT]) if @env[SESSION_SERIALIZED]
+        end
+
         # Persist the session data as a cookie.  If transparently upgrading from
         # Rack::Session::Cookie, mark the related cookie for expiration so it isn't
         # sent in the future.
@@ -296,8 +307,6 @@ class Roda
         # hmac and coder.
         def _deserialize_rack_session(data)
           opts = roda_class.opts[:sessions]
-          key = opts[:upgrade_from_rack_session_cookie_key]
-          secret = opts[:upgrade_from_rack_session_cookie_secret]
           data, digest = data.split("--", 2)
           unless digest
             return _session_serialization_error("Not decoding Rack::Session::Cookie session: invalid format")
@@ -315,6 +324,11 @@ class Roda
           # Mark rack session cookie for deletion on success
           env[SESSION_DELETE_RACK_COOKIE] = true
 
+          # Delete the session id before serializing it.  Starting in rack 2.0.8,
+          # this is an object and not just a string, and calling to_s on it raises
+          # a RuntimeError.
+          session.delete("session_id")
+
           # Convert the rack session by roundtripping it through
           # the parser and serializer, so that you would get the
           # same result as you would if the session was handled

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 = 27
+  RodaMinorVersion = 28
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/define_roda_method_spec.rb

@@ -8,12 +8,12 @@ describe "Roda.define_roda_method" do
   it "should define methods using block" do
     m0 = app.define_roda_method("x", 0){1}
     m0.must_be_kind_of Symbol
-    m0.must_match /\A_roda_x_\d+\z/
+    m0.must_match(/\A_roda_x_\d+\z/)
     @scope.send(m0).must_equal 1
 
     m1 = app.define_roda_method("x", 1){|x| [x, 2]}
     m1.must_be_kind_of Symbol
-    m1.must_match /\A_roda_x_\d+\z/
+    m1.must_match(/\A_roda_x_\d+\z/)
     @scope.send(m1, 3).must_equal [3, 2]
   end
 

data/spec/plugin/common_logger_spec.rb

@@ -14,26 +14,26 @@ describe "common_logger plugin" do
 
     body.must_equal '/'
     @logger.rewind
-    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 200 1 0.\d\d\d\d\n\z/
+    @logger.read.must_match(/\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 200 1 0.\d\d\d\d\n\z/)
 
     @logger.rewind
     @logger.truncate(0)
     body('', 'HTTP_X_FORWARDED_FOR'=>'1.1.1.1', 'REMOTE_USER'=>'je', 'REQUEST_METHOD'=>'POST', 'QUERY_STRING'=>'', "HTTP_VERSION"=>'HTTP/1.1').must_equal ''
     @logger.rewind
-    @logger.read.must_match /\A1\.1\.1\.1 - je \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "POST  HTTP\/1.1" 200 - 0.\d\d\d\d\n\z/
+    @logger.read.must_match(/\A1\.1\.1\.1 - je \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "POST  HTTP\/1.1" 200 - 0.\d\d\d\d\n\z/)
 
     @logger.rewind
     @logger.truncate(0)
     body('/b', 'REMOTE_ADDR'=>'1.1.1.2', 'QUERY_STRING'=>'foo=bar', "HTTP_VERSION"=>'HTTP/1.0').must_equal '/b'
     @logger.rewind
-    @logger.read.must_match /\A1\.1\.1\.2 - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/b\?foo=bar HTTP\/1.0" 200 2 0.\d\d\d\d\n\z/
+    @logger.read.must_match(/\A1\.1\.1\.2 - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/b\?foo=bar HTTP\/1.0" 200 2 0.\d\d\d\d\n\z/)
 
     @app.plugin :common_logger, Logger.new(@logger)
     @logger.rewind
     @logger.truncate(0)
     body.must_equal '/'
     @logger.rewind
-    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 200 1 0.\d\d\d\d\n\z/
+    @logger.read.must_match(/\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 200 1 0.\d\d\d\d\n\z/)
   end
 
   it 'skips timer information if not available' do
@@ -44,7 +44,7 @@ describe "common_logger plugin" do
 
     body.must_equal '/'
     @logger.rewind
-    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 200 1 -\n\z/
+    @logger.read.must_match(/\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 200 1 -\n\z/)
   end
 
   it 'skips length information if not available' do
@@ -54,7 +54,7 @@ describe "common_logger plugin" do
 
     body.must_equal ''
     @logger.rewind
-    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 500 - 0.\d\d\d\d\n\z/
+    @logger.read.must_match(/\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 500 - 0.\d\d\d\d\n\z/)
   end
 
   it 'does not log if an error is raised' do
@@ -80,6 +80,6 @@ describe "common_logger plugin" do
 
     body.must_equal 'bad'
     @logger.rewind
-    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 500 3 0.\d\d\d\d\n\z/
+    @logger.read.must_match(/\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 500 3 0.\d\d\d\d\n\z/)
   end
 end

data/spec/plugin/json_parser_spec.rb

@@ -15,6 +15,14 @@ describe "json_parser plugin" do
     body('rack.input'=>StringIO.new('a[b]=1'), 'REQUEST_METHOD'=>'POST').must_equal '1'
   end
 
+  it "parses incoming json if content type specifies json and body is already read" do
+    @app.route do |r|
+      r.body.read
+      r.params['a']['b'].to_s
+    end
+    body('rack.input'=>StringIO.new('{"a":{"b":1}}'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal '1'
+  end
+
   it "returns 400 for invalid json" do
     req('rack.input'=>StringIO.new('{"a":{"b":1}'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal [400, {}, []]
   end

data/spec/plugin/sessions_spec.rb

@@ -28,8 +28,11 @@ if RUBY_VERSION >= '2'
           r.get('g',  String){|k| session[k].to_s}
           r.get('sct'){|i| session; env['roda.session.created_at'].to_s}
           r.get('ssct', Integer){|i| session; (env['roda.session.created_at'] -= i).to_s}
+          r.get('ssct2', Integer, String, String){|i, k, v| session[k] = v; (env['roda.session.created_at'] -= i).to_s}
           r.get('sc'){session.clear; 'c'}
           r.get('cs', String, String){|k, v| clear_session; session[k] = v}
+          r.get('cat'){t = r.session_created_at; t.strftime("%F") if t}
+          r.get('uat'){t = r.session_updated_at; t.strftime("%F") if t}
           ''
         end
       end
@@ -68,6 +71,16 @@ if RUBY_VERSION >= '2'
       errors.must_equal []
     end
 
+    it "allows accessing session creation and last update times" do
+      status('/cat').must_equal 404
+      status('/uat').must_equal 404
+      status('/s/foo/bar').must_equal 200
+      body('/cat').must_equal Date.today.strftime("%F")
+      body('/uat').must_equal Date.today.strftime("%F")
+      status('/ssct2/172800/bar/baz').must_equal 200
+      body('/cat').must_equal((Date.today - 2).strftime("%F"))
+    end
+
     it "does not add Set-Cookie header if session does not change, unless outside :skip_within seconds" do
       req('/').must_equal [200, {"Content-Type"=>"text/html", "Content-Length"=>"0"}, [""]]
       _, h, b = req('/s/foo/bar')
@@ -97,16 +110,16 @@ if RUBY_VERSION >= '2'
 
     it "removes session cookie when session is submitted but empty after request" do
       body('/s/foo/bar').must_equal 'bar'
-      sct = body('/sct').to_i
+      body('/sct').to_i
       body('/g/foo').must_equal 'bar'
 
       _, h, b = req('/sc')
 
       # Parameters can come in any order, and only the final parameter may omit the ;
       ['roda.session=', 'max-age=0', 'path=/'].each do |param|
-        h['Set-Cookie'].must_match /#{Regexp.escape(param)}(;|\z)/
+        h['Set-Cookie'].must_match(/#{Regexp.escape(param)}(;|\z)/)
       end
-      h['Set-Cookie'].must_match /expires=Thu, 01 Jan 1970 00:00:00 (-0000|GMT)(;|\z)/
+      h['Set-Cookie'].must_match(/expires=Thu, 01 Jan 1970 00:00:00 (-0000|GMT)(;|\z)/)
 
       b.must_equal ['c']
 
@@ -116,16 +129,16 @@ if RUBY_VERSION >= '2'
     it "removes session cookie even when max-age and expires are in cookie options" do
       app.plugin :sessions, :cookie_options=>{:max_age=>'1000', :expires=>Time.now+1000}
       body('/s/foo/bar').must_equal 'bar'
-      sct = body('/sct').to_i
+      body('/sct').to_i
       body('/g/foo').must_equal 'bar'
 
       _, h, b = req('/sc')
 
       # Parameters can come in any order, and only the final parameter may omit the ;
       ['roda.session=', 'max-age=0', 'path=/'].each do |param|
-        h['Set-Cookie'].must_match /#{Regexp.escape(param)}(;|\z)/
+        h['Set-Cookie'].must_match(/#{Regexp.escape(param)}(;|\z)/)
       end
-      h['Set-Cookie'].must_match /expires=Thu, 01 Jan 1970 00:00:00 (-0000|GMT)(;|\z)/
+      h['Set-Cookie'].must_match(/expires=Thu, 01 Jan 1970 00:00:00 (-0000|GMT)(;|\z)/)
 
       b.must_equal ['c']
 

data/spec/plugin/streaming_spec.rb

@@ -216,7 +216,7 @@ describe "streaming plugin" do
         end
       end
 
-      *, b = req
+      req
       q.deq
       a.must_equal %w'a b c d e f g h i j'
     end
@@ -238,7 +238,7 @@ describe "streaming plugin" do
         end
       end
 
-      *, b = req
+      req
       q.deq
       a.must_equal %w'a b c d e'
     end

data/spec/session_spec.rb

@@ -27,11 +27,11 @@ describe "session handling" do
       end
     end
 
-    _, h, b = req
+    _, _, b = req
     b.join.must_equal 'ab'
-    _, h, b = req
+    _, _, b = req
     b.join.must_equal 'abb'
-    _, h, b = req
+    _, _, b = req
     b.join.must_equal 'abbb'
   end
 end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ if ENV['COVERAGE']
 
   def SimpleCov.roda_coverage(opts = {})
     start do
+      enable_coverage :branch if ENV['BRANCH_COVERAGE']
       add_filter "/spec/"
       add_group('Missing'){|src| src.covered_percent < 100}
       add_group('Covered'){|src| src.covered_percent == 100}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.27.0
+  version: 3.28.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -238,6 +238,7 @@ extra_rdoc_files:
 - doc/release_notes/3.25.0.txt
 - doc/release_notes/3.26.0.txt
 - doc/release_notes/3.27.0.txt
+- doc/release_notes/3.28.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -301,6 +302,7 @@ files:
 - doc/release_notes/3.25.0.txt
 - doc/release_notes/3.26.0.txt
 - doc/release_notes/3.27.0.txt
+- doc/release_notes/3.28.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
@@ -578,7 +580,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Routing tree web toolkit