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 57 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 token_type = target_audience ? :id_token : :access_token fetch_access_token! opts if send(token_type).nil? || expires_within?(60) a_hash[AUTH_METADATA_KEY] = "Bearer #{send token_type}" end
build_default_connection()
click to toggle source
# File lib/googleauth/signet.rb, line 94 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 75 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!
notify_refresh_listeners()
click to toggle source
# File lib/googleauth/signet.rb, line 87 def notify_refresh_listeners listeners = defined?(@refresh_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 69 def on_refresh &block @refresh_listeners = [] unless defined? @refresh_listeners @refresh_listeners << block end
retry_with_error(max_retry_count = 5) { || ... }
click to toggle source
# File lib/googleauth/signet.rb, line 104 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
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 65 def updater_proc lambda(&method(:apply)) end