roda 2.24.0 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b17a05c593a91658be1194fb29c9564dcd6e3fe2
-  data.tar.gz: 153d3095509dd43d37e9297c963aea4e39ef2cbe
+  metadata.gz: 8a70fe0e0ab208cb5ca42d42d60633e1c03ec77a
+  data.tar.gz: 5aedc804b0e884c1a05d87d325bf4c28e4798c6c
 SHA512:
-  metadata.gz: d3871a3650c8490435fd94d13148a5ba90c636779cb1235c94c0bb61d76ef35efa8cf5c504e29271a3e34bcc818c179ed8a709e1576ccbeb53fb8c4825da2272
-  data.tar.gz: 0ab43b3207200bfc783a00d714b058d04220a1ab1dd333670b8c2d590530cab87564e9323f4023a6c8e48f63a50fd3cf82f842429ae395bdf8f192905fb035bd
+  metadata.gz: c9ea6a8f1ea687572e874af5d6ff92a06617bc7881d1337a307b64f63c125912e836a577944f156da1c340a8b11eecf78cf780bcef42be122d29fe3887f8f457
+  data.tar.gz: 6ef1c484659735450a053f3f3d5dddf7bc4f65c78bfe52e54d1930529938f3a99c8810c2b0ea69846fc11cb757727f9dbe2df43ae90aae60af1c5d0bac75a893

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 2.25.0 (2017-04-18)
+
+* Add error_mail plugin, similar to error_email but using mail instead of net/smtp directly (jeremyevans)
+
 = 2.24.0 (2017-03-15)
 
 * Have h plugin use cgi/escape if available for faster escaping (jeremyevans)

data/README.rdoc

@@ -415,6 +415,50 @@ If +false+ or +nil+ is given directly as a matcher, it doesn't match anything.
 
 Everything else matches anything.
 
+== Optional segments
+
+There are multiple ways you can handle optional segments in Roda.  For example,
+let's say you want to accept both +/items/123+ and +/items/123/456+, with 123 being
+the item's id, and 456 being some optional data.
+
+The simplest way to handle this is by treating this as two separate routes with a
+shared branch:
+
+  r.on "items", :id do |item_id|
+    # Shared code for branch here
+
+    # /items/123/456
+    r.is :opt_data do |optional_data|
+    end
+
+    # /items/123
+    r.is do
+    end
+  end
+
+This works well for many cases, but there are also cases where you really want to
+treat it as one route with an optional segment.  One simple way to do that is to
+use a parameter instead of an optional segment (e.g. +/items/123?opt=456+).
+
+  r.is "items", :id do |item_id|
+    optional_data = r['opt']
+  end
+
+However, if you really do want to use a optional segment, there are a couple different
+ways to use matchers to do so.  One is using an array matcher where the last element
+is true:
+
+  r.is "items", :id, [:opt_data, true] do |item_id, optional_data|
+  end
+
+Note that this technically yields only one argument instead of two arguments if the
+optional segment isn't provided.
+
+An alternative way to implement this is via a regexp:
+
+  r.is "items", /(\d+)(?:\/(\d+))?/ do |item_id, optional_data|
+  end
+
 == Status codes
 
 When it comes time to finalize a response,

data/doc/release_notes/2.25.0.txt

@@ -0,0 +1,14 @@
+= New Features
+
+* An error_mail plugin has been added for reporting exceptions raised
+  via email.  This is similar to the existing error_email plugin, but
+  uses the mail library instead of net/smtp directly.  If you are
+  already using the mail library and the error_email plugin in your
+  application, it's recommended to switch to the error_mail plugin.
+  Example:
+
+    plugin :error_mail, :to=>'to@example.com', :from=>'from@example.com'
+    plugin :error_handler do |e|
+      error_mail(e)
+      'Internal Server Error'
+    end

data/lib/roda/plugins/error_email.rb

