Module: HTTPX::Plugins::OAuth

Defined in:
lib/httpx/plugins/oauth.rb,
sig/plugins/oauth.rbs

Overview

https://gitlab.com/os85/httpx/wikis/OAuth

Defined Under Namespace

Modules: InstanceMethods, OAuthRetries, OptionsMethods, _OAuthOptions Classes: OAuthSession

Constant Summary collapse

SUPPORTED_GRANT_TYPES =

Returns:

  • (::Array[grant_type]) 
%w[client_credentials refresh_token].freeze
SUPPORTED_AUTH_METHODS =

Returns:

  • (::Array[token_auth_method]) 
%w[client_secret_basic client_secret_post].freeze

Class Method Summary collapse

Class Method Details

.extra_options(options) ⇒ Object 



26
27
28
 
# File 'lib/httpx/plugins/oauth.rb', line 26

def extra_options(options)
  options.merge(auth_header_type: "Bearer")
end

.load_dependencies(klass) ⇒ void

This method returns an undefined value.

Parameters:



14
15
16
17
18
 
# File 'lib/httpx/plugins/oauth.rb', line 14

def load_dependencies(klass)
  require "monitor"
  require_relative "auth/basic"
  klass.plugin(:auth)
end

.subplugins ⇒ Object 



20
21
22
23
24
 
# File 'lib/httpx/plugins/oauth.rb', line 20

def subplugins
  {
    retries: OAuthRetries,
  }
end