roda 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f3983563024d2c3f03d3a9edcf291f9a6f128ee
-  data.tar.gz: 4ac86dfd93b62b8e4f79f19788cf9dbd110df8f2
+  metadata.gz: cde8be71334a4d1be45b77656f9314fbac254bd1
+  data.tar.gz: 6c100351e8af6103d141f64967971c3e56dec13d
 SHA512:
-  metadata.gz: 807d5d4fcc03d18823d045b18cb8cf6ce532ea8501254c2f0ce7f245742e4ea6495e399c0e33ae1f7939726b0cb511bc7cc0d9620ec5d19099df86523d9c9847
-  data.tar.gz: cc40d28a3152b29755e7949304a4b3bd3a83147ce3975fe0fba829c332641651134727157726425da90feec610f8acfa6b1efd6ba5e8362c14ba97fb2dfe93a9
+  metadata.gz: 9084568d409627ac84c60d16049a6d2c545bdd9ac6cd6ba4dc312720474ccebc4e859dcc559d7e82390b66e04f31b06ee63ba32a288df57a832ea36ed18fd2ef
+  data.tar.gz: 74b8305898e306b49179ccb05349d4cf25a8fd4f7d481baec071728626a6c1eec99f40fd04faa6d85321e256154db6bf9a74717dbee50a50edad22f552152086

data/CHANGELOG

