Class: Signet::OAuth2::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/googleauth/signet.rb

Overview

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.

Instance Method Summary collapse

Instance Method Details

#apply(a_hash, opts = {}) ⇒ Object

Returns a clone of a_hash updated with the authentication token


51
52
53
54
55
# File 'lib/googleauth/signet.rb', line 51

def apply a_hash, opts = {}
  a_copy = a_hash.clone
  apply! a_copy, opts
  a_copy
end

#apply!(a_hash, opts = {}) ⇒ Object

Updates a_hash updated with the authentication token


43
44
45
46
47
48
# File 'lib/googleauth/signet.rb', line 43

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 needs_access_token?
  a_hash[AUTH_METADATA_KEY] = "Bearer #{send token_type}"
end

#build_default_connectionObject


88
89
90
91
92
93
94
95
96
# File 'lib/googleauth/signet.rb', line 88

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) ⇒ Object


26
27
28
29
30
# File 'lib/googleauth/signet.rb', line 26

def configure_connection options
  @connection_info =
    options[:connection_builder] || options[:default_connection]
  self
end

#fetch_access_token!(options = {}) ⇒ Object


69
70
71
72
73
74
75
76
77
78
79
# File 'lib/googleauth/signet.rb', line 69

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

#needs_access_token?Boolean

Whether the id_token or access_token is missing or about to expire.

Returns:

  • (Boolean)

38
39
40
# File 'lib/googleauth/signet.rb', line 38

def needs_access_token?
  send(token_type).nil? || expires_within?(60)
end

#notify_refresh_listenersObject


81
82
83
84
85
86
# File 'lib/googleauth/signet.rb', line 81

def notify_refresh_listeners
  listeners = defined?(@refresh_listeners) ? @refresh_listeners : []
  listeners.each do |block|
    block.call self
  end
end

#on_refresh(&block) ⇒ Object


63
64
65
66
# File 'lib/googleauth/signet.rb', line 63

def on_refresh &block
  @refresh_listeners = [] unless defined? @refresh_listeners
  @refresh_listeners << block
end

#orig_fetch_access_token!Object


68
# File 'lib/googleauth/signet.rb', line 68

alias orig_fetch_access_token! fetch_access_token!

#retry_with_error(max_retry_count = 5) ⇒ Object


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/googleauth/signet.rb', line 98

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_typeObject

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


33
34
35
# File 'lib/googleauth/signet.rb', line 33

def token_type
  target_audience ? :id_token : :access_token
end

#updater_procObject

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


59
60
61
# File 'lib/googleauth/signet.rb', line 59

def updater_proc
  proc { |a_hash, opts = {}| apply a_hash, opts }
end