Module: Grape::Middleware::Auth::DSL

Included in:
API::Instance
Defined in:
lib/grape/middleware/auth/dsl.rb

Instance Method Summary collapse

Instance Method Details

#auth(type = nil, options = {}, &block) ⇒ Object 



7
8
9
10
11
12
13
 
# File 'lib/grape/middleware/auth/dsl.rb', line 7

def auth(type = nil, options = {}, &block)
  namespace_inheritable = inheritable_setting.namespace_inheritable
  return namespace_inheritable[:auth] unless type

  namespace_inheritable[:auth] = options.reverse_merge(type: type.to_sym, proc: block)
  use Grape::Middleware::Auth::Base, namespace_inheritable[:auth]
end

#http_basic(options = {}, &block) ⇒ Object

Add HTTP Basic authorization to the API.

Parameters:

  • options (Hash) (defaults to: {}) —

    A hash of options.

Options Hash (options):

  • :realm (String) —

    “API Authorization” The HTTP Basic realm.



19
20
21
22
 
# File 'lib/grape/middleware/auth/dsl.rb', line 19

def http_basic(options = {}, &block)
  options[:realm] ||= 'API Authorization'
  auth :http_basic, options, &block
end

#http_digest(options = {}, &block) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/grape/middleware/auth/dsl.rb', line 24

def http_digest(options = {}, &block)
  options[:realm] ||= 'API Authorization'

  if options[:realm].respond_to?(:values_at)
    options[:realm][:opaque] ||= 'secret'
  else
    options[:opaque] ||= 'secret'
  end

  auth :http_digest, options, &block
end