@@ -1,3 +1,9 @@
+= 2.14.0 (2016-05-13)
+
+* Add symbol_status plugin for using symbols as status codes (Papierkorb) (#65)
+
+* Make middleware plugin also run the application's middleware (jeremyevans)
+
 = 2.13.0 (2016-04-14)
 
 * Add :check_paths and :allowed_paths to render plugin options to avoid security issues with template rendering (jeremyevans)

data/doc/release_notes/2.14.0.txt

@@ -0,0 +1,44 @@
+= New Features
+
+* A symbol_status plugin has been added for using symbolic status names
+  in response.status=:
+
+    class App < Roda
+      plugin :symbol_status
+
+      route do |r|
+        r.is "needs_authorization"
+          response.status = :unauthorized
+        end
+      end
+
+= Other Improvements
+
+* The middleware plugin will now also run the application's middleware
+  when the application is used as middleware.  For example, if you
+  have the following code in your config.ru file:
+
+    class App < Roda
+      plugin :csrf
+      plugin :middleware
+      route{}
+    end
+
+    use App
+  
+  previously, the csrf protection would not be enforced, as it uses a
+  middleware instead of being part of the application. Now, csrf
+  protection will be enforced.  This change makes it so the Roda
+  application operates the same way regardless of whether it is run
+  as the rack application or used as rack middleware.
+
+  Because of this change, if you are nesting roda applications using
+  the middleware plugin, you may need to use the middleware plugin's
+  :env_var option to specify the environment variable used to
+  indicate to the Roda application that it is being run as middleware.
+
+= Backwards Compatibility
+
+* See above changes to the middleware plugin if you are using
+  middleware inside a Roda application that uses the middleware
+  plugin.

data/lib/roda/plugins/middleware.rb

@@ -36,6 +36,16 @@ class Roda
     # It is possible to use the Roda app as a regular app even when using
     # the middleware plugin.
     module Middleware
+      # Configure the middleware plugin.  Options:
+      # :env_var :: Set the environment variable to use to indicate to the roda
+      #             application that the current request is a middleware request.
+      #             You should only need to override this if you are using multiple
+      #             roda middleware in the same application.
+      def self.configure(app, opts={})
+        app.opts[:middleware_env_var] = opts[:env_var] if opts.has_key?(:env_var)
+        app.opts[:middleware_env_var] ||= 'roda.forward_next'
+      end
+
       # Forward instances are what is actually used as middleware.
       class Forwarder
         # Store the current middleware and the next middleware to call.
@@ -51,9 +61,8 @@ class Roda
           res = nil
 
           call_next = catch(:next) do
-            scope = @mid.new(env)
-            scope.request.forward_next = true
-            res = scope.call(&@mid.route_block)
+            env[@mid.opts[:middleware_env_var]] = true
+            res = @mid.call(env)
             false
           end
 
@@ -89,7 +98,9 @@ class Roda
       module RequestMethods
         # Whether to forward the request to the next application.  Set only if
         # this request is being performed for middleware.
-        attr_accessor :forward_next
+        def forward_next
+          env[roda_class.opts[:middleware_env_var]]
+        end
       end
     end
 

data/lib/roda/plugins/symbol_status.rb

@@ -0,0 +1,30 @@
+# frozen-string-literal: true
+
+class Roda
+  module RodaPlugins
+    # The symbol_status plugin patches the +status=+ response method to
+    # accept the status name as a symbol.  If given an integer value,
+    # the default behaviour is used.
+    #
+    # Examples:
+    #   r.is "needs_authorization"
+    #     response.status = :unauthorized
+    #   end
+    #   r.is "nothing"
+    #     response.status = :no_content
+    #   end
+    #
+    # The conversion is done through <tt>Rack::Utils.status_code</tt>.
+    module SymbolStatus
+      module ResponseMethods
+        # Sets the response status code by fixnum or symbol name
+        def status=(code)
+          code = Rack::Utils.status_code(code) if code.is_a?(Symbol)
+          super(code)
+        end
+      end
+    end
+
+    register_plugin(:symbol_status, SymbolStatus)
+  end
+end

data/lib/roda/version.rb

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

data/spec/plugin/middleware_spec.rb

@@ -75,4 +75,24 @@ describe "middleware plugin" do
 
     body('/a/b').must_equal 'ab'
   end
+
+  it "uses the app's middleware if :include_middleware option is given" do
+    mid = Struct.new(:app) do
+      def call(env)
+        env['foo'] = 'bar'
+        app.call(env)
+      end
+    end
+    app(:bare) do
+      plugin :middleware, :include_middleware=>true
+      use mid
+      route{}
+    end
+    mid2 = app
+    app(:bare) do
+      use mid2
+      route{env['foo']}
+    end
+    body.must_equal 'bar'
+  end
 end

data/spec/plugin/symbol_matchers_spec.rb

@@ -27,6 +27,10 @@ describe "symbol_matchers plugin" do
           "thing#{d}"
         end
 
+        r.is "thing2", :thing do |d|
+          "thing2#{d}"
+        end
+
         r.is :f do |f|
           "f#{f}"
         end
@@ -69,5 +73,6 @@ describe "symbol_matchers plugin" do
     body("/qa/b/c/d//f/g").must_equal 'resta/b/c/d//f/g'
     body('/q').must_equal 'rest'
     body('/thing/q').must_equal 'thingq'
+    body('/thing2/q').must_equal 'thing2q'
   end
 end

data/spec/plugin/symbol_status_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
+
+describe "symbol_status plugin" do
+  it "accepts a symbol" do
+    app(:symbol_status) do |r|
+      r.on do
+        response.status = :unauthorized
+      end
+    end
+
+    status.must_equal 401
+  end
+
+  it "accepts a fixnum" do
+    app(:symbol_status) do |r|
+      r.on do
+        response.status = 204
+      end
+    end
+
+    status.must_equal 204
+  end
+end

data/spec/plugin/websockets_spec.rb

@@ -61,21 +61,23 @@ describe "websockets plugin" do
   it "supports websocket requests" do
     ws = Faye::WebSocket::Client.new("ws://localhost:#{@port}")
     msg = nil
+    sleep_for = 0.01
+    wait_for = 10
     ws.on(:open){|event| msg = true}
     t = Time.now
-    sleep 0.01 until msg || Time.now - t > 5
+    sleep sleep_for until msg || Time.now - t > wait_for
     msg.must_equal true
 
     msg = nil
     ws.on(:message){|event| msg = event.data}
     ws.send("hello")
     t = Time.now
-    sleep 0.01 until msg || Time.now - t > 5
+    sleep sleep_for until msg || Time.now - t > wait_for
     msg.must_equal 'olleh'
 
     ws.close
     t = Time.now
-    sleep 0.01 until @events == %w'open hello close' || Time.now - t > 5
+    sleep sleep_for until @events == %w'open hello close' || Time.now - t > wait_for
     @events.must_equal %w'open hello close'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.14.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -179,6 +179,7 @@ extra_rdoc_files:
 - doc/release_notes/2.11.0.txt
 - doc/release_notes/2.12.0.txt
 - doc/release_notes/2.13.0.txt
+- doc/release_notes/2.14.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -195,6 +196,7 @@ files:
 - doc/release_notes/2.11.0.txt
 - doc/release_notes/2.12.0.txt
 - doc/release_notes/2.13.0.txt
+- doc/release_notes/2.14.0.txt
 - doc/release_notes/2.2.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
@@ -269,6 +271,7 @@ files:
 - lib/roda/plugins/status_handler.rb
 - lib/roda/plugins/streaming.rb
 - lib/roda/plugins/symbol_matchers.rb
+- lib/roda/plugins/symbol_status.rb
 - lib/roda/plugins/symbol_views.rb
 - lib/roda/plugins/view_options.rb
 - lib/roda/plugins/view_subdirs.rb
@@ -347,6 +350,7 @@ files:
 - spec/plugin/status_handler_spec.rb
 - spec/plugin/streaming_spec.rb
 - spec/plugin/symbol_matchers_spec.rb
+- spec/plugin/symbol_status_spec.rb
 - spec/plugin/symbol_views_spec.rb
 - spec/plugin/view_options_spec.rb
 - spec/plugin/websockets_spec.rb