class Signet::OAuth2::Client

Signet::OAuth2::Client creates an OAuth2 client

This reopens Client to add apply and apply! methods which update a hash with the fetched authentication token.

Attributes

universe_domain[RW]

Set the universe domain

Public Instance Methods

build_default_connection() click to toggle source
# File lib/googleauth/signet.rb, line 64
def build_default_connection
  if !defined?(@connection_info)
    nil
  elsif @connection_info.respond_to? :call
    @connection_info.call
  else
    @connection_info
  end
end
configure_connection(options) click to toggle source
# File lib/googleauth/signet.rb, line 37
def configure_connection options
  @connection_info =
    options[:connection_builder] || options[:default_connection]
  self
end
fetch_access_token!(options = {}) click to toggle source
# File lib/googleauth/signet.rb, line 52
def fetch_access_token! options = {}
  unless options[:connection]
    connection = build_default_connection
    options = options.merge connection: connection if connection
  end
  info = retry_with_error do
    orig_fetch_access_token! options
  end
  notify_refresh_listeners
  info
end
Also aliased as: orig_fetch_access_token!
orig_fetch_access_token!(options = {})
Alias for: fetch_access_token!
retry_with_error(max_retry_count = 5) { || ... } click to toggle source
# File lib/googleauth/signet.rb, line 74
def retry_with_error max_retry_count = 5
  retry_count = 0

  begin
    yield
  rescue StandardError => e
    raise e if e.is_a?(Signet::AuthorizationError) || e.is_a?(Signet::ParseError)

    if retry_count < max_retry_count
      retry_count += 1
      sleep retry_count * 0.3
      retry
    else
      msg = "Unexpected error: #{e.inspect}"
      raise Signet::AuthorizationError, msg
    end
  end
end
token_type() click to toggle source

The token type as symbol, either :id_token or :access_token

# File lib/googleauth/signet.rb, line 44
def token_type
  target_audience ? :id_token : :access_token
end
update_token!(options = {}) click to toggle source
# File lib/googleauth/signet.rb, line 30
def update_token! options = {}
  options = deep_hash_normalize options
  update_token_signet_base options
  self.universe_domain = options[:universe_domain] if options.key? :universe_domain
  self
end
Also aliased as: update_token_signet_base
update_token_signet_base(options = {})
Alias for: update_token!