Contents

# frozen_string_literal: true

require 'rack/auth/basic'
require 'active_support/concern'

module Grape
  module Middleware
    module Auth
      module DSL
        extend ActiveSupport::Concern

        module ClassMethods
          # Add an authentication type to the API. Currently
          # only `:http_basic`, `:http_digest` are supported.
          def auth(type = nil, options = {}, &block)
            if type
              namespace_inheritable(:auth, options.reverse_merge(type: type.to_sym, proc: block))
              use Grape::Middleware::Auth::Base, namespace_inheritable(:auth)
            else
              namespace_inheritable(:auth)
            end
          end

          # Add HTTP Basic authorization to the API.
          #
          # @param [Hash] options A hash of options.
          # @option options [String] :realm "API Authorization" The HTTP Basic realm.
          def http_basic(options = {}, &block)
            options[:realm] ||= 'API Authorization'
            auth :http_basic, options, &block
          end

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

Version data entries

11 entries across 11 versions & 2 rubygems

Version	Path
grape-1.6.0	lib/grape/middleware/auth/dsl.rb
grape-1.5.3	lib/grape/middleware/auth/dsl.rb
grape-1.5.2	lib/grape/middleware/auth/dsl.rb
grape-1.5.1	lib/grape/middleware/auth/dsl.rb
grape-1.5.0	lib/grape/middleware/auth/dsl.rb
grape-extra_validators-2.0.0	vendor/bundle/ruby/2.6.0/gems/grape-1.4.0/lib/grape/middleware/auth/dsl.rb
grape-1.4.0	lib/grape/middleware/auth/dsl.rb
grape-1.3.3	lib/grape/middleware/auth/dsl.rb
grape-1.3.2	lib/grape/middleware/auth/dsl.rb
grape-1.3.1	lib/grape/middleware/auth/dsl.rb
grape-1.3.0	lib/grape/middleware/auth/dsl.rb