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.

Public Instance Methods

apply(a_hash, opts = {}) click to toggle source

Returns a clone of a_hash updated with the authentication token

# File lib/googleauth/signet.rb, line 56
def apply(a_hash, opts = {})
  a_copy = a_hash.clone
  apply!(a_copy, opts)
  a_copy
end

apply!(a_hash, opts = {}) click to toggle source

Updates a_hash updated with the authentication token

# File lib/googleauth/signet.rb, line 48
def apply!(a_hash, opts = {})
  # fetch the access token there is currently not one, or if the client
  # has expired
  fetch_access_token!(opts) if access_token.nil? || expires_within?(60)
  a_hash[AUTH_METADATA_KEY] = "Bearer #{access_token}"
end

build_default_connection() click to toggle source

# File lib/googleauth/signet.rb, line 91
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 41
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 74
def fetch_access_token!(options = {})
  unless options[:connection]
    connection = build_default_connection
    options = options.merge(connection: connection) if connection
  end
  info = orig_fetch_access_token!(options)
  notify_refresh_listeners
  info
end

Also aliased as: orig_fetch_access_token!

notify_refresh_listeners() click to toggle source

# File lib/googleauth/signet.rb, line 84
def notify_refresh_listeners
  listeners = @refresh_listeners || []
  listeners.each do |block|
    block.call(self)
  end
end

on_refresh(&block) click to toggle source

# File lib/googleauth/signet.rb, line 68
def on_refresh(&block)
  @refresh_listeners ||= []
  @refresh_listeners << block
end

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 101
def retry_with_error(max_retry_count = 5)
  retry_count = 0

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

    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

updater_proc() click to toggle source

Returns a reference to the apply method, suitable for passing as a closure

# File lib/googleauth/signet.rb, line 64
def updater_proc
  lambda(&method(:apply))
end