lib/roda/plugins/cookies.rb



# frozen-string-literal: true

require 'rack/utils'

#
class Roda
  module RodaPlugins
    # The cookies plugin adds response methods for handling cookies.
    # Currently, you can set cookies with +set_cookie+ and delete cookies
    # with +delete_cookie+:
    #
    #   response.set_cookie('foo', 'bar')
    #   response.delete_cookie('foo')
    #
    # Pass a hash of cookie options when loading the plugin to set some
    # defaults for all cookies upon setting and deleting. This is particularly
    # useful for configuring the +domain+ and +path+ of all cookies.
    #
    #   plugin :cookies, domain: 'example.com', path: '/api'
    module Cookies
      # Allow setting default cookie options when loading the cookies plugin.
      def self.configure(app, opts={})
        app.opts[:cookies_opts] = (app.opts[:cookies_opts]||{}).merge(opts).freeze
      end

      module ResponseMethods
        # Modify the headers to include a Set-Cookie value that
        # deletes the cookie.  A value hash can be provided to
        # override the default one used to delete the cookie.
        # Example:
        #
        #   response.delete_cookie('foo')
        #   response.delete_cookie('foo', domain: 'example.org')
        def delete_cookie(key, value = {})
          ::Rack::Utils.delete_cookie_header!(@headers, key, roda_class.opts[:cookies_opts].merge(value))
        end

        # Set the cookie with the given key in the headers.
        #
        #   response.set_cookie('foo', 'bar')
        #   response.set_cookie('foo', value: 'bar', domain: 'example.org')
        def set_cookie(key, value)
          value = { :value=>value } unless value.respond_to?(:keys)
          ::Rack::Utils.set_cookie_header!(@headers, key, roda_class.opts[:cookies_opts].merge(value))
        end
      end
    end

    register_plugin(:cookies, Cookies)
  end
end