class OAuth2::Session
Overview
An OAuth2 session makes it easy to implement APIs that need to refresh an access token once its expired before executing an HTTP request.
Defined in:
oauth2/session.crClass Method Summary
-
.new(oauth2_client : Client, access_token : AccessToken, expires_at = Time.utc_now, &callback : OAuth2::Session -> )
Creates an OAuth2::Session.
Instance Method Summary
- #access_token : OAuth2::AccessToken
-
#authenticate(http_client)
Authenticates an HTTP::Client, refreshing the access token if it is expired.
- #expires_at : Time
- #oauth2_client : OAuth2::Client
Instance methods inherited from class Reference
==(other)==(other : self) ==, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, same?(other : Reference)
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Instance methods inherited from class Object
!=(other)
!=,
!~(other)
!~,
==(other)
==,
===(other)===(other : YAML::Any)
===(other : JSON::Any) ===, =~(other) =~, class class, clone clone, crystal_type_id crystal_type_id, dup dup, hash hash, inspect
inspect(io : IO) inspect, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(io : IO)
to_pretty_json to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try
Class methods inherited from class Object
==(other : Class)
==,
===(other)
===,
cast(other) : self
cast,
from_json(string_or_io) : self
from_json,
from_yaml(string : String) : self
from_yaml,
hash
hash,
inspect(io)
inspect,
name : String
name,
to_s(io)
to_s,
|(other : U.class)
|
Class Method Detail
def self.new(oauth2_client : Client, access_token : AccessToken, expires_at = Time.utc_now, &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.
Instance Method Detail
def authenticate(http_client)
#
Authenticates an HTTP::Client, refreshing the access token if it is expired.
Invoke this method on an HTTP::Client before executing an HTTP request.