@@ -14,6 +14,11 @@ class Roda
     #     'Internal Server Error'
     #   end
     #
+    # It is similar to the error_mail plugin, except that it uses net/smtp
+    # directly instead of using the mail library.  If you are not already using the
+    # mail library in your application, it makes sense to use error_email
+    # instead of error_mail.
+    #
     # Options:
     #
     # :from :: The From address to use in the email (required)
@@ -34,7 +39,7 @@ class Roda
     module ErrorEmail
       OPTS = {}.freeze
       DEFAULTS = {
-        :headers=>{},
+        :headers=>OPTS,
         :host=>'localhost',
         # :nocov:
         :emailer=>lambda{|h| Net::SMTP.start(h[:host]){|s| s.send_message(h[:message], h[:from], h[:to])}},

data/lib/roda/plugins/error_mail.rb

@@ -0,0 +1,133 @@
+# frozen-string-literal: true
+
+require 'mail'
+
+class Roda
+  module RodaPlugins
+    # The error_mail plugin adds an +error_mail+ instance method that
+    # send an email related to the exception.  This is most useful if you are
+    # also using the error_handler plugin:
+    #
+    #   plugin :error_mail, :to=>'to@example.com', :from=>'from@example.com'
+    #   plugin :error_handler do |e|
+    #     error_mail(e)
+    #     'Internal Server Error'
+    #   end
+    #
+    # It is similar to the error_email plugin, except that it uses the mail
+    # library instead of net/smtp directly.  If you are already using the
+    # mail library in your application, it makes sense to use error_mail
+    # instead of error_email.
+    #
+    # Options:
+    #
+    # :from :: The From address to use in the email (required)
+    # :headers :: A hash of additional headers to use in the email (default: empty hash)
+    # :prefix :: A prefix to use in the email's subject line (default: no prefix)
+    # :to :: The To address to use in the email (required)
+    #
+    # The subject of the error email shows the exception class and message.
+    # The body of the error email shows the backtrace of the error and the
+    # request environment, as well the request params and session variables (if any).
+    # You can also call error_mail with a plain string instead of an exception,
+    # in which case the string is used as the subject, and no backtrace is included.
+    #
+    # Note that emailing on every error as shown above is only appropriate
+    # for low traffic web applications.  For high traffic web applications,
+    # use an error reporting service instead of this plugin.
+    module ErrorMail
+      OPTS = {}.freeze
+
+      # Set default opts for plugin.  See ErrorEmail module RDoc for options.
+      def self.configure(app, opts=OPTS)
+        app.opts[:error_mail] = email_opts = (app.opts[:error_mail] || OPTS).merge(opts).freeze
+        unless email_opts[:to] && email_opts[:from]
+          raise RodaError, "must provide :to and :from options to error_mail plugin"
+        end
+      end
+
+      module InstanceMethods
+        # Send an email for the given error.  +exception+ is usually an exception
+        # instance, but it can be a plain string which is used as the subject for
+        # the email.
+        def error_mail(exception)
+          _error_mail(exception).deliver!
+        end
+
+        # The content of the email to send, include the headers and the body.
+        # Takes the same argument as #error_mail.
+        def error_mail_content(exception)
+          _error_mail(exception).to_s
+        end
+
+        private
+
+        def _error_mail(e)
+          email_opts = self.class.opts[:error_mail]
+          subject = if e.respond_to?(:message)
+            "#{e.class}: #{e.message}"
+          else
+            e.to_s
+          end
+          subject = "#{email_opts[:prefix]}#{subject}"
+
+          format = lambda{|h| h.map{|k, v| "#{k.inspect} => #{v.inspect}"}.sort.join("\n")}
+
+          message = String.new
+          message << <<END
+Path: #{request.path}
+
+END
+          if e.respond_to?(:backtrace)
+            message << <<END
+Backtrace:
+
+#{e.backtrace.join("\n")}
+END
+          end
+
+          message << <<END
+
+ENV:
+
+#{format[env]}
+END
+
+          unless request.params.empty?
+            message << <<END
+
+Params:
+
+#{format[request.params]}
+END
+          end
+
+          if env['rack.session']
+            message << <<END
+
+Session:
+
+#{format[session]}
+END
+          end
+
+
+          Mail.new do
+            from email_opts[:from]
+            to email_opts[:to]
+            subject subject
+            body message
+
+            if headers = email_opts[:headers]
+              headers.each do |k,v|
+                header[k] = v
+              end
+            end
+          end
+        end
+      end
+    end
+
+    register_plugin(:error_mail, ErrorMail)
+  end
+end

data/lib/roda/plugins/flash.rb

@@ -27,6 +27,14 @@ class Roda
     #       end
     #     end
     #   end
+    #
+    # You can modify the flash for the current request (instead of
+    # the next request) by using the +flash.now+ method:
+    #
+    #   r.get do
+    #     flash.now['a'] = 'b'
+    #     flash['a'] # = >'b'
+    #   end
     module Flash
       # The internal session key used to store the flash.
       KEY = :_flash

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

data/spec/matchers_spec.rb

@@ -275,6 +275,39 @@ describe "matchers" do
     status('/123bard').must_equal 404
   end
 
+  it "should allow arrays to match optional segments with splats" do
+    app do |r|
+      r.on :foo, [:bar, true] do |*m|
+        m.inspect
+      end
+    end
+
+    body('/123').must_equal '["123"]'
+    body('/123/456').must_equal '["123", "456"]'
+  end
+
+  it "should allow arrays to match optional segments with separate arguments" do
+    app do |r|
+      r.on :foo, [:bar, true] do |f, b|
+        [f, b].inspect
+      end
+    end
+
+    body('/123').must_equal '["123", nil]'
+    body('/123/456').must_equal '["123", "456"]'
+  end
+
+  it "should allow regexp to match optional segments with separate arguments" do
+    app do |r|
+      r.on /(\d+)(?:\/(\d+))?/ do |f, b|
+        [f, b].inspect
+      end
+    end
+
+    body('/123').must_equal '["123", nil]'
+    body('/123/456').must_equal '["123", "456"]'
+  end
+
   it "should have array capture match string if match" do
     app do |r|
       r.on %w'p q' do |id|

data/spec/plugin/error_mail_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
+
+begin
+  require 'mail'
+rescue LoadError
+  warn "mail not installed, skipping mail plugin test"  
+else
+Mail.defaults do
+  delivery_method :test
+end
+
+describe "error_mail plugin" do 
+  def app(opts={})
+    @emails = emails = [] unless defined?(@emails)
+    @app ||= super(:bare) do
+      plugin :error_mail, {:to=>'t', :from=>'f'}.merge(opts)
+
+      route do |r|
+        r.get('noerror'){error_mail("Problem"); 'g'}
+        raise ArgumentError, 'bad foo' rescue error_mail($!)
+        'e'
+      end
+    end
+  end
+
+  before do
+    Mail::TestMailer.deliveries.clear
+  end
+
+  def email
+    Mail::TestMailer.deliveries.last
+  end
+
+  it "adds error_mail method for emailing exceptions" do
+    app
+    body('rack.input'=>StringIO.new, 'QUERY_STRING'=>'b=c', 'rack.session'=>{'d'=>'e'}).must_equal 'e'
+    email.to.must_equal ['t']
+    email.from.must_equal ['f']
+    email.header.to_s.must_match(/^Subject: ArgumentError: bad foo/)
+    email.body.to_s.must_match(/^Backtrace:$.+^ENV:$.+^"rack\.input" => .+^Params:$\s+^"b" => "c"$\s+^Session:$\s+^"d" => "e"$/m)
+  end
+
+  it "have error_mail method support string arguments" do
+    app
+    body('/noerror', 'rack.input'=>StringIO.new, 'QUERY_STRING'=>'b=c', 'rack.session'=>{'d'=>'e'}).must_equal 'g'
+    email.to.must_equal ['t']
+    email.from.must_equal ['f']
+    email.header.to_s.must_match(/^Subject: Problem/)
+    email.body.to_s.must_match(/^ENV:$.+^"rack\.input" => .+^Params:$\s+^"b" => "c"$\s+^Session:$\s+^"d" => "e"$/m)
+    email.body.to_s.wont_include('Backtrace')
+  end
+
+  it "supports error_mail_content for the content of the email" do
+    app.route do |r|
+      raise ArgumentError, 'bad foo' rescue error_mail_content($!)
+    end
+    b = body('rack.input'=>StringIO.new, 'QUERY_STRING'=>'b=c', 'rack.session'=>{'d'=>'e'})
+    b.must_match(/^Subject: ArgumentError: bad foo/)
+    b.must_match(/^Backtrace:.+^ENV:.+^"rack\.input" => .+^Params:\s+^"b" => "c"\s+^Session:\s+^"d" => "e"/m)
+  end
+
+  it "adds :prefix option to subject line" do
+    app(:prefix=>'TEST ')
+    body('rack.input'=>StringIO.new).must_equal 'e'
+    email.header.to_s.must_match(/^Subject: TEST ArgumentError/)
+  end
+
+  it "uses :headers option for additional headers" do
+    app(:headers=>{'Foo'=>'Bar', 'Baz'=>'Quux'})
+    body('rack.input'=>StringIO.new).must_equal 'e'
+    email.header.to_s.must_match(/^Foo: Bar/)
+    email.header.to_s.must_match(/^Baz: Quux/)
+  end
+
+  it "requires the :to and :from options" do
+    proc{app :from=>nil}.must_raise(Roda::RodaError)
+    proc{app :to=>nil}.must_raise(Roda::RodaError)
+  end
+
+  it "works correctly in subclasses" do
+    @app = Class.new(app)
+    @app.route do |r|
+      raise ArgumentError rescue error_mail($!)
+      'e'
+    end
+    body('rack.input'=>StringIO.new).must_equal 'e'
+    email.to.must_equal ['t']
+    email.from.must_equal ['f']
+    email.header.to_s.must_match(/^Subject: ArgumentError: ArgumentError/)
+    email.body.to_s.must_match(/^Backtrace:$.+^ENV:$.+^"rack\.input" => .+/m)
+  end
+end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 2.24.0
+  version: 2.25.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -204,6 +204,7 @@ extra_rdoc_files:
 - doc/release_notes/2.22.0.txt
 - doc/release_notes/2.23.0.txt
 - doc/release_notes/2.24.0.txt
+- doc/release_notes/2.25.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -232,6 +233,7 @@ files:
 - doc/release_notes/2.22.0.txt
 - doc/release_notes/2.23.0.txt
 - doc/release_notes/2.24.0.txt
+- doc/release_notes/2.25.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
 - doc/release_notes/2.5.0.txt
@@ -263,6 +265,7 @@ files:
 - lib/roda/plugins/environments.rb
 - lib/roda/plugins/error_email.rb
 - lib/roda/plugins/error_handler.rb
+- lib/roda/plugins/error_mail.rb
 - lib/roda/plugins/flash.rb
 - lib/roda/plugins/h.rb
 - lib/roda/plugins/halt.rb
@@ -353,6 +356,7 @@ files:
 - spec/plugin/environments_spec.rb
 - spec/plugin/error_email_spec.rb
 - spec/plugin/error_handler_spec.rb
+- spec/plugin/error_mail_spec.rb
 - spec/plugin/flash_spec.rb
 - spec/plugin/h_spec.rb
 - spec/plugin/halt_spec.rb
@@ -450,7 +454,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Routing tree web toolkit