module Grape::Middleware::Auth::DSL
def auth(type = nil, *legacy_options, **options, &block)
def auth(type = nil, *legacy_options, **options, &block) namespace_inheritable = inheritable_setting.namespace_inheritable return namespace_inheritable[:auth] unless type options = merge_legacy_auth_options(:auth, legacy_options, options) namespace_inheritable[:auth] = { type: type.to_sym, proc: block }.merge!(options) use Grape::Middleware::Auth::Base, namespace_inheritable[:auth] end
def http_basic(*legacy_options, **options, &)
(**options)-
:realm(String) -- "API Authorization" the HTTP Basic realm
Parameters:
-
options(Hash) -- a hash of options
def http_basic(*legacy_options, **options, &) options = merge_legacy_auth_options(:http_basic, legacy_options, options) options[:realm] ||= 'API Authorization' auth(:http_basic, **options, &) end
def http_digest(*legacy_options, **options, &)
def http_digest(*legacy_options, **options, &) options = merge_legacy_auth_options(:http_digest, legacy_options, options) options[:realm] ||= 'API Authorization' if options[:realm].respond_to?(:values_at) options[:realm][:opaque] ||= 'secret' else options[:opaque] ||= 'secret' end auth(:http_digest, **options, &) end
def merge_legacy_auth_options(method_name, legacy_options, options)
- Passing a positional options Hash is deprecated; pass
def merge_legacy_auth_options(method_name, legacy_options, options) return options if legacy_options.empty? Grape.deprecator.warn("Passing a positional options Hash to `#{method_name}` is deprecated. Pass keyword arguments instead.") legacy_options.first.merge(options) end