class

OAuth2::Session

Inherits Reference / Object

An OAuth2 session makes it easy to implement APIs that need to refresh an access token once its expired before executing an HTTP request.

Constructors

new(oauth2_client : Client, access_token : AccessToken, expires_at : Time | Nil = Time.utc, &callback : OAuth2::Session -> )

Creates an OAuth2::Session.

Params:

  • oauth2_client: the OAuth2::Client used to refresh an access token.
  • access_token: the OAuth2::AccessToken to make requests.
  • expires_at: the Time when the access token expires.
  • callback: invoked when an access token is refreshed, giving you a chance to persist it.
Source

Instance methods

access_token
Source
authenticate(http_client : HTTP::Client) : Nil

Authenticates an HTTP::Client, refreshing the access token if it is expired.

Invoke this method on an HTTP::Client before executing an HTTP request.

Source
expires_at
Source
oauth2_client
Source