Class: Google::Auth::TokenStore

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

Overview

Interface definition for token stores. It is not required that implementations inherit from this class. It is provided for documentation purposes to illustrate the API contract.

Class Attribute Summary collapse

Instance Method Summary collapse

Class Attribute Details

.default ⇒ Object

Returns the value of attribute default.



22
23
24
 
# File 'lib/googleauth/token_store.rb', line 22

def default
  @default
end

Instance Method Details

#delete(_id) ⇒ Object

Remove the token data from storage for the given ID.

Parameters:

  • id (String) —

    ID of the token data to delete

Raises:

  • (NoMethodError) 


49
50
51
 
# File 'lib/googleauth/token_store.rb', line 49

def delete _id
  raise NoMethodError, "delete not implemented"
end

#load(_id) ⇒ String

Load the token data from storage for the given ID.

Parameters:

  • id (String) —

    ID of token data to load.

Returns:

  • (String) —

    The loaded token data.

Raises:

  • (NoMethodError) 


31
32
33
 
# File 'lib/googleauth/token_store.rb', line 31

def load _id
  raise NoMethodError, "load not implemented"
end

#store(_id, _token) ⇒ Object

Put the token data into storage for the given ID.

Parameters:

  • id (String) —

    ID of token data to store.

  • token (String) —

    The token data to store.

Raises:

  • (NoMethodError) 


41
42
43
 
# File 'lib/googleauth/token_store.rb', line 41

def store _id, _token
  raise NoMethodError, "store not implemented"